Help:Funtoo Editing Guidelines/Headings

From Funtoo
Jump to: navigation, search

Page and Section Capitalization

In general, capitalize all words in page names and section heading except:

  • Articles: a, an, the
  • Coordinating Conjunctions: and, but, or, for, nor, etc.
  • Prepositions (fewer than five letters): on, at, to, from, by, etc.

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 Titles

   example wikitext
= 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 Titles

   example wikitext
== 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 Titles

   example wikitext
=== 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 Titles

   example wikitext
==== Level 4 Sub-Section Title ====

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