Xfce Wiki

Sub domains
 

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
contribute:documentation [2015/02/27 22:56] – [Screenshots] ochosicontribute:documentation [2022/11/02 05:46] (current) – grammar improvement kevinbowen
Line 1: Line 1:
 +~~NOTOC~~
 ====== Documentation ====== ====== Documentation ======
 +
 +
 +  * **[[#Contributing|Contributing]]**
 +  * **[[#Reporting Bugs|Reporting Bugs]]**
 +  * **[[#Editing the Documentation|Editing the Documentation]]**
 +  * **[[#Screenshots|Screenshots]]**
  
 ===== Introduction ===== ===== Introduction =====
  
-Since Xfce 4.10 there are no application manuals in the packages. Reason for this change is that hardly any documentation was contributed over the years mainly because people had problems with the various formats (docbook and mallard) or with the complexity of the VCS((GIT, the Version Control System used by Xfce)).+Since Xfce 4.10, there are no application manuals in the packages. The reason for this change is that hardly any documentation was contributed over the years mainly because people had problems with the various formats (docbook and mallard) or with the complexity of the VCS((GIT, the Version Control System used by Xfce)).
  
-To make the documentation barrier lower it was decided to start a documentation wiki where contributors, developers and translators can work on good and up-to-date documentation.+In order to lower the documentation barrier, it was decided to start a documentation wiki where contributors, developers and translators can work on good and up-to-date documentation.
  
 From the various dialogs and links in the Xfce applications, we redirect to the sections in this wiki. From the various dialogs and links in the Xfce applications, we redirect to the sections in this wiki.
 +
 +----
  
 ===== Contributing ===== ===== Contributing =====
Line 15: Line 24:
 For translators the same applies, however then send an email to the [[https://mail.xfce.org/mailman/listinfo/xfce-i18n|xfce-i18n]] mailing list. Make sure you also include the language you want to translate. Note that this only applies for an account on docs.xfce.org, information about code translation can be found [[contribute:translate:|here]]. For translators the same applies, however then send an email to the [[https://mail.xfce.org/mailman/listinfo/xfce-i18n|xfce-i18n]] mailing list. Make sure you also include the language you want to translate. Note that this only applies for an account on docs.xfce.org, information about code translation can be found [[contribute:translate:|here]].
  
-===== Special Syntax =====+----
  
-A number of plugins are installed to make the wiki suitable for writing documentation, at the bottom of the [[/wiki/syntax?#notes|syntax]] take those plugins are listed.+===== Reporting Bugs ===== 
 +If you happen to find a typo, dead link, missing or outdated images in the Xfce or Wiki documentation, your way of helping getting things getting fixed to report a bug about it. Learn here about submitting a bug and to see what bugs are currently outstanding. 
 + 
 +  * **[[:contribute:documentation:bugs|Reporting Bugs]]** -- Open bug reports and how to report new bugs 
 + 
 +If you see an open bug, here, that you think that you may be able to fix it; this is a great way to start contributing to Xfce even if you are not a programmer. 
 +---- 
 + 
 +===== Editing the Documentation ===== 
 + 
 +If you are unfamiliar with, or simply need a refresher, take a look at the [[doku>DokuWiki]] [[/wiki/syntax|syntax]] page for guidance. 
 + 
 +If you want to try something out before editing a page, just use the [[playground:playground|playground]] page. Just remember to leave the playground as you found it for others to have a blank slate to experiment with their documentation. 
 + 
 +If you wish to have editing access to either the documentation, or the wiki, please reach out to us either through [[irc://irc.libera.chat/#xfce-dev|#xfce-dev on Libera]] or the [[https://mail.xfce.org/mailman/listinfo/xfce4-dev|Xfce-dev mailing list]]. See the [[:contribute:dev/start#communication_with_the_xfce_development_team|Communication with the Xfce Development]] for additional information. 
 +----
  
 ===== Screenshots ===== ===== Screenshots =====
  
 Try to make screenshots that look consistent with the other previews. We generally try to use the following setup: Try to make screenshots that look consistent with the other previews. We generally try to use the following setup:
-  * Gtk theme: Greybird (https://github.com/shimmerproject/Greybird) +  * Gtk theme: Greybird  
-  * Xfwm: Default (xfwm4 git-master)+     * [[https://github.com/shimmerproject/Greybird|Desktop theme suite for Xfce]] 
 +  * Xfwm: Default 
 +    * [[https://git.xfce.org/xfce/xfwm4/|xfwm4 git-master]]
   * Icons: Faenza   * Icons: Faenza
 +    * [[https://code.google.com/archive/p/faenza-icon-theme/downloads|Faenza theme downloads]]
 +    * [[https://github.com/shimmerproject/Faenza-Xfce|Faenza-icon-theme Addon for Xfce]]
   * Font: Bitstream Vera Sans Roman, full hinting   * Font: Bitstream Vera Sans Roman, full hinting
 +    * [[https://www.gnome.org/fonts/|Official site]]
 +    * [[http://ftp.gnome.org/pub/GNOME/sources/ttf-bitstream-vera/1.10/|Latest release]]
 +
 +Most of these themes, icons and fonts should be included with your distribution. The download locations are provided above should that not be the case.
  
-Also compress the png files before uploading, with //optipng// for example.+Also, consider compressing the png files before uploading, with [[http://optipng.sourceforge.net/|optipng]] for [[https://www.mankier.com/1/optipng#Examples_(TL;DR)|example]].
  
  
 +[[|Back To Top]]
 +----
 +[[:contribute:start|Back to Main contribute page]]