Difference between revisions of "StyleGuide"
From GRFSpecs
Jump to navigationJump to search (more details) |
Planetmaker (talk | contribs) (→Action0 pages: style for properties) |
||
| Line 20: | Line 20: | ||
=Description= |
=Description= |
||
| + | ==01: Property 1 name== |
||
| ⚫ | |||
| + | Detailed Description |
||
| + | |||
| + | ==02: Property 2 name== |
||
| ⚫ | |||
=Example= |
=Example= |
||
Revision as of 11:21, 13 June 2011
Pages in the NewGRF specs wiki should try to follow a common style. Headings are as follows:
Action0 pages
=Introduction=
One to three sentences for summary.
=Properties=
{|
!Property !!Version !!Size !! Description
|-
|01 || ||B ||Short summary 1
|-
|02 || ||W ||Short summary 2
|-
|03 || ||D ||Short summary 3
|-
|04 || ||B/B* ||Short summary 4
|}
=Description=
==01: Property 1 name==
Detailed Description
==02: Property 2 name==
Detailed description
=Example=
General example for the action, not specific to the a single property.
VarAction2 pages
=Introduction=
One to three sentences for summary.
=Variables=
{|
!Variable !!Version !!Size !! Description
|-
|01 || ||B ||Short summary 1
|-
|02 || ||W ||Short summary 2
|-
|03 || ||D ||Short summary 3
|-
|04 || ||B/B* ||Short summary 4
|}
=Description=
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.
