From: <edd...@us...> - 2006-08-27 15:42:58
|
Revision: 1353 Author: eddyanthony Date: 2006-08-27 08:42:37 -0700 (Sun, 27 Aug 2006) ViewCVS: http://svn.sourceforge.net/pcgen/?rev=1353&view=rev Log Message: ----------- [ 1543509 ] Document new format for global SOURCE tags Modified Paths: -------------- Trunk/pcgen/docs/listfilepages/datafilestagpages/datafilesraces.html Trunk/pcgen/docs/listfilepages/datafilestagpages/datafilesstartingkits.html Trunk/pcgen/docs/listfilepages/globalfilestagpages/globalfilesother.html Trunk/pcgen/docs/listfilepages/listfileLSTstandards.html Trunk/pcgen/docs/listfilepages/listfileLSTwalkthrough.html Trunk/pcgen/docs/listfilepages/listfileimportanttoknow.html Trunk/pcgen/docs/listfilepages/lstfileclass/lfc_lesson11_race5.html Trunk/pcgen/docs/listfilepages/lstfileclass/lfc_lesson6_race4.html Trunk/pcgen/docs/navlistindex.html Modified: Trunk/pcgen/docs/listfilepages/datafilestagpages/datafilesraces.html =================================================================== --- Trunk/pcgen/docs/listfilepages/datafilestagpages/datafilesraces.html 2006-08-24 13:49:31 UTC (rev 1352) +++ Trunk/pcgen/docs/listfilepages/datafilestagpages/datafilesraces.html 2006-08-27 15:42:37 UTC (rev 1353) @@ -334,18 +334,6 @@ <p class="indent2"><code>SKILLMULT:1</code></p> <p class="indent3">Monsters have x1 since adding class levels is done as Multi-classing.</p> - <p></p><a name="SOURCEPAGE"></a><hr> - <p class="new">*** Updated</p> - <p class="indent0"><strong>Tag Name:</strong> SOURCEPAGE:x</p> - <p class="indent1"><strong>Variables Used (x):</strong> Number (Source Page Number)</p> - <p class="indent1"><strong>What it does:</strong></p> - <p class="indent2">This is used to show where in the source the race information is listed. - SOURCEPAGE should always be used, since display of any of the SOURCE information requires - its presence.</p> - <p class="indent1"><strong>Example:</strong></p> - <p class="indent2"><code>SOURCEPAGE:p.102</code></p> - <p class="indent3">Further information can be found on page 102 of the source.</p> - <p></p><a name="STARTFEATS"></a><hr> <p class="new">*** Updated</p> <p class="indent0"><strong>Tag Name:</strong> STARTFEATS:x</p> Modified: Trunk/pcgen/docs/listfilepages/datafilestagpages/datafilesstartingkits.html =================================================================== --- Trunk/pcgen/docs/listfilepages/datafilestagpages/datafilesstartingkits.html 2006-08-24 13:49:31 UTC (rev 1352) +++ Trunk/pcgen/docs/listfilepages/datafilestagpages/datafilesstartingkits.html 2006-08-27 15:42:37 UTC (rev 1353) @@ -43,33 +43,6 @@ <p class="indent2"><code>REGION:None</code></p> <p class="indent3">There is no region prerequisite for these kits.</p> - <p></p><a name="SOURCELONG"></a><hr> - <p class="indent0"><strong>Tag Name:</strong> SOURCELONG:x</p> - <p class="indent1"><strong>Variables Used (x):</strong> Text (Long source name)</p> - <p class="indent1"><strong>What it does:</strong></p> - <p class="indent2">The standard format for this is the full company name.</p> - <p class="indent1"><strong>Example:</strong></p> - <p class="indent2"><code>SOURCELONG:Monkey Madness & Mania</code></p> - <p class="indent3">The source's long name.</p> - - <p></p><a name="SOURCESHORT"></a><hr> - <p class="indent0"><strong>Tag Name:</strong> SOURCESHORT:x</p> - <p class="indent1"><strong>Variables Used (x):</strong> Text (Short source name)</p> - <p class="indent1"><strong>What it does:</strong></p> - <p class="indent2">The standard format for this is the company's initials name.</p> - <p class="indent1"><strong>Example:</strong></p> - <p class="indent2"><code>SOURCESHORT:MMM</code></p> - <p class="indent3">The source's short name.</p> - - <p></p><a name="SOURCEWEB"></a><hr> - <p class="indent0"><strong>Tag Name:</strong> SOURCEWEB:x</p> - <p class="indent1"><strong>Variables Used (x):</strong> Text (Source's web site)</p> - <p class="indent1"><strong>What it does:</strong></p> - <p class="indent2">The standard format for this is the company's website/URL.</p> - <p class="indent1"><strong>Example:</strong></p> - <p class="indent2"><code>SOURCEWEB:http://www.monkeymania.com</code></p> - <p class="indent3">The source's web site.</p> - <hr><h2>Main Body Tags</h2> <p>All Main Body Tags are fully capable of being limited by the use of PRExxx tags.</p> Modified: Trunk/pcgen/docs/listfilepages/globalfilestagpages/globalfilesother.html =================================================================== --- Trunk/pcgen/docs/listfilepages/globalfilestagpages/globalfilesother.html 2006-08-24 13:49:31 UTC (rev 1352) +++ Trunk/pcgen/docs/listfilepages/globalfilestagpages/globalfilesother.html 2006-08-27 15:42:37 UTC (rev 1353) @@ -435,18 +435,21 @@ <p></p><a name="SOURCELONG"></a><hr> - <p class="new">*** Updated 4.3.10</p> + <p class="new">*** Updated 5.10</p> <p class="indent0"><strong>Tag Name:</strong>SOURCELONG:x</p> <p class="indent1"><strong>Variables Used (x):</strong>Text (Long Source Name)</p> <p class="indent1"><strong>What it does:</strong></p> - <p class="indent2"> The full product/book name.</p> + <p class="indent2">Specifies the full product/book name. + SOURCELONG tags can be used on individual object lines or it can be used by itself on it's own line. + When used by itself the SOURCELONG tag will be used by all objects which follow it. + When used on an object line it is used only by the object it is in and overrides any stand alone SOURCELONG on lines which preceeded it. + Multiple SOURCE tags can be used in objects and on their own lines but in all cases the tags should be separated by tabs.</p> <p class="indent1"><strong>Example:</strong></p> <p class="indent2"><code>SOURCELONG:Core Rulebook I (Foo Handbook)</code></p> <p class="indent3">The long source name for this file is "Core Rulebook I (Foo Handbook)".</p> <p></p><a name="SOURCEPAGE"></a><hr> - <p class="new">*** Updated</p> <p class="indent0"><strong>Tag Name:</strong> SOURCEPAGE:x</p> <p class="indent1"><strong>Variables Used (x):</strong> Number (Source Page Number)</p> <p class="indent1"><strong>What it does:</strong></p> @@ -459,22 +462,30 @@ <p></p><a name="SOURCESHORT"></a><hr> - <p class="new">*** Updated 4.3.10</p> + <p class="new">*** Updated 5.10</p> <p class="indent0"><strong>Tag Name:</strong>SOURCESHORT:x</p> <p class="indent1"><strong>Variables Used (x):</strong>Text (Short Source Name)</p> <p class="indent1"><strong>What it does:</strong></p> - <p class="indent2">The short product/book name.</p> + <p class="indent2">Specifies the short product/book name. + SOURCESHORT tags can be used on individual object lines or it can be used by itself on it's own line. + When used by itself the SOURCESHORT tag will be used by all objects which follow it. + When used on an object line it is used only by the object it is in and overrides any stand alone SOURCESHORT on lines which preceeded it. + Multiple SOURCE tags can be used in objects and on their own lines but in all cases the tags should be separated by tabs.</p> <p class="indent1"><strong>Example:</strong></p> <p class="indent2"><code>SOURCESHORT:FHB</code></p> <p class="indent3">The short source name for this file is "FHB".</p> <p></p><a name="SOURCEWEB"></a><hr> - <p class="new">*** Updated 4.3.10</p> + <p class="new">*** Updated 5.10</p> <p class="indent0"><strong>Tag Name:</strong>SOURCEWEB:x</p> <p class="indent1"><strong>Variables Used (x):</strong>Text (Source Web Site)</p> <p class="indent1"><strong>What it does:</strong></p> - <p class="indent2"> The URL that points directly to this product/book.</p> + <p class="indent2">Specifies the URL that points directly to this product/book. + SOURCEWEB tags can be used on individual object lines or it can be used by itself on it's own line. + When used by itself the SOURCEWEB tag will be used by all objects which follow it. + When used on an object line it is used only by the object it is in and overrides any stand alone SOURCEWEB on lines which preceeded it. + Multiple SOURCE tags can be used in objects and on their own lines but in all cases the tags should be separated by tabs.</p> <p class="indent1"><strong>Example:</strong></p> <p class="indent2"><code>SOURCEWEB:http://www.foogames.com/product.php?products=654321</code></p> <p class="indent3">The web site for this source is "SOURCEWEB:http://www.foogames.com/product.php?products=654321".</p> Modified: Trunk/pcgen/docs/listfilepages/listfileLSTstandards.html =================================================================== --- Trunk/pcgen/docs/listfilepages/listfileLSTstandards.html 2006-08-24 13:49:31 UTC (rev 1352) +++ Trunk/pcgen/docs/listfilepages/listfileLSTstandards.html 2006-08-27 15:42:37 UTC (rev 1353) @@ -188,10 +188,15 @@ <h3>SOURCELONG, SOURCESHORT, SOURCEWEB, SOURCEPAGE</h3> - <p>SOURCELONG, SOURCESHORT, and SOURCEWEB are defined in both the PCC and the top of the LST - files. These can be easily be changed by the submission team, so do not feel - bad if they are.</p> + <p>SOURCELONG, SOURCESHORT, and SOURCEWEB are defined in both the PCC and the + top of the LST files. These can be easily be changed by the submission team, + so do not feel bad if they are. <b>Note:</b> Prior to version 5.10 SOURCE header + tags were grouped in a single block separated with pipe (|) symbols. This has + been changed to allow for easier parsing, SOURCE header tags should still be + put on one line at the top of the file but should be separated by tabs instead + of pipes.</p> + <p>Formats should be as follows:</p> <ul> Modified: Trunk/pcgen/docs/listfilepages/listfileLSTwalkthrough.html =================================================================== --- Trunk/pcgen/docs/listfilepages/listfileLSTwalkthrough.html 2006-08-24 13:49:31 UTC (rev 1352) +++ Trunk/pcgen/docs/listfilepages/listfileLSTwalkthrough.html 2006-08-27 15:42:37 UTC (rev 1353) @@ -136,7 +136,7 @@ </tr> <tr> <td width="50%" valign="top"><code>RANK: 1</code></td> - <td width="50%">Rank indicates priority in sorts.</td> + <td width="50%">Rank indicates priority in sorting.</td> </tr> <tr> <td width="50%" valign="top"><code>GAMEMODE:3e</code></td> @@ -150,7 +150,7 @@ </tr> <tr> <td width="50%" valign="top"><code>TYPE:Dominant Game Publisher.SRD</code></td> - <td width="50%">Type will be used for sorts.</td> + <td width="50%">Type will be used for sorting.</td> </tr> <tr> <td width="50%" valign="top"><code>SOURCELONG:The Full Name of the Source</code></td> @@ -169,10 +169,6 @@ <td width="50%">If the source uses the open gaming license (OGL) See OGL FAQ.</td> </tr> <tr> - <td width="50%" valign="top"><code>OGL version</code></td> - <td width="50%">Version of OGL, if applicable.</td> - </tr> - <tr> <td width="50%" valign="top"><code>COPYRIGHT:Open Game License v 1.0a Copyright 2000, Your Name</code></td> <td width="50%">Copyright Terms.</td> </tr> @@ -204,10 +200,11 @@ <p>Types of LST:</p> <ul> <li>CLASS</li> + <li>COMPANION MODIFIER</li> <li>DEITY</li> <li>DOMAIN</li> <li>EQUIPMENT</li> - <li>EQUIPMOD</li> + <li>EQUIPMENT MODIFIER</li> <li>FEAT</li> <li>KIT</li> <li>LANGUAGE</li> @@ -268,6 +265,7 @@ <li>language</li> <li>proficiency</li> <li>skill</li> + <li>companion modifier</li> <li>deity</li> <li>domain</li> <li>equipmod</li> @@ -301,7 +299,7 @@ <p>Here is the header block:</p> - <p><code>SOURCELONG:PCGen Documentation |SOURCESHORT:P-Doc|SOURCEWEB:http://www.pcgen.org</code></p> + <p><code>SOURCELONG:PCGen Documentation <tab> SOURCESHORT:P-Doc <tab> SOURCEWEB:http://www.pcgen.org</code></p> <p>Here the header tells us in detail where the information came from, a short name for use in cramped locations, and the website of the source.</p> @@ -346,7 +344,7 @@ <p>First, the header block:</p> - <p><code>SOURCELONG:PCGen Documentation |SOURCESHORT:P-Doc|SOURCEWEB:http://www.pcgen.org</code></p> + <p><code>SOURCELONG:PCGen Documentation <tab> SOURCESHORT:P-Doc <tab> SOURCEWEB:http://www.pcgen.org</code></p> <p>Then comes the actual code. In order we list the item's name, type, cost, weight, sourcepage, proficiency used, crit multiplier, critical range (i.e. 1 for a 20, 2 for 19-20, @@ -596,7 +594,7 @@ <p>Cannibalizing the srdweaponprof.lst file we get:</p> - <p><code>SOURCELONG:PCGen Documentation |SOURCESHORT:P-Doc|SOURCEWEB:http://www.pcgen.org</code></p> + <p><code>SOURCELONG:PCGen Documentation <tab> SOURCESHORT:P-Doc <tab> SOURCEWEB:http://www.pcgen.org</code></p> <table border="0" cellpadding="0" cellspacing="0" width="64%"> <tr> @@ -865,8 +863,10 @@ <p>Building our race.lst file from scratch we put our standard header.</p> - <p><code>SOURCELONG:PCGen Documentation |SOURCESHORT:P-Doc|SOURCEWEB:http://www.pcgen.org/</code></p> +<p><code>SOURCELONG:PCGen Documentation <tab> SOURCESHORT:P-Doc <tab> + SOURCEWEB:http://www.pcgen.org/</code></p> + <table border="0" cellpadding="0" cellspacing="0" width="64%"> <tr> <td width="100%" colspan="2"><code>Silverback</code></td> @@ -1722,7 +1722,8 @@ </tr> </table> - <p>SOURCELONG:PCGen Documentation |SOURCESHORT:P-Doc|SOURCEWEB:http://www.pcgen.org</p> + +<p>SOURCELONG:PCGen Documentation <tab> SOURCESHORT:P-Doc <tab> SOURCEWEB:http://www.pcgen.org</p> </code> <!-- <p class="cvsfooter">$Source: /cvsroot/pcgendocs/pcgendocs/docs/listfilepages/listfileLSTwalkthrough.html,v $ ($Revision$) last updated $Date$ by $Author$</p> --> Modified: Trunk/pcgen/docs/listfilepages/listfileimportanttoknow.html =================================================================== --- Trunk/pcgen/docs/listfilepages/listfileimportanttoknow.html 2006-08-24 13:49:31 UTC (rev 1352) +++ Trunk/pcgen/docs/listfilepages/listfileimportanttoknow.html 2006-08-27 15:42:37 UTC (rev 1353) @@ -197,17 +197,11 @@ </code> </p> - <p>Or they can be all one line, separated by a | (Pipe) delimiter:</p> + <p>Or they can be all one line, separated by a tab delimiter:</p> - <p class="indent1"><code>SOURCELONG:Dominant Game Publisher - System Reference Document|SOURCESHORT:SRD|SOURCEWEB:HTTP://www.rpgpublisher.com/</code></p> + <p class="indent1"><code>SOURCELONG:Dominant Game Publisher - System Reference Document <tab> + SOURCESHORT:SRD <tab> SOURCEWEB:HTTP://www.rpgpublisher.com/</code></p> - <p><strong>*NOTE</strong> - There are a couple of files that are special cases, - any xxxspecialist.lst (playerhbspecialist.lst as an example) can not have ANY - source tag information in it and the xxxtemplates.lst can ONLY have the SOURCE - tag information at the end of the entry line, NOT as a 1<sup>st</sup> line. The - combined, | (pipe) delimited method is the recommended way to add the source - information in the templates list files.</p> - <!-- <p class="cvsfooter">$Source: /cvsroot/pcgendocs/pcgendocs/docs/listfilepages/listfileimportanttoknow.html,v $ ($Revision$) last updated $Date$ by $Author$</p> --> </body> Modified: Trunk/pcgen/docs/listfilepages/lstfileclass/lfc_lesson11_race5.html =================================================================== --- Trunk/pcgen/docs/listfilepages/lstfileclass/lfc_lesson11_race5.html 2006-08-24 13:49:31 UTC (rev 1352) +++ Trunk/pcgen/docs/listfilepages/lstfileclass/lfc_lesson11_race5.html 2006-08-27 15:42:37 UTC (rev 1353) @@ -43,7 +43,7 @@ <a href="../datafilestagpages/datafilesraces.html#LEGS">LEGS</a>, <a href="../datafilestagpages/datafilesraces.html#HANDS">HANDS</a>, <a href="../globalfilestagpages/globalfilesother.html#SPELLS">SPELLS</a>, - <a href="../datafilestagpages/datafilesraces.html#SOURCEPAGE">SOURCEPAGE</a> + <a href="../globalfilestagpages/globalfilesother |