Category:Templates

From Audacity Wiki
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

Box Templates

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

{{alert|1=This is a dire warning that you ignore at your peril}}
ednote template:
  • Only editors will see this.
intro template used for introductory text:
  • Usually used at the start of a page.
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 for a step by step example:
  1. Use numberd lists for steps.
  2. Images are good.
Bulb icon tip to set off some really interesting text.
Warning icon advice is a warning really.
Warning icon alert for dire warnings. Use it sparingly. Having too many is like crying WOLF. Try to group alerts together into one.


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. File > Check Dependencies...
  • shortcut e.g. here showing the Cmd symbol for mac. ⌘ + W
    • fullshortcut is used for an extra/optional shortcut. e.g. "Use Cmd + Meta + AltGreen + S   Extra to show the extra special seek-scrub-sidebar".
  • key e.g.

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. Return
  • bh is used for bold headers.
  • button is used for buttons.
  • more... if you want to know more, see the 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: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.


These are obsolete as we now use automagicke tables, which are much more compact.

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



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:

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


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

{{hint|1='''HINT:''' {{external|1=[http://youtube.com/results?search_query=audacity 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:
http://en.wikipedia.org/wiki/Help:Template