Download Reference Manual
The Developer's Library for D
About Wiki Forums Source Search Contact

Standard wiki formatting

This page tries to standardize how to format the most widely used elements in the Tango wiki. All pages should try to follow the conventions below, but especially documentation pages like reference chapters and tutorials.

Headings

  • The chapter title should be formatted using H1, = Title = .
  • All of the sections suggested in the manual and tutorial styleguides, should have H2 headers, == Section title ==
  • Further subsectioning should use H3 headers, === Subsection title ===
  • Sections corresponding directly to a module name, should use the docs macro to create a link to the API-docs page.

Example of docs macro usage:

[[docs(Util,tango.text.Util.html,h2)]]

The first argument to the macro is what will be visible in the header, qualify as necessary.

Symbols and other simple elements

  • All symbol names used throughout the text should be boldened, using '''symbolname'''. This includes module names (also fully qualified), methods, functions and classes/interfaces.
  • If a module name is used outside a section which has it's name, see sections named after modules above, then the doc macro can be used in the same way as above, but by omitting the last argument (e.g. h2), leaving a link to the API docs in the text without rendering it as a header.
  • When a type is mentioned, e.g. char, italicize it using {{{ typename }}. Consider if a class/interface in a given context should rather be considered as a type, and not a symbol, and format accordingly.

Code

General code like content can be wrapped using thrice of braces {{{ content }}}, whereas D source will be syntax colored if doing

{{{
#!d
D code
}}}