StyleGuide
From GRFSpecs
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.