StyleGuide

From GRFSpecs
Revision as of 22:11, 22 July 2011 by Planetmaker (talk | contribs) (→‎Links: typo)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Pages in the NewGRF specs wiki should try to follow a common style. Headings are as follows:

Note: section headings are indicated by == otherwise they have the same size as the page title

Links

  • Use the "ttwiki:" prefix for interwiki links to TT-Wiki.
  • Use the "ottdwiki:" prefix for interwiki links to OpenTTD-Wiki.

Action0 pages

==Introduction==
One to three sentences for summary.

==Properties==
{|
!Property !!Version !![[GRFActionsDetailed|Size]] !! Description
|-
|01 || ||B ||Short summary 1
|-
|02 || ||W ||Short summary 2
|-
|03 || ||D ||Short summary 3
|-
|04 || ||B/B* ||Short summary 4
|}

==Description==
===Property 1 name (01)===
Detailed Description

===Property 2 name (02)===
Detailed description

===Property N name (0xN)===
Detailed description

==Example==
General example for the action, not specific to the a single property. Lines are ALL indented by a single space at least
 -1 * 0 00 00 \b3 01 \b*2 // \b<number of props to change> \b*<vehicle ID>
     09 \w192 // value for speed (192 km/h)
     0B \w3800 // value for power (3800 hp)
     12 FD // use new graphics

VarAction2 pages

==Introduction==
One to three sentences for summary.

==Variables==
{|
!Variable !!Version !![[GRFActionsDetailed|Size]] !! Description
|-
|01 || ||B ||Short summary 1
|-
|02 || ||W ||Short summary 2
|-
|03 || ||D ||Short summary 3
|-
|04 || ||B/B* ||Short summary 4
|}

==Description==
===Variable 1 name (01)===
Detailed Description

===Variable 2 name (02)===
Detailed description

===Variable N name (0xN)===
Detailed description

==Example==
General example for the action, not specific to the a single variable.

Other pages

==Introduction==
One to three sentences for summary.

==Syntax==
Formal syntax definition, including a table with summaries for the variable parts of it.

==Description==
Detailed description.

==Example==
General example for the action.

See also