Difference between revisions of "StyleGuide"
From GRFSpecs
Jump to navigationJump to searchPlanetmaker (talk | contribs) m (→Action0 pages) |
Planetmaker (talk | contribs) (heading sizes) |
||
| Line 1: | Line 1: | ||
Pages in the NewGRF specs wiki should try to follow a common style. Headings are as follows: |
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 |
||
| ⚫ | |||
| + | |||
| ⚫ | |||
<pre> |
<pre> |
||
| − | =Introduction= |
+ | ==Introduction== |
One to three sentences for summary. |
One to three sentences for summary. |
||
| − | =Properties= |
+ | ==Properties== |
{| |
{| |
||
!Property !!Version !!Size !! Description |
!Property !!Version !!Size !! Description |
||
| Line 19: | Line 21: | ||
|} |
|} |
||
| − | =Description= |
+ | ==Description== |
| − | ==Property 1 name (01)== |
+ | ===Property 1 name (01)=== |
Detailed Description |
Detailed Description |
||
| − | ==Property 2 name (02)== |
+ | ===Property 2 name (02)=== |
Detailed description |
Detailed description |
||
| − | ==Property N name (0xN)== |
+ | ===Property N name (0xN)=== |
Detailed description |
Detailed description |
||
| − | =Example= |
+ | ==Example== |
General example for the action, not specific to the a single property. |
General example for the action, not specific to the a single property. |
||
</pre> |
</pre> |
||
| − | = VarAction2 pages = |
+ | == VarAction2 pages == |
<pre> |
<pre> |
||
| − | =Introduction= |
+ | ==Introduction== |
One to three sentences for summary. |
One to three sentences for summary. |
||
| − | =Variables= |
+ | ==Variables== |
{| |
{| |
||
!Variable !!Version !!Size !! Description |
!Variable !!Version !!Size !! Description |
||
| Line 51: | Line 53: | ||
|} |
|} |
||
| − | =Description= |
+ | ==Description== |
Detailed description. |
Detailed description. |
||
| − | =Example= |
+ | ==Example== |
General example for the action, not specific to the a single variable. |
General example for the action, not specific to the a single variable. |
||
</pre> |
</pre> |
||
| − | = Other pages = |
+ | == Other pages == |
<pre> |
<pre> |
||
| − | =Introduction= |
+ | ==Introduction== |
One to three sentences for summary. |
One to three sentences for summary. |
||
| − | =Syntax= |
+ | ==Syntax== |
Formal syntax definition, including a table with summaries for the variable parts of it. |
Formal syntax definition, including a table with summaries for the variable parts of it. |
||
| − | =Description= |
+ | ==Description== |
Detailed description. |
Detailed description. |
||
| − | =Example= |
+ | ==Example== |
General example for the action. |
General example for the action. |
||
</pre> |
</pre> |
||
Revision as of 11:30, 13 June 2011
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
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==
===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.
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.
