~~NOTOC~~ ====== Documentation ====== * **[[#Contributing|Contributing]]** * **[[#AI/LLM Assisted Contribution Policy|AI/LLM Assisted Contribution Policy]]** * **[[#Reporting Bugs|Reporting Bugs]]** * **[[#Requesting Editing Access|Requesting Editing Access]]** * **[[#Editing the Documentation|Editing the Documentation]]** * **[[#Screenshots|Screenshots]]** ===== Introduction ===== Since the release of Xfce 4.10(2012), man pages(application manuals) are no longer being provided with the Xfce packages. Low contribution and complexity were the primary motivating factors for this change. In order to encourage a wider range of participation in the Xfce project, it was decided to start this documentation wiki. Contributors, developers, translators, and end-users are all encouraged to help work on improving and maintaining up-to-date Xfce documentation. Within the various Xfce application dialog windows, links, and help buttons, users are redirected to the appropriate documentation sections on the [[:start:|docs.xfce.org]]. ---- ===== Contributing ===== If you want to help improving the Xfce documentation, an account can be requested on the [[https://matrix.to/#/#xfce-dev:matrix.org|#xfce-dev Matrix channel]]. Give yourself an introduction and an account will be setup on docs.xfce.org so you can begin contributing to the Xfce project. For translators, please visit our [[https://matrix.to/#/#xfce-translation:matrix.org|#xfce-translation Matrix channel]]. Please make sure to include the language you are interested in translating. Information about code translation can be found [[contribute:translate:|here]]. ---- ===== AI/LLM Assisted Contribution Policy ===== * Contributions containing material generated with the assistance of an AI/LLM (e.g., large language models, Claude, ChatGPT, etc.) are **not** permitted for documentation contributions. * Contributors are fully responsible for the accuracy, legality, and quality of their submissions. * For contributors whose primary language is not English, using a tool such as [[https://translate.google.com/|Google translate]] or similar is permitted and considered acceptable. Xfce editors will work with contributors to improve their submitted content. * Low-quality content may be rejected, and repeated violations may result in account suspension or ban. ---- ===== 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 fixed is 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 that you think you may be able to fix, this is a great way to start contributing to Xfce even if you are not a programmer. ---- ===== Requesting Editing Access ====== If you wish to have editing access to the Xfce documentation, please reach out to us either through the [[https://matrix.to/#/#xfce-dev:matrix.org|#xfce-dev Matrix channel]]. See the [[:contribute:dev/start#communication_with_the_xfce_development_team|Communication with the Xfce Development]] for additional information. ---- ===== Editing the Xfce Documentation ===== The [[:start|Xfce documentation]] wiki is built upon the [[https://www.dokuwiki.org/dokuwiki|DokuWiki]] software platform. DokuWiki uses a simplified markup language for page formatting. Use either the [[doku>DokuWiki]] article or the local [[/wiki/syntax|syntax]] page for guidance and reference when editing pages. We also have a 'playground' page available for practice use, and provides and area for safe experimentation that will not affect existing documetation. If you want to try something out before editing a page, use the [[playground:playground|playground]] page. Remember to leave the playground as you found it for others to have a blank slate to experiment with their documentation. Generally, most edits will be made on already existing pages. However, if a new page needs to be created, please refer to [[:contribute:documentation:creating_new_pages|formatting guidelines for new pages]] on details for maintaining a consistent document structure across the Xfce documentation pages. ---- ===== Screenshots ===== 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|Desktop theme suite for Xfce]] * Xfwm: Default * [[https://git.xfce.org/xfce/xfwm4/|xfwm4 git-master]] * 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 * [[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, 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]]