Difference between revisions of "Help:Commonly used templates"

(In preparation for… bah. Just ask me on my talk page if you're curious.)
Line 2: Line 2:
  
 
==Off-Page Administration==
 
==Off-Page Administration==
 
 
 
;'''{{tl|deletion|Enter your reason here}}''': Use this tag to mark a page for review for deletion by an [[BattleTechWiki:Administrators|Admin]]. Write your reason for deletion over '''Enter your reason here'''. ''Please'' review [[Help:Deletion]] before placing this tag.
 
;'''{{tl|deletion|Enter your reason here}}''': Use this tag to mark a page for review for deletion by an [[BattleTechWiki:Administrators|Admin]]. Write your reason for deletion over '''Enter your reason here'''. ''Please'' review [[Help:Deletion]] before placing this tag.
  
 
+
;'''#REDIRECT [[real article name here]]''': This redirects a link to a different article than the one linked. The usual purpose for this is to directly link an acronym or abbreviation (ex: AFFS or 'Mech) to an article with the full name (ex: Armed Forces of the Federated Suns or BattleMech), but common titles that would all share the same article material also make use of this command. The redirect will then automatically send all so-named links (throughout the BattleTechWiki) directly to the proper page. Place this magic word on an otherwise empty article or it won't work.
;'''#REDIRECT [[real article name here]]''': This redirects a link to a different article than the one linked. The usual purpose for this is to directly link an acronym or abbreviation (ex: AFFS or 'Mech) to an article with the full name (ex: Armed Forces of the Federated Suns or BattleMech), but common titles that would all share the same article material also make use of this command. The redirect will then automatically send all so-named links (throughout the BattleTechWiki) directly to the proper page. Place the tag on an ''empty'' article it won't work otherwise.
 
  
 
==On-Page Administration==
 
==On-Page Administration==
 
+
;'''[[Category:Insert Category Name Here]]''': Use this tag to automatically link an article with articles linked to the same name. Even if you don't know if a category exists, consider adding it, because you'll start the category yourself by doing so. Insert the tag at the bottom of the page, with the category's name in place of '''Insert Category Name Here'''.
 
 
;'''[[Category:''Insert Category Name Here'']]''': Use this tag to automatically link an article with articles linked to the same name. Even if you don't know if a category exists, consider adding it, because you'll start the category yourself by doing so. Insert the tag at the bottom of the page, with the category's name in place of '''Insert Category Name Here'''.
 
 
 
  
 
;'''{{tl|cleanup}}''': Use this tag to mark a page for generic cleanup. Currently, any problem falls into this category.
 
;'''{{tl|cleanup}}''': Use this tag to mark a page for generic cleanup. Currently, any problem falls into this category.
  
 +
;'''{{citation needed}}''' or '''{{tl|cn}}''': Use this tag following an article sentence, in order to request a proper reference be provided.
  
;'''<nowiki>{{cite}}</nowiki>''' or '''{{tl|cn}}''': Use this tag following an article sentence, in order to request a proper reference be provided.
+
;'''{{tl|details|Article name|Optional parameter}}''': Use this tag if you wish to highlight link providing more detail than the sub-section in which it's placed. e.g., in the Clans article, a subsection on Clan Blood Spirit would have '{{tl|details|Clan Blood Spirit}}', and would produce text saying "For more details on this topic, see [[Clan Blood Spirit]].". The link would then direct the reader to the full Clan Blood Spirit article.
 
 
 
 
;'''{{tl|details|Article name|Optional parameter}}''': Use this tag if you wish to highlight link providing more detail than the sub-section in which it's placed. e.g., in the Clans article, a subsection on Clan Blood Spirit would have '{{tl|details|Clan Blood Spirit}}', and would produce text saying "For more details on this topic, see [[Clan Blood Spirit]]." The link would then direct the Reader to the full Clan Blood Spirit article.
 
 
:To use this tag, replace '''Article name''' with the name of the page which is being linked. If it would make more sense than using the default text, include the '''Optional parameter'''; replacing it with meaningful text. e.g., {{tl|details|Clan Blood Spirit|this particular clan}} which would produce text similar to the prior example only "this topic" would be "this particular clan".
 
:To use this tag, replace '''Article name''' with the name of the page which is being linked. If it would make more sense than using the default text, include the '''Optional parameter'''; replacing it with meaningful text. e.g., {{tl|details|Clan Blood Spirit|this particular clan}} which would produce text similar to the prior example only "this topic" would be "this particular clan".
  
 +
;'''{{tl|disambig}}''': Place this template at the bottom of a [[BattleTechWiki:Disambiguation|disambiguation]] article.
  
;'''{{tl|disambig}}''': Place this tag at the bottom of a [[BattleTechWiki:Disambiguation|disambiguation]] article.
+
;'''{{tl|fanon}}''': This template is placed at the top of new fan-created articles, to clearly indicate it does not deal with licensed material.
 
 
 
 
;'''{{tl|Fanon}}''': This tag is placed at the top of new fan-created articles, to clearly indicate it does not deal with licensed material.
 
 
 
  
 
;'''{{tl|otheruses|1|2|3|4}}''': To be placed at the top of an article where possible confusion may exist with other similarly named articles. The fourth parameter is optional. See [[Template:Otheruses]] for proper usage.
 
;'''{{tl|otheruses|1|2|3|4}}''': To be placed at the top of an article where possible confusion may exist with other similarly named articles. The fourth parameter is optional. See [[Template:Otheruses]] for proper usage.
 
  
 
;'''{{tl|quote|''statement here''}}''': Place this one the page where you want the quote to stand out, and add in the actual quote in place of the statement here.
 
;'''{{tl|quote|''statement here''}}''': Place this one the page where you want the quote to stand out, and add in the actual quote in place of the statement here.
 
  
 
;'''{{tl|stub}}''': Place this tag at the top of an article you feel needs to be expanded in order to be fully considered an article. Expand on your concerns in the article's discussion page.
 
;'''{{tl|stub}}''': Place this tag at the top of an article you feel needs to be expanded in order to be fully considered an article. Expand on your concerns in the article's discussion page.
  
 
+
;'''{{tl|update|source title|month year}}''': Place the bolded code on top of the article's page. Replace '''''source title''''' with the article name of the new source material (there is no need to wiki-link it) and '''''month year''''' with the actual month name and year the tagged was placed.
;'''{{tl|Update|source title|month year}}''': Place the bolded code on top of the article's page. Replace '''''source title''''' with the article name of the new source material (there is no need to wiki-link it) and '''''month year''''' with the actual month name and year the tagged was placed.
 
 
 
  
 
;'''{{tl|verify}}''': Place this tag at the top of an article or in a section you feel needs to be referenced, possibly due to a statement that may not be commonly known. Expand on your concerns in the article's discussion page.
 
;'''{{tl|verify}}''': Place this tag at the top of an article or in a section you feel needs to be referenced, possibly due to a statement that may not be commonly known. Expand on your concerns in the article's discussion page.
 
  
 
;'''{{tl|Wikipedia}}''': Place this tag at the top of an article that has a sister article (with the same name) at [http://en.wikipedia.org/wiki/Main_Page Wikipedia]. It will automatically make properly formatted link that leads to the sister page.
 
;'''{{tl|Wikipedia}}''': Place this tag at the top of an article that has a sister article (with the same name) at [http://en.wikipedia.org/wiki/Main_Page Wikipedia]. It will automatically make properly formatted link that leads to the sister page.
  
 
==Talk Pages==
 
==Talk Pages==
 
+
;'''{{tl|sign}}''': To provide an easy and stock-standard message for editors to use to explain to people the hows and whys of signing their posts. Place this template on the user's talk page (and don't forget to sign the entry yourself).
 
 
;'''{{tl|Sign}}''': To provide an easy and stock-standard message for editors to use to explain to people the hows and whys of signing their posts. Place this template on the user's talk page (and don't forget to sign the entry yourself).
 
 
 
  
 
;'''{{tl|unsigned|Username}}''' or '''{{tl|unsigned|Username|Optional comment}}''': Place this tag at the end of an [[Policy:Sign your posts on talk pages|unsigned post]]. Replace '''Username''' with the name of the user who left the comment. If you use the second example, you can include a comment of your own by replacing '''Optional comment''' with your own text. This parameter is useful for adding a timestamp, should you happen to know when the unsigned post was originally made.
 
;'''{{tl|unsigned|Username}}''' or '''{{tl|unsigned|Username|Optional comment}}''': Place this tag at the end of an [[Policy:Sign your posts on talk pages|unsigned post]]. Replace '''Username''' with the name of the user who left the comment. If you use the second example, you can include a comment of your own by replacing '''Optional comment''' with your own text. This parameter is useful for adding a timestamp, should you happen to know when the unsigned post was originally made.
 
  
 
==Templates==
 
==Templates==
 
+
;'''{{tl|tl|template name|Optional parameter|5=0}}''': This tag is for making links to templates. You may even include one or more optional parameters. Replace '''Template name''' with the name of the template you're linking to. Replace '''Optional parameter''' with a short, meaningful description of what you put as that parameter. You can have up to three optional parameters. Note that most editors will rarely need to use this tag, its primary purpose is to help with creating pages like this one, or giving an example to a new editor.
 
 
;'''{{tl|tl|Template name|Optional parameter|5=0}}''': This tag is for making links to templates. You may even include one or more optional parameters. Replace '''Template name''' with the name of the template you're linking to. Replace '''Optional parameter''' with a short, meaningful description of what you put as that parameter. You can have up to three optional parameters. Note that most editors will rarely need to use this tag, its primary purpose is to help with creating pages like this one, or giving an example to a new editor.
 
 
 
 
 
 
 
 
 
  
 
[[Category:Help]]
 
[[Category:Help]]

Revision as of 16:04, 19 July 2009

Use these tags either to help edit an article or create established formatted articles.

Off-Page Administration

{{deletion}}
Use this tag to mark a page for review for deletion by an Admin. Write your reason for deletion over Enter your reason here. Please review Help:Deletion before placing this tag.
#REDIRECT [[real article name here]]
This redirects a link to a different article than the one linked. The usual purpose for this is to directly link an acronym or abbreviation (ex: AFFS or 'Mech) to an article with the full name (ex: Armed Forces of the Federated Suns or BattleMech), but common titles that would all share the same article material also make use of this command. The redirect will then automatically send all so-named links (throughout the BattleTechWiki) directly to the proper page. Place this magic word on an otherwise empty article or it won't work.

On-Page Administration

[[Category:Insert Category Name Here]]
Use this tag to automatically link an article with articles linked to the same name. Even if you don't know if a category exists, consider adding it, because you'll start the category yourself by doing so. Insert the tag at the bottom of the page, with the category's name in place of Insert Category Name Here.
{{cleanup}}
Use this tag to mark a page for generic cleanup. Currently, any problem falls into this category.
{{citation needed}} or {{cn}}
Use this tag following an article sentence, in order to request a proper reference be provided.
{{details}}
Use this tag if you wish to highlight link providing more detail than the sub-section in which it's placed. e.g., in the Clans article, a subsection on Clan Blood Spirit would have '{{details}}', and would produce text saying "For more details on this topic, see Clan Blood Spirit.". The link would then direct the reader to the full Clan Blood Spirit article.
To use this tag, replace Article name with the name of the page which is being linked. If it would make more sense than using the default text, include the Optional parameter; replacing it with meaningful text. e.g., {{details}} which would produce text similar to the prior example only "this topic" would be "this particular clan".
{{disambig}}
Place this template at the bottom of a disambiguation article.
{{fanon}}
This template is placed at the top of new fan-created articles, to clearly indicate it does not deal with licensed material.
{{otheruses}}
To be placed at the top of an article where possible confusion may exist with other similarly named articles. The fourth parameter is optional. See Template:Otheruses for proper usage.
{{quote}}
Place this one the page where you want the quote to stand out, and add in the actual quote in place of the statement here.
{{stub}}
Place this tag at the top of an article you feel needs to be expanded in order to be fully considered an article. Expand on your concerns in the article's discussion page.
{{update}}
Place the bolded code on top of the article's page. Replace source title with the article name of the new source material (there is no need to wiki-link it) and month year with the actual month name and year the tagged was placed.
{{verify}}
Place this tag at the top of an article or in a section you feel needs to be referenced, possibly due to a statement that may not be commonly known. Expand on your concerns in the article's discussion page.
{{Wikipedia}}
Place this tag at the top of an article that has a sister article (with the same name) at Wikipedia. It will automatically make properly formatted link that leads to the sister page.

Talk Pages

{{sign}}
To provide an easy and stock-standard message for editors to use to explain to people the hows and whys of signing their posts. Place this template on the user's talk page (and don't forget to sign the entry yourself).
{{unsigned}} or {{unsigned}}
Place this tag at the end of an unsigned post. Replace Username with the name of the user who left the comment. If you use the second example, you can include a comment of your own by replacing Optional comment with your own text. This parameter is useful for adding a timestamp, should you happen to know when the unsigned post was originally made.

Templates

{{tl}}
This tag is for making links to templates. You may even include one or more optional parameters. Replace Template name with the name of the template you're linking to. Replace Optional parameter with a short, meaningful description of what you put as that parameter. You can have up to three optional parameters. Note that most editors will rarely need to use this tag, its primary purpose is to help with creating pages like this one, or giving an example to a new editor.