PREV UP next Olympia: The Age of Gods PBEM (Oct 4 2000)

H.2: TAGS Format

In TAGS format, XML-like "tags" are inserted into the turn report. Each tag is enclosed in angle brackets and begins with "tag" or "/tag". For example:

<tag type=game_totals players=32 controlled=171 other=10,999>

Game totals:
Players:                 32
Controlled units:       171
Other units:          10,999

</tag type=game_totals>

This example contains two tags, and illustrates some important features:

  1. Note the matching "<tag...>" and "</tag...>". The matching tags enclose the text description of the same information. Not every "<tag...>" has a balancing "</tag...>".
  2. The type of tag is indicated by the "type=game_totals" within the tag. Every tag has a type keyword.
  3. Additional keywords ("players", "controlled" and "other") provide additional information, corresponding to the information in the enclosed text block.
  4. Game identifiers in tags are printed in integer format. For example, the identifier "[aa0b]" will print as "36121". To convert back and forth between integer and "license plate" format, see the conversion tools available on the web site.

The following table summarizes the current tags:

Tag Encloses? Description
tab No Tab to indicated column in text output.
turn Yes Entire turn report.
box Yes A reference to a game entity.
unit_section Yes Unit summary section of report.
player_summary Yes Player summary section of report.
account_summary Yes Account summary section of report.
game_totals Yes Game total section of report.
faction_summary Yes Faction summary section of report.
faction_entry No Entry in faction summary.
header Yes A header line for text output.
loc_summary Yes Location summary section of report.
capacity_summary Yes Capacity summary section of report.
capacity_unit No Entry in capacity summary.
ship_report Yes Ship report section.
ship Yes Entry in ship report.
garr_report Yes Garrison report section.
garrison Yes Entry in garrison report.
garr_inv Yes Garrison inventory.
hrule No Insert a horizontal rule across page.
unit_report Yes Unit report.
loc_report Yes Location report.
order_template Yes Order template.
command Yes Use of command in unit report.