Difference between revisions of "Template:Intro"

From Audacity Wiki
Jump to: navigation, search
(edit to match the Manual intro template)
(Default empty second argument.)
 
Line 1: Line 1:
<noinclude>__NOTOC__{{intro|The '''''Intro'' Template''' formats text inside a standard introductory blue header, just like this one.|}}
+
<noinclude>__NOTOC__{{intro|The '''''Intro'' Template''' formats text inside a standard introductory blue header, just like this one.}}
  
  
Line 20: Line 20:
 
'''Alternative:'''
 
'''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;}}:  
+
If all the text is to be displayed without emphasis, do it like so:  
  
{{code|<nowiki>{{Intro|</nowiki> ''Text to be displayed standard'' <nowiki>|}}</nowiki>}}
+
{{code|<nowiki>{{Intro| Text to be displayed standard }}</nowiki> }}
  
 +
It will appear like so:
  
Note that if the pipe symbol is missing, only a dummy parameter will be displayed instead of your intended text.
+
{{Intro| Text to be displayed standard }}
 
 
  
 
'''Style and abbreviations'''
 
'''Style and abbreviations'''
Line 32: Line 32:
 
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.
 
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:
+
If either the standard or emphasised text must contain the equals sign "=" , then the text after the pipe can be enclosed inside {{shortcut|<nowiki> <nowiki> </nowiki> </nowiki>}} tags:
 +
 
 +
{{code|<nowiki>{{Intro|<nowiki>This page explains why "2 + 2 = 4" is correct.</nowiki></nowiki><nowiki>}}</nowiki>}}
 +
 
 +
A perhaps easier way is to use '1=' for the first argument and '2=' for the second, like so:
  
{{code|<nowiki>{{Intro|<nowiki>This page explains why "2 + 2 = 4" is correct.</nowiki></nowiki><nowiki></nowiki><nowiki>|}}</nowiki>}}
+
{{code|<nowiki>{{Intro|1=This page explains why "2 + 2 = 4" is correct.|2=This is in italics}}</nowiki>}}
  
 +
which gives this:
 +
 +
{{Intro|1=This page explains why "2 + 2 = 4" is correct.|2=This is in italics}}
  
 
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.  
 
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.  
Line 44: Line 51:
 
'''Typing this:'''
 
'''Typing this:'''
  
{{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>}}
+
{{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>}} 
 +
 
 +
'''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>}}  
 +
 
 +
'''Optional second parameter:'''
 +
 
 +
The second parameter can now be omitted, if you so wish.
  
 +
{{code|<nowiki>{{Intro|OGG is Great!}}</nowiki>}} 
  
 
'''will produce this:'''
 
'''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>}}  
+
{{Intro|OGG is Great!}}
 +
 
 +
 
  
 
[[Category:Templates]]
 
[[Category:Templates]]
 
 
----
 
----
  
''Ignore the following, it's only a representation of formatting and a parameter dummy.''
+
</noinclude><includeonly><div style="margin:24px">
</noinclude>
 
<div style="margin:24px">
 
 
{| style="background:#DFEAF9;border:1px solid black; padding-left:12px; padding-right:12px" width="100%" align="center"
 
{| style="background:#DFEAF9;border:1px solid black; padding-left:12px; padding-right:12px" width="100%" align="center"
 
|-
 
|-
 
|align="left" valign="top"|{{{1}}}
 
|align="left" valign="top"|{{{1}}}
 
{| style="margin-left:2em;margin-right:1.2em;background:#DFEAF9;font-style:italic"  cellpadding="5px"
 
{| style="margin-left:2em;margin-right:1.2em;background:#DFEAF9;font-style:italic"  cellpadding="5px"
|{{{2}}}   
+
|{{{2|}}}   
|}
 
 
|}
 
|}
</div>
+
|}</div></includeonly>

Latest revision as of 12:20, 14 March 2018

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


Note: An alternative variant of this template called Introrel is also available. This additionally places a bulleted, indented list of related articles underneath the blue header.


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 text indented at left and right margins. 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, do it like so:

{{Intro| Text to be displayed standard }}

It will appear like so:

Text to be displayed standard

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 can be enclosed inside </nowiki> tags:

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

A perhaps easier way is to use '1=' for the first argument and '2=' for the second, like so:

{{Intro|1=This page explains why "2 + 2 = 4" is correct.|2=This is in italics}}

which gives this:

This page explains why "2 + 2 = 4" is correct.
This is in italics

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.

Optional second parameter:

The second parameter can now be omitted, if you so wish.

{{Intro|OGG is Great!}}

will produce this:

OGG is Great!