Allicorn's Outfit Reporter

Creating your own custom report template

Please note that using this feature will require a little knowledge of HTML and CSS and I'm not about to answer requests for help with that. Visit the W3C and read the specifications for the standards.

Starting out

A good way to start is to make a copy of the file Default.html that resides in the program's home directory. This is the default HTML template that generates the normal orange-backdrop report. Make a copy, keep it in the same directory and call it MyOutfit.html or somesuch. Outfit Reporter will list all HTML files that appear in that directory as possible report template choices when you run the program.

Template Tags

The individual peices of stat data are inserted into your HTML via special tags. The tags all start with two dollar signs ($$) and end with a semicolon (;). Open up your new HTML file in a decent text editor (notepad will do if you've got nothing else) and take a look. You should see a block that looks something like this:

<table>
	<tr>
		<td class=struct colspan=2><div>$$title;</div></td>
	</tr>
	<tr>
		<td class=struct colspan=2><div>$$stats;</div></td>
	</tr>
	<tr>
		<td class=struct colspan=2><div class=scroll>$$roles;</div></td>
	</tr>
	<tr>
		<td class=struct colspan=2><div class=scroll>$$certs;</div></td>
	</tr>
	<tr>
		<td class=struct><div class=scroll>$$op;</div></td>
		<td class=struct><div class=scroll>$$accumulatedop;</div></td>
	</tr>
	<tr>
		<td class=struct><div class=scroll>$$kbrcr;</div></td>
		<td class=struct><div class=scroll>$$kh;</div></td>
	</tr>
	<tr>
		<td class=struct><div class=scroll>$$br;</div></td>
		<td class=struct><div class=scroll>$$cr;</div></td>
	</tr>
	<tr>
		<td class=struct><div class=scroll>$$kills;</div></td>
		<td class=struct><div class=scroll>$$killsthisweek;</div></td>
	</tr>
	<tr>
		<td class=struct><div class=scroll>$$hacks;</div></td>
		<td class=struct><div class=scroll>$$hacksthisweek;</div></td>
	</tr>
	<tr>
		<td class=struct><div class=scroll>$$accumulatedkills;</div></td>
		<td class=struct><div class=scroll>$$accumulatedhacks;</div></td>
	</tr>
	<tr>
		<td class=struct><div class=scroll>$$e1kills;</div></td>
		<td class=struct><div class=scroll>$$e2kills;</div></td>
	</tr>
	<tr>
		<td class=struct colspan=2><div class=scroll>$$e1e2;</div></td>
	</tr>
	<tr>
		<td class=struct colspan=2><div class=scroll>$$outfitawards;</div></td>
	</tr>
	<tr>
		<td class=struct colspan=2><div class=scroll>$$awards;</div></td>
	</tr>
	<tr>
		<td class=struct colspan=2><div>$$promotions;</div></td>
	</tr>
</table>
		

The green highlighted bits are the Outfit Reporter Template Tags. Wherever, in your HTML, you place those tags, Outfit Reporter will replace them with an HTML table containing the indicated part of the report. They are as follows:

• $$title;
  The outfit name, number of active members and the name of the outfit leader.
• $$stats;
  The Outfit Stats section
• $$op;
  The Outfit Points leaderboard
• $$accumlatedop;
  The Outfit Points (Accumulated across Alt-Characters) leaderboard
• $$kbrcr;
  The Kills/BR+CR leaderboard
• $$kh;
  The Kills/Hack leaderboard
• $$accumulatedkh;
  The Kills/Hack (Accumulated across Alt-Characters) leaderboard
• $$certs;
  The Cert Distribution table
• $$roles;
  The Key Roles tables
• $$br;
  The Battle Rank leaderboard
• $$cr;
  The Command Rank leaderboard
• $$kills;
  The Kills leaderboard
• $$accumulatedkills;
  The Kills (Accumulated across Alt-Characters) leaderboard
• $$killsthisweek;
  The Last-7-Days-Kills leaderboard
• $$hacks;
  The Hacked Facilities leaderboard
• $$accumulatedhacks;
  The Hacked Facilities (Accumulated across Alt-Characters) leaderboard
• $$hacksthisweek;
  The Last-7-Days-Hacked Facilities leaderboard
• $$e1kills;
  The Enemy Faction #1 Kills leaderboard
• $$e2kills;
  The Enemy Faction #2 Kills leaderboard
• $$e1e2;
  The Faction #1 to #2 Kill Ratio table
• $$awards;
  The Awards section
• $$promotions;
  The Promotions section

While editting your template, if you decide you don't want to show any of the individual parts, just don't bother including it. Outfit Reporter will work just fine even if you only include one $$tag; in your template. Please make VERY sure that you don't ever leave one of the semi-colons off of the end of any tags you use, as this'll really screw things up horribly.

Doing it with Style

Although most of the HTML created by the Outfit Reporter uses tags with no explicit style (and therefore things will render in the default style you've associated with your page), there are a few elements that have a class attribute associated with them so that you can set up specific styles if necessary.

The named styles are:

TD.shade which is associated with the table cells containing the captions of the Key Roles section.

.smallprint which is associated with the small captions under the main headings in the Key Roles section.

.smalllink which is associated with the player names appearing in the Key Roles section. Since there may be a lot of names, it can be useful to have them appear in the smallest print possible.

Other style changes within the report are mainly just relative font size changes and are placed inline and can't be changed.

All Done

Gah! It didn't work!