Task #2938: XHP editor - Documentation - The Document Foundation Redmine

Task #2938

closed

XHP editor

Added by Florian Effenberger over 5 years ago. Updated almost 4 years ago.

Status:

Closed

Priority:

Normal

Assignee:

Olivier Hallot

Target version:

Team - Q1/2020

Start date:

Due date:

% Done:

Description

As discussed during the in-person meeting in Munich:

https://newdesign.libreoffice.org/help_editor/index.html
Need to change rendering in right-hand panel to PHP - to do it server-side (currently doesn't work in Safari/IE)
For "Open File" - picker/browser would be better
Buttons complete - make prettier
CodeMirror plugin can be built against our version of Gerrit - but JS bits didn't work https://vm178.documentfoundation.org/#/q/status:open - "Plugin "codemirror-editor" failed to load" - it's trying to load https://vm178.documentfoundation.org/plugins/codemirror-editor/static/codemirror_editor.html
Eventual plan to upgrade to Gerrit 2.16, which should make it work - upgrades will take a lot of work though, path is very problematic - so not before the conference; possibly before FOSDEM
For LibOCon: finalise interface and PHP rendering, and encourage doc editors to use it in copy-and-paste mode

Related issues

Related to Documentation - Task #2394: master ticket for new documentation approach

In Progress

Olivier Hallot

Actions

Issue # Delay: days Cancel

History
Notes
Property changes

Actions

Copy link

Updated by Florian Effenberger over 5 years ago

Related to Task #2394: master ticket for new documentation approach added

Actions

Copy link

Updated by Olivier Hallot about 5 years ago

Better naming for organization
https://gerrit.libreoffice.org/#/c/84028/

Initial php port
https://gerrit.libreoffice.org/#/c/84200/
https://gerrit.libreoffice.org/#/c/84222/

Actions

Copy link

Updated by Olivier Hallot about 5 years ago

Move editor to php (3) (WIP)

add a config file
remove cruft in XSLT

Change-Id: I820895cf646844235192cbf7eb0e739716142039
Reviewed-on: https://gerrit.libreoffice.org/84262

Move editor to php (4) (WIP)

Fix image position
Improve rendered CSS

Change-Id: I82c756c201b5b24ec3cc2c7de84fe62b11e6904b
Reviewed-on: https://gerrit.libreoffice.org/84265

Actions

Copy link

Updated by Olivier Hallot about 5 years ago

Move editor to php (5) (WIP)

remove cruft from javascript

Change-Id: Iabb1b9518d90b68eebececb36c7ab431adbbf0e6
Reviewed-on: https://gerrit.libreoffice.org/84469
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
Tested-by: Olivier Hallot <olivier.hallot@libreoffice.org>

XHP editor: open local file and render

Change-Id: Ia6e1358064281e03d326f6398fb101a71637450e
Reviewed-on: https://gerrit.libreoffice.org/84541
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
Tested-by: Olivier Hallot <olivier.hallot@libreoffice.org>

Actions

Copy link

Updated by Olivier Hallot about 5 years ago

Next step:
- Upload current status in NewDesign
- Save XHP locally

Actions

Copy link

Updated by Olivier Hallot about 5 years ago

Code is uploaded:

https://newdesign.libreoffice.org/xhpeditor/index.php

Should open the editor.

Actions

Copy link

Updated by Mike Saunders about 5 years ago

https://newdesign.libreoffice.org/xhpeditor/index.php

Thanks Olivier -- I can confirm that it works in Chome, Firefox and Safari. It looks like it's already in a good state for XHP editors to use; what do you plan to implement next (eg the "Generate patch") button? As mentioned, I can look into some cosmetic improvements, or we can let the community try that...

Actions

Copy link

Updated by Olivier Hallot about 5 years ago

To test the rendering, please clone the Help repo with 'git clone https://gerrit.libreoffice.org/help helpcontent2' and you will have the folder helpcontent2 in your computer. Then click on Open File in the Editor and choose any file in helpcontent2/source/text/ in your computer. After loading, click Render to see the file on the left.

to refresh memory, the editor code is in dev-tools/ repo. To clone in your local machine and hack, use 'git clone https://gerrit.libreoffice.org/dev-tools dev-tools' and the editor is under help3/

If you have a local web server, you can configure it to open dev-tools/help3/xhpeditor/index.php and set the config.php file for the right folder locations.

Interesting tasks to follow.
Housekeeping: separate editor CSS from rendering CSS. The last is in xhpeditor.css. Note: the left and right sides of the screen is id="rightside" and id="leftside" div's.

Actions

Copy link

Updated by Olivier Hallot about 5 years ago

Progress report

Author: Olivier Hallot <olivier.hallot@libreoffice.org>
Date: Sat Dec 7 19:14:20 2019 -0300

Fixes in the editor XSLT

Change-Id: I0d553d506343c6134f95f9502e64e3c14c17b2ea
    Reviewed-on: https://gerrit.libreoffice.org/84700

Author: Olivier Hallot <olivier.hallot@libreoffice.org>
Date: Sat Dec 7 19:15:56 2019 -0300

Fix snippets.js

Change-Id: I62a4a813e91a7f1cdeb1f4c13f177feff0daaa57
    Reviewed-on: https://gerrit.libreoffice.org/84701

Author: Olivier Hallot <olivier.hallot@libreoffice.org>
Date: Sat Dec 7 22:30:46 2019 -0300

Add MAC code snippets

Change-Id: Iea9a6d185beaacb8590d7c8f79760c49fcf4c4da
    Reviewed-on: https://gerrit.libreoffice.org/84703

Author: Olivier Hallot <olivier.hallot@libreoffice.org>
Date: Sat Dec 7 22:33:02 2019 -0300

Add Save command in XHP editor

Change-Id: Idee319110ca2613dc33dcd220fc50b9f91923906
    Reviewed-on: https://gerrit.libreoffice.org/84704

Actions

Copy link

#10

Updated by Olivier Hallot about 5 years ago

Author: Olivier Hallot <olivier.hallot@libreoffice.org>
Date: Mon Dec 9 11:42:37 2019 -0300

XHP Editor: add 'system' switches

Add buttons to select computer system on rendered page
Mute links to prevent clicking on href's
cleanup on scripts

Change-Id: I90de6a2ce84b59df9764f0bdd123579177ff7016
    Reviewed-on: https://gerrit.libreoffice.org/84757

Author: Olivier Hallot <olivier.hallot@libreoffice.org>
Date: Mon Dec 9 13:16:06 2019 -0300

Add appl switch selector

Change-Id: Ie412a4b391a444b1f68e750fd657c0a817e836f2
    Reviewed-on: https://gerrit.libreoffice.org/84769

Author: Olivier Hallot <olivier.hallot@libreoffice.org>
Date: Mon Dec 9 18:20:19 2019 -0300

handle rendered images style

Change-Id: If854b8a2c8d0cf7f7c3e8bf15aaf5899dfd9c85d
    Reviewed-on: https://gerrit.libreoffice.org/84790

Author: Olivier Hallot <olivier.hallot@libreoffice.org>
Date: Tue Dec 10 10:37:49 2019 -0300

xhpeditor: remove references to online/offline help

Change-Id: I8051258b12d1deafce87cd3b00f68ed801830702
    Reviewed-on: https://gerrit.libreoffice.org/84848

Actions

Copy link

#11

Updated by Olivier Hallot about 5 years ago

Author: Olivier Hallot <olivier.hallot@libreoffice.org>
Date: Tue Dec 17 08:27:19 2019 -0300

xhpeditor: implement check XHP and refactor

changed switch selector to radio
offload index.php of chuncks of HTML
Implement check DTD (after stackoverflow)
added companion snippets.php for aux functions

Change-Id: I54bd08f1316227d1b3f1e597cb9a043ca5f4e9c5
    Reviewed-on: https://gerrit.libreoffice.org/85291

Actions

Copy link

#12

Updated by Olivier Hallot almost 5 years ago

xhpeditor: Add duplicate ID check for XHP

Add check of duplicated id for
- paragraph,
- headings ('-6)
-and notes, tips, warning

Change-Id: I10049bda08f03cc940d1678253fbee8f80996d11
Reviewed-on: https://gerrit.libreoffice.org/c/dev-tools/+/86221
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
Tested-by: Olivier Hallot <olivier.hallot@libreoffice.org>

xhpeditor: fixes and improvements

- close bracket at right place
- improve icontable snippet
- add image paragraph
- better switch layout
- better switchinline layout

Change-Id: Ib1f57d0ba35937a5b81427d180d0c5a53769ecaa
Reviewed-on: https://gerrit.libreoffice.org/c/dev-tools/+/86228
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
Tested-by: Olivier Hallot <olivier.hallot@libreoffice.org>

Add XML formation check

Change-Id: I14d87d2e348a795286bd08d36015bac38c88a9ba
Reviewed-on: https://gerrit.libreoffice.org/c/dev-tools/+/86242
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
Tested-by: Olivier Hallot <olivier.hallot@libreoffice.org>

Actions

Copy link

#13

Updated by Olivier Hallot almost 5 years ago

xhpeditor: several refactor

- place codemirror config in proper javascript file
- refactor snippets buttons
- add codemirror niceties (WIP)

Change-Id: I6b0afd1a120026e5952823d370d5f7827b3c6fe5
Reviewed-on: https://gerrit.libreoffice.org/c/dev-tools/+/86271
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
Tested-by: Olivier Hallot <olivier.hallot@libreoffice.org>

Actions

Copy link

#14

Updated by Olivier Hallot almost 5 years ago

Wiki page on the XHP Help editor, with instructions and tips to use:

https://wiki.documentfoundation.org/DocumentationHelpEditor

Actions

Copy link

#15

Updated by Olivier Hallot almost 5 years ago

Fix header in rendered page

Allow to keep the appl and sys selectors visible when scrolling
the rendered page.

Change-Id: I5579523b73f6bd734bcae2854e788ad760abb954
Reviewed-on: https://gerrit.libreoffice.org/c/dev-tools/+/86628
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
Tested-by: Olivier Hallot <olivier.hallot@libreoffice.org>

xhpeditor: Add dropdown menu

- Add css-only dropdown menu from W3C
- Add Help for XHP ref and editor commands
- Fix header divs on top to display when scrollng
- Refactor large chunks of page elemets display

Change-Id: Ie173c492a72b9f49200303d99b30544bdfc0d53e
Reviewed-on: https://gerrit.libreoffice.org/c/dev-tools/+/86636
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
Tested-by: Olivier Hallot <olivier.hallot@libreoffice.org>

Actions

Copy link

#16