Everyone is welcome to join our documentation team! It’s a great way to build up experience in a large and well-known open source project, especially if you’re interested in a career in technical writing one day.
Running LibreOffice on Windows 10? Need help with file management? Check out this video for beginners, created by volunteers in our documentation community… (Thanks to Harald Berger)
News from the documentation community: The Help project of LibreOffice underwent a major revamp in the last couple of years, with the introduction of the browser-based Help replacing the old Writer-Web solution. Still, editing the Help XML files (XHP) continued to be very hard for any volunteer or skilled developer, due to the specifics of the XML dialect and time required to be proficient in writing Help pages, which continued to be a major block for any individual.
To address the issue, we developed an online editor to assist and make textual editing quicker for any Help writer, by featuring the possibility of rendering the help page at once, at the click of a button. Also, we implemented a series of checking, including XML validity and the verification of ID unicity, crucial for translation.
Editor main screen with page loaded
The Help editor is available at https://newdesign.libreoffice.org/xhpeditor/index.php and contains features that greatly improve and simplify the XHP editing process. For instance, the menu allows users to write content in plain text and the wrap each text segment into the proper XHP tag. For example, after writing a paragraph in plain text, select the text and choose menu Paragraph – <paragraph> to wrap the text into a paragraph tag with the benefit of adding a unique identifier for the paragraph, which is vital for the translation process of LibreOffice Help.
Another nice feature is the editor autocompletion, which allows user to type only the start of a tag name and the editor suggests the rest of the name, sparing the energy spent in typing the whole tag name. When adding any tag to the text, the autoclose feature adds the closing tag automatically. Users can also press F11 to display the editing area in the whole browser area, enlarging the editing space, or even press Ctrl+F to open a search and replace window in the editor.
Help page verification
You can open and save a local XHP file and select Tool – Render page to have it displayed in the browser area. Or you can copy the XHP plain text and paste in the editor area to continue edition. The XHP editor uses CodeMirror, a popular JavaScript editor with many, many interesting features.
Detailed instructions and a short User manual are available in the wiki page https://wiki.documentfoundation.org/DocumentationHelpEditor and can also be accessed from the editor Help menu. To read the XHP dialect reference , use menu Help > XHP Reference.
We hope the editor will encourage volunteers to address the challenge of writing and updating the Help pages. We are eager to receive suggestion and contributions to the editor project. Come and join us!
the LibreOffice Online Guide was created as part of the Google Season of Docs programme, and released in December 2019. Today we’re announcing that the Czech LibreOffice community has finished translating the guide, and it can be downloaded here. (See this page for English documentation.)
It was a team effort, and participants were Petr Kuběj, Zuzana Pitříková, Zdeněk Crhonek, Roman Toman, Tereza Portešová, Petr Valach and Stanislav Horáček. Thanks to all volunteers! The Czech team continues with the translation of the Getting Started Guide, and is always open for new volunteers, translators and correctors. Give them a hand!
Berlin, January 27th, 2020 – The LibreOffice Documentation Team is happy to announce the Calc Guide 6.2, a long-awaited update of the old Calc Guide 4.4, to cover all of the innovations included in newer versions of the suite. The team wanted to catch-up with the forthcoming release of LibreOffice 6.4, while offering to the user community a book with its contents suitable for the most-used features of the LibreOffice 6 family.
Several team members contributed to the effort, notably Steve Fanning, Jean Weber, Kees Kriek, Cathy Crumbley, Zach Parlimann, Dave Barton and Drew Jensen.
“Joining the LibreOffice Documentation Team was an opportunity for me to continue to be technically active after my recent retirement and, with my mathematical background, the Calc Guide was a great book for me to start with“, said Steve Fanning, volunteer technical writer. “I enjoyed contributing to the update of this guide, finding the task both interesting and challenging. In fact, one of the topics caught my imagination to such an extent that I proposed, and am now implementing, a new wiki-based online reference guide for the extensive set of spreadsheet functions provided by Calc“, he added.
Steve Fanning
The LibreOffice suite – and the Calc spreadsheet module in particular – is a complex application with many uses in the modern world. Calc is widely used in all kinds of businesses, and contains advanced calculation and mathematical features that demand quality and broad documentation. The team strived to provide the best content, from simple arithmetic calculations to complex features such as statistics, enhanced pivot tables, data crunching techniques and many more.
The Dutch community is actively translating the LibreOffice Guides to improve the reach of LibreOffice in the Netherlands. “The Calc Guide is an important piece of documentation that is always in great demand from our users. I devoted time and energy to review many chapters and get the guide ready quickly, so it was also possible to start the translation to Dutch sooner, and have the Dutch users benefit of the new Calc guide too“, said Kees Kriek, volunteer reviewer and translator for the Dutch community.
Berlin, January 22nd, 2020 – With the upcoming release of LibreOffice 6.4, the Documentation Team is proud to announce the Math Guide 6.4, an update of the previous Math 4.0 guide, updated to cover all innovations included in LibreOffice 6.4. The guide was updated by Roman Kuznetsov and revised by Dave Barton from the documentation community.
“I updated the Math Guide to give everyone up-to-date information about using that interesting and (often forgotten) tool in LibreOffice”, said Roman Kuznetsov, community member and volunteer technical writer. “I did it to improve my skills in writing of documentation. Also I want say thank you to the LibreOffice Documentation Team for its help with that task.”
The LibreOffice Documentation Team is devoted to producing the best documentation for the LibreOffice end user, and is actively pursuing the goal of keeping the LibreOffice literature updated, effective and accurate. Come and join us!.
