Note

The Funtoo Linux project has transitioned to "Hobby Mode" and this wiki is now read-only.

Help:Funtoo Editing Guidelines/Headings

From Funtoo
Jump to navigation Jump to search

Document Hierarchy

Use section headings to create a document hierarchy for your page. These will define the table of contents that appears at the top of the wiki page. Create chapters, sections and sub-sections as follows:

= Level 1 Page Title =

Try not to use "level 1" headings like the one above, since they render as the same size as the page title at the top.

== Level 2 Chapter Title ==

Level 2 titles can be used to split your page up into chapters. But they should not be used on smaller pages.

=== Level 3 Section Title ===

Level 3 titles should be the preferred section for small to medium-sized pages as they render compactly. As more and more content is added to a page, then it may make sense to make light use of level 2 titles.

==== Level 4 Sub-Section Title ====

Level 4 titles can be used to create sub-sections, and can be used on pages of varying complexity.

Chapter Title

Section Title

SubSection Title

In general, when creating new documents, it's best to use level-3 (three "="'s) Section Titles to break up content. Level-2 Section Titles are best used for major sections of larger documents. Use them infrequently. Level-1 Section Titles generally do not need to be used.