Difference between revisions of "Template:Shortcut"

From Audacity Wiki
Jump to: navigation, search
(matches Manual; depends on shortcut css class)
(New template from manual wiki.)
Line 26: Line 26:
 
will cause the following to be displayed:
 
will cause the following to be displayed:
  
<span class="shortcut">CTRL +V</span>
+
{{shortcut|CTRL + V}}
 +
 
 +
You can also add a colour, for example:
 +
<nowiki>{{</nowiki>shortcut|CTRL + V|d5c9e6<nowiki>}}</nowiki>
 +
 
 +
gives:
 +
{{shortcut|CTRL + V|d5c9e6}}
 +
 
 +
which is using the older colour.
  
 
[[Category:Templates]]
 
[[Category:Templates]]
----
+
<includeonly><span class="kbrd" style="background-color: #{{{2|e0e0f0}}}">{{{1}}}</span></includeonly>
''Ignore the following, it's only a representation of formatting and a parameter dummy.''
 
 
 
</noinclude><span class="shortcut">{{{1}}}</span>
 

Revision as of 16:07, 29 April 2017

The Shortcut Template formats a string of text defining a Keyboard Shortcut with a standard background colour to make it stand out amongst the surrounding text. Keyboard shortcuts are key presses which access menu items and/or perform actions in programs.


Purpose

This formatting can be used for shortcuts in any program (not just Audacity) or for those in operating systems. Examples of such shortcuts are:

  • CTRL + A
  • ALT + Z
  • CTRL + SHIFT + X
  • CMD + F (Mac computers)

For more details of Audacity keyboard shortcuts, please see Keyboard Layouts.


NOTE: This template should be used only for keyboard shortcuts. Other templates are available for other uses, see Templates.


Usage of Shortcut Template:

{{shortcut|text to be formatted}}

For example, typing this:

{{shortcut|CTRL + V}}

will cause the following to be displayed:

CTRL + V

You can also add a colour, for example:

{{shortcut|CTRL + V|d5c9e6}}

gives: CTRL + V

which is using the older colour.