Project

General

Profile

Task #2394

Updated by Florian Effenberger almost 6 years ago

GOALS 

 * Bring all help content together 
 * -Use Use the XHP help as the primary source of information- information 
 * -Make Make it easier for end users to contribute fixes and new content- content 
 * -Retire Retire old tools like the HelpAuthoring extension (buggy and generates bad XHP)- XHP) 

 STEPS 

 * -Remove Remove offline (F1 key) built-in help tool in LO 6.0 (Kendy is working on a patch for this)- this) 

 * -For For LO 6.0, create help packages (Olivier)- (Olivier) 

 * -From From LO 6.0 onwards, offline and online help will be displayed in the user's browser, for better rendering- rendering 

 * -Update Update XHP spec for additional sections, so that some can be used in online help, and others for books (Mike and Olivier)- 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 

 TRACKING PROGRESS 

 * Call on November 14th or 15th to discuss progress and ideas 

 * Mike to join ESC calls 

Back