From Audacity Wiki
Revision as of 17:33, 17 July 2007 by Suf (talk | contribs) (Unifying descriptive text)
Jump to: navigation, search


The Code Template can be used to format a string of text in a consistent way across the Wiki, with a background and foreground colour which will make it stand out amongst surrounding text. This template is intended for code snippets (either in programs or in scripts), for emphasising the specific code used. Code Template can be used for any program or script.

NOTE: This template should be used only for code snippets (either in programs or in scripts). (Other templates are available for other uses, see Templates.)

Usage of Template Code:

{{code|text to be formatted}}

For example, typing this:

See e.g. line 123: {{code|foreach($pics as $p)}}.

will cause the following to be displayed:

See e.g. line 123: foreach($pics as $p)

IMPORTANT NOTE: Wikis are very picky when it comes to what goes inside a template "call", some things (like equal signs, e.g.) might not come out as expected unless some tricks are resorted to! You may have to enclose the text part of the call in <nowiki></nowiki> tags to get it right.

Ignore the following, it's only a representation of formatting and a parameter dummy.