This page will be used to provide standards to follow in the creation of documentation pages for PCGen.
The following is a generic example of the format to be used when documenting LST tags. You can copy the code and use it as a starting point for new entries if you wish. Following the entry will be a detailed explanation of how the format is should be used.
Tag Name: TAG:x
Variables Used (x): Text (Explanation)
Variables Used (x): Number (Explanation)
Variables Used (x): Property (Explanation)
What it does:
Explanation of what this tag does and how to use it.
Description of what this example tag does.
Identify deprecated syntax.
Where it is used:
Explanation of where this tag may be used in terms of lines and files.
If you examine the source code you will see that the first line of the entry contains a named anchor next to the horizontal rule. This is so the entry can be linked to from the index and other relevant entries. The anchor name should match the tag name up to the first variable minus any symbols used. See the source code for examples
Some entries are labeled " New "/" New ", " Updated "/" Updated ", or " Deprecated ". When the state of a tag entry has changed in the current or immediately previous development cycle the state will appear in red . Entries whose state has gone unchanged through at least one full stable release cycle will have their state displayed in " black ". Tag entries marked for deprecation will marked in " red " until they are removed from the PCGen Tag Dictionary.
The tag name is entered with the whole structure and syntax demonstrated. The variables are indicated using the letter x, y and z. You can use u, v, w and other letters if needed.
All the variables that can be used are explained. Number variables can be standard numbers or formulas or other variables if the tags accepts them. Text variables accept text strings, names and other text forms. Property variables indicate that the variable must be one of several properties hardcoded into the program. These properties are usually presented in a list following the variable.
A complete explanation of the tag and its uses.
Examples of the tag in as many variations as needed to demonstrate the variety of uses of the tag.
Obsolete LST tag syntax is included here. When the deprecated syntax represents a complete LST tag entry, a link to the deprecated listing is provided. Were applicable, the version in which the syntax was deprecated should be included as per the 'State of the Entry' information listed above.
Obsolete LST tag conversion examples are
included here. The form of the example generally takes the form
old lst code
Some times it may be helpful to indicate exactly where the tag may be used. Most times this is indicated by the page the entry is found on.
The LST Tag Documentation Style Guide will be placed here.