From Audacity Wiki
Revision as of 22:04, 14 December 2009 by James (talk | contribs) (Added new templates to list.)
Jump to: navigation, search
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.

Templates for text formatting

  • Template:Alert for drawing attention to dangerous or ill-advised actions or advising caution, using a standard pink box with exclamation image. Use Template:Advice or Template:Instruction for important advice or instruction sets, but which don't need a warning about non-adherence.
  • Template:Advice for emphasizing essential information inside a standard light yellow box. Note: You can use Template:Instruction for instruction sets, which automatically includes a bold, centred "INSTRUCTIONS" header inside a similar box.
  • Template:Button for button-like formatting of the text of a single program button, tab or menu, or a single non-shortcut keyboard button.
  • Template: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.
  • 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:Hint for enclosing a "hint" or other secondary information (for example, information that only applies in particular cases) inside a standard light green box.
  • Template: Instruction for emphasizing instruction sets inside a standard light yellow box, including a bold, centred "INSTRUCTIONS" header.
  • Template:Intro for enclosing page introductions inside a standard blue header box, and optionally, to italicise and centre-align a subsequent string of text for additional emphasis. Template:Introrel is an alternative variant which additionally, places a bulleted, indented list of related articles underneath the introduction box.
  • Template:Menu for highlighting paths (sequential steps) in program and operating system menus and interfaces with a green background and brown font. Template:Menugrey is an alternative variant with a dark grey background which may work better if you are working inside a panel with a non-white background.
  • Template:Path for highlighting absolute and relative paths in operating systems.
  • Template:Shortcut for highlighting single or multiple press keyboard shortcuts with a black font on orange background.
Warning icon For subscribers to audacity-devel mailing list only:

Templates for 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

Warning icon For subscribers to audacity-devel mailing list only:
  • Template:Audacity Devel to mark a page as a Developer Work in Progress.
  • 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 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 "1=" (without quotes) after the pipe symbol (|), as in this example using Template:External:


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

{{hint|1='''HINT:''' {{external|1=[ Search Youtube for Audacity]}}.}}

Note here that as the URL in the nested Template:External contains an equals sign, that template must also include "1=" 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> tags, for example:

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

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

More information on template issues is available at: