Module:Files/Address/doc

This module is used to implement a template that generates address boxes

Input

Header

• space - Denotes what "space" the address box will use for reference. supported spaces are offset, ram, rom, manual, the global context and certain files (at the moment, only code (File). Makes it simpler to document both ram and rom addresses with a single reference
• name - Sets address box's caption, or overrides the default caption if the space is set to offset, ram, or rom
• subpage - Sets super page for the address table, and adds a link to each row to the relevant subpage for that version.
• hideoff - Optional. Hides the offset column if set to true. Default value is false
• hideend - Optional. Hides the end column(s) if set to true. Default value is false

Records

• ver# - Sets version name. Only a specific set of values will be accepted here
• ref# - Sets what type of reference is being recorded. Values are offset, ram, rom, and manual.

If ref# is set to offset, ram, or rom, you can use the following parameters:

• start# - Sets the start address or offset for the reference
• end# - Optional. Sets the end address or offset for the reference
• size# - Optional. Sets the size spanned by the reference

Otherwise, when ref# is set to manual, you can set the following parameters.

• offset# - Sets the start offset for the reference
• ram-start# - sets the ram address start for the reference
• ram-end#
• rom-start#
• rom-end#

Note that offset# can be omitted if hideoff = true. Similarly, if space = ram, rom-start#/end# can be omitted, and if space = rom, ram-start#/end# can be omitted.