Vorlage:Überarbeiten/Doku: Unterschied zwischen den Versionen

Aus WiiDatabase Wiki
Zur Navigation springenZur Suche springen
K (1 Version)
 
Keine Bearbeitungszusammenfassung
 
(Eine dazwischenliegende Version desselben Benutzers wird nicht angezeigt)
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>

Aktuelle Version vom 10. Juli 2018, 11:26 Uhr

Dokumentations-Unterseite Diese Seite ist die Dokumentations-Unterseite der Vorlage:Überarbeiten.
TemplateData
Blendet eine Box ein: „Dieser Artikel oder Abschnitt bedarf einer Überarbeitung“

Vorlagenparameter

ParameterBeschreibungTypStatus
Diskussionsseite1
„Näheres ist auf der <Parameterwert> angegeben“
Standard
Diskussionsseite zu diesem Artikel
Beispiel
[[Diskussion:XY|Diskussionsseite zum Artikel XY]]
Seitennamevorgeschlagen
Beanstandeter Bereich2
Umfang des problematischen Inhalts
Standard
Dieser Artikel oder Abschnitt
Beispiel
Die folgende Tabelle
Einzeiliger Textvorgeschlagen
Grundgrund
Grund für die Beanstandung. Wenn der Parameter angegeben wird, wird kein Link auf die Diskussionsseite erzeugt und Parameter 1 ignoriert.
Beispiel
Einleitung ist zu weitschweifig
Einzeiliger Textvorgeschlagen

Format: inline

Grundsätzlicher Aufbau

Der Text innerhalb der Box besteht aus folgenden Elementen:

  • Kurzbeschreibung: Warum ist der Baustein gesetzt? – Standard: Dieser Artikel oder Abschnitt bedarf einer Überarbeitung.
  • Link zur genauen Problembeschreibung. – Standard: Näheres ist auf der Diskussionsseite angegeben.
  • Ermunterung, mitzuhelfen. – immer: Hilf mit, ihn zu verbessern, und entferne anschließend diese Markierung.

Beispiele

Folgende Beispiele sind für den fiktiven Artikel „Artikelname“ erstellt. Alle in den Kopiervorlagen enthaltenen kursiven Passagen sind entsprechend anzupassen/zu ersetzen.

  • Normalfall (ohne Parameter)
    {{Überarbeiten}}
    ergäbe den obigen Standardfall (ein Diskussionshinweis fehlt automatisch, wenn keine Diskussionsseite vorhanden ist)
  • Mit Option {{{1}}}
    • a)
      {{Überarbeiten|[[Diskussion:Artikelname#Überschrift des Abschnitts auf der Diskussionsseite|Diskussionsseite]]}} oder {{Überarbeiten|1=[[...]]}}
      oder präziser (mittels seitenabhängiger Variable)
      {{Überarbeiten|Diskussionsseite, unter „[[{{DISKUSSIONSSEITE}}#Überschrift des Abschnitts auf der Diskussionsseite|Überschrift des Abschnitts auf der Diskussionsseite]]“,}}
      ergäben:
Dieser Artikel oder Abschnitt bedarf einer Überarbeitung. Näheres ist auf der Diskussionsseite angegeben. Hilf mit, ihn zu verbessern, und entferne anschließend diese Markierung.
oder
Dieser Artikel oder Abschnitt bedarf einer Überarbeitung. Näheres ist auf der Diskussionsseite, unter „Überschrift des Abschnitts auf der Diskussionsseite“, angegeben. Hilf mit, ihn zu verbessern, und entferne anschließend diese Markierung.
  • b)
    Alternative Formulierung für eine andere Diskussionsseite
    {{Überarbeiten|Diskussionsseite „[[Diskussion:Artikelname2#Überschrift des Abschnitts auf der Diskussionsseite von Artikel2|Artikelname2]]“}}
    ergäbe:
Dieser Artikel oder Abschnitt bedarf einer Überarbeitung. Näheres ist auf der Diskussionsseite „Artikelname2“ angegeben. Hilf mit, ihn zu verbessern, und entferne anschließend diese Markierung.
  • Mit Option {{{2}}}
    • {{Überarbeiten||Dieser Abschnitt}}
      oder
      {{Überarbeiten|2=Dieser Abschnitt}}
      ergäben:
Dieser Abschnitt bedarf einer Überarbeitung. Hilf mit, ihn zu verbessern, und entferne anschließend diese Markierung.
  • Mit Option {{{1}}} und {{{2}}}
    • {{Überarbeiten|[[Diskussion:Artikelname#Überschrift des Abschnitts auf der Diskussionsseite|Diskussionsseite]]|Der folgende Absatz}}
      oder
      {{Überarbeiten|2=Der folgende Absatz|1=[[Diskussion:Artikelname#Überschrift des Abschnitts auf der Diskussionsseite|Diskussionsseite]]}}
      oder
      {{Überarbeiten|1=[[Diskussion:Artikelname#Überschrift des Abschnitts auf der Diskussionsseite|Diskussionsseite]]|2=Der folgende Absatz}}
      ergäben:
Der folgende Absatz bedarf einer Überarbeitung. Näheres ist auf der Diskussionsseite angegeben. Hilf mit, ihn zu verbessern, und entferne anschließend diese Markierung.

Vorsicht

  • Senkrechte Striche „|“ innerhalb von Vorlagen-Parametern müssen häufig durch „{{!}}“ ersetzt werden. Als Trenner innerhalb von Wikilinks sind sie aber unproblematisch.
  • Parameter, die „=“ enthalten, müssen grundsätzlich mit „1=“ bzw. „2=“ und so weiter beginnen.
Abgerufen von „https://wiki.wiidatabase.de/index.php?title=Vorlage:Überarbeiten/Doku&oldid=6435“