Difference between revisions of "Template:Intro"

From Audacity Wiki
Jump to: navigation, search
(New and Improved - now with emphasis string!)
(Publish and Category:Templates)
Line 1: Line 1:
−
<noinclude>__NOTOC__
+
<noinclude>__NOTOC__{{intro|The '''''Intro'' Template''' formats text inside a standard introductory blue header, just like this one.|}}
−
{{UserWip}}
 
  
  
−
{{intro|The '''''Intro'' Template''' Formats text as an introduction.|}}
+
'''Purpose'''
  
 +
* This template formats text inside a standardised "introduction" header box with blue background. The text should be placed at the top of the page and should provide a concise summary (preferably in one or two sentences) of the overall content of the page. If a second paragraph is needed, you can use ENTER on the keyboard to create one, just as in normal editing. 
 +
* A subsequent string of text can be added that will be displayed below the first, and emphasised with italicised, centre-aligned text. This can be useful when any particular point needs to be made, such as explaining what aspects are <i>not</i> covered in the page text.
  
  
−
=== Purpose ===
+
'''Usage of ''Intro'' Template'''
  
 +
'''General usage:'''
 +
 +
{{code|<nowiki>{{Intro|</nowiki> ''Text to be displayed standard'' <nowiki>|</nowiki> ''Text to be displayed emphasised'' <nowiki>}}</nowiki>}}
 +
 +
 +
'''Alternative:'''
 +
 +
If all the text is to be displayed without emphasis, you still need to supply the second pipe symbol <nowiki> "|" </nowiki>, so that after your unemphasised text, the template is closed with {{shortcut|&nbsp;<nowiki>|}}</nowiki>&nbsp;}}:
 +
 +
{{code|<nowiki>{{Intro|</nowiki> ''Text to be displayed standard'' <nowiki>|}}</nowiki>}}
 +
 +
 +
Note that if the pipe symbol is missing, only a dummy parameter will be displayed instead of your intended text.
  
−
* This template formats the text in a standardised "introduction" format, on blue background.
 
−
* A second string of text can be added, that will be displayed below the first, and emphasised (e.g. when any particular point has to be made).
 
  
 +
'''Style and abbreviations'''
  
−
=== Usage of ''Intro'' Template ===
+
As the introduction is the first thing the reader sees, the header should be written in full English with no abbreviations such as "viz" or "e.g.".  If a technical abbreviation is necessary, a link to explanatory text must be provided.
  
 +
If either the standard or emphasised text must contain the equals sign "=" , then the text after the pipe must be enclosed inside {{shortcut|<nowiki> <nowiki> </nowiki> </nowiki>}} tags:
  
−
'''General usage:'''
+
{{code|<nowiki>{{Intro|<nowiki>This page explains why "2 + 2 = 4" is correct.</nowiki></nowiki><nowiki></nowiki><nowiki>|}}</nowiki>}}
  
−
{{code|<nowiki>{{Intro|</nowiki> ''Text to be displayed standard'' <nowiki>|</nowiki> ''Text to be displayed emphasised'' <nowiki>}}</nowiki>}}
 
  
−
It should be added as the first item on the page in question.
+
Similarly, if other essential symbols in the text cause the text to display incorrectly, try enclosing the text inside {{shortcut|<nowiki> <nowiki> </nowiki> </nowiki>}} tags.  
  
  
−
'''Alternative'''
+
'''Example:'''
  
−
If no text to be emphaises is supplied, an "empty" string still has to be supplied as in thiss example:
+
'''Typing this:'''
  
−
{{code|<nowiki>{{Intro|</nowiki> ''Text to be displayed standard'' <nowiki>|}}</nowiki>}}
+
{{code|<nowiki>{{Intro|OGG is strictly an open, free container format for digital multimedia, but the term is commonly used to refer to the high-quality lossy compressed audio file format known as OGG Vorbis.|<nowiki>Please note: if encoding at the command line, " filename = %f " must not be used.</nowiki></nowiki><nowiki></nowiki><nowiki>}}</nowiki>}}
  
−
Note that the invocation of the template is closed by {{shortcut|&nbsp;<nowiki>|}}</nowiki>&nbsp;}}, if only closed by {{shortcut|&nbsp;<nowiki>}}</nowiki>&nbsp;}} the dummy parameter will be displayed.
 
  
 +
'''will produce this:'''
 +
{{Intro|OGG is strictly an open, free container format for digital multimedia, but the term is commonly used to refer to the high-quality lossy compressed audio file format known as OGG Vorbis.| <nowiki>Please note: if encoding at the command line, " filename = %f " must not be used.</nowiki>}}
  
−
=== Example ===
 
  
 +
----
  
−
Using the tag produces the following "box" (with the supplied texts replacing the <nowiki>{{{1}}}</nowiki> placeholder):
+
''Ignore the following, it's only a representation of formatting and a parameter dummy.''
 
</noinclude>
 
</noinclude>
 
{| style="background:#EEEEFF"  cellpadding="10px" width=90% align="center"
 
{| style="background:#EEEEFF"  cellpadding="10px" width=90% align="center"
Line 46: Line 60:
 
|}
 
|}
 
|}
 
|}
 +
 +
 +
 +
[[Category:Templates]]

Revision as of 03:26, 15 November 2007

The Intro Template formats text inside a standard introductory blue header, just like this one.


Purpose

  • This template formats text inside a standardised "introduction" header box with blue background. The text should be placed at the top of the page and should provide a concise summary (preferably in one or two sentences) of the overall content of the page. If a second paragraph is needed, you can use ENTER on the keyboard to create one, just as in normal editing.
  • A subsequent string of text can be added that will be displayed below the first, and emphasised with italicised, centre-aligned text. This can be useful when any particular point needs to be made, such as explaining what aspects are not covered in the page text.


Usage of Intro Template

General usage:

{{Intro| Text to be displayed standard | Text to be displayed emphasised }}


Alternative:

If all the text is to be displayed without emphasis, you still need to supply the second pipe symbol "|" , so that after your unemphasised text, the template is closed with   :

{{Intro| Text to be displayed standard |}}


Note that if the pipe symbol is missing, only a dummy parameter will be displayed instead of your intended text.


Style and abbreviations

As the introduction is the first thing the reader sees, the header should be written in full English with no abbreviations such as "viz" or "e.g.". If a technical abbreviation is necessary, a link to explanatory text must be provided.

If either the standard or emphasised text must contain the equals sign "=" , then the text after the pipe must be enclosed inside </nowiki> tags:

{{Intro|<nowiki>This page explains why "2 + 2 = 4" is correct.</nowiki>|}}


Similarly, if other essential symbols in the text cause the text to display incorrectly, try enclosing the text inside </nowiki> tags.


Example:

Typing this:

{{Intro|OGG is strictly an open, free container format for digital multimedia, but the term is commonly used to refer to the high-quality lossy compressed audio file format known as OGG Vorbis.|<nowiki>Please note: if encoding at the command line, " filename = %f " must not be used.</nowiki>}}


will produce this:

OGG is strictly an open, free container format for digital multimedia, but the term is commonly used to refer to the high-quality lossy compressed audio file format known as OGG Vorbis.
Please note: if encoding at the command line, " filename = %f " must not be used.


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

{{{1}}}
{{{2}}}
Retrieved from "https://wiki.audacityteam.org/w/index.php?title=Template:Intro&oldid=7070"