Xfce Wiki

Sub domains
 

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
documentation [2010/11/07 09:49]
mike updated writers section
documentation [2011/10/20 16:34] (current)
mike [Developers]
Line 1: Line 1:
 +~~NOTRANS~~
 +
 ====== Xfce Documentation ====== ====== Xfce Documentation ======
  
Line 19: Line 21:
 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. 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.
  
-==== Retrieving ​and creating ​documentation ​==== +  * [[documentation:​retrieve-documentation|Retrieve ​and create ​documentation]] 
- +  * [[documentation:​compile-documentation|Compile and read documentation]] 
-  * how to download the xfce4-docs repo +  * [[documentation:​templates|Templates]]
-  * how to checkout a documentation +
-  * how to create a new documentation +
  
 ===== Translators ===== ===== Translators =====
Line 32: Line 31:
 ===== Developers ===== ===== Developers =====
  
-  * How to add .gitmodules +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. 
-  * How to use the latest xdt-autogen with XDT_AUTOGEN_CHECK_DOCS+ 
 +  * [[documentation:​migrate-documentation|Set up documentation]]