UserManual:Template/Example/Notification Box - Revision history

Mlink-rodrigue: Replaced content with " {{DISPLAYTITLE:Notification Box}} {{Manual:Template/Example/Notification_Box}}"

2020-10-28T10:42:26Z

Replaced content with "<bookshelf src="Book:User manual" /> {{DISPLAYTITLE:Notification Box}} {{Manual:Template/Example/Notification_Box}}"

Bookmanager at 14:30, 28 July 2020

2020-07-28T14:30:49Z

Bookmanager at 14:22, 28 July 2020

2020-07-28T14:22:14Z

Bookmanager at 10:12, 18 December 2019

2019-12-18T10:12:25Z

Mlink-rodrigue at 14:57, 13 December 2019

2019-12-13T14:57:07Z

Mlink-rodrigue: Created page with "{{DISPLAYTITLE:Notification Box}} ==Template example: Notification box== To emphasize text passages, it is common to use a type of notifcation box. In this example, we crea..."

2019-12-13T14:51:56Z

Created page with "{{DISPLAYTITLE:Notification Box}} ==Template example: Notification box== To emphasize text passages, it is common to use a type of notifcation box. In this example, we crea..."

New page

{{DISPLAYTITLE:Notification Box}}

==Template example: Notification box==
To emphasize text passages, it is common to use a type of notifcation box.

In this example, we create a notification box that can be used to show a warning, a tip or a note:

[[File:boxnote-outputs.png|480x480px]]

The color of the box and the box label change automatically depending on the type of box a user selects.

==Creating the template==

#'''Create''' the page ''Template:Box Note''
#'''Add''' the template content '''and save''' the page:<syntaxhighlight lang="html">
<div class="infobox notification-{{{boxtype}}}">
<span class="boxlabel">
{{#switch: {{{boxtype}}}
| note = Note:
| tip = Tip:
| warning = Warning:
| #default = Note:
}}
</span>
{{{Note text}}}
</div>
</syntaxhighlight>What this code does:

*The container (<code><nowiki><div>...</div></nowiki></code>) is used for styling the box. It has the style classes ''infobox'' and <code>''<nowiki>{{{boxtype}}}</nowiki>''</code>. The boxtype parameter provides the actual value the user chooses when using the template.
*The <code><nowiki><span>...</span></nowiki></code> contains the label for the box. It displays the label for the box type the user chooses. It has the style class ''boxlabel'' which is used to format the label.
*<code><nowiki>{{{Note text}}}</nowiki></code> is the placeholder for the actual text the user creates on a particular page.

To make it easy for users to insert and use this template in visual editing mode, we include a ''<nowiki><templatedata></nowiki>'' section in the template. It is wrapped in a <code><nowiki><noinclude>...</noinclude><nowiki></code> tag to ensure that this part of the template is not transcluded in the target page that uses the actual template. This template sections function is to describe the parameters of the template. It also populates the form for visual editing:<code><noinclude></noinclude></code>

<syntaxhighlight lang="html">
<div class="infobox notification-{{{boxtype}}}">
<span class="boxlabel">
{{#switch: {{{boxtype}}}
| note = Note:
| tip = Tip:
| warning = Warning:
| #default = Note:
}}
</span>
{{{Note text}}}
</div>

<noinclude>
<templatedata>
{
"params": {
"boxtype": {
"description": "Possible values: note, tip, warning",
"example": "note",
"type": "string",
"default": "note",
"required": true
},
"Note text": {}
},
"description": "To add standard infoboxes such as notes or related links to a page"
}
</templatedata>
</noinclude>
</syntaxhighlight>

What this code does:

*It lists the two parameters (''boxtype'' and ''Note text''), separated by a comma.
*It lists the parameter objects (optional): description, example, type, etc. For a full ist of template data objects, see [https://www.mediawiki.org/wiki/Extension:TemplateData#Param_object www.mediawiki.org/wiki/Extension:TemplateData#Param_object]
*It describes the purpose of the template (''description'') so that users can distinguish it from similar templates.

==Creating the template styles==
To style the notification box, we have assigned three style classes:

*infobox: Container for the infobox. We can specify layout properties such as border, background or padding
*notification-<nowiki>{{{boxtype}}}</nowiki>: Used for color-coding the box based on what type of box a user wants to insert on a page.
*boxlabel: Styling of the box label.

Since we want to load the styles only when this template is used on a page, we create the stylesheet page as a subpage of the template.

'''To create the styleheet:'''

#'''Create''' the stylesheet page:''Template:Box Note/styles.css''
#'''Add''' the styles '''and save''' the page:
<syntaxhighlight lang="html">
/* Box Note*/
.infobox {
padding: 1em;
margin: 2em 0;
border:1px solid #ccc;
}
.infobox p {
padding: 0;
margin: 0;
}
.boxlabel {
font-weight:bold;
padding-right:0.5em;
}
.notification-note {
border-left: solid 4px #3498db;
}
.notification-tip {
border-left: solid 4px #f2c412;
}
.notification-warning {
border-left: solid 4px #c23c2b;
}
</syntaxhighlight>

Now, add the reference to the stylesheet at the top of the template page (''Template:Box Note'') and save the template again:<syntaxhighlight lang="html">
<templatestyles src="Template:Box_Note/styles.css" />
<div class="infobox notification-{{{boxtype}}}">
....
</syntaxhighlight>Your template is now ready to use.

==Using the template==
'''To create a notification box on a page:'''

#'''Select''' ''Insert > Template'' in visual editing mode:[[File:template-insert.png|link=https://en.wiki.bluespice.com/wiki/File:template-insert.png|center]]
#'''Select''' the template ''Box Note'' and click '''Add template''':[[File:template-insert-selecttemplate.png|400x400px|link=https://en.wiki.bluespice.com/wiki/File:template-insert-selecttemplate.png|center]]
#'''Enter the name''' for the type of box you want to create, for example ''note'':[[File:template-insert-type.png|400x400px|center]]
#'''Click''' ''Add more information''
#'''Click''' ''Note text'' and enter the text for your notification box:[[File:template-insert-text.png|link=https://en.wiki.bluespice.com/wiki/File:template-insert-text.png|400x400px|center]]
#'''Click''' ''Insert''. The notification box is now included on your page:[[File:boxnote-output-note.png|alt=Screenshot: output for notification box|center|450x450px]]<br />

Save the page if you have no further edits to make.

To later edit the notification in visual editing mode, simply double-click the notification and the template dialog window opens.

[[en:{{FULLPAGENAME}}]]
[[UserManual:De:Vorlagen/Beispiel/Infobox]]

← Older revision		Revision as of 14:30, 28 July 2020
Line 1:		Line 1:
		+	<bookshelf src="Book:User manual" />
	{{DISPLAYTITLE:Notification Box}}		{{DISPLAYTITLE:Notification Box}}

← Older revision		Revision as of 10:12, 18 December 2019
Line 1:		Line 1:
−	~~<bookshelf src="Book:User manual" />~~
	{{DISPLAYTITLE:Notification Box}}		{{DISPLAYTITLE:Notification Box}}

← Older revision		Revision as of 14:57, 13 December 2019
Line 1:		Line 1:
		+	<bookshelf src="Book:User manual" />
	{{DISPLAYTITLE:Notification Box}}		{{DISPLAYTITLE:Notification Box}}

@@ Line 1: / Line 1: @@
 <bookshelf src="Book:User manual" />
 {{DISPLAYTITLE:Notification Box}}
+{{Manual:Template/Example/Notification_Box}}

@@ Line 17: / Line 17: @@
 <span class="boxlabel">
 {{#switch: {{{boxtype}}}
-  | note = Note:
+  | note = Hinweis:
-  | tip = Tip:
+  | tip = Tipp:
-  | warning = Warning:
+  | warning = Achtung:
-  | #default = Note:
+ | example = Beispiel:
 }}
-</span>
+</span>{{{Note text}}}
 </div>
 </syntaxhighlight>What this code does:
@@ Line 40: / Line 42: @@
   | tip = Tip:
   | warning = Warning:
   | #default = Note:
 }}
-</span>
+</span>{{{Note text}}}
 </div>
@@ Line 51: / Line 55: @@
 	"params": {
 		"boxtype": {
-			"description": "Possible values: note, tip, warning",
+			"description": "Possible values: note, tip, warning,example, important, backgroundbox",
 			"example": "note",
 			"type": "string",
@@ Line 59: / Line 63: @@
 		"Note text": {}
 	},
-	"description": "To add standard infoboxes such as notes or related links to a page"
+	"description": "To add standard info boxes such as notes or warnings to a page"
+}
 </templatedata>
@@ Line 107: / Line 111: @@
 .notification-warning {
 border-left: solid 4px #c23c2b;
+}
 </syntaxhighlight>
 Now, add the reference to the stylesheet at the top of the template page (''Template:Box Note'') and save the template again:<syntaxhighlight lang="html">
@@ Line 134: / Line 143: @@
 [[en:{{FULLPAGENAME}}]]
-[[UserManual:De:Vorlagen/Beispiel/Infobox]]
+[[de:Vorlagen/Beispiel/Infobox]]