Difference between revisions of "StyleGuide"

From GRFSpecs
Jump to navigationJump to search
(VarAction2)
(more details)
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:
   
For Action0 pages:
+
= Action0 pages =
 
<pre>
 
<pre>
 
=Introduction=
 
=Introduction=
  +
One to three sentences for summary.
   
 
=Properties=
 
=Properties=
 
{|
 
{|
!Poperty !!Version !!Size !! Description
+
!Property !!Version !!Size !! Description
 
|-
 
|-
|01 || ||B ||desc1
+
|01 || ||B ||Short summary 1
 
|-
 
|-
|02 || ||W ||desc2
+
|02 || ||W ||Short summary 2
 
|-
 
|-
|03 || ||D ||desc3
+
|03 || ||D ||Short summary 3
 
|-
 
|-
|04 || ||B/B* ||desc4
+
|04 || ||B/B* ||Short summary 4
 
|}
 
|}
   
 
=Description=
 
=Description=
  +
Detailed description.
   
 
=Example=
 
=Example=
  +
General example for the action, not specific to the a single property.
 
</pre>
 
</pre>
   
For VarAction2 pages:
+
= VarAction2 pages =
 
<pre>
 
<pre>
 
=Introduction=
 
=Introduction=
  +
One to three sentences for summary.
   
 
=Variables=
 
=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=
 
=Description=
  +
Detailed description.
   
 
=Example=
 
=Example=
  +
General example for the action, not specific to the a single variable.
 
</pre>
 
</pre>
   
For other pages:
+
= Other pages =
 
<pre>
 
<pre>
 
=Introduction=
 
=Introduction=
  +
One to three sentences for summary.
   
 
=Syntax=
 
=Syntax=
  +
Formal syntax definition, including a table with summaries for the variable parts of it.
   
 
=Description=
 
=Description=
  +
Detailed description.
   
 
=Example=
 
=Example=
  +
General example for the action.
 
</pre>
 
</pre>

Revision as of 10:35, 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=
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.