 |
Other languages English; None yet |
Please remove this {{Draft}}template, when you're sure the page is complete and correct.
|
Contents
Introduction
This page deals with the tools and processes to write Mageia's official documentation. Whilst primarily intended for use by members of the Documentation Team, all are welcome to read it.
This page is intended to replace How to write and translate Mageia doc, which became outdated. About translating our official documentation, How to translate our official documentation will be written later.
Requirements
If you aren't coming from this page https://wiki.mageia.org/en/Documentation_team, have a look at it. You will learn how to join the Doc team and how to subscribe to the doc-discuss mailing list. It is the place to be to have all the needed information about every work in progress.
From writing to publishing
Our manuals and help files are written using DocBook XML files. They are written with Calenco tools on the Calenco website, although it is also possible to upload new or changed XML files. The latter is done for all translations. Calenco tools are used to create HTML, WebHelp HTML, EPUB and PDF publications. See Calenco's exhaustive documentation. There is also a very short quickstarter available.
Calenco access
If you would like to help improve our official documentation and have already helped to improve the English part of our wiki, then you can ask for credentials.
However, If we see that we haven't managed to explain you well enough how to correctly contribute to the wiki, then we first need to find a way to improve our communication.
If that isn't a problem, then you can send a mail to
"papoteur At mageia DOT org"
This e-mail must include the following information:
- Your full name (given name + surname)
- The chosen nickname
Additions to the Calenco documentation
Some things that weren't easy to find in the large Calenco manual:
Where to select to create a new publication
In the Documents tab, select the article or book that is needed for the publication and then click on the book icon on the same line. In the Publications pop up that appears, you can select to create a publication.
