Most documentation contributions to docs.xfce.org and the wiki consist of small edits or modifications to specific sections of the documentation.

If a new page is needed, it is important to keep its layout and appearance consistant with the rest of the documentation.

Below are some “style” guidelines to use when creating a new documentation page.

1. Use the at the very top of the page in the editing window. This is a internal Dokuwiki control macro that will disable the autogeneration of a list in the sidebar. If a document becomes long enough, it is recommended to manually create and maintain a table of contents within the body of the documentation page.

As a rule of thumb, if a page becomes longer than a screen and has multiple sections, it is recommended to manually create a table of contents.

2. Use a horizontal rule for breaking up sections of a page. A horizontal rule is creating by using —- in between two black lines. Be sure to check your preview before saving to ensure that the divider properly renders.

3. If a section is long enough and the top of the page scrolls far beyond the top of the screen, insert the code Back to Top followed by a horizontal rule to allow the reader to return back to the top of page and the table of contents.

4.At the bottom of the page, if it makes sense, create one or two back-links to the main page. For example, on https://docs.xfce.org/xfce/thunar/thunar-archive-plugin/bugs I have included two back-links. One returns the user to the subsection on the thunar archive plugin, and the second goes back to the main thunar page.