Battlestar Wiki:Template List/XML Templates/Instructions - Revision history

Joe Beaudoin Jr.: spelling corrections

2007-03-11T06:07:55Z

spelling corrections

← Older revision		Revision as of 06:07, 11 March 2007
Line 3:		Line 3:
	== The XML Document ==		== The XML Document ==

	The XML document holds all the templates, sections (~~catagories~~), and any ~~addistionial~~ values that many be needed for the website in question, however there are only so many options that the Wikipedia Toolbar can handle.		The XML document holds all the templates, sections (categories), and any additional values that many be needed for the website in question, however there are only so many options that the Wikipedia Toolbar can handle.

	First of all, the XML document always starts with this line:		First of all, the XML document always starts with this line:
Line 37:		Line 37:
	* Type - The type of wiki that it operates.		* Type - The type of wiki that it operates.
	* Icon - For future		* Icon - For future
	* Lang - The ~~lanagues~~ installed. ~~Seperated~~ by comma's (''',''').		* Lang - The languages installed. Separated by comma's (''',''').

	=== Lang Setup ===		=== Lang Setup ===
Line 49:		Line 49:
	</pre>		</pre>

	The "overall" block for each ~~langauge~~ is as follows:		The "overall" block for each language is as follows:

	<pre>		<pre>
Line 84:		Line 84:
	* Label - Short Label of the Section		* Label - Short Label of the Section
	* Area - A '''''unique''''' ID for this section.		* Area - A '''''unique''''' ID for this section.
	* Parent - '''~~Optionial~~'''; If this is set, this must equal something to <code>area</code> and must be placed after the orginal section is placed. (as shown above).		* Parent - '''Optional'''; If this is set, this must equal something to <code>area</code> and must be placed after the orginal section is placed. (as shown above).

	== Templates ==		== Templates ==
Line 108:		Line 108:
	* Label - A short label.		* Label - A short label.
	* Text - The template itself.		* Text - The template itself.
	* Cat - '''~~Optionial~~'''; What section it falls under. If this is not put in, it goes in the upper level section that holds the catagories in the first place.		* Cat - '''Optional'''; What section it falls under. If this is not put in, it goes in the upper level section that holds the catagories in the first place.
	* Tooltip - '''~~Optionial~~'''; What tooltip will shopw up if you hover your mouse over the template label.		* Tooltip - '''Optional'''; What tooltip will shopw up if you hover your mouse over the template label.

	Another type of template settings are possaible.		Another type of template settings are possaible.
Line 129:		Line 129:
	</pre>		</pre>

	* Templatecode - The text that will be displayed in the input box that will popup telling the user, what to enter. The <code>\|{r\|o}</code> at the end stands for either '''r'''(equired) or '''o'''(~~ptionial~~) to tell the system on how this ~~varabile~~ can be treated. If this is missing, it is assumed that it is ~~optionial~~.		* Templatecode - The text that will be displayed in the input box that will popup telling the user, what to enter. The <code>\|{r\|o}</code> at the end stands for either '''r'''(equired) or '''o'''(ptional) to tell the system on how this variable can be treated. If this is missing, it is assumed that it is optional.

	Having one "var" in the template creates a unique check system. If text is selected when selecting this template, that selected text will replace the var with no dialog poping up. If there is no text selected, a dialog would popup asking you to input text.		Having one "var" in the template creates a unique check system. If text is selected when selecting this template, that selected text will replace the var with no dialog poping up. If there is no text selected, a dialog would popup asking you to input text.

	A more complex "template" include ones that has ~~muilitiple~~ var's and their could be differences making the required and optionial.		A more complex "template" include ones that has muiltiple var's and their could be differences making the required and optionial.

	<pre>		<pre>

Shane at 17:27, 18 January 2007

2007-01-18T17:27:38Z

← Older revision		Revision as of 17:27, 18 January 2007
Line 1:		Line 1:
	~~{{inuse\|'Typing Intructions'\|Shane}}~~

	To help you through the editing of this process this page breaks down the sections of the XML document, and how everything should be formated.		To help you through the editing of this process this page breaks down the sections of the XML document, and how everything should be formated.

Shane: /* Templates */ - typing up more data

2006-04-22T19:34:53Z

Templates: - typing up more data

← Older revision		Revision as of 19:34, 22 April 2006
Line 134:		Line 134:

	Having one "var" in the template creates a unique check system. If text is selected when selecting this template, that selected text will replace the var with no dialog poping up. If there is no text selected, a dialog would popup asking you to input text.		Having one "var" in the template creates a unique check system. If text is selected when selecting this template, that selected text will replace the var with no dialog poping up. If there is no text selected, a dialog would popup asking you to input text.

			A more complex "template" include ones that has muilitiple var's and their could be differences making the required and optionial.

			<pre>
			<templates>
			<template>
			<id>userdata</id>
			<label>User Data</label>
			<text>{{User Data\|
			\|photo= %image
			\|name= %name
			\|age= %age
			\|location= %location
			\|email= %email
			\|gmail= %gmail
			\|aim= %aim
			\|callsign= %callsign
			\|parents= %parents
			\|siblings= %siblings
			\|children= %childern
			\|marital status= %maritalstatus
			\|occupation= %occupation
			\|rank= %rank
			\|admin= %admin
			}}</text>
			<cat>dblocks</cat>
			<tooltip>User data block</tooltip>
			</template>
			... Insert More Template Blocks ...
			</templates>
			</pre>

Shane: /* Templates */

2006-04-22T19:11:58Z

Templates

@@ Line 90: / Line 90: @@
 == Templates ==
-The accual templates is where it gets tricky, and where there can be many many options to deal with.
+The accual templates is where it gets tricky, and where there can be many options to deal with.
 <pre>
@@ Line 105: / Line 107: @@
 </pre>
-This is the first type of template.
+* ID - Must be a '''''unique''''' ID within the "templates" section..
 * Label - A short label.
 * Text - The template itself.
 * Cat - '''Optionial'''; What section it falls under. If this is not put in, it goes in the upper level section that holds the catagories in the first place.
 * Tooltip - '''Optionial'''; What tooltip will shopw up if you hover your mouse over the template label.

Shane: /* Templates */

2006-04-22T18:50:11Z

Templates

← Older revision		Revision as of 18:50, 22 April 2006
Line 101:		Line 101:
	<tooltip>Used to cite RDM's blog.</tooltip>		<tooltip>Used to cite RDM's blog.</tooltip>
	</template>		</template>
			... Insert More Template Blocks ...
	</templates>		</templates>
	</pre>		</pre>

Shane: /* Templates */

2006-04-22T18:49:47Z

Templates

← Older revision		Revision as of 18:49, 22 April 2006
Line 106:		Line 106:
	This is the first type of template.		This is the first type of template.

	* ID - Must be a ''unique'' ID.		* ID - Must be a '''''unique''''' ID.
	* Label - A short label.		* Label - A short label.
	* Text - The template itself.		* Text - The template itself.
	* Cat - '''Optionial'''; What section it falls under. If this is not put in, it goes in the upper level section that holds the catagories in the first place.		* Cat - '''Optionial'''; What section it falls under. If this is not put in, it goes in the upper level section that holds the catagories in the first place.
	* Tooltip - '''Optionial'''; What tooltip will shopw up if you hover your mouse over the template label.		* Tooltip - '''Optionial'''; What tooltip will shopw up if you hover your mouse over the template label.

Shane: /* Templates */

2006-04-22T18:49:25Z

Templates

@@ Line 90: / Line 90: @@
 == Templates ==
 <pre>
 		<templates>
 			<template>
 				<id>rdmblog</id>
@@ Line 107: / Line 100: @@
 				<cat>cit</cat>
 				<tooltip>Used to cite RDM's blog.</tooltip>
 			</template>
 		</templates>
 </pre>

Shane: /* Templates */

2006-04-22T18:44:31Z

Templates

← Older revision		Revision as of 18:44, 22 April 2006
Line 89:		Line 89:

	== Templates ==		== Templates ==


			<pre>
			<templates>
			<template>
			<id>note</id>
			<label>Note</label>
			<text>{{note\|%idname}}</text>
			<cat>cit</cat>
			<tooltip>Used in the endnote/footnote section ...</tooltip>
			<idname>What is the reference ID? ...</idname>
			</template>
			<template>
			<id>rdmblog</id>
			<label>From RDM Blog</label>
			<text>{{From RDM blog}}</text>
			<cat>cit</cat>
			<tooltip>Used to cite RDM's blog.</tooltip>
			</template>
			<template>
			<id>userdata</id>
			<label>User Data</label>
			<text>{{User Data\|
			\|photo= %image
			\|name= %name
			\|age= %age
			\|location= %location
			\|email= %email
			\|gmail= %gmail
			\|aim= %aim
			\|callsign= %callsign
			\|parents= %parents
			\|siblings= %siblings
			\|children= %childern
			\|marital status= %maritalstatus
			\|occupation= %occupation
			\|rank= %rank
			\|admin= %admin
			}}</text>
			<cat>dblocks</cat>
			<tooltip>User data block</tooltip>
			</template>
			</templates>
			</pre>

Shane: /* Sections */

2006-04-22T18:42:06Z

Sections

← Older revision		Revision as of 18:42, 22 April 2006
Line 86:		Line 86:
	* Label - Short Label of the Section		* Label - Short Label of the Section
	* Area - A '''''unique''''' ID for this section.		* Area - A '''''unique''''' ID for this section.
	* Parent - '''Optionial'''; If this is set, this must equal something to area and must be placed after the orginal section is placed. (as ~~soon~~ above).		* Parent - '''Optionial'''; If this is set, this must equal something to <code>area</code> and must be placed after the orginal section is placed. (as shown above).

	== Templates ==		== Templates ==

Shane: /* Sections */

2006-04-22T18:39:02Z

Sections

← Older revision		Revision as of 18:39, 22 April 2006
Line 66:		Line 66:

	== Sections ==		== Sections ==

			To have different sections withing the "popup" menu, follow this format:

			<pre>
			<sections>
			<section>
			<label>Citations</label>
			<area>cit</area>
			</section>
			<section>
			<label>Endnote/Footnote References</label>
			<area>endfoot</area>
			<parent>cit</parent>
			</section>
			.... More Sections Here ....
			</sections>
			</pre>

			* Label - Short Label of the Section
			* Area - A '''''unique''''' ID for this section.
			* Parent - '''Optionial'''; If this is set, this must equal something to area and must be placed after the orginal section is placed. (as soon above).

	== Templates ==		== Templates ==