Differences
This shows you the differences between two versions of the page.
| |
| zh-cn:documentation [2021/02/04 03:14] – created yjwork | zh-cn:documentation [2026/10/04 18:00] (current) – Delete untranslated page epetriglia |
|---|
| FIXME **This page is not fully translated, yet. Please help completing the translation.**\\ //(remove this paragraph once the translation is finished)// | |
| |
| ~~NOTRANS~~ | |
| |
| ====== Xfce Documentation ====== | |
| |
| This page describes the Xfce documentation project as well as how documentation works for writers, translators and developers. | |
| |
| **NB:** this page is a work in progress | |
| |
| ===== Generalities ===== | |
| |
| The documentation is available online at [[http://git.xfce.org/|git.xfce.org]] in the //xfce4-docs// repository. The //master// branch contains the Xfce User Guide, a general documentation for the Xfce desktop. Furthermore this repository is made up of one branch per documentation, for example the Xfce Panel documentation is held in the branch //xfce4-panel-master//. | |
| |
| The documentation is written with the [[http://projectmallard.org/|Mallard]] markup language. | |
| |
| Translation is done on Transifex at [[http://translations.xfce.org/|translations.xfce.org]] as individual PO files. | |
| |
| ===== Writers ===== | |
| |
| To discuss the Xfce documentation project you have to join the mailing-list [[http://foo-projects.org/mailman/listinfo/xfce4-dev|xfce4-dev]]. When sending messages to the list simply make it clear in the subject of your message that it concerns the documentation. | |
| |
| For people new and interested into writing documentation, there is a [[http://library.gnome.org/devel/gdp-handbook/stable/index.html.en|complete handbook]] written by the [[http://live.gnome.org/DocumentationProject|GNOME Documentation Project]]. It contains useful information on how to present the content, categorize the sections or the overall tone to keep inside a documentation. However since the Xfce documentation is written in Mallard markup language, the sections concerning Docbook are insignificant. | |
| |
| * [[documentation:retrieve-documentation|Retrieve and create documentation]] | |
| * [[documentation:compile-documentation|Compile and read documentation]] | |
| * [[documentation:templates|Templates]] | |
| |
| ===== Translators ===== | |
| |
| **NB:** we probably should wait til Tx 1.0 gets installed. | |
| |
| ===== Developers ===== | |
| |
| As a developer of a project, you can migrate existing documentation inside the //xfce4-docs// repository. To then include a documentation in your project from this repository, you will need to add a git submodule, and update the //autogen.sh// script with a recent version of the Xfce devevelopment tools (//xfce4-dev-tools//). Starting version 4.7.3 there is a new check specific for documentation to initialize the git submodule automatically. | |
| |
| * [[documentation:migrate-documentation|Set up documentation]] | |
| |