Vorlage:Überarbeiten/Doku: Unterschied zwischen den Versionen

keine Bearbeitungszusammenfassung
K (2 Versionen: Transfer)
Keine Bearbeitungszusammenfassung
 
Zeile 1: Zeile 1:
<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
=== Grundsätzlicher Aufbau ===
{{templateData|JSON=
{ "description": "Blendet eine Box ein: „Dieser Artikel oder Abschnitt bedarf einer Überarbeitung“",
"params": {
"1": {
"label": "Diskussionsseite",
"description": "„Näheres ist auf der <Parameterwert> angegeben“",
"type":        "wiki-page-name",
"suggested":  true,
"default":    "Diskussionsseite zu diesem Artikel",
"example":    "[[Diskussion:XY|Diskussionsseite zum Artikel XY]]"
},
"2": {
"label":      "Beanstandeter Bereich",
"description": "Umfang des problematischen Inhalts",
"type":        "line",
"suggested":  true,
"default":    "Dieser Artikel oder Abschnitt",
"example":    "Die folgende Tabelle"
},
"grund": {
"label": "Grund",
"description": "Grund für die Beanstandung. Wenn der Parameter angegeben wird, wird kein Link auf die Diskussionsseite erzeugt und Parameter 1 ignoriert.",
"type": "line",
"suggested": true,
"example": "Einleitung ist zu weitschweifig"
}
},
"format": "inline"
}
|TOC=1}}
 
== Grundsätzlicher Aufbau ==
Der Text innerhalb der Box besteht aus folgenden Elementen:
Der Text innerhalb der Box besteht aus folgenden Elementen:
* Kurzbeschreibung: Warum ist der Baustein gesetzt? – ''Standard:'' Dieser Artikel oder Abschnitt bedarf einer Überarbeitung.
* Kurzbeschreibung: Warum ist der Baustein gesetzt? – ''Standard:'' Dieser Artikel oder Abschnitt bedarf einer Überarbeitung.
Zeile 6: Zeile 37:
* Ermunterung, mitzuhelfen. – ''immer:'' Hilf mit, ihn zu verbessern, und entferne anschließend diese Markierung.
* Ermunterung, mitzuhelfen. – ''immer:'' Hilf mit, ihn zu verbessern, und entferne anschließend diese Markierung.


=== Parameter ===
== Beispiele ==
Es existieren mehrere Parameter, mit denen der Text präzisiert werden kann:
Folgende Beispiele sind für den fiktiven Artikel „<code>[[Artikelname]]</code>“ erstellt. Alle in den Kopiervorlagen enthaltenen ''kursiven'' Passagen sind entsprechend anzupassen/zu ersetzen.
 
==== Parameter 1 ====
<code><nowiki>{{{1}}}</nowiki></code> – Anstelle von „<code>Näheres ist auf der [[Vorlage Diskussion:Überarbeiten|Diskussionsseite]] angegeben</code>“ kann ein bestimmter Abschnitt der Diskussionsseite (auch auf einer anderen Diskussionsseite) verlinkt werden. Eingefügt wird bei Angabe des Parameterwertes: „<code>Näheres ist auf der <Parameterwert> angegeben</code>“
 
==== Parameter 2 ====
<code><nowiki>{{{2}}}</nowiki></code> – Anstelle von „<code>Dieser Artikel oder Abschnitt</code>“ kann der Umfang des problematischen Inhalts genauer angegeben werden. Beispielsweise:
* „<code>Dieser Artikel</code>“
* „<code>Dieser Abschnitt</code>“
* „<code>Dieser Absatz</code>“
* oder auch „<code>Die folgende Tabelle</code>“
 
==== Parameter „grund“ ====
<code>grund=</code>: Es kann ein Grund für die Überarbeitung angegeben werden. Wenn der Parameter angegeben wird, wird kein Link auf die Diskussionsseite erzeugt und Parameter 1 ignoriert.
Beispiel:
:<code><nowiki>{{Überarbeiten|grund=Einleitung ist zu weitschweifig.|2=Dieser Abschnitt}}</nowiki></code>
liefert:
{{Überarbeiten|grund=Einleitung ist zu weitschweifig.|2=Dieser Abschnitt}}
 
=== Beispiele ===
Folgende Beispiele sind für den fiktiven Artikel ''„<code>[[Artikelname]]</code>“'' erstellt. Alle in den Kopiervorlagen enthaltenen ''kursiven'' Passagen sind entsprechend anzupassen/zu ersetzen.
* '''Normalfall''' (ohne Parameter)
* '''Normalfall''' (ohne Parameter)
:<code>&#x7B;&#x7B;'''Überarbeiten'''<nowiki>}}</nowiki></code><br />ergäbe den obigen Standardfall '''(ein Diskussionshinweis fehlt automatisch, wenn keine Diskussionsseite vorhanden ist)'''
*:<code>&#x7B;&#x7B;'''Überarbeiten'''<nowiki>}}</nowiki></code><br />ergäbe den obigen Standardfall '''(ein Diskussionshinweis fehlt automatisch, wenn keine Diskussionsseite vorhanden ist)'''
 
* '''Mit Option <code><nowiki>{{{1}}}</nowiki></code>'''
* '''Mit Option <code><nowiki>{{{1}}}</nowiki></code>'''
** '''a)'''<br /><code>&#x7B;&#x7B;'''Überarbeiten'''<nowiki>|[[Diskussion:</nowiki>''Artikelname''<nowiki>#</nowiki>''Überschrift des Abschnitts auf der Diskussionsseite''<nowiki>|Diskussionsseite]]}}</nowiki></code> oder <code>&#x7B;&#x7B;'''Überarbeiten|1='''<nowiki>[[...]]}}</nowiki></code><br />oder präziser (mittels seitenabhängiger Variable)<br /><code>&#x7B;&#x7B;'''Überarbeiten'''<nowiki>|Diskussionsseite, unter „[[{{DISKUSSIONSSEITE}}</nowiki>''#Überschrift des Abschnitts auf der Diskussionsseite|Überschrift des Abschnitts auf der Diskussionsseite''<nowiki>]]“,}}</nowiki></code><br />ergäben:<br />{{Überarbeiten|[[Diskussion:Artikelname#Überschrift des Abschnitts auf der Diskussionsseite|Diskussionsseite]]}}
** '''a)'''<br /><code>&#x7B;&#x7B;'''Überarbeiten'''<nowiki>|[[Diskussion:</nowiki>''Artikelname''<nowiki>#</nowiki>''Überschrift des Abschnitts auf der Diskussionsseite''<nowiki>|Diskussionsseite]]}}</nowiki></code> oder <code>&#x7B;&#x7B;'''Überarbeiten|1='''<nowiki>[[...]]}}</nowiki></code><br />oder präziser (mittels seitenabhängiger [[WP:VAR|Variable]])<br /><code>&#x7B;&#x7B;'''Überarbeiten'''<nowiki>|Diskussionsseite, unter „[[{{DISKUSSIONSSEITE}}</nowiki>''#Überschrift des Abschnitts auf der Diskussionsseite|Überschrift des Abschnitts auf der Diskussionsseite''<nowiki>]]“,}}</nowiki></code><br />ergäben:<br />{{Überarbeiten|[[Diskussion:Artikelname#Überschrift des Abschnitts auf der Diskussionsseite|Diskussionsseite]]}}
:oder
::oder
{{Überarbeiten|Diskussionsseite, unter „[[{{DISKUSSIONSSEITE}}#Überschrift des Abschnitts auf der Diskussionsseite|Überschrift des Abschnitts auf der Diskussionsseite]]“,}}
{{Überarbeiten|Diskussionsseite, unter „[[{{DISKUSSIONSSEITE}}#Überschrift des Abschnitts auf der Diskussionsseite|Überschrift des Abschnitts auf der Diskussionsseite]]“,}}
:* '''b)'''<br />Alternative Formulierung für eine andere Diskussionsseite<br /><code>&#x7B;&#x7B;'''Überarbeiten'''<nowiki>|Diskussionsseite „[[Diskussion:</nowiki>''Artikelname2''<nowiki>#</nowiki>''Überschrift des Abschnitts auf der Diskussionsseite von Artikel2''|''Artikelname2''<nowiki>]]“}}</nowiki></code><br />ergäbe:
:* '''b)'''<br />Alternative Formulierung für eine andere Diskussionsseite<br /><code>&#x7B;&#x7B;'''Überarbeiten'''<nowiki>|Diskussionsseite „[[Diskussion:</nowiki>''Artikelname2''<nowiki>#</nowiki>''Überschrift des Abschnitts auf der Diskussionsseite von Artikel2''|''Artikelname2''<nowiki>]]“}}</nowiki></code><br />ergäbe:
Zeile 40: Zeile 50:
** <code>&#x7B;&#x7B;'''Überarbeiten'''<nowiki>||Dieser Abschnitt}}</nowiki></code><br />oder<br /><code>&#x7B;&#x7B;'''Überarbeiten|2='''Dieser Abschnitt<nowiki>}}</nowiki></code><br />ergäben:
** <code>&#x7B;&#x7B;'''Überarbeiten'''<nowiki>||Dieser Abschnitt}}</nowiki></code><br />oder<br /><code>&#x7B;&#x7B;'''Überarbeiten|2='''Dieser Abschnitt<nowiki>}}</nowiki></code><br />ergäben:
{{Überarbeiten||Dieser Abschnitt}}
{{Überarbeiten||Dieser Abschnitt}}
* '''Mit Option <code><nowiki>{{{1}}}</nowiki></code> und <code><nowiki>{{{2}}}</nowiki></code>'''
* '''Mit Option <code><nowiki>{{{1}}}</nowiki></code> und <code><nowiki>{{{2}}}</nowiki></code>'''
** <code>&#x7B;&#x7B;'''Überarbeiten'''<nowiki>|[[Diskussion:</nowiki>''Artikelname''<nowiki>#</nowiki>''Überschrift des Abschnitts auf der Diskussionsseite''<nowiki>|Diskussionsseite]]|Der folgende Absatz}}</nowiki></code><br />oder<br /><code>&#x7B;&#x7B;'''Überarbeiten'''<nowiki>|2=Der folgende Absatz|1=[[Diskussion:</nowiki>''Artikelname''<nowiki>#</nowiki>''Überschrift des Abschnitts auf der Diskussionsseite''<nowiki>|Diskussionsseite]]}}</nowiki></code><br />oder<br /><code>&#x7B;&#x7B;'''Überarbeiten'''<nowiki>|1=[[Diskussion:</nowiki>''Artikelname''<nowiki>#</nowiki>''Überschrift des Abschnitts auf der Diskussionsseite''<nowiki>|Diskussionsseite]]|2=Der folgende Absatz}}</nowiki></code><br />ergäben:
** <code>&#x7B;&#x7B;'''Überarbeiten'''<nowiki>|[[Diskussion:</nowiki>''Artikelname''<nowiki>#</nowiki>''Überschrift des Abschnitts auf der Diskussionsseite''<nowiki>|Diskussionsseite]]|Der folgende Absatz}}</nowiki></code><br />oder<br /><code>&#x7B;&#x7B;'''Überarbeiten'''<nowiki>|2=Der folgende Absatz|1=[[Diskussion:</nowiki>''Artikelname''<nowiki>#</nowiki>''Überschrift des Abschnitts auf der Diskussionsseite''<nowiki>|Diskussionsseite]]}}</nowiki></code><br />oder<br /><code>&#x7B;&#x7B;'''Überarbeiten'''<nowiki>|1=[[Diskussion:</nowiki>''Artikelname''<nowiki>#</nowiki>''Überschrift des Abschnitts auf der Diskussionsseite''<nowiki>|Diskussionsseite]]|2=Der folgende Absatz}}</nowiki></code><br />ergäben:
{{Überarbeiten|[[Diskussion:Artikelname#Überschrift des Abschnitts auf der Diskussionsseite|Diskussionsseite]]|Der folgende Absatz}}
{{Überarbeiten|[[Diskussion:Artikelname#Überschrift des Abschnitts auf der Diskussionsseite|Diskussionsseite]]|Der folgende Absatz}}


=== Vorsicht ===
== Vorsicht ==
* Senkrechte Striche „<code>'''|'''</code>“ ''innerhalb von Vorlagen-Parametern'' müssen häufig durch „<code><nowiki>{{!}}</nowiki></code>“ ersetzt werden. Als Trenner innerhalb von Wikilinks sind sie aber unproblematisch.
* Senkrechte Striche „<code>'''|'''</code>“ ''innerhalb von Vorlagen-Parametern'' müssen häufig durch „<code><nowiki>{{!}}</nowiki></code>“ ersetzt werden. Als Trenner innerhalb von Wikilinks sind sie aber unproblematisch.
* Parameter die „<code>'''='''</code>“ enthalten müssen grundsätzlich mit „<code>'''1='''</code>“ bzw. „<code>'''2='''</code>“ und so weiter beginnen.
* Parameter, die „<code>'''='''</code>“ enthalten, müssen grundsätzlich mit „<code>'''1='''</code>“ bzw. „<code>'''2='''</code>“ und so weiter beginnen.
<includeonly>
[[Kategorie:Vorlage:vom Druck ausgeschlossen]]
[[Kategorie:Vorlage:Wartungsbaustein]]
</includeonly>