The Funtoo Linux project has transitioned to "Hobby Mode" and this wiki is now read-only.
Difference between revisions of "Help:Funtoo Editing Guidelines/Headings"
| Line 7: | Line 7: | ||
</pre> | </pre> | ||
'''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 1 headings are top-level headings. '''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.''' There is generally not a reason to use these. | ||
<pre> | <pre> | ||
| Line 13: | Line 13: | ||
</pre> | </pre> | ||
'''Level 2 titles can be used to split your page up into chapters, but they should not be used on smaller pages.''' | Level 2 headings are for chapters. '''Level 2 titles can be used to split your page up into chapters, but they should not be used on smaller pages that do not have logical chapters.''' | ||
<pre> | <pre> | ||
| Line 19: | Line 19: | ||
</pre> | </pre> | ||
''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 to split your level 3 sections into logical groups. | ''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 to split your level 3 sections into logical groups. | ||
<pre> | <pre> | ||
Revision as of 02:37, February 24, 2019
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 =
Level 1 headings are top-level headings. 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. There is generally not a reason to use these.
== Level 2 Chapter Title ==
Level 2 headings are for chapters. Level 2 titles can be used to split your page up into chapters, but they should not be used on smaller pages that do not have logical chapters.
=== 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 to split your level 3 sections into logical groups.
==== Level 4 Sub-Section Title ====
Level 4 titles can be used to create sub-sections, and can be used on pages of varying complexity.