Lightweight markup language: Difference between revisions

Revision as of 12:44, 22 May 2016

Revision as of 13:35, 24 May 2016

Line 478:

Headings are usually available in up to six levels, but the top one is often reserved to contain the same as the document title, which may be set externally. Some documentation may associate levels with divisional types, e.g. part, chapter, section, article or paragraph.

Most LMLs follow one of two styles for headings, either [[Setext]]-like underlines or [[ATX]]-like line markers, or they support both.

==== Underlined headings ====

Line 497:

! <code><nowiki>~</nowiki></code>

! <code><nowiki>*</nowiki></code>

! <code><nowiki>+</nowiki></code>

! <code><nowiki>#</nowiki></code>

! <code><nowiki>+</nowiki></code>

! <code><nowiki>^</nowiki></code>

! <code><nowiki>_</nowiki></code>

Line 509:

!title=“Minimum of characters”| min

<!--! mix-->

|-

! {{rh}} | [[AsciiDoc]]

| {{yes|1}} || {{yes|2}} || {{yes|3}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{dunno}}

|-

! {{rh}} | [[Markdown]]

| {{yes|1}} || {{yes|2}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{dunno}}

|-

! {{rh}} | [[reStructuredText]]

| {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{dunno}}

|-

! {{rh}} | [[Setext]]

| {{yes|1}} || {{yes|2}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{dunno}}

|-

! {{rh}} | [[AsciiDoc]]

| {{yes|1}} || {{yes|2}} || {{yes|3}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{dunno}}

|-

! {{rh}} | [[Texy!]]

| {{yes}} || {{yes}} || {{no}} || {{yes}} || {{noyes}} || {{yesno}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{dunno}}

|-

! {{rh}} | [[reStructuredText]]

| {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{yes}} || {{dunno}}

|-

|}

RST and Texy may determine heading levels dynamically, which makes authoring more individual on the one hand, but complicates merges from external sources on the other hand.

==== Prefixed headings ====

Line 750:

|}

<!-- TO DO:

TO DO:

=== Image syntax ===

also embedded audio and video

-->

=== List syntax ===

==== Ordered, numbered list syntax ====

HTML requires an explicit element for the list, specifying its type, and one for each list item, but most lightweight markup languages need only different line prefixes for the bullet points or enumerated items. Some languages rely on indentation for nested lists, others use repeated parent list markers.

==== Unordered, bulleted list syntax ====

==== Labeled, glossary list syntax ====

{| class="wikitable"

====|+ Unordered, bulletedbullet list syntax ====items

! Chars:

! <code><nowiki>*</nowiki></code>

! <code><nowiki>-</nowiki></code>

! <code><nowiki>+</nowiki></code>

! <code><nowiki>#</nowiki></code>

! <code><nowiki>.</nowiki></code>

!title="middle dot"| <code><nowiki>·</nowiki></code>

!title="bullet"| <code><nowiki>•</nowiki></code>

! <code><nowiki>_</nowiki></code>

! <code><nowiki>:</nowiki></code>

!title="en-dash"| <code><nowiki>–</nowiki></code>

!title="em-dash"| <code><nowiki>—</nowiki></code>

!title=“number of whitespace characters before the line prefix”| indent

!title=“number of whitespace characters after the line prefix”| skip

! nest

|-

! {{rh}} | [[Markdown]]

| {{yes}} || {{yes}} || {{yes}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || 0–3 || 1–3 || indent

|-

! {{rh}} | [[MediaWiki]]

| {{yes}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || 0 || 1+ || repeat

|-

|}

Languages differ on whether they support optional or mandatory digits in numbered list items, which kinds of enumerators they understand (e.g. decimal digit ''1'', roman numerals ''i'' or ''I'', alphabetic letters ''a'' or ''A'') and whether they support to keep explicit values in the output format. Some Markdown dialects, for instance, will honor a start value other than 1, but ignore any other explicit value.

{| class="wikitable"

|+ Ordered, enumerated list items

! Chars:

! <code><nowiki>#1</nowiki></code>

! <code><nowiki>1.</nowiki></code>

! <code><nowiki>1)</nowiki></code>

! <code><nowiki>1]</nowiki></code>

! <code><nowiki>1}</nowiki></code>

! <code><nowiki>(1)</nowiki></code>

! <code><nowiki>[1]</nowiki></code>

! <code><nowiki>{1}</nowiki></code>

!title=“number of whitespace characters before the line prefix”| indent

!title=“number of whitespace characters after the line prefix”| skip

! nest

|-

! {{rh}} | [[Markdown]]

| {{no}} || {{yes|1}} || {{yes|1}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || 0–3 || 1–3 || indent

|-

! {{rh}} | [[MediaWiki]]

| {{yes-No|#}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || {{no}} || 0 || 1+ || repeat

|-

|}

<!-- TO DO:

{| class="wikitable"

====|+ Labeled, glossary, definition list syntax ====

|}

-->

<!-- TO DO:

=== Quotation syntax ===

> Foo

==== Block quote ====

=== Table syntax ===

Cell, Row, Column, Header, Caption