Burnout Wiki:Format documentation specification: Difference between revisions
Burnout Wiki:Format documentation specification (view source)
Revision as of 07:16, 4 August 2023
, 9 months agoBurninrubber0 moved page Burnout Wiki:Format documentation guide to Burnout Wiki:Format documentation specification
m (Burninrubber0 moved page Format documentation guide to Burnout Wiki:Format documentation guide: Namespace change) |
m (Burninrubber0 moved page Burnout Wiki:Format documentation guide to Burnout Wiki:Format documentation specification) |
||
| (One intermediate revision by the same user not shown) | |||
Line 47:
==== Type ====
The data type of the field. If the type is unknown, refer to [[#Choosing a data type
If the type is known and is a structure, union, enumeration, or custom typedef, this should be a link to the relevant section. If the official documentation states it is a standard type but it is still used as an enumerated value or similar, leave the link in the Comments column in the style "See <nowiki>[[link]]</nowiki>".
Line 84:
== Columns ==
==== Length ====
The length of the field. This should always be hexadecimal and prefixed with <code>0x</code>, even if the length is less than decimal 10. See [[#Length
The length should be defined per member just as it is with structures. The overall length of the type will be determined by its largest member and should not be listed separately.
==== Type ====
The data type of the field. If the type is unknown, refer to [[#Choosing a data type
If the type is known and is a structure, union, enumeration, or custom typedef, this should be a link to the relevant section. If the official documentation states it is a standard type but it is still used as an enumerated value or similar, leave the link in the Comments column in the style "See <nowiki>[[link]]</nowiki>".
Line 144:
== Traditional enumerations ==
Most enumerations are sets of sequential values from which a single value may be used per variable. It follows that such enumerations are typically in decimal format, and wiki content should reflect this. Sometimes, however, it is appropriate to use hexadecimal, such as with how [[Resource Types
Enumerations should be displayed in the following format:
Line 188:
= Bit fields =
[https://en.wikipedia.org/wiki/Bit_field Bit fields] should be denoted in a similar manner to [[#Structures
{| class="wikitable"
Line 198:
== LSB 0 vs MSB 0 ==
As with [[#Binary flags
This solution used by the wiki is to display all binary structures in MSB 0 notation, even when official documentation has it in LSB 0. This improves consistency and readability.
Line 231:
! Bit value !! 0 !! 0 !! 0 !! 1 !! 0 !! 0 !! 0 !! 1 !! 1 !! 1 !! 1 !! 1 !! 1 !! 1 !! 0 !! 0
|-
| '''Parsed value''' || colspan=4
|-
| '''Description''' || colspan=4
|}
Line 240:
{| class="wikitable"
|-
! rowspan=3
|-
| colspan=4
|-
| colspan=4
|}
| |||