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:

TagEncloses?Description
tabNoTab to indicated column in text output.
turnYesEntire turn report.
boxYesA reference to a game entity.
unit_sectionYesUnit summary section of report.
player_summaryYesPlayer summary section of report.
account_summaryYesAccount summary section of report.
game_totalsYesGame total section of report.
faction_summaryYesFaction summary section of report.
faction_entryNoEntry in faction summary.
headerYesA header line for text output.
loc_summaryYesLocation summary section of report.
capacity_summaryYesCapacity summary section of report.
capacity_unitNoEntry in capacity summary.
ship_reportYesShip report section.
shipYesEntry in ship report.
garr_reportYesGarrison report section.
garrisonYesEntry in garrison report.
garr_invYesGarrison inventory.
hruleNoInsert a horizontal rule across page.
unit_reportYesUnit report.
loc_reportYesLocation report.
order_templateYesOrder template.
commandYesUse of command in unit report.