Documentation/Wish List

TDF LibreOffice Document Liberation Project Community Blogs Weblate Nextcloud Redmine Ask LibreOffice Donate

• Wiki Home
• Development
• Design
• QA
• Events
• Documentation
• Website
• Localization
• Accessibility
• Marketing
• Diversity
• Wiki Help

• Documentation Home
• Official Publications
• Other Resources
• FAQ
• HowTo
• Macros
• Docs Development

Please list here anything you would like to see provided. This includes updating existing documentation that is old or inadequate.

If you see something that you could help with, see Documentation/Development for instructions.

Wish list for user documentation

Note: Currently some old drafts are hosted on this page. These need to be moved somewhere more appropriate, such as a new wiki page, or ODFAuthors.

User guides, tutorials, etc.

Guides and tutorials on topics aimed at intermediate and advanced users:

• A collection of examples for LibreOffice Math (e.g. markup language for a 4x4-matrix with placeholders, spread over multiple lines)
  • Here is a first draft - comments welcome.
• Styles and templates in Writer
  • outline and proposed topic list
• Using XForms in LibreOffice - Could be based on J David Eisenberg's 2006 paper, XForms and OpenDocument in OpenOffice.org, which we have permission to use as we see fit. More info is in Valden Longhurst's 2009 paper, Using XForms and the OpenDocument format in OpenOffice.org and StarOffice, but we may not be able to copy from that one.

Documents aimed at specific audiences, e.g. technical writers, small business, university students:

• Guide for technical writers
  • DocPlan: Guide for Technical Writers
  • Draft: Guide for technical writers (LO 3.3)
• Using Assistive Technologies With LibreOffice

Update old OpenOffice.org user guides for the current version of LibreOffice:

• Migration Guide - Update and adapt the OpenOffice.org 2.0 migration guide for LibreOffice
• Administrators' Guide - Could be based on the OpenOffice.org Admin Guide.
• Basic Programmers' Guide - Could be based on the OpenOffice.org BASIC Programmers' Guide.
• Developers' Guide - Could be based on the OpenOffice.org Developers' Guide.

Other ideas:

• Make user guides available in other formats
  • wiki format -- in progress
  • ePub format -- see EPUB

Wiki

• Finish the English version of the FAQs
• Re-organize the Documentation wiki-pages structure
  • in progress, Khanson679 (talk) 2017-08-19T06:23:15 (UTC)

For Doc Team

• A library of material to be used in more than one document. For example, some info on setup, customization, printing, and PDF export is used in guides for several components.

Miscellaneous

• Training materials (may be done through another group in LibreOffice community?)

Wish List for Developer Documentation

Note: This section needs to be updated.

• Packaging (.deb, .rpm, .dmg, .pisi,...)

• UNO/LibreOffice Object Model (objects, methods, properties) would help macro and LibreOffice developers alike.
  • A few diagrams of the object model hierarchy would help newcomers get started faster.  

• Documentation on using Javascript for Extensions and Macros

• Documentation on debugging macros/Extensions in Java, Python, Javascript. There is some info on the "how to debug" page existing (scroll to the end), but is is sparse and lacks images/examples to clarify.

• Developer level workflow including git, running soffice with the debugger and when to build all/modules.  Developer FAQs for different phases of development.  (These probably belong in Development section).