From: <tak...@us...> - 2007-08-12 03:25:30
|
Revision: 3755 http://pcgen.svn.sourceforge.net/pcgen/?rev=3755&view=rev Author: takeyabue Date: 2007-08-11 20:25:32 -0700 (Sat, 11 Aug 2007) Log Message: ----------- W3C Validation Effort Modified Paths: -------------- Trunk/pcgen/docs/standards.html Modified: Trunk/pcgen/docs/standards.html =================================================================== --- Trunk/pcgen/docs/standards.html 2007-08-12 03:22:23 UTC (rev 3754) +++ Trunk/pcgen/docs/standards.html 2007-08-12 03:25:32 UTC (rev 3755) @@ -4,7 +4,6 @@ <!-- PCGen Documentation Project - $Header: /cvsroot/pcgendocs/pcgendocs/docs/acknowledgments/standards.html,v 1.2 2004/07/27 05:27:27 eddyanthony Exp $ $Author: eddyanthony $ $Date: 2006-04-15 06:27:03 +0000 (Sat, 15 Apr 2006) $ $Revision: 805 $ @@ -18,7 +17,8 @@ --> <head> <title>Documentation Standards</title> - <link rel="stylesheet" type="text/css" href="../pcgen.css" /> + <link rel="stylesheet" type="text/css" href="../pcgen.css"> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> </head> <body> @@ -36,9 +36,9 @@ 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.</p> - <p></p><a name="TAGANCHOR"></a><hr> + <p></p><hr> <p class="new">*** New</p> - <p class="indent0"><strong>Tag Name:</strong> TAG:x</p> + <p class="indent0"><strong><a name="TAGANCHOR">Tag Name:</a></strong> TAG:x</p> <p class="indent1"><strong>Variables Used (x):</strong> Text (Explanation)</p> <p class="indent1"><strong>Variables Used (x):</strong> Number (Explanation)</p> <p class="indent1"><strong>Variables Used (x):</strong> Property (Explanation)</p> @@ -85,7 +85,12 @@ <p>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.</p> - <!-- <p class="cvsfooter">$Source: /cvsroot/pcgendocs/pcgendocs/docs/acknowledgments/standards.html,v $ ($Revision: 805 $) last updated $Date: 2006-04-15 06:27:03 +0000 (Sat, 15 Apr 2006) $ by $Author: eddyanthony $</p> --> - </body> + <p> + <a href="http://validator.w3.org/check?uri=referer"><img + src="../images/system/valid-html401.png" + alt="Valid HTML 4.01 Strict" height="31" width="88"></a> + </p> +</body> + </html> \ No newline at end of file This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <edd...@us...> - 2007-11-09 05:39:38
|
Revision: 4487 http://pcgen.svn.sourceforge.net/pcgen/?rev=4487&view=rev Author: eddyanthony Date: 2007-11-08 21:39:43 -0800 (Thu, 08 Nov 2007) Log Message: ----------- fixed broken link to pcgen.css Modified Paths: -------------- Trunk/pcgen/docs/standards.html Modified: Trunk/pcgen/docs/standards.html =================================================================== --- Trunk/pcgen/docs/standards.html 2007-11-08 17:59:28 UTC (rev 4486) +++ Trunk/pcgen/docs/standards.html 2007-11-09 05:39:43 UTC (rev 4487) @@ -17,7 +17,7 @@ --> <head> <title>Documentation Standards</title> - <link rel="stylesheet" type="text/css" href="../pcgen.css"> + <link rel="stylesheet" type="text/css" href="pcgen.css"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> </head> @@ -87,7 +87,7 @@ <p> <a href="http://validator.w3.org/check?uri=referer"><img - src="../images/system/valid-html401.png" + src="images/system/valid-html401.png" alt="Valid HTML 4.01 Strict" height="31" width="88"></a> </p> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <mar...@us...> - 2008-01-06 16:02:38
|
Revision: 4843 http://pcgen.svn.sourceforge.net/pcgen/?rev=4843&view=rev Author: maredudd800 Date: 2008-01-06 08:02:43 -0800 (Sun, 06 Jan 2008) Log Message: ----------- Added 'Deprecated Syntax' to the LST Doc Standard. Modified Paths: -------------- Trunk/pcgen/docs/standards.html Modified: Trunk/pcgen/docs/standards.html =================================================================== --- Trunk/pcgen/docs/standards.html 2008-01-06 13:55:39 UTC (rev 4842) +++ Trunk/pcgen/docs/standards.html 2008-01-06 16:02:43 UTC (rev 4843) @@ -47,6 +47,9 @@ <p class="indent1"><strong>Example:</strong></p> <p class="indent2"><code>TAG:EXAMPLE</code></p> <p class="indent3">Description of what this example tag does.</p> + <p class="indent1"><strong>Deprecated Syntax:</strong></p> + <p class="indent2"><code>Deprecated TAG:EXAMPLE</code></p> + <p class="indent3">Identify the deprecated syntax.</p> <p class="indent1"><strong>Where it is used:</strong></p> <p class="indent2">Explanation of where this tag may be used in terms of lines and files.</p> @@ -59,8 +62,9 @@ source code for examples</p> <h3>State of the entry</h3> - <p>Some entries are labeled "New" or "Updated". It is useful - to label new tags with the version number that the tag became active.</p> + <p>Some entries are labeled "New", "Updated", or + "Deprecated". It is useful to label new tags with the version number + that the tag became active or deprecated.</p> <h3>Tag Name</h3> <p>The tag name is entered with the whole structure and syntax demonstrated. The @@ -81,6 +85,10 @@ <p>Examples of the tag in as many variations as needed to demonstrate the variety of uses of the tag.</p> + <h3>Deprecated Syntax</h3> + <p>Obsolete LST tag syntax examples are included here. When the deprecated syntax + representes a complete LST tag entry, a link to the depecated listing is provided.</p> + <h3>Where it is used</h3> <p>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.</p> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <mar...@us...> - 2008-01-06 16:08:21
|
Revision: 4844 http://pcgen.svn.sourceforge.net/pcgen/?rev=4844&view=rev Author: maredudd800 Date: 2008-01-06 08:08:23 -0800 (Sun, 06 Jan 2008) Log Message: ----------- A couple of grammer corrections to the added Deprecated Syntax standard. Modified Paths: -------------- Trunk/pcgen/docs/standards.html Modified: Trunk/pcgen/docs/standards.html =================================================================== --- Trunk/pcgen/docs/standards.html 2008-01-06 16:02:43 UTC (rev 4843) +++ Trunk/pcgen/docs/standards.html 2008-01-06 16:08:23 UTC (rev 4844) @@ -48,8 +48,8 @@ <p class="indent2"><code>TAG:EXAMPLE</code></p> <p class="indent3">Description of what this example tag does.</p> <p class="indent1"><strong>Deprecated Syntax:</strong></p> - <p class="indent2"><code>Deprecated TAG:EXAMPLE</code></p> - <p class="indent3">Identify the deprecated syntax.</p> + <p class="indent2"><code>TAG:EXAMPLE</code></p> + <p class="indent3">Identify deprecated syntax.</p> <p class="indent1"><strong>Where it is used:</strong></p> <p class="indent2">Explanation of where this tag may be used in terms of lines and files.</p> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <mar...@us...> - 2008-01-06 16:21:02
|
Revision: 4845 http://pcgen.svn.sourceforge.net/pcgen/?rev=4845&view=rev Author: maredudd800 Date: 2008-01-06 08:21:07 -0800 (Sun, 06 Jan 2008) Log Message: ----------- Added note on including the version in which syntax was deprecated. Modified Paths: -------------- Trunk/pcgen/docs/standards.html Modified: Trunk/pcgen/docs/standards.html =================================================================== --- Trunk/pcgen/docs/standards.html 2008-01-06 16:08:23 UTC (rev 4844) +++ Trunk/pcgen/docs/standards.html 2008-01-06 16:21:07 UTC (rev 4845) @@ -87,7 +87,9 @@ <h3>Deprecated Syntax</h3> <p>Obsolete LST tag syntax examples are included here. When the deprecated syntax - representes a complete LST tag entry, a link to the depecated listing is provided.</p> + representes a complete LST tag entry, a link to the depecated 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.</p> <h3>Where it is used</h3> <p>Some times it may be helpful to indicate exactly where the tag may be used. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <mar...@us...> - 2008-03-31 11:32:39
|
Revision: 5761 http://pcgen.svn.sourceforge.net/pcgen/?rev=5761&view=rev Author: maredudd800 Date: 2008-03-31 04:32:46 -0700 (Mon, 31 Mar 2008) Log Message: ----------- Standardise LST and OS token examples Issue#: 1929970 Modified Paths: -------------- Trunk/pcgen/docs/standards.html Modified: Trunk/pcgen/docs/standards.html =================================================================== --- Trunk/pcgen/docs/standards.html 2008-03-31 11:10:34 UTC (rev 5760) +++ Trunk/pcgen/docs/standards.html 2008-03-31 11:32:46 UTC (rev 5761) @@ -24,19 +24,21 @@ <body> <h1>Documentation Standards</h1> - <p>This page will be used to provide standards to follow in the creation of documentation pages for PCGen.</p> + <p class="indent0">This page will be used to provide standards to follow in the creation of documentation pages for PCGen.</p> <h2>Documentation Page Standards</h2> - <p>Each page should have information commented in the page which should contain + <p class="indent0">Each page should have information commented in the page which should contain the names of those contributing to the creation and maintenance of the page. There should also be a brief description of the purpose of the page.</p> <h2>LST Tag Documentation Standards</h2> - <p>The following is a generic example of the format to be used when documenting LST tags. + <p class="indent0">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.</p> - - <p></p><hr> + <p></p> + +<hr> + <p class="new">*** New</p> <p class="indent0"><strong><a name="TAGANCHOR">Tag Name:</a></strong> TAG:x</p> <p class="indent1"><strong>Variables Used (x):</strong> Text (Explanation)</p> @@ -53,48 +55,56 @@ <p class="indent1"><strong>Where it is used:</strong></p> <p class="indent2">Explanation of where this tag may be used in terms of lines and files.</p> - <hr> +<hr> + <h3>Anchors</h3> - <p>If you examine the source code you will see that the first line of the entry + <p class="indent0">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</p> <h3>State of the entry</h3> - <p>Some entries are labeled "New", "Updated", or + <p class="indent0">Some entries are labeled "New", "Updated", or "Deprecated". It is useful to label new tags with the version number that the tag became active or deprecated.</p> <h3>Tag Name</h3> - <p>The tag name is entered with the whole structure and syntax demonstrated. The + <p class="indent0">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.</p> <h3>Variables Used</h3> - <p>All the variables that can be used are explained. Number variables can be standard + <p class="indent0">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.</p> <h3>What it does</h3> - <p>A complete explanation of the tag and its uses.</p> + <p class="indent0">A complete explanation of the tag and its uses.</p> <h3>Example</h3> - <p>Examples of the tag in as many variations as needed to demonstrate the variety + <p class="indent0">Examples of the tag in as many variations as needed to demonstrate the variety of uses of the tag.</p> <h3>Deprecated Syntax</h3> - <p>Obsolete LST tag syntax examples are included here. When the deprecated syntax + <p class="indent0">Obsolete LST tag syntax examples are included here. When the deprecated syntax representes a complete LST tag entry, a link to the depecated 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.</p> <h3>Where it is used</h3> - <p>Some times it may be helpful to indicate exactly where the tag may be used. + <p class="indent0">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.</p> +<hr> + + <h2>LST Tag Documentation Style Guide</h2> + <p class="indent0">The LST Tag Documentation Style Guide will be placed here.</p> + + +<hr> <p> <a href="http://validator.w3.org/check?uri=referer"><img src="images/system/valid-html401.png" This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |