Vorlage Diskussion:Dokumentation

Kritik an der grafischen Gestaltung der Vorlage

Auf die Gefahr hin, den Autoren dieser zweifellos sinnvollen Vorlage auf die Füße zu treten, möchte ich hier doch eine Reihe ganz konkreter Mängel benennen.

1. Warum eine graue Rahmenlinie? Die Seite hat doch selbst schon eine graue Rahmenlinie. Warum noch ein Kasten um alles?
2. Warum ein (schmutzig)weißer Hintergrund? Artikel sind weiß. Warum jetzt auch Vorlagen?
3. Warum werden die Bearbeiten-Links ausgeblendet? Sie würden problemlos funktionieren.
4. Warum wird der Bearbeiten-Link für die Dokumentationsseite nicht hinter der Überschrift „Dokumentation“ eingeblendet, wie alle anderen Bearbeiten-Links auch?
5. Warum blendet die Vorlage die ganzen Informationskästen oberhalb der Dokumentation ein? Im Extremfall sind das vier Stück (Wartung, XML, Test und der obligatorische Kasten mit dem Hinweis auf /Doku und /Meta), zusätzliche Informationskästen von der Dokumentationsseite noch gar nicht mitgezählt (Tausendfach verwendet usw.). Die eigentliche Dokumentation ist dann kaum noch lesbar. Anders gefragt: Warum werden Wartung, XML und Test höher gewichtet als die Dokumentation?
6. Warum ist es wichtig zu erfahren, woher „die Dokumentation eingebunden wird“, bevor man sie überhaupt gelesen hat? Anders gefragt: Warum wird der Hinweis auf die Auslagerung und Bearbeitung der Dokumentation höher gewichtet als die Dokumentation selbst?

Damit man mir nicht vorwerfen kann, dass ich nur meckern würde, im Folgenden noch ein Beispiel für eine mögliche alternative Umsetzung. --TM 22:52, 19. Feb. 2008 (CET)

Antworten:

1. Damit man erkennt, von wo bis wo etwas eingebunden wird.
2. Ist weg, war ein Designschnitzer.
3. Nein, sie werden erst mit den neuen Parser funktionieren.
4. Wär ein Duplikat zu Link darunter.
5. Damit man sie bemerkt.
6. Damit man, wenn man oben einen Tippo entdeckt, nicht verwirrt ist, was für ein Quelltext erscheint, wenn man auf Bearbeiten klickt.

--Revolus Echo der Stille 01:39, 20. Feb. 2008 (CET)

was ich mir noch vorstellen könnte, wäre das alle Informationen in einem Kasten gebündelt werden. -- visi-on 13:56, 21. Feb. 2008 (CET)

Klingt gut. So war es ja auch meine erste Idee ;-) Die weiße Box ist nur ein Relikt davon. --Revolus Echo der Stille 16:09, 21. Feb. 2008 (CET)

Ich habe mein Beispiel (siehe ganz unten) einmal entsprechend angepasst. In dieser kompakten (!) Form würde ich auch akzeptieren, dass der Kasten oberhalb der Dokumentation steht. Die Linkbeschriftungen habe ich absichtlich so gewählt („von einer Unterseite eingebunden“ etc.), damit die anklickbaren Flächen möglichst groß sind. Ich bin immer noch der Meinung, dass man auf den Rahmen drumherum verzichten kann. --TM 10:38, 22. Feb. 2008 (CET)

Ich habs mal fast so umgesetzt. In der Totalen kann man es jetzt zB bei Vorlage:Coordinate sehen. -- visi-on 11:35, 22. Feb. 2008 (CET)

Ich hätte die Wartungsseite an der zweiten Position gelassen, weil das am ehesten das ist, was regelmäßig benötigt wird. Was mir noch nicht gefällt sind die runden Klammern. Am aussagekräftigsten wäre meiner Meinung nach etwas in dieser Art: „Die Metadaten (Kategorien und andere Sprachen) werden von einer Unterseite eingebunden und können dort bearbeitet werden.“ --TM 12:46, 22. Feb. 2008 (CET)

Beispiel vorher

Für diese Vorlage existiert eine Wartungsseite. Eine in der Vorlage definierte Menge von Problemen im Zusammenhang mit den Verwendungen dieser Vorlage (etwa fehlende Einträge oder fehlerhafte Parameter) kann dort einfach lokalisiert werden. Eine genauere Anleitung und Beschreibung des Mechanismus findet sich unter Hilfe:Infoboxen.

Für diese Vorlage existiert eine XML-Beschreibung für den Vorlagenmeister. Fragen zum Zweck und zur Verwendungsweise bitte dort stellen.

Dokumentation

Diese Dokumentation wird aus Vorlage:Infobox Burg/Doku eingebunden. (Bearbeiten)

Hier steht die eigentliche Dokumentation.

Beispiel nachher

Dokumentation

Diese Dokumentation wird von einer Unterseite eingebunden und kann dort bearbeitet werden. Für diese Vorlage existiert eine Wartungsseite zum Auffinden fehlerhafter Verwendungen. Für diese Vorlage existiert eine XML-Beschreibung für den Vorlagenmeister.

Hier steht die eigentliche Dokumentation.

Bild

Ich würde dieses etwas mehrsagende Bild vorschlagen (from en:) -- Perhelion 16:11, 28. Sep. 2010 (CEST)

Nur zu, keine Einwände. Gruß, --Revo Echo der Stille 16:13, 28. Sep. 2010 (CEST)

Zu meinen Änderungen

Ich seh gerade, dass das bereits hier diskutiert wurde: als ich mir die Vorlage anschaute, stieß es mir auf, dass technische Details ("Vorlage von einer Unterseite eingebunden etc.) vor dem kommen, was derjenige, der die Vorlagenseite aufruft, eigentlich wissen will: Die Beschreibung der Vorlage selbst. Ich habe versucht, dieses Problem zu beheben, indem ich die technischen Details mal nach rechts gerückt und etwas kleiner gesetzt habe. Mir ist auch klar, dass manche Vorlagen jetzt erstmal a bisserl seltsam aussehen, würde mir aber wünschen, dass nicht sofort revertiert wird, sondern man vielleicht lieber die Vorlagen behebt, die seltsam aussehen (in einigen Fällen kann man damit auch gleich andere Mängel beheben). --Elian Φ 13:26, 10. Aug. 2008 (CEST)

Das hat etliche Zeilenumbrüche und schlechte Lesbarkeit zur Folge. Finde ich so nicht gut. Warum verschiebst du diese Box (inkl. Icon) nicht einfach ans Ende ? Cäsium137 (D.) 19:53, 10. Aug. 2008 (CEST)

Ich habe das mal umgesetzt. Jetzt gibt es viel weniger Probleme mit den bisherigen Einbindungen und dein Anliegen, die Technik nicht so nach vorne zu puschen, ist auch berücksichtigt. Cäsium137 (D.) 20:18, 10. Aug. 2008 (CEST)

Einbindung selber Doku-Vorlage für mehrere Vorlagen

Hallo,

ich würde gerne die Dokumentationsvorlage in die Vorlagen der Kategorie:Vorlage:Metadaten Einwohnerzahl (Frankreich) einbinden, allerdings dass für alle Vorlagen nur eine einzige Dokumentation mit Metadaten etc. notwendig wird. Ist dies möglich, oder technisch zu aufwendig? Grüße, Patrick, «Disk» «V» 12:07, 23. Okt. 2008 (CEST)

Eine Möglichkeit wäre eine Weiterleitung. Beispiel Vorlage:BB/Meta. Alternativ könnte man auch die Vorlage anpassen, das ein Parameter mit der zentralen Seite mitgegeben wird. halte es aber nicht für nötig, da nicht sofort erkennbar ist, woher es stammt, bei einer Weiterleitung sieht man es ja noch. Außerdem sehe ich (derzeit) keine verwendung im großen Stil, so dass es sich lohnen würde. Der Umherirrende 16:44, 23. Okt. 2008 (CEST)

Verwendung

Hallo. Der untere Link "Verwendung" auf der Dokuseite dieser Vorlage stimmt nicht, denn ein Klick darauf listet dann die Verwendung der Vorlage im Artikelnamensraum auf; also genau gesagt nichts. Wie könnte das eventuell korrigiert werden? Gruß --Tlustulimu 13:27, 7. Jan. 2009 (CET)

Das bezieht sich auf die jeweilige Vorlage, in welche die Vorlage Dokumentation eingebunden wird. Ich habe es mit einer includeonly/noinclude - Kombination gelöst. Cäsium137 (D.) 22:39, 7. Jan. 2009 (CET)

Doku

Hallo. Wo ist denn die Dokumentation dieser Vorlage geblieben? Kann das eventuell mal jemand beheben? Danke und frohes Schaffen weiterhin --Tlustulimu 12:19, 20. Jan. 2009 (CET)

Ich habe sie wieder verfügbar gemacht. Ich weiß aber nicht was mit diesem Edit bezüglich "Rekursionssperre" bezweckt werden sollte. Falls es eine Vorlagenschleife geben sollte, wird dies vom Parser erkannt und eine Fehlermeldung ausgegeben (MediaWiki:parser-template-loop-warning). Der Umherirrende 21:29, 21. Jan. 2009 (CET)

Genau dies war der Fall. Im Moment ist sie aber weg. Cäsium137 (D.) 18:17, 22. Jan. 2009 (CET)

Da hatte sich jemand einen scherz erlaubt, und dadurch hast du vermutlich den Hinweis gesehen. Der Umherirrende 18:57, 22. Jan. 2009 (CET)

Stimmt. Passt zeitlich genau hin. Ok. Cäsium137 (D.) 19:14, 22. Jan. 2009 (CET)

leere neben Vorlagenvorschau

Ich habe mal clear:both durch clear:left ersetzt und das info-icon etwas anders gefloatet. Ich hoffe so passt es überall. -- visi-on 05:04, 11. Jul. 2009 (CEST)

Bei den getätigten Stichproben siehts so wie erwartet aus. -- visi-on 05:08, 11. Jul. 2009 (CEST)

Von der roten Linie …

… bekomme ich Augenkrebs … --Revolus Echo der Stille 23:16, 20. Jul. 2009 (CEST)

schwärzen, bläuen, grauen, transparenten ... ;-)

Was soll die Funktion dieser Linie sein? -- visi-on 23:25, 20. Jul. 2009 (CEST)

Ich auch. Beißt sich in meinen Fall gerade mit dem grün von mehrsprachig. Zudem liest das "Tausendfach verwendet" da unten nun keiner mehr. Merlissimo 23:29, 20. Jul. 2009 (CEST)

Nun verprügelt mich doch nicht gleich so. Sie ist doch nur 4px dick ... Ich möchte auf geeignete Weise die Trennung zw. Vorlagentext und Doku-Unterseite stärker aufzeigen, so wie die rote Linie auf den Bilderseiten mit Commons-Bildern. Soll ich die Farbe ändern (schwarz ist nicht so optimal) ?

Vorschläge:

1.  

   ---

2.  

   ---

3.  

   ---

4.  

   ---

5.  

   ---

6.  

   ---

7.  

   ---

8.  

   ---

Ich habe mal ein dezenteres Blau genommen. Meinungen dazu ? Cäsium137 (D.) 23:48, 20. Jul. 2009 (CEST)

Nimm doch eine der Standard Hintergrundfarben

1.  

   ---

2.  

   ---

3.  

   ---

4.  

   ---

5.  

   ---

6.  

   ---

7.  

   ---

8.  

   ---

9.  

   ---

-- visi-on 00:46, 21. Jul. 2009 (CEST)

Gleich viel schicker :-) --Revolus Echo der Stille 03:26, 21. Jul. 2009 (CEST)

Farbe6 ist also sexy ;-) na dann lassen wir dem radioaktiven Element doch die Freude am Strich -- visi-on 07:42, 21. Jul. 2009 (CEST)

Ich hab mal die Balken vereinheitlicht und für symmetrie gesorgt (top und bottom). left und right margin, dass auch beim Umfliessen der Vorschau zB. Vorlage:Infobox Bahnhof klarer zwischen Doku und Vorlage getrennt wird (siehe Diskussionsbeitrag eins drüber). -- visi-on 08:08, 21. Jul. 2009 (CEST)

Naja, zumindest nicht mehr ganz so schlimm. Nur wenn ich auf monobook umschalte sieht es ganz gut aus. Sinn vom Balken habe ich aber immer noch nicht verstanden - der schwarze Kasten (in monobook dunkelgrau) reichte mir eigentlich. Aber wenn ihr das so wollt …. Merlissimo 09:24, 21. Jul. 2009 (CEST)

Mir hätte es auch gereicht ;-) Welche Skin nutzt du? -- visi-on 11:06, 21. Jul. 2009 (CEST)

Modern. Merlissimo 11:26, 21. Jul. 2009 (CEST)

auch nicht viel anders ... ;-) -- visi-on 12:14, 21. Jul. 2009 (CEST)

Bei einigen Vorlagen hatte ich den Eindruck, dass dieser Übergang optisch unterdrückt ist. Er soll einfach deutlicher hervortreten. Eine Standardfarbe ist eine gute Idee. Da kommen individuelle CSS-Einstellungen nicht zu kurz. Ich habe dem HR-Tag die zusätzliche Klasse "rulerdocumentation" verpasst. Wer will, kann sie jetzt in seiner CSS-Datei mit

 hr.rulerdocumentation {display:none; }

ausblenden. Cäsium137 (D.) 13:36, 21. Jul. 2009 (CEST)

Einbindung an das Ende

Moin, ist es wichtig bzw. besser diese Vorlage am Ende einer Vorlage einzubinden? --xZise 18:37, 9. Jul. 2010 (CEST)

Hallo xZise, sofern die Vorlage auf der Vorlagenseite ausgeblendet wird, spielt es keine Rolle, an welcher Stelle die Vorlage:Dokumentation eingebunden wird. Wird der Vorlagen-Inhalt jedoch angezeigt, so sollte meiner Meinung nach die Vorlage:Dokumentation erst am Ende nach dem Vorlagen-Code eingebunden werden. Generell machst Du also nichts falsch, wenn Du sie stets nach ganz hinten im Code stellst. Gruß --W_I^KImaniac 19:45, 9. Jul. 2010 (CEST)

Okay, weil ich dachte mir so, dass dann der Code optimiert wird (der Parser sieht den include-only Block und ignoriert alles danach). --xZise 11:22, 22. Jul. 2010 (CEST)

Die aktuelle Auswertungsstrategie des Parsers musst Du mit einem der Entwickler besprechen: #mediawiki (vgl. Wikipedia:Chat#Channels). Gruß --W_I^KImaniac 19:26, 25. Jul. 2010 (CEST)

Hallo xZise, es kann mehrere includeonly-, onlyinclude- und noinclude-Blöcke geben. Es werden immer alle ausgewertet/angezeigt, weshalb eh immer der gesamte Quelltext geparst werden muss. Das Wiki-Text-Parsen selbst hat nur einen minimalen Anteil an der Zeitdauer des Compilierprozesses¹, weshalb man sich da keine Gedanken über Optimierungen machen muss. Gruß, --Revo Echo der Stille 19:39, 25. Jul. 2010 (CEST) ¹) verglichen mit Datenbankanfragen, Textersetzungen mittels Regexen und zigfachem Übersetzen von Text→DOM und andersrum …

Bearbeiten/Versionen-Links

Hallo, ich würde mir in der Aufzählung der Unterseiten noch Links zum Bearbeiten und zur History der jeweiligen Seite wünschen (insgesamt also 3 Links ala dem englischen „v d e“). Sinnvollerweise versteckt man sie als class="metadata", wenn ihr wollt aber auch gerne offen. Ich hätte es ja auch selbst eingebaut, aber wegen der Sperrung muss ich wohl auf einen gütigen Admin hoffen ;-)
Ich hätte die Links direkt hinter den Link zur Unterseite platziert, beispielsweise also

…spezielle [[{{SUBJECTPAGENAME}}/Druck|Druckversion]]<span class="metadata metadata-label"> ([{{fullurl:{{SUBJECTPAGENAME}}/Druck|action=edit}} Bearbeiten] / [{{fullurl:{{SUBJECTPAGENAME}}/Druck|action=history}} Versionen])</span> für die [[Hilfe:Buchfun…

meint -- ✓ ^Bergi 19:57, 4. Sep. 2010 (CEST)

Probiere es mal in deinem BNR aus und teste es mit Spezial:Vorlagen_expandieren. Wenn es dann funktioniert, dann kannst du die Änderung exakter beschreiben und es findet sixch eher jemand, der den Quelltext kopiert. ÅñŧóñŜûŝî (Ð) 22:04, 4. Sep. 2010 (CEST)

Ich habe mal bei WP:EW angeklopft. Gruß, --Revo Echo der Stille 22:57, 4. Sep. 2010 (CEST)

Danke, ist drin. -- ✓ ^Bergi 21:01, 5. Sep. 2010 (CEST)

Ist das normal das der Bearbeiten-Link mehr als doppelt so groß als normal ist? -- Perhelion 16:14, 28. Sep. 2010 (CEST)

Das ist mir auch gerade aufgefallen - hat da jemand eine Antwort/Lösung? -- Gruß, aka 19:39, 27. Jun. 2011 (CEST)

Die Schriftgröße wird durch die verwendete Vorlage:Überschriftensimulation 4 verursacht. Gruß --W_I^KImaniac 19:57, 27. Jun. 2011 (CEST)

Ja, soweit so unschön ;-) Ich hatte mal bei Wikipedia:Fzw#Überschriftensimualtion in Vorlage:Dokumentation gefragt, ob jemand eine Lösung kennt. -- Gruß, aka 20:01, 27. Jun. 2011 (CEST)

Interwiki-Links für Vorlagen in /Doku?

Die Vorlage OEIS wird 150 mal verwendet. Ich habe dort einige Interwiki-Links hinzugefügt (no, ja, it, fr ...), bin aber jetzt unsicher, ob ich nicht lieber gleich den ganzen noinclude-Teil in eine neue Seite Vorlage:OEIS/Doku hätte verschieben sollen.

Mir stellt sich die Frage, ob die Interwiki-Links zwischen den Vorlagen in den einzelnen Sprachen genauso verstanden werden ("es gibt diese Vorlage in den Sprachen xx, yy, zz"), wenn sie auf den Dokumentationsunterseiten angelegt werden, oder ob die Interwiki-Links dort bedeuten: "es gibt eine analoge Dokumentation dieser Vorlage in den Sprachen xx, yy, zz".

Soll ich also bei Vorlage:OEIS die Vorlage:Dokumentation einsetzen? --Gfis 21:29, 16. Jan. 2011 (CET)

Hallo Gfis, die Dokumentationsvorlage kannst Du grundsätzlich bei allen Vorlagen verwenden. Interwiki-Links in der Vorlagen-Meta-Unterseite bedeuten dabei, dass es eine analoge Vorlage in einer anderen Sprache gibt. Bitte trage Interwikis jedoch nicht in die Vorlagen-Doku-Unterseite, sondern in die Vorlagen-Meta-Unterseite ein. Gruß --W_I^KImaniac 18:45, 19. Jan. 2011 (CET)

Bei Fragen…

Wäre es nicht vielleicht ganz gut, für den den Bausteinkasten

Bei Fragen zu dieser Vorlage kannst Du Dich an die Vorlagenwerkstatt wenden.

eine Erweiterung vorzusehen, ggf. wenn ein Parameter {{Dokumentation|Ersteller=1}} gesetzt wird,

Bei Fragen zu dieser Vorlage kannst du dich an an den Ersteller oder an die Vorlagenwerkstatt wenden.

oder sogar explizit mit {{Dokumentation|Ersteller=Revolus}}

Bei Fragen zu dieser Vorlage kannst du dich an an den Ersteller oder an die Vorlagenwerkstatt wenden.

BTW: Das (respektvolle?) Kapitalisieren der Pronomina ist recht antiquiert. -- sarang♥사랑 13:42, 12. Mai 2011 (CEST)

Rahmen

Hallo. Wo wurde die Entfernung des Rahmens um die Dokumentation beschlossen? Es sieht ohne Rahmen irgendwie komisch aus. Gruß --Tlustulimu 17:45, 19. Jul. 2011 (CEST)

Komisch = ungewohnt?

Ist kein Beschluss, sondern ein Versuch von mir. Ich finde den Doppelrahmen hässlich, unübersichtlich und unnötig platzfressend. --PM3 18:35, 19. Jul. 2011 (CEST)

Was ist an einem Rahmen unübersichtlich und platzfressend? --Tlustulimu 19:28, 19. Jul. 2011 (CEST)

Dass der Platz frisst, versteht sich von selbst. Unübersichtlich wegen ineinander verschachtelter Rahmen. Das ist die m.W. einzige Stelle, an der Seiteninhalte nochmal in einen weiteren Rahmen geschachtelt wurden; ich finde sowas eine layouttechnische Sünde.

Andersrum gefragt: Was ist ein einem nicht-Rahmen komisch, außer dass du dich erst noch dran gewöhnen musst? --PM3 19:44, 19. Jul. 2011 (CEST)