Vorlage Diskussion:Dokumentation

aus Wikipedia, der freien Enzyklopädie

[Bearbeiten] 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)

[Bearbeiten] 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.

[Bearbeiten] Beispiel nachher

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.