Sections

Created on Oct. 26, 2012, 12:01 a.m. by Hevok & updated by Hevok on May 2, 2013, 5:12 p.m.

In order to break text into sections, use section headers, which are single line of text with adornment:

  • an underline alone or an underline and overline together
  • in dashes (---), equals (===), tilds (~~~) or any other non-alphanumeric character that looks aesthetic: = - ` : ' " ~ ^ _ * + # < >
  • underline-only adornment is distinct from an overline-and-underline one using the same character.
  • the underline/overline must be at least as long as the title itself.

Be consistent, all sections marked with the same adornment style are deemed to be at the same level:

Chapter 1 Title
===============

Section 1.1 Title
-----------------

Subsection 1.1.1 Title
~~~~~~~~~~~~~~~~~~~~~~

Section 1.2 Title
-----------------

Chapter 2 Title
===============

Chapter 1 Title

Section 1.1 Title

Subsection 1.1.1 Title

Section 1.2 Title

Chapter 2 Title

Note a blank line after a section title is optional.


Linking

Linking section, refer to "Linking_". In the case where the heading has spaces in it like "This is the End", use quoting "This is the End_"." style="color: #CC0000">Section headers are available as link targets by simply using their name. To link to this Linking section, refer to "Linking_". In the case where the heading has spaces in it like "This is the End", use quoting "This is the End_".


















This is the End

No, its not! Jump back to "Linking".

headings.jpg

Tags: documentation, rest
Categories: Tutorial
Parent: reStructuredText

Update entry (Admin) | See changes

Comment on This Data Unit