View source for Category:Templates

{{Intro|'''''Templates''''' may be used as an easy way of formatting text for specific purposes in a consistent manner across the Wiki. Possible purposes include highlighting file or program paths, or placing notices on pages.|As Templates are created for specific purposes, please don't use them for other than the intended purposes detailed below.}}


:* '''Jump to:''' [[#list|Quick alphabetical list of templates]] 


__TOC__

==Templates==

===Box Templates===
In increasing order of 'danger'.  These are used, for example like so:

 <nowiki>{{alert|1=This is a dire warning that you ignore at your peril}}</nowiki>
{{ednote|1= '''ednote''' template:
* Only editors will see this.}}
{{intro|1= '''intro''' template used for introductory text:
* Usually used at the start of a page.}}
{{hint|1= '''hint''' to set off some slightly interesting text:
* Consider using an image instead, if using it to break up lengthy text.
* Bullet points in the hint also help.}}
{{example|1= '''example''' for a step by step example:
# Use numberd lists for steps.
# Images are good.}}
{{tip|1= '''tip''' to set off some ''really'' interesting text.}}
{{advice|1= '''advice''' is a warning really.}}{{alert|1= '''alert''' for dire warnings.  Use it sparingly.  Having too many is like crying '''WOLF'''. Try to group alerts together into one.}}

* [[Template:Introrel]] is an alternative to '''[[Template:Intro]]''' which additionally, places a bulleted, indented list of related articles underneath the introduction box. '''Note''' that ''Introrel'' is not supported in the Manual.
* [[Template:IntroNoItal]] formats text inside a standard introductory blue header similar to [[Template:Intro]] and [[Template:Introrel]] but has no concluding italicised paragraph or list of related articles. 


::::{{Code|1='''code''' for prominent display of indented lines or blocks of programming code, mathematical formulas or regular expressions.}}

* [[Template:Codelist]] is an optional,  slightly more indented variant for use with bulleted or ordered lists.


===Inline Templates===

* '''menu''' e.g. {{menu|File > [[File Menu#Check Dependencies...|Check Dependencies...]]}} 
** There are special versions on the [[Templates|full gory details page]] if you need to use this on a colored background.
* '''shortcut''' e.g. here showing the Cmd symbol for mac.  {{shortcut|Cmd + W}}
** '''fullshortcut''' is used for an extra/optional shortcut.  e.g. "Use {{fullshortcut|Cmd + Meta + AltGreen + S}} to show the extra special seek-scrub-sidebar".
* '''key''' e.g. {{key|Return}} used for a key that is not a shortcut.
** You may also see '''kbrd''' being used.  It is probably obsolete and gives a lighter result.  {{kbrd|Return}}
* '''bh''' is used for bold headers.
* '''button''' is used for buttons.
* more...  if you want to know more, see the [[Templates|Templates complete details page]]



===Templates for text formatting===

* '''[[Template:External]]''' for displaying links to web sites (URL's) outside the Wiki as italicised plainlinks, without the pointing arrow that will otherwise be appended to external links.      
* '''[[Template:Path]]''' for highlighting absolute and relative paths in operating systems.  


* '''[[Template:Button]]''' for button-like formatting of the text of a single on screen push button.
* '''[[Template:CheckboxChecked]]''' for button-like formatting of the text of a single on screen checkbox in a checked state.
* '''[[Template:CheckboxNotChecked]]''' for button-like formatting of the text of a single on screen checkbox in an unchecked state.
* '''[[Template:DropdownMenu]]''' for button-like formatting of the text of a single on screen dropdown menu. The text should be the content of the menu, not it's title.
* '''[[Template:Kbrd]]''' for highlighting a key press that is not a shortcut.
* '''[[Template:Menu]]''' for highlighting paths (sequential steps) in program and operating system menus and interfaces with a pale yellow background and bold font.
**[[Template:Menuadvice]] is a special variant for use inside an advice template.
**[[Template:Menualert]] is a special variant for use inside an alert template.
* '''[[Template:RadioSelected]]''' for button-like formatting of the text of a single on screen radio button in a selected state.
* '''[[Template:RadioNotSelected]]''' for button-like formatting of the text of a single on screen radio button in an unselected state.
* '''[[Template:Shortcut]]''' for highlighting single or multiple press keyboard shortcuts with a black bold italic font on purple-grey background.  


{{ednote|1=These are obsolete as we now use automagicke tables, which are much more compact.
==Templates for [[Scripting Syntax|scripting syntax]]==
These three templates also exist on the manual wiki.
* '''[[Template:Send_Receive_Title]]''' Adds the 'send' 'receive' headings for a table showing the action of a scripting command.  It takes no parameters.
* '''[[Template:Send_Receive]]''' Adds one row to a table showing the action of a scripting command.  Parameter 1 gives what is sent.  Parameter 2 gives what is received.
* '''[[Template:Param]]''' Used to format a parameter description for display.  Parameter 1 is the name of the parameter.  Parameter 2 is the description.
}}

==Templates for adding notices==

* '''[[Template:UserWip]]''' for '''Users''' to mark a page as a ''User Work in Progress''.


* [[Template:Audacity Devel]] to mark a page as a ''Developer Work in Progress''.
* [[Template:GSoC_Ideas_Key]] for inserting text shared between different "ideas" pages.
* [[Template:Proposal_Header]] for use on design proposals pages. Its purpose is to mark this as a family page with an intended structure and inform [[:Category:GSoC|GSoC]] students about how proposal pages relate to GSoC proposals.



==Using symbols and other templates inside templates==

Most of the Formatting templates will be used for formatting a string in some fashion. A few characters will cause the intended text to not display properly, most notably the '''equals sign'''. '''Using a second template inside the first one''' will also cause errors. In these cases you can almost always resolve these issues by appending <b>&quot;1=&quot;</b> (without quotes) after the pipe symbol (|), as in this example using [[Template:External]]:

{{code|<nowiki>{{external|1=[http://youtube.com/results?search_query=audacity]}}</nowiki>
}}


and in this example nesting [[Template:External]] inside [[Template:Hint]]:

{{code|<nowiki>{{hint|1='''HINT:''' {{external|1=[http://youtube.com/results?search_query=audacity Search Youtube for Audacity]}}.}}</nowiki>}}


Note here that as the URL in the nested [[Template:External]] contains an equals sign, that template must also include  <b>&quot;1=&quot;</b> after its pipe symbol.  Starting the parameter string with '''1=''' says something like 'set parameter one to the following string', which prevents the template parser from interpreting the equals sign in the string. 

If any symbols needed in the text still cause it to display incorrectly, try enclosing the text after the pipe inside  '''<nowiki> <nowiki> </nowiki> </nowiki>''' tags, for example: 

{{code|<nowiki>{{Hint|<nowiki>The above also explains why you cannot use the following symbols  @  ^ ? !  inside the text.</nowiki></nowiki><nowiki></nowiki><nowiki>}}</nowiki>}}


One restriction however with '''<nowiki> <nowiki> </nowiki> </nowiki>''' tags is that they cannot be used when nesting templates inside each other, as the tags prevent the second template being parsed.  

{{Hint|More information on template issues is available at:<br>http://en.wikipedia.org/wiki/Help:Template}}


<div id="list"></div>
[[Category:For Editors]]