Vorlage:Tmbox/Doku: Unterschied zwischen den Versionen

K
88 Versionen von wikivoyage:Vorlage:Tmbox/Doku importiert
imported>Davidgothberg
(→‎Technical details: Added more documentation.)
K (88 Versionen von wikivoyage:Vorlage:Tmbox/Doku importiert)
 
(78 dazwischenliegende Versionen von 37 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
{{Documentation subpage}}
{{Dokumentation Unterseite}}
{{High-use}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{mbox templates}}
This is the {{tl|tmbox}}, or '''talk page message box''', meta-template. This template is called by other templates to give a consistent structure and appearance to boilerplate messages used on talk pages across the project.  It ''may'' be called directly on a talk page in order to present a one-off message in the same format as boilerplate messages, but this is non-standard (if a message is important enough to be presented in this form, you should consider creating a separate template so that it is easily available to other editors). Tmbox offers several different colors for different purposes, provides default images if no image parameter is given, and has some other pleasant features. This template works similarly to {{tl|ambox}} and uses the same parameters.


This is the {{tl|tmbox}} or '''talk page message box''' meta-template.
This template should not be used for WikiProject banners. Such banners have special programming constraints that merit their own meta-templates. See the "Siehe auch" section below for links.


It is used to build message box templates for talk pages.
=== Vorgeschlagene Stilstandards ===


This template works similarly to {{tl|ambox}} and uses the same parameters.
The types of talkpage messageboxes follow the same naming convention as the boxes for all other namespaces, but the type of any particular talkpage messagebox may not be as obvious as in other namespaces.  When deciding on the type to use for a talkpage messagebox, please consider the following guidelines:
* '''speedy''' should ''only'' be used for [[:Category:Speedy deletion templates|speedy deletion templates]].
* '''delete''' should ''only'' be used for templates relating to ''ongoing'' deletion discussions.  Please do ''not'' use this type just to get a red border for a messagebox.
* '''content''' and '''style''' should be used for warnings and alerts.  Use '''content''' (which has an orange border) for more important and immediate alerts, and '''style''' (yellow border) for less important warnings.  Messageboxes of these types should ideally be ''transitory'': they should not be expected to remain on a talkpage indefinitely. 
* '''move''' and '''protection''' should only be used for messageboxes relating to moves and merges, and page protection, respectively.
* The '''notice''' type should be used for the majority of talkpage messageboxes; those that are intended to convey or summarise information.  If a talkpage messagebox does not obviously fit into one of the other types, it is probably a notice type.


=== Suggested style standard ===
=== Benutzung ===


The styles of talk page message boxes and the usage of this template is currently being standardised and discussed on the [[Template talk:Tmbox|talk page]] of this template. Thus <u>don't use this meta-template for real message boxes yet</u>, but feel free to use it for testing. Discussions that lead to the creation of this template is available at the [[Template talk:Imbox#Other spaces message boxes|talk page]] of imbox.
Simple usage example:
 
<pre>
{{tmbox | text = Some text.}}
</pre>
 
{{tmbox | text = Some text.}}
 
Complex example:
 
<pre>
{{tmbox
| type      = style
| image    = [[Image:Emblem-question-yellow.svg|40px]]
| style    = width: 400px;
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body text.
}}
</pre>
 
{{tmbox
| type      = style
| image    = [[Image:Emblem-question-yellow.svg|40px]]
| style    = width: 400px;
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body text.
}}


=== Talk page message box types ===
=== Talk page message box types ===


These are the colours and styles that this meta-template currently produces. When this template is used to build actual message boxes they should contain the same (long) texts as before, with links to explanations and they can use more specific images than the default images shown here.
The following examples use different '''type''' parameters but use no image parameters thus they use the default images for each type.
 
Note that the vast majority of talk page message boxes are expected to use the "notice" type and thus will look like before.


{{tmbox
{{tmbox
Zeile 47: Zeile 79:
}}
}}


Alternative suggestions for these styles might be available at the {{tl|tmbox/sandbox}}. To discuss these boxes and to see or make other examples go to the [[Template talk:Ombox|talk page]].
=== Spezial ===


=== Usage ===
Some other parameter combinations.


Simple usage example:
<pre>
{{tmbox | text = Some text.}}
</pre>
{{tmbox | text = Some text.}}
Complex example:
<pre>
{{tmbox
{{tmbox
| type     = style
| text  = No type and no image given ('''default''')
| image     = [[Image:Emblem-question-yellow.svg|40px]]
}}
| style    = width: 400px;
{{tmbox
| textstyle = color: red; font-weight: bold; font-style: italic;
| image = none
| text     = The message body text.
| text  = No type and '''image=none''' – No image is used and the '''text''' uses the whole message box area.
}}
}}
</pre>
{{tmbox
{{tmbox
| type      = style
| image = [[Image:Gnome globe current event.svg|42px]]
| image    = [[Image:Emblem-question-yellow.svg|40px]]
| imageright = [[Image:Nuvola apps bookcase.svg|40px]]
| style    = width: 400px;
| text  = image = <nowiki>[[Image:Gnome globe current event.svg|42px]]</nowiki> <br> imageright = <nowiki>[[Image:Nuvola apps bookcase.svg|40px]]</nowiki>
| textstyle = color: red; font-weight: bold; font-style: italic;
| text      = The message body text.
}}
}}


=== Parameters ===
=== Parameter ===


List of all parameters:
Liste aller Parameter:


<pre>
<pre>
Zeile 89: Zeile 105:
| image = none / [[Image:Some image.svg|40px]]
| image = none / [[Image:Some image.svg|40px]]
| imageright = [[Image:Some image.svg|40px]]
| imageright = [[Image:Some image.svg|40px]]
| style = CSS value
| style = CSS values
| textstyle = CSS value
| textstyle = CSS values
| text  = The message body text.  
| text  = The message body text.  
| small = {{{small|}}} / yes
| smallimage = none / [[Image:Some image.svg|30px]]
| smallimageright = none / [[Image:Some image.svg|30px]]
| smalltext  = A shorter message body text.
}}
}}
</pre>
</pre>


'''type'''
'''type'''
:If no '''type''' parameter is given the template defaults to type '''notice'''. That means it gets a gray border.
: If no '''type''' parameter is given the template defaults to type '''notice'''. That means it gets a gray border.


'''image'''
'''image'''
:'''No parameter''' = If no '''image''' parameter is given the template uses a default image. Which default image it uses depends on the '''type''' parameter.  
: '''No parameter''' = If no '''image''' parameter is given the template uses a default image. Which default image it uses depends on the '''type''' parameter.  
:'''An image''' = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) For example:  
: '''An image''' = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) For example:  
::<code><nowiki>image = [[Image:Crystal package settings.png|40px]]</nowiki></code>
:: <code><nowiki>image = [[Image:Crystal package settings.png|40px]]</nowiki></code>
:'''none''' = Means that no image is used.
: '''none''' = Means that no image is used.


'''imageright'''
'''imageright'''
:'''No parameter''' = If no '''imageright''' parameter is given then no image is shown on the right side.
: '''No parameter''' = If no '''imageright''' parameter is given then no image is shown on the right side.
:'''An image''' = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) For example:  
: '''An image''' = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) For example:  
::<code><nowiki>imageright = [[Image:Nuvola apps bookcase.png|40px]]</nowiki></code>
:: <code><nowiki>imageright = [[Image:Nuvola apps bookcase.png|40px]]</nowiki></code>
:'''Anything''' = Any other object that you want to show on the right side.
: '''Anything''' = Any other object that you want to show on the right side.
 
'''small'''
: '''yes''' = Makes it a smaller right floating message box. This also makes the default images smaller.
: For more information read the chapter below.


'''style'''
'''style'''
:An optional [[Cascading Style Sheets|CSS]] value used by the entire message box table. Without quotation marks <code>" "</code>. For example:
: Optional [[Cascading Style Sheets|CSS]] values used by the entire message box table. Without quotation marks <code>" "</code> but with the ending semicolons <code>;</code>. For example:
::<code>style = margin-bottom: 0.5em;</code>
:: <code>style = margin-bottom: 0.5em;</code>


'''textstyle'''
'''textstyle'''
:An optional [[Cascading Style Sheets|CSS]] value used by the text cell. For example:
: Optional [[Cascading Style Sheets|CSS]] values used by the text cell. For example:
::<code>textstyle = text-align: center;</code>
:: <code>textstyle = text-align: center;</code>


'''text'''
'''text'''
:The message body text.
: The message body text.


=== Technical details ===
==== Parameter für die Ausgabe einer verkleinerten Box ====


This template currently uses hard coded styles. Later it will use CSS classes enabling it to be skinned.
{{tmbox
| small = yes
| text = small = yes
}}
{{tmbox
| type = style
| small = yes
| text = type = style <br> small = yes
}}
'''small'''
: '''yes''' = Makes it a smaller right floating message box. This also makes the default images smaller. Note that any data fed to the '''smallimage''', '''smallimageright''' and '''smalltext''' parameters is only used if "small=yes". To make it so your template also understands the small parameter you can use this code:
:: <code><nowiki>small = {{{small|}}}</nowiki></code>
 
{{tmbox
| small = yes
| image      = [[Image:Nuvola apps bookcase.svg|40px]]
| smallimage = [[Image:Nuvola apps bookcase.svg|30px]]
| text =
small = yes <br> image = <nowiki>[[Image:Nuvola apps bookcase.svg|40px]]</nowiki> <br> smallimage = <nowiki>[[Image:Nuvola apps bookcase.png|30px]]</nowiki>
}}
'''smallimage'''
: '''No parameter''' = If no '''smallimage''' parameter is given then this template falls back to use the '''image''' parameter. If the '''image''' parameter also is empty then a small default image is used.
: '''An image''' = Should be an image with usual wiki notation. 30px width is usually about right. For example:
:: <code><nowiki>smallimage = [[Image:Crystal package settings.png|30px]]</nowiki></code>
: '''none''' = Means that no image is used. This overrides any image fed to '''image''', when "small=yes".
 
{{tmbox
| small = yes
| imageright = [[Image:Nuvola apps bookcase.svg|40px]]
| text =
small = yes <br> imageright = <nowiki>[[Image:Nuvola apps bookcase.svg|40px]]</nowiki>
}}
{{tmbox
| small = yes
| imageright = [[Image:Nuvola apps bookcase.svg|30px]]
| smallimageright = none
| text =
small = yes <br> imageright = <nowiki>[[Image:Nuvola apps bookcase.svg|40px]]</nowiki> <br> smallimageright = none
}}
 
'''smallimageright'''
: '''No parameter''' = If no '''smallimageright''' parameter is given then this template falls back to use the '''imageright''' parameter. If the '''imageright''' parameter also is empty then no image is shown on the right side.
: '''An image''' = Should be an image with usual wiki notation. 30px width is usually about right. For example:
:: <code><nowiki>smallimageright = [[Image:Nuvola apps bookcase.png|30px]]</nowiki></code>
: '''Anything''' = Any other object that you want to show on the right side.
: '''none''' = Means that no right side image is used. This overrides any image fed to '''imageright''', when "small=yes".
 
'''smalltext'''
: A shorter version of the message body text. If no '''smalltext''' parameter is given then this template falls back to use the '''text''' parameter.
 
=== Technische Details ===


If you need to use special characters in the text parameter then you need to escape them like this:  
If you need to use special characters in the text parameter then you need to escape them like this:  
Zeile 144: Zeile 218:
</div>
</div>
}}
}}
This template uses the tmbox CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable.
This template calls {{tl|tmbox/core}} which holds most of the code for {{tl|tmbox}}, while {{tl|tmbox}} itself does parameter preprocessing.


Internally this meta-template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta-templates since wiki markup has several drawbacks. For instance it makes it harder to use [[m:Help:ParserFunctions|parser functions]] and special characters in parameters.  
Internally this meta-template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta-templates since wiki markup has several drawbacks. For instance it makes it harder to use [[m:Help:ParserFunctions|parser functions]] and special characters in parameters.  
Zeile 149: Zeile 227:
For more technical details see the [[Template talk:Tmbox|talk page]]. Since this template works almost exactly like {{tl|ambox}}, {{tl|imbox}}, {{tl|cmbox}} and {{tl|ombox}} their talk pages and related pages might also contain more details.
For more technical details see the [[Template talk:Tmbox|talk page]]. Since this template works almost exactly like {{tl|ambox}}, {{tl|imbox}}, {{tl|cmbox}} and {{tl|ombox}} their talk pages and related pages might also contain more details.


=== See also ===
=== Siehe auch ===
 
Ähnliche Vorlagen:
* {{tl|Notice}}
{{Mbox templates see also}}


There are several meta-templates in the mbox family:
Andere Seiten:
* {{tl|ambox}} – For article message boxes.
* [[w:en:Wikipedia:Talk page templates|Talk page templates]] Eine Richtlinie der englischen Wikipedia zum Design von Benachrichtigungsboxen für Diskussionsseiten.
* {{tl|tmbox}} – For talk page message boxes.
* {{tl|imbox}} – For image page message boxes.
* {{tl|cmbox}} For category message boxes.
* {{tl|ombox}} – For other pages message boxes.
* {{tl|mbox}} – Has namespace detection, for message boxes that are used on several types of pages and thus need to change style depending on what page they are used on.


Other pages:
<!--WikiProject banners:
* [[Wikipedia:Talk page templates]] The guideline specifying the styles for talk page message boxes.
* {{tl|WikiProjectBannerShell}} and {{tl|WPBannerMeta}} – A system for collapsing, wrapping and creating WikiProject banners.
* {{tl|WikiProjectBanners}} Another system for collapsing WikiProject banners.-->
{{mbox template family}}


<includeonly>
<includeonly>[[Kategorie:Vorlagen:Infoboxen]]</includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Wikipedia metatemplates|{{PAGENAME}}]]
[[hsb:Předłoha:Tmbox]]
</includeonly>