Difference between revisions of "Help:Note boxes"
(→Quote) |
|||
| (9 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
Note boxes can be used in an article to highlight certain text information. Find all noteboxes in the [[:Category:Article template|category "Article template"]]. | Note boxes can be used in an article to highlight certain text information. Find all noteboxes in the [[:Category:Article template|category "Article template"]]. | ||
| + | |||
| + | The styling for the noteboxes is added via CSS as referred to in the templates. | ||
| + | |||
| + | ==Different noteboxes== | ||
| + | At the moment, there are the following note box templates available: | ||
| + | *[[Template:Note|Note]] | ||
| + | *[[Template:Note-info|Note-info]] | ||
| + | *[[Template:Note-warning|Note-warning]] | ||
| + | *[[Template:Note-nutshell|Note-nutshell]] | ||
| + | *[[Template:Quote|Quote]] | ||
Use the code <code>'''{{Note<nowiki>|</nowiki>''Note text''}}'''</code> in your text and change ''Note text'' to the content you need. | Use the code <code>'''{{Note<nowiki>|</nowiki>''Note text''}}'''</code> in your text and change ''Note text'' to the content you need. | ||
| − | + | In the noteboxes usually there is a default title that can be changed by including a template parameter. Refer to the template pages for detailed information and all compulsory and optional template parameters. | |
===In a nutshell=== | ===In a nutshell=== | ||
| − | For making use of the template [[Template:Note-nutshell|Note-nutshell]], include <code>'''{{Note-nutshell<nowiki>|</nowiki>''This is the page in one sentence. Actually, two.''}}'''</code> at the very beginning of your text (before the table of contents) to produce: | + | For making use of the template [[Template:Note-nutshell|Note-nutshell]], include <code>'''{{Note-nutshell<nowiki>|summary=</nowiki>''This is the page in one sentence. Actually, two.''}}'''</code> at the very beginning of your text (before the table of contents) to produce: |
| − | {{Note-nutshell|This is the page in one sentence. Actually, two.}} | + | {{Note-nutshell|summary=This is the page in one sentence. Actually, two.}} |
| + | |||
| + | You can change the title by including the title parameter <code>|title=</code> into the template: | ||
| + | |||
| + | <code>'''{{Note-nutshell<nowiki> |title=</nowiki>''Please read first.''<nowiki> |summary=</nowiki>''This is the page in one sentence. Actually, two.''}}'''</code> | ||
| + | |||
| + | This will give you: | ||
| + | |||
| + | {{Note-nutshell|title=Please read first.|summary=This is the page in one sentence. Actually, two.}} | ||
| + | |||
| + | Remember to write longer template calls below each other: | ||
| + | |||
| + | <code>'''{{Note-nutshell<br /><nowiki> |title=</nowiki>''Please read first.''<br /><nowiki> |summary=</nowiki>''This is the page in one sentence. Actually, two.''<br />}}'''</code> | ||
===Note=== | ===Note=== | ||
| Line 16: | Line 38: | ||
{{Note|Note text}} | {{Note|Note text}} | ||
| + | |||
| + | A different title is optional, include it with the "title" parameter: | ||
| + | |||
| + | <code>'''{{Note<nowiki>|title=Screenshot trick:</nowiki>|''Note text''}}'''</code> | ||
| + | {{Note|title=Screenshot trick:|Note text}} | ||
===Info=== | ===Info=== | ||
| Line 21: | Line 48: | ||
{{Note-info|This helps you a lot!}} | {{Note-info|This helps you a lot!}} | ||
| + | |||
| + | A different title is optional, include it with the "title" parameter: | ||
| + | |||
| + | <code>'''{{Note-info<nowiki>|title=See also:</nowiki>|''Note text''}}'''</code> | ||
| + | {{Note-info|title=See also:|Note text}} | ||
===Warning=== | ===Warning=== | ||
| Line 26: | Line 58: | ||
{{Note-warning|Attention, attention!}} | {{Note-warning|Attention, attention!}} | ||
| + | |||
| + | A different title is optional, include it with the "title" parameter: | ||
| + | |||
| + | <code>'''{{Note-warning<nowiki>|title=Beware:</nowiki>|''Note text''}}'''</code> | ||
| + | {{Note-warning|title=Beware:|Note text}} | ||
===Quote=== | ===Quote=== | ||
| Line 36: | Line 73: | ||
===References=== | ===References=== | ||
<references /> | <references /> | ||
| + | |||
| + | ==Best practices== | ||
| + | |||
| + | {{Note|It does not matter if you write the template parameters in one row or underneath: | ||
| + | <code>{{Note<nowiki>|title=</nowiki>''Note text''}}</code> will give the same as | ||
| + | |||
| + | <code>{{Note<br /><nowiki>|title=</nowiki>''Note text''<br />}}</code> | ||
| + | |||
| + | how it's often written in longer templates. | ||
| + | }} | ||
Latest revision as of 16:00, 15 August 2015
Note boxes can be used in an article to highlight certain text information. Find all noteboxes in the category "Article template".
The styling for the noteboxes is added via CSS as referred to in the templates.
Contents
Different noteboxes
At the moment, there are the following note box templates available:
Use the code {{Note|Note text}} in your text and change Note text to the content you need.
In the noteboxes usually there is a default title that can be changed by including a template parameter. Refer to the template pages for detailed information and all compulsory and optional template parameters.
In a nutshell
For making use of the template Note-nutshell, include {{Note-nutshell|summary=This is the page in one sentence. Actually, two.}} at the very beginning of your text (before the table of contents) to produce:
You can change the title by including the title parameter |title= into the template:
{{Note-nutshell |title=Please read first. |summary=This is the page in one sentence. Actually, two.}}
This will give you:
Remember to write longer template calls below each other:
{{Note-nutshell
|title=Please read first.
|summary=This is the page in one sentence. Actually, two.
}}
Note
For making use of the template Note, include {{Note|Note text}} in your text to produce:
A different title is optional, include it with the "title" parameter:
{{Note|title=Screenshot trick:|Note text}}
Template:Note
Info
For making use of the template Note-info, include {{Note-info|This helps you a lot!}} in your text to produce:
A different title is optional, include it with the "title" parameter:
{{Note-info|title=See also:|Note text}}
Warning
For making use of the template Note-warning, include {{Note-warning|Attention, attention!}} in your text to produce:
A different title is optional, include it with the "title" parameter:
{{Note-warning|title=Beware:|Note text}}
Quote
Usage of the template Quote by including {{Quote|Quote text|Speaker|Source}} into the text.
Quote text
Speaker[1]
Make sure to include the <references /> tag at the end of the page under a separate heading to list all sources.
References
- ↑ Source
