ModEnc is currently in Maintenance Mode: Changes could occur at any given moment, without advance warning.

Difference between revisions of "ModEnc:Templates"

From ModEnc
Jump to: navigation, search
(Updated accordingly.)
(Formatting: added Template:S, learned the alphabet)
 
(52 intermediate revisions by 6 users not shown)
Line 3: Line 3:
 
If you have ideas for more templates, feel free to suggest them on the [[ModEnc_talk:Templates|talk-page]] or code them yourself. But don't forget to update this list.
 
If you have ideas for more templates, feel free to suggest them on the [[ModEnc_talk:Templates|talk-page]] or code them yourself. But don't forget to update this list.
  
==<nowiki>{{categories}}</nowiki>==
+
Click on a link to see information on how to include the template in question.
Adds the table of categories seen on the main page. Should not be necessary somewhere else.<br>
 
{{categories}}
 
  
==<nowiki>{{disambig}}</nowiki>==
+
==List==
Adds the disambiguation-notice. Example usage [[AR2|here]]. <br><br>
+
===Messages and Marks===
{{disambig}}
+
; [[Template:Cleanup]] : Cleanup-mark-template, to mark pages violating [[ModEnc:Styleguide|the Styleguide]]
 +
; [[Template:del]] : Adds articles to the deletion list
 +
; [[Template:Disambig]] : Disambiguation template, for disambiguation pages <!--- duh -->
 +
; [[Template:Discussed]] : Work in Progress template, for pages under discussion
 +
; [[Template:Highlighted]] : Highlighted page template, to mark pages of exceptional quality
 +
; [[Template:Meanings]] : Primary meaning template, for cases where disambiguation would be too much
 +
; [[Template:NeedsTesting]] : Used to indicate articles containing unverified information
 +
; [[Template:NotVerified]] : Not verified template, for pages whose information is unverified
 +
; [[Template:Obsolete]] : "Obsolete" template, for pages whose described feature is obsolete in either RA2, YR or both
 +
; [[Template:Stub]] : Marks "stubs", short, incomplete temporary pages
 +
; [[Template:WrongTitle]] : Wrong title template, for those pages whose name can't be saved correctly due to technical reasons
  
 +
===Bars and Boxes===
 +
; [[Template:BigHorizontalBar]] : Horizontal bar template, big horizontal bar with custom text
 +
; [[Template:HorizontalBar]] : Horizontal bar template, standard horizontal bar with custom text
 +
; [[Template:GameBar]] : Game information bar template. Information sidebar for pages on the C&C games.
 +
; [[Template:ModBar]] : Mod information bar template, information sidebar for mod-pages
 +
; [[Template:Sidebar]] : Side bar template, creating a sidebar which includes another page as content.
 +
; [[Template:ToolBar]] : Modding tool information bar template. Information sidebar for modding application pages.
  
==<nowiki>{{discussed|http://www.fullurl.tld}}</nowiki>==
+
===Formatting===
Adds the "Work in Progress"-template. The parameter does not accept PHP-variable-parts (i.e. attachments like ?var=value), which renders it useless for forum-posts. I'll think of a solution for this.<br>
+
; [[Template:Clr]] : Clear break-template, to end floating of text
{{discussed|http://www.fullurl.tld}}
+
; [[Template:Co]] : Colorization-template for text, easier to use than &lt;font&gt; tags
 +
; [[Template:F]] : Used to format INI flags
 +
; [[Template:Sc]] : Small caps-template, shortcut to writing text in small caps
 +
; [[Template:Strike]] : Strike out-template, shortcut to striking out text
 +
; [[Template:Sub]] : Subscript-template, shortcut to writing subscript
 +
; [[Template:Sup]] : Superscript-template, shortcut to writing superscript
 +
; [[Template:Sl]] : Section Link, quickly creates teletyped, brackets-enclosed links to section pages
 +
; [[Template:S]] : Used to format INI section headers
 +
; [[Template:Tt]] : Teletype-template, to access monospacing without HTML-hassle
 +
; [[Template:U]] : Underline-template, shortcut to underlining text
  
==<nowiki>{{flag|name=|files=|values=|special=|default=|types=|games=}}</nowiki>==
+
===Markup Assistance===
Adds the standard header for INI-flags. Example usage [[BuildLimit|here]].<br>
+
; [[Template:!]] : Gets replaced by a pipe character ("|"), for situations where a real "|" would disrupt the template-syntax
If there is no value, put "None"; capitalization is important in this case, as there may also be the value "none", which would be lower-case only.<br>
+
; [[Template:Arr]] : Arrow-template, to quickly generate arrows in text
'''Note:''' This is to be put directly at the page's beginning - no extra horizontal lines, to empty lines, nothing. Either relocate the TOC via <nowiki>__TOC__</nowiki> or disable it entirely via <nowiki>__NOTOC__</nowiki>.
+
; [[Template:Edit]] : Link-template, outputs the full url to an edit page
<br><br>
+
; [[Template:Equal]] : Gets replaced by an equal sign ("="), for situations where a real "=" would disrupt the template-syntax
----
+
; [[Template:Fn]] : Used to generate a footnote paragraph with a backlink
{{flag|name=Flag's name|files=Which files can it be used in?|values=Possible values|special=Special values, like -1 for unlimited|default=Default value|types=Can be added to which Types/sections?|games=Works in which games?}}
+
; [[Template:Fnl]] : Used to generate a link to a footnote
==<nowiki>{{meanings|Bracket-input}}</nowiki>==
+
; [[Template:Imglink]] : Image-template, to link images to something other than their Image: page
In some cases, a word is strongly associated with a certain meaning, but can still mean something else. In that case, a disambiguation page may not be the best choice - use <nowiki>{{meanings}}</nowiki> instead.<br>
+
; [[Template:Ini]] : Generates an md'd link to an INI-file page
{{meanings|Bracket-input}}
+
; [[Template:Plain]] : Removes the external link indicator from external links
As you can see, <nowiki>{{meanings}}</nowiki> creates a link to a page named exactly as the current page, with an additional bracket; the bracket's content has to be determined by the parameter. On the [[Cost]]-page, this is used to add an additional link to [[Cost (Multiplier)]], but you could also append a real disambiguation page throught the use of <nowiki>{{meanings|disambiguation}}</nowiki>.
+
; [[Template:Progress]] : Generates a box showing a progress-percentage bar for a feature
 +
; [[Template:Quote]] : Quote-template, to unify quotation markups
 +
; [[Template:Tocleft]] : Puts the TOC inside a left-floating table
 +
; [[Template:Tocright]] : Puts the TOC inside a right-floating table
 +
; [[Template:Values]] : Generates standardized value type descriptions
  
==<nowiki>{{NotVerified}}</nowiki>==
+
===Categories===
Adds the warning header for speculative or incomplete pages.
+
; [[Template:CatAllTypes]] : Categorization-template for flags which are available on all *Types
{{NotVerified}}
+
; [[Template:Categ]] : Categorization-template for [[Template:Flag|<nowiki>{{flag|files=}}</nowiki>]]-entries
 +
; [[Template:FlagMoved]] : Categorization-template for [[Template:Flag|<nowiki>{{flag|files=}}</nowiki>]]-entries that have been moved between games
 +
 
 +
===Special Purpose===
 +
; [[Template:CnC Navigation]] : Navigation-template for C&amp;C games and add-ons
 +
; [[Template:CNCRedirect]] : Redirect template to CNCWiki for Units, Buildings, etc.
 +
; [[Template:Flag]] : INI-Flag template, header for all INI flag pages
 +
; [[Template:LaunchBase]] : Template for LaunchBase Related pages
 +
; [[Template:OffCo]] : Official Content template, header mark for ModEnc policy (or similar) pages
 +
; [[Template:RockPatch]] : RockPatch pages template, the standard RockPatch header pointing to the main pages
 +
; [[Template:RockPatchTagRef]] : RockPatch tag reference template, for the RockPatch tag reference <!-- it's sad that people need sentences like these -->
 +
; [[Template:Rpo]] : To mark content that only works with pd's RockPatch
 +
; [[Template:WeaponsRelated]] : Adds a block with links to pages related to the Armament System
 +
; [[Template:Wishlist/TOC]] : Wishlist TOC template, the RockPatch Wishlist's table of contents
 +
; [[Template:XCC NavBar]] : Navigational template for quick-jumping between the tools pages
 +
; [[Template:Yro]] : To mark content that only works in Yuri's Revenge
 +
 
 +
===Quick Link Generators===
 +
; [[Template:Rules]] : Creates {{rules}}
 +
; [[Template:Art]] : Creates {{art}}
 +
; [[Template:Sound]] : Creates {{sound}}
 +
; [[Template:Ai]] : Creates {{ai}}
 +
; [[Template:Theguide]] : Creates {{theguide}}
 +
====Games, Expansions, and EXE Patches====
 +
; [[Template:Td]] : Creates {{td}}
 +
; [[Template:Cop]] : Creates {{cop}}
 +
; [[Template:Ra]] : Creates {{ra}}
 +
; [[Template:Cs]] : Creates {{cs}}
 +
; [[Template:Am]] : Creates {{am}}
 +
; [[Template:Ts]] : Creates {{ts}}
 +
; [[Template:Fs]] : Creates {{fs}}
 +
; [[Template:Ets]] : Creates {{ets}}
 +
; [[Template:Ra2]] : Creates {{ra2}}
 +
; [[Template:Yr]] : Creates {{yr}}
 +
; [[Template:Rp]] : Creates {{rp}}
 +
; [[Template:Gen]] : Creates {{gen}}
 +
; [[Template:Zh]] : Creates {{zh}}
 +
; [[Template:Tw]] : Creates {{tw}}
 +
; [[Template:Kw]] : Creates {{kw}}
 +
 
 +
===Other===
 +
; [[Template:N]] : Minitemplate used to indicate "no" on functionality tables, checklists and the like
 +
; [[Template:Q]] : Minitemplate used to indicate "unknown/untested" on functionality tables, checklists and the like
 +
; [[Template:Y]] : Minitemplate used to indicate "yes" on functionality tables, checklists and the like
 +
 
 +
=== Custom Extensions ===
 +
; Counting pages in category : CategSize is an extension that simply prints the number representing the count of pages in a category. Usage: <pre>{{#CategSize|categoryname}}</pre> So far it's only used on the Main Page to count remaining DeeZire pages.
 +
 
 +
 
 +
 
 +
==Creating your own Templates==
 +
You are free to add your own templates, under '''three conditions''':
 +
#'''The templates serves an actual valuable purpose'''
 +
#'''You add it to the list above'''
 +
#'''It fits the general style of the rest'''
 +
To achieve point three, please consult [[ModEnc:Tables]], [[ModEnc:Styleguide]], and make use of pre-existing templates, e.g. the ones from the [[#Bars and Boxes|Bars and Boxes]] section.
 +
 
 +
In addition to the rules above, this should be included on template-pages:
 +
<pre>&lt;includeonly&gt;[[Category:CategoryName]]&lt;/includeonly&gt;
 +
&lt;noinclude&gt;Usage:
 +
&lt;pre&gt;&lt;/pre&gt;
 +
Copy-paste the code above and use as instructed.&lt;br&gt;
 +
Template includes Category:CategoryName automatically.
 +
&lt;/noinclude&gt;</pre>
 +
Use the &lt;includeonly&gt; block to include a category to which all pages including this template will be added, and the &lt;noinclude&gt; part to give a tutorial on how to use this template. Use the &lt;pre&gt; part to post a blank, copy-paste ready version of the template.
 +
 
 +
Look at already existing template-pages for examples.

Latest revision as of 07:30, 27 November 2009

This is a list of Templates available on ModEnc. It will be updated everytime a new one is added. Usage of these templates is simple: Just put {{templatename}} somewhere in a page's text, and it gets replaced by the template. In some cases, you have to give a parameter.

If you have ideas for more templates, feel free to suggest them on the talk-page or code them yourself. But don't forget to update this list.

Click on a link to see information on how to include the template in question.

List

Messages and Marks

Template:Cleanup 
Cleanup-mark-template, to mark pages violating the Styleguide
Template:del 
Adds articles to the deletion list
Template:Disambig 
Disambiguation template, for disambiguation pages
Template:Discussed 
Work in Progress template, for pages under discussion
Template:Highlighted 
Highlighted page template, to mark pages of exceptional quality
Template:Meanings 
Primary meaning template, for cases where disambiguation would be too much
Template:NeedsTesting 
Used to indicate articles containing unverified information
Template:NotVerified 
Not verified template, for pages whose information is unverified
Template:Obsolete 
"Obsolete" template, for pages whose described feature is obsolete in either RA2, YR or both
Template:Stub 
Marks "stubs", short, incomplete temporary pages
Template:WrongTitle 
Wrong title template, for those pages whose name can't be saved correctly due to technical reasons

Bars and Boxes

Template:BigHorizontalBar 
Horizontal bar template, big horizontal bar with custom text
Template:HorizontalBar 
Horizontal bar template, standard horizontal bar with custom text
Template:GameBar 
Game information bar template. Information sidebar for pages on the C&C games.
Template:ModBar 
Mod information bar template, information sidebar for mod-pages
Template:Sidebar 
Side bar template, creating a sidebar which includes another page as content.
Template:ToolBar 
Modding tool information bar template. Information sidebar for modding application pages.

Formatting

Template:Clr 
Clear break-template, to end floating of text
Template:Co 
Colorization-template for text, easier to use than <font> tags
Template:F 
Used to format INI flags
Template:Sc 
Small caps-template, shortcut to writing text in small caps
Template:Strike 
Strike out-template, shortcut to striking out text
Template:Sub 
Subscript-template, shortcut to writing subscript
Template:Sup 
Superscript-template, shortcut to writing superscript
Template:Sl 
Section Link, quickly creates teletyped, brackets-enclosed links to section pages
Template:S 
Used to format INI section headers
Template:Tt 
Teletype-template, to access monospacing without HTML-hassle
Template:U 
Underline-template, shortcut to underlining text

Markup Assistance

Template:! 
Gets replaced by a pipe character ("|"), for situations where a real "|" would disrupt the template-syntax
Template:Arr 
Arrow-template, to quickly generate arrows in text
Template:Edit 
Link-template, outputs the full url to an edit page
Template:Equal 
Gets replaced by an equal sign ("="), for situations where a real "=" would disrupt the template-syntax
Template:Fn 
Used to generate a footnote paragraph with a backlink
Template:Fnl 
Used to generate a link to a footnote
Template:Imglink 
Image-template, to link images to something other than their Image: page
Template:Ini 
Generates an md'd link to an INI-file page
Template:Plain 
Removes the external link indicator from external links
Template:Progress 
Generates a box showing a progress-percentage bar for a feature
Template:Quote 
Quote-template, to unify quotation markups
Template:Tocleft 
Puts the TOC inside a left-floating table
Template:Tocright 
Puts the TOC inside a right-floating table
Template:Values 
Generates standardized value type descriptions

Categories

Template:CatAllTypes 
Categorization-template for flags which are available on all *Types
Template:Categ 
Categorization-template for {{flag|files=}}-entries
Template:FlagMoved 
Categorization-template for {{flag|files=}}-entries that have been moved between games

Special Purpose

Template:CnC Navigation 
Navigation-template for C&C games and add-ons
Template:CNCRedirect 
Redirect template to CNCWiki for Units, Buildings, etc.
Template:Flag 
INI-Flag template, header for all INI flag pages
Template:LaunchBase 
Template for LaunchBase Related pages
Template:OffCo 
Official Content template, header mark for ModEnc policy (or similar) pages
Template:RockPatch 
RockPatch pages template, the standard RockPatch header pointing to the main pages
Template:RockPatchTagRef 
RockPatch tag reference template, for the RockPatch tag reference
Template:Rpo 
To mark content that only works with pd's RockPatch
Template:WeaponsRelated 
Adds a block with links to pages related to the Armament System
Template:Wishlist/TOC 
Wishlist TOC template, the RockPatch Wishlist's table of contents
Template:XCC NavBar 
Navigational template for quick-jumping between the tools pages
Template:Yro 
To mark content that only works in Yuri's Revenge

Quick Link Generators

Template:Rules 
Creates Rules(md).ini
Template:Art 
Creates Art(md).ini
Template:Sound 
Creates Sound(md).ini
Template:Ai 
Creates Ai(md).ini
Template:Theguide 
Creates DeeZire's Red Alert 2 and Yuris Revenge INI Editing Guide

Games, Expansions, and EXE Patches

Template:Td 
Creates Tiberian Dawn
Template:Cop 
Creates The Covert Operations
Template:Ra 
Creates Red Alert
Template:Cs 
Creates Counterstrike
Template:Am 
Creates Aftermath
Template:Ts 
Creates Tiberian Sun
Template:Fs 
Creates Firestorm
Template:Ets 
Creates Extended Tiberian Sun
Template:Ra2 
Creates Red Alert 2
Template:Yr 
Creates Yuri's Revenge
Template:Rp 
Creates RockPatch
Template:Gen 
Creates Generals
Template:Zh 
Creates Zero Hour
Template:Tw 
Creates Tiberium Wars
Template:Kw 
Creates Kane's Wrath

Other

Template:N 
Minitemplate used to indicate "no" on functionality tables, checklists and the like
Template:Q 
Minitemplate used to indicate "unknown/untested" on functionality tables, checklists and the like
Template:Y 
Minitemplate used to indicate "yes" on functionality tables, checklists and the like

Custom Extensions

Counting pages in category 
CategSize is an extension that simply prints the number representing the count of pages in a category. Usage:
{{#CategSize|categoryname}}
So far it's only used on the Main Page to count remaining DeeZire pages.


Creating your own Templates

You are free to add your own templates, under three conditions:

  1. The templates serves an actual valuable purpose
  2. You add it to the list above
  3. It fits the general style of the rest

To achieve point three, please consult ModEnc:Tables, ModEnc:Styleguide, and make use of pre-existing templates, e.g. the ones from the Bars and Boxes section.

In addition to the rules above, this should be included on template-pages:

<includeonly>[[Category:CategoryName]]</includeonly>
<noinclude>Usage:
<pre></pre>
Copy-paste the code above and use as instructed.<br>
Template includes Category:CategoryName automatically.
</noinclude>

Use the <includeonly> block to include a category to which all pages including this template will be added, and the <noinclude> part to give a tutorial on how to use this template. Use the <pre> part to post a blank, copy-paste ready version of the template.

Look at already existing template-pages for examples.