master ticket for new documentation approach
- Bring all help content together
- Use the XHP help as the primary source of information
- Make it easier for end users to contribute fixes and new content
- Retire old tools like the HelpAuthoring extension (buggy and generates bad XHP)
- Remove offline (F1 key) built-in help tool in LO 6.0 (Kendy is working on a patch for this)
- For LO 6.0, create help packages (Olivier)
- From LO 6.0 onwards, offline and online help will be displayed in the user's browser, for better rendering
- Update XHP spec for additional sections, so that some can be used in online help, and others for books (Mike and Olivier)
- For LO 6.1, implement an "Edit" button in the online help, along with login credentials and a user-friendly WYSIWYG editor that saves as XHP (Mike to work on this)
- Then implement the workflow: use Git as ultimate source of XHP, and Gerrit for submissions of help content changes. When the user saves his/her changes, the editor creates a commit after submission, which goes to Gerrit for review by the docs team. (Maybe add a bot to do XML verification before integration?) (Mike to work on this)
- Long-term goal for LO 6.2: extend XHP for merging with the books (eg sections or markup) - maybe even generate new guidebooks from that content. Add an editor preview mode - eg show how changes will look in the context of other help sections or a book
- Another long-term goal: add "Search Ask" bar to online help interface
- Call on November 14th or 15th to discuss progress and ideas
- Mike to join ESC calls
#1 Updated by Mike Saunders 5 months ago
Making notes of some reference materials for the XHP specification, as I start to investigate it:
#2 Updated by Olivier Hallot 5 months ago
This one may also help in the editor phase
#3 Updated by Mike Saunders 4 months ago
So here's an update on the XML editor situation. Buovjaga has helpfully pointed out a couple of options:
- CodeMirror, which is non-WYSIWYG: https://codemirror.net
- ProseMirror, which adds WYSIWYG on top: https://prosemirror.net
I'm investigating the latter now, as I believe WYSIWYG is important for encouraging people to work on the docs, without having to know what's going on with XML in the background.
Also waiting to hear from Jean Spiteri regarding his ideas, but haven't heard from him for a few weeks now.
#4 Updated by Mike Saunders 4 months ago
- File editor_progress_1.png editor_progress_1.png added
- File editor_progress_2.png editor_progress_2.png added
- File editor_progress_3.png editor_progress_3.png added
Still haven't heard back from Jean Spiteri, and ProseMirror turns out to be immensely complicated (the developers even describe it as a toolkit for creating editors, rather than an editor itself). So I've been working on an editing system that's built upon the new web help viewer that Olivier has created: https://helponline.libreoffice.org
First I added the "contenteditable" attribute to the "DisplayArea" div. This makes the div editable, but there's no immediate way to store the changes
- editor_progress_1.png - "DisplayArea" with "contenteditable" attribute, and a Save button which sends the data to process.php
- editor_progress_2.png - The output of process.php, a one-line script which just shows the data passed to it. Here's where we have a limitation...
- editor_progress_3.png - The data being passed (.innerHTML from the "DisplayArea" div) is the HTML after the stylesheet transformation, whereas we want the XML.
#5 Updated by Florian Effenberger 18 days ago
- Status changed from New to In Progress
#6 Updated by Mike Saunders 16 days ago
Florian Effenberger wrote:
Olivier Hallot and Mike Saunders - can you update this ticket? Ideally Olivier shares the state of play with Mike and outlines the next steps, and Mike updates the ticket as we've done initially. Then we can split individual larger tasks into subtickets.
I'll arrange a catch-up call with Olivier now, and we can make a roadmap for the next steps. Then I'll update this.
#7 Updated by Jean Spiteri 15 days ago
Just to let you know, I've finished a basic 1.0 version of my work if there is still interest. Mike Saunders and Olivier Hallot should have received a status update from me. If anyone wants to help, feel free to ask for updates on this ticket. Thank you Florian for letting me know (indirectly) about the mention feature.