Template:Note: Difference between revisions

From Danno's Rocket Wiki
No edit summary
m (112 revisions imported)
 
(73 intermediate revisions by 27 users not shown)
Line 1: Line 1:
<includeonly>{{#if: {{{1|}}}|<table cellspacing="0" cellpadding="0" border="0" style="background: transparent;"><tr><td nowrap="nowrap" valign="top">}}<span style="position: relative; top: -2px;">[[File:Bulbgraph.png|18px|Note|link=]]</span> '''Note''': {{#if: {{{1|}}}|</td><td valign="top" style="padding-left:0.5em;">''{{{1|}}}''</td></tr></table>}}</includeonly><noinclude>
<languages/>
== Why using this template ==
<onlyinclude>{{#switch:<translate></translate>
Displays a {{TestNote}}''icon and text.''
| =
 
{{#if: {{#if:{{{1|{{{text|}}}}}}|{{{1|{{{text|}}}}}}|{{#if:<noinclude>demo</noinclude>|demo|{{{demo|}}}}} }} | <templatestyles src="Note/styles.css" /><div role="note" class="note note-{{#switch: {{{2|{{{type|}}}}}}
== Parameters ==
    |gotcha=error
List the parameters with a brief description.
    |=info
*Note text is optional, see [[#Methode 2|Method 2]] for details.
    |#default={{{2|{{{type|}}}}}}
    }} {{#ifeq:{{{inline|}}}|1|note-inline}}">{{{1|{{{text}}}}}}</div>
  | [[File:OOjs UI icon lightbulb-20 fc3.svg|18px|<translate><!--T:1--> Note</translate>|link=]]&nbsp;'''<translate><!--T:2--> Note:</translate>''' }}
| #default=
  {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Note|noshift=1}}
}}</onlyinclude>
{{documentation|content=
<translate>
== Usage == <!--T:3-->
</translate>
<pre>
{{Note|Foo}}
{{Note|Foo|info}}
{{Note|Foo|reminder}}
{{Note|Foo|warn}}
{{Note|Foo|error}}
{{Note}} <translate nowrap><!--T:6--> Loose test</translate>


== How to use ==
* Text {{Note|Foo|inline=1}}
<pre>
{{TestNote|parameter1=value}}
</pre>
</pre>
{{Note|Foo}}
{{Note|Foo|info}}
{{Note|Foo|reminder}}
{{Note|Foo|warn}}
{{Note|Foo|error}}
{{Note}} <translate><!--T:4--> Loose test</translate>


=== Method 1 ===
* Text {{Note|Foo|inline=1}}
The following displays the note icon and the word 'Note:'.  You can follow this with whatever text/images/markup you like, and it works in-line, within a paragraph.
Monsters are green. <nowiki>{{TestNote}}''This is an in-line note, to remind you that some monsters are orangey-purple.''</nowiki>


Monsters are green. {{TestNote}}''This is an in-line note, to remind you that some monsters are orangey-purple.''
== Parameters ==
 
=== Method 2 ===
The following includes the text passed to the template, and uses a table to stop the text flowing round the icon.  These always force a newline before and after the note.


<nowiki>{{TestNote|Here is a long note, which is sufficiently wordy to run onto a second line,
{{Note/doc}}
which would normally cause it to wrap round the icon, but because we passed it as a parameter
it keeps its left alignment straight.}}</nowiki>


{{TestNote|Here is a long note, which is sufficiently wordy to run onto a second line, which would normally cause it to wrap round the icon, but because we passed it as a parameter it keeps its left alignment straight.}}
}}
</noinclude>
[[Category:Templates{{#translation:}}|{{PAGENAME}}]]

Latest revision as of 23:23, 22 January 2021

<languages/> {{#switch:<translate></translate> | =

{{#if: {{#if:||{{#if:demo|demo|}} }} | <templatestyles src="Note/styles.css" />

{{{text}}}
 | <translate> Note</translate> <translate> Note:</translate> }}

| #default=

 {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Note|noshift=1}}

}} {{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}{{#if:<translate>

Usage

</translate>

{{Note|Foo}}
{{Note|Foo|info}}
{{Note|Foo|reminder}}
{{Note|Foo|warn}}
{{Note|Foo|error}}
{{Note}} <translate nowrap><!--T:6--> Loose test</translate>

* Text {{Note|Foo|inline=1}}

{{#switch:<translate></translate> | =

{{#if: {{#if:Foo|Foo|{{#if:|demo|}} }} | <templatestyles src="Note/styles.css" />

Foo
 | <translate> Note</translate> <translate> Note:</translate> }}

| #default=

 {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Note|noshift=1}}

}} {{#switch:<translate></translate> | =

{{#if: {{#if:Foo|Foo|{{#if:|demo|}} }} | <templatestyles src="Note/styles.css" />

Foo
 | <translate> Note</translate> <translate> Note:</translate> }}

| #default=

 {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Note|noshift=1}}

}} {{#switch:<translate></translate> | =

{{#if: {{#if:Foo|Foo|{{#if:|demo|}} }} | <templatestyles src="Note/styles.css" />

Foo
 | <translate> Note</translate> <translate> Note:</translate> }}

| #default=

 {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Note|noshift=1}}

}} {{#switch:<translate></translate> | =

{{#if: {{#if:Foo|Foo|{{#if:|demo|}} }} | <templatestyles src="Note/styles.css" />

Foo
 | <translate> Note</translate> <translate> Note:</translate> }}

| #default=

 {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Note|noshift=1}}

}} {{#switch:<translate></translate> | =

{{#if: {{#if:Foo|Foo|{{#if:|demo|}} }} | <templatestyles src="Note/styles.css" />

Foo
 | <translate> Note</translate> <translate> Note:</translate> }}

| #default=

 {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Note|noshift=1}}

}} {{#switch:<translate></translate> | =

{{#if: {{#if:||{{#if:|demo|}} }} | <templatestyles src="Note/styles.css" />

{{{text}}}
 | <translate> Note</translate> <translate> Note:</translate> }}

| #default=

 {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Note|noshift=1}}

}} <translate> Loose test</translate>

  • Text {{#switch:<translate></translate>

| =

{{#if: {{#if:Foo|Foo|{{#if:|demo|}} }} | <templatestyles src="Note/styles.css" />

Foo
 | <translate> Note</translate> <translate> Note:</translate> }}

| #default=

 {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Note|noshift=1}}

}}

Parameters

<templatedata> { "params": { "inline": { "label": "Inline formatting", "description": "Show the template without line breaks before and after it", "type": "boolean" }, "text": { "aliases": [ "1" ], "label": "Text", "type": "content", "required": true }, "type": { "aliases": [ "2" ], "label": "Type", "description": "One of 'info', 'reminder', 'warn', or 'error'. This setting affects the color and icon.", "type": "line", "default": "info" } }, "format": "inline", "description": "Show a note in a box (e.g. a top-of-the-page warning).", "paramOrder": [ "type", "text", "inline" ] } </templatedata>| [[Category:Template documentation pages{{#translation:}}]] }} [[Category:Templates{{#translation:}}|Note]]