Difference between revisions of "StyleGuide"

From GRFSpecs
Jump to navigationJump to search
(→‎Action0 pages: style for properties)
Line 20: Line 20:
   
 
=Description=
 
=Description=
==01: Property 1 name==
+
==Property 1 name (01)==
 
Detailed Description
 
Detailed Description
   
==02: Property 2 name==
+
==Property 2 name (02)==
  +
Detailed description
  +
  +
==Property N name (0xN)==
 
Detailed description
 
Detailed description
   

Revision as of 11:24, 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=
==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.