Module:Files/Address/doc - Revision history

Mzxrules: /* Input */

2021-08-06T16:39:28Z

‎Input

Mzxrules: /* Input */

2018-03-07T08:56:09Z

‎Input

Mzxrules at 08:22, 14 November 2017

2017-11-14T08:22:43Z

Mzxrules: Created page with "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. sup..."

2015-12-06T11:50:08Z

Created page with "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. sup..."

New page

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, the [[Global Context|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
* 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.

=== Offset, Ram, Rom only 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

=== Manual only 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#

@@ Line 3: / Line 3: @@
 == Input ==
 === Header ===
-* space - Denotes what "space" the address box will use for reference. supported spaces are offset, ram, rom, manual, the [[Global Context|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
+* space - Denotes what "space" the address box will use for reference. supported spaces are offset, ram, rom, manual, gctx ([[Game Play]]), code ([[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.

@@ Line 3: / Line 3: @@
 == Input ==
 === Header ===
-* space - Denotes what "space" the address box will use for reference. supported spaces are offset, ram, rom, the [[Global Context|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
+* space - Denotes what "space" the address box will use for reference. supported spaces are offset, ram, rom, manual, the [[Global Context|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.
@@ Line 13: / Line 13: @@
 * ref# - Sets what type of reference is being recorded. Values are offset, ram, rom, and manual.
-=== Offset, Ram, Rom only parameters ===
+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
-=== Manual only parameters ===
+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
@@ Line 24: / Line 24: @@
 * rom-start#
 * rom-end#

@@ Line 5: / Line 5: @@
 * space - Denotes what "space" the address box will use for reference. supported spaces are offset, ram, rom, the [[Global Context|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
 * 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