Das offizielle Minecraft Wiki twittert hier: Wiki-Twitter  –  Chatte im Wiki-Discord  –  Noch keinen Server gefunden? Es gibt einen Wiki-Server

Minecraft Wiki Diskussion:Projekte/Vorlagendoku-Umstellung

Aus Minecraft Wiki
Wechseln zu: Navigation, Suche

Abstimmung: Welche weiterführenden Arbeitsschritte werden durchgeführt?[Bearbeiten]

Arbeitsschritt

Pro

Contra

Teilweise erledigt
: Alle Vorlagendokumentationen von /doc nach /Dokumentation verschieben
violine1101, -- Sumpfhütte, Xzipx, Caleb Blackhand

Abgelehnt
: Eigene neue Vorlage:Dokumentationslinks erstellen (wenn möglich)
violine1101 -- Sumpfhütte, Xzipx, Caleb Blackhand

Erledigt
: Verschiebung der Vorlage:Grid2 und Unterseiten nach Vorlage:Grid
violine1101, Xzipx, Caleb Blackhand

Erledigt
: Zusammenschließung der Lizenzvorlagen
violine1101, -- Sumpfhütte, Xzipx

Ich bin mir nicht ganz sicher, ob alle eventuellen Arbeitsschritte, die ich auf der Projektseite angegeben habe, von allen gewollt sind. Von daher bitte einmal in dieser Tabelle abstimmen, bevor wir mit dem Umstellen anfangen. | violine1101 (Diskussion) 12:51, 1. Jan. 2015 (UTC) Buch und Feder.png

Ich habe zur besseren Übersichtlichkeit diese Diskussion in mehrere Unterabschnitte aufgeteilt. | violine1101 (Diskussion) 19:37, 3. Jan. 2015 (UTC)

Dokumentationslinks[Bearbeiten]

Grid2[Bearbeiten]

Lizenzen[Bearbeiten]

Zusammenschluss[Bearbeiten]

/doc zu /Dokumentation[Bearbeiten]

Lua-Hinweis[Bearbeiten]

Die neue "Vorlage:Lua" erzeugt eine Hinweisbox. Da wir aber in jeder Doku bereits eine Hinweisbox haben (ist in "Vorlage:Doku/Start" eingebaut), würde ich diese beiden Hinweise zusammenfassen, damit nicht zukünftig zwei Boxen am Kopf einiger Dokus stehen. Das heißt, die neue Vorlage würde eher "Vorlage:Dokuhinweis" heißen mit optionalem Lua-Parameter statt "Vorlage:Lua". -- Sumpfhütte 14:18, 1. Jan. 2015 (UTC)

Im Gegensatz zum EN-Wiki haben wir auf jeder Seite als Kopf noch einen Hinweis auf die Vorlagenhilfe. Das ist eigentlich viel benutzerfreundlicher. Da wir eine solche Vorlage sowieso erstellen müssen, kann man das gerade zusammenpacken. Andererseits muss man keine neue Vorlage erstellen - man müsste nur das neue Modul erweitern. | violine1101 (Diskussion) 19:37, 3. Jan. 2015 (UTC)
Ja das ist noch besser. -- Sumpfhütte 20:45, 3. Jan. 2015 (UTC)
In meinem ersten Post meinte ich, beide Hinweise in einer Box zusammenzufassen, wäre das möglich? -- Sumpfhütte 12:47, 6. Jan. 2015 (UTC)
Ja, das wäre möglich. Ich habe es jetzt aber so gelöst, dass die Hilfe unten neben dem Link auf die Dokumentation erwähnt und bei den Bearbeiten- und Aktualisierenlinks auch verlinkt wird. Wäre das auch okay? | violine1101 (Diskussion) 14:08, 6. Jan. 2015 (UTC)
Das finde ich noch besser. Eine Hinweisbox ist nichts wert, wenn sie in jeder Vorlage steht - so wie es jetzt ist. Der Hinweis muss da unten aber deutlicher sein. Daher habe ich das Verkehrsschild mit reingenommen. Nun bliebe die Lua-Hinweisbox alleine übrig. Doch eine Hinweisbox ist dafür viel zu plakativ. Es handelt sich um eine Randinformation, die den Benutzer der Vorlage nicht interessiert, sondern nur den Entwickler. Und der kann sie eigentlich auch durch Anschauen des Quellcodes gewinnen. Wesentlich geeigneter als eine dicke Hinweisbox ist eine Texteinbettung in Art der {{Navigationsboxhinweis}}. Ich würde daher den lua-Parameter aus dem Modul entfernen und eine eigene Vorlage erstellen, die mit dem Lua-Logo aber ohne weitere plakative Formatierung die Lua-Module als Text ausgibt. Diese "Vorlage:LuaInfo" wird dann in den betroffenen Vorlagendokus am Ende der Einleitung eingesetzt. -- Sumpfhütte 15:21, 6. Jan. 2015 (UTC)
Man könnte es aber auch in den Dokumentationskopf integrieren, also entweder in die Vorlage:Dokumentationskopf (welche ich gleich erstellen werde) oder in das Modul. | violine1101 (Diskussion) 15:39, 6. Jan. 2015 (UTC)
Gute Idee. Ich warte aber erstmal mal ab, wie der Dokumentationskopf aussieht. -- Sumpfhütte 15:56, 6. Jan. 2015 (UTC)
Dokumentationskopf erstellt, siehe Benutzer:Violine1101/Vorlagentestseite/Dokumentation für ein Beispiel. | violine1101 (Diskussion) 18:04, 6. Jan. 2015 (UTC)
Der Text "Diese Vorlage hat keine Dokumentation. Wenn du weißt, wie diese Vorlage funktioniert, dann erstelle sie bitte." sollte (wie vorher) einen Rotlink anbieten, den man nur anklicken muss, um die Doku zu schreiben. Sonst weiß man ja gar nicht wohin sie soll. Der neue Dokukopf sagt: "Dies ist die Dokumentation, sie sollte auf der Vorlagenseite eingebunden werden. Siehe Vorlage:Dokumentation für weitere Informationen." Das sollte aber nicht im Dokukopf stehen. Dort soll nur (wie vorher) die Überschrift "Dokumentation" stehen (nur ohne dieses merkwürdige blaue "i", so wie jetzt). Der Hinweis auf die Hilfe ist im Kopf (wie vorher) besser aufgehoben als im Fuß, bitte in den Kopf verschieben (wie jetzt ohne gelben Hinweiskasten). Den Lua-Hinweis finde ich im Kopf nicht an der richtigen Stelle. Die perfekte Stelle ist nach der Einleitung, dann machen wir doch eine eigene LuaInfo-Vorlage (ohne gelben Hinweiskasten). -- Sumpfhütte 18:46, 6. Jan. 2015 (UTC)

Ich habe den Hinweis jetzt in den Kopf verschoben. Das Achtung-Schild sieht jetzt aber etwas fehl am Platz aus.
Wie wäre es, wenn man das Hilfsmodul ähnlich wie "Hilfe" verlinken würde? Der Hauptgrund für die geplante Vorlage war ja, das Modul besser zu verlinken.
Die Zeile, die du auf der Dokumentationsseite siehst, ist die Kopfzeile. Man könnte zwar eine Fußzeile hinzufügen, aber ich finde, dass man so Vorlage und Dokumentation besser unterscheiden kann. Und das "Dokumentation" steht ja schon im Seitentitel. | violine1101 (Diskussion) 22:00, 6. Jan. 2015 (UTC)

Der jetzt eingebaute "Hilfe"-Link ist gut gemeint, aber wir brauchen einen Holzhammer. Das Achtung-Schild ist genau richtig für diesen Zweck. Wir hatten den gelben Hinweiskasten, der jetzt zum Achtung-Schild wird, erst letztes Jahr eingeführt, weil es einige Nutzer gab, die voller Elan Vorlage um Vorlage erstellt haben, ohne vorher die Grundsätze dieses Wikis zu beachten, wie z.B. den Aufbau der Doku oder den Leitsatz "Nicht jede Spielerei, die möglich ist, ist auch sinnvoll."
Der Satz "Dies ist die Dokumentation, sie sollte auf der Vorlagenseite eingebunden werden" ist nach wie vor verwirrend. Die Doku IST doch bereits eingebunden, wenn man das liest. Ich würde ihn ersetzen durch "Das ist die Dokumentation von <Link>". Sollte es mal eine Doku ohne Vorlage geben, wäre der Link ein Rotlink, sonst zeigt er auf die Vorlage.
Ich habe mir den engl. Lua-Hinweis noch mal angeschaut: "This template uses Module:Lua, a script written in Lua. Please see wp:Lua and mw:Extension:Scribunto to learn more." Ich halte es nicht für sinnvoll, die Vorlage damit zu versehen. Wenn eine Vorlage eine andere Vorlage enthält machen wir ja auch nicht ein Schild oben drüber mit großem Tamtam. Wir haben einen eigenen Lua-Abschnitt auf der Hilfeseite. Sollte dort noch eine Info fehlen, dann bitte nachtragen. Das schicke Lua-Symbol würde ich im Modul einbinden und zwar in den Dokumentationskopf immer dann, wenn es sich um ein Modul handelt. -- Sumpfhütte 12:36, 8. Jan. 2015 (UTC)
Ich werde mal sehen, ich glaube, ich verschiebe den Hinweis mit Achtung-Schild noch ein wenig nach rechts.
Der Satz "Dies ist die Dokumentation, sie sollte auf der Vorlagenseite eingebunden werden" wird nur in der Dokumentation an sich angezeigt, und da Vorlagen nicht automatisch eingebunden werden, kann man nicht davon ausgehen, dass sie eingebunden ist →‎ Die Doku sollte eingebunden sein. Den Link füge ich hinzu.
Okay, ich habe bisher an der Lua-Box nichts geändert, um die Diskussion hier abzuwarten. Aber du hast Recht, ich verschiebe den Hinweis mit geändertem Text in den Moduldokumentationskopf. In der Vorlage füge ich zusätzlich in der Fußzeile einen einfachen Texthinweis hinzu, der auf das Modul verlinkt. | violine1101 (Diskussion) 16:43, 8. Jan. 2015 (UTC)
Ist das Modul jetzt so okay, oder muss man da noch was ändern? | violine1101 (Diskussion) 19:54, 9. Jan. 2015 (UTC)
Noch etwas ändern:
-- Sumpfhütte 20:20, 9. Jan. 2015 (UTC)
Danke, hatte ich übersehen. Behoben. | violine1101 (Diskussion) 22:51, 9. Jan. 2015 (UTC)
Prima. Ich habe mir meine Testfälle nochmal angeschaut, sieht jetzt gut aus :-) Hast du auch die anderen Parameter mal getestet (baddoc, nodoc etc.?) Wobei: Ich weiß gar nicht, ob wir baddoc und nodoc überhaupt benutzen. Seitdem Xzipx alle Vorlagen auf Vordermann gebracht hat, dürfte es die nicht bei uns geben. -- Sumpfhütte 14:45, 10. Jan. 2015 (UTC)
baddoc funktioniert, und nodoc wird automatisch eingeschaltet, und funktioniert auch. Und baddoc würde ich jetzt nicht aus dem Modul entfernen, es gäbe keinen Grund dafür, auch wenn baddoc nie benutzt wird. | violine1101 (Diskussion) 21:58, 14. Jan. 2015 (UTC)
Gut, dass du es getestet hast. Und ich stimme dir zu, ich würde diese Parameter auch drin lassen. -- Sumpfhütte 16:56, 15. Jan. 2015 (UTC)

Vorlage "Dokumentation"[Bearbeiten]

Wenn man dem Link zur Anlage einer neuen Dokumenation folgt, wird das Edit-Fenster mit Text vorbelegt. Der noinclude-Teil am Ende ist jedoch bei uns nicht nötig. Wir haben keine Navigationsboxen und Kategorien, die in den Dokus vergeben werden, weil dies für die Vorlage gemacht wird. Eine spezielle Navigation für die Dokus ist überflüssig, weil sie identisch mit der Vorlagennavigation wäre. Dasselbe gilt auch für die Interwikilinks für Dokus. Ich weiß, das ist im engl. Wiki anders, aber ich sehe bei uns keine Notwendigkeit dafür. Im Gegenteil: Der Verwaltungsaufwand, Vorlageninterwiki mit Dokuinterwiki synchron zu halten, käme noch dazu. Und Dokuinterwikis werden nicht benötigt, weil man ja die Vorlageninterwikis hat. Doppelte Info, doppelter Verwaltungsaufwand, kein Nutzen. Der vorbelegte Text ist grundsätzlich eine sehr gute Sache. Aber wenn dort zweimal Navboxen, Kategorien und Interwikilinks einzutragen sind, wird das immer wieder zu Verwirrung, Doppel- und Falscheinträgen führen, hinter denen hergeräumt werden muss. Und wenn wir beide mal nicht da sind, gibt es keinen, der das versteht oder gar korrigiert. Daher bitte keinen noinclude-Teil. -- Sumpfhütte 11:32, 8. Jan. 2015 (UTC)

Den voreingestellten Teil kann man über "Vorlage:Dokumentation/Start" bearbeiten. Ich habe nichts dagegen, man benutzt die Dokumentationsseiten an sich ja äußerst selten. | violine1101 (Diskussion) 16:43, 8. Jan. 2015 (UTC)

Systemnachrichten- und CSS-Dokus[Bearbeiten]

Ist es eigentlich möglich, Dokumentationen zu .css- und .js-Dateien und Systemnachrichten anzulegen? Wenn ja, wie? Im EN-Modul ist die Rede davon, ich hab das einfach hierher übernommen. | violine1101 (Diskussion) 19:06, 6. Jan. 2015 (UTC)

Ich habe mal "MediaWiki:Scribunto-doc-page-header/Dokumentation" angelegt. In der Systemnachricht erscheint aber kein Dokutext. CSS- und JS-Seiten werden im jeweiligen Skript dokumentiert, was ich auch für sinnvoll halte, weil sie sehr lang sein können und dann die Doku beim jeweiligen Code steht. -- Sumpfhütte 13:03, 8. Jan. 2015 (UTC)
Ein Klick auf den "Links auf diese Seite"-Link beim EN-Modul und Sortierung nach Namespace zeigt - von wegen "Systemnachricht" ist Quatsch. Das Modul wird nie als Systemnachrichtsdokumentation benutzt. Allerdings bin ich bei einigen Benutzer.js im EN-Wiki fündig geworden - Die Dokumentation wird eingebettet, siehe en:MediaWiki:Clearyourcache. Vorgeschlagener Code, der dort hinzugefügt werden sollte:
<div class=dokumentation>{{#if: {{#pos: {{PAGENAME}} | .css }}{{ #pos: {{PAGENAME}} | .js }} | {{#invoke: Dokumentation | page }} }}</div>
Damit würde auf jeder Skriptdatei der Hinweis zum Erstellen der Dokumentation, wie er zur Zeit bei Vorlage:Dokumentationskopf steht, angezeigt werden. Alternativ kann man auch eine Namensraumabfrage schalten, sodass nur der Namensraum Benutzer und/oder der Namensraum MediaWiki damit versehen wird.
Es würde sich bei solchen Skriptdokus nicht um eine genaue Erläuterung, wie das Skript funktioniert, sondern darum, den Nutzen und die Einbindemöglichkeit des Skripts hervorzuheben, handeln.
Mit dem obigen Code kann man übrigens die Dokumentation über eigenes CSS ansteuern. | violine1101 (Diskussion) 16:43, 8. Jan. 2015 (UTC)
Hört sich gut an. Wir probieren das mal aus, sobald wir mit der Hauptaufgabe des Doku-Moduls (= Vorlagen und Module) fertig sind. -- Sumpfhütte 17:36, 8. Jan. 2015 (UTC)

Aktuelle Probleme[Bearbeiten]

Bei den letzten Änderungen sind mir ein paar Probleme aufgefallen:

  • Vorlage:Person => Was bedeutet dieser Test?
  • Benutzer:Johnny JayJay/Testseite 1/Dokumentation => Wenn der baddoc-Parameter nur mit "content=" funktioniert, würde ich ihn lieber weglassen. Ansonsten müsste der Bearbeiter nicht nur die Doku korrigieren, sondern die {{!}} wieder zurückverwandeln, wobei er nicht mehr unterschieden kann, welche bleiben müssen und welche nur durch "content=" entstanden sind. Sehr unübersichtlich. Ich finde, diese "Johnny JayJay"-Doku kann so nicht bleiben.
  • Modul:Dokumentation => Das Modul generiert aus dem pageType automatisch eine Kategorie. Die Kategorien Vorlagendokumentation und Moduldokumentation existieren bereits und haben den richtigen Headertext. Sollten wir jetzt für alle Namensräume vorsorglich eine pageType-Kategorie anlegen? Oder nur noch für Widget?

-- Sumpfhütte 21:39, 13. Mai 2015 (UTC)

  • Der Test basiert auf dieser Änderung im EN-Wiki, welche die Darstellung des Wikinamens vereinfacht, scheint aber wegen der englischen Namensräume hier nicht zu funktionieren. Wird rückgängig gemacht.
  • Ich habe erst nachdem ich die Dokumentation bearbeitet habe, gesehen, dass sie überhaupt nicht verwendet wird. Ich habe daraufhin versucht, sie durch die neue Vorlage in den vorherigen Zustand zurückzuversetzen. Dazu benötigte ich aber die {{!}}s, da sonst die Tabelle nicht angezeigt werden würde. Ich werde die Seite gleich dennoch auf die Version von heute (20:27 Uhr) zurücksetzen, da ich meine Änderung im Nachhinein nicht als sinnvoll erachte.
  • Die Kategorien sind definiert für Vorlagen, Module, Stylesheets und Skripte. Alle anderen Namensräume würden dann als "Vorlage" durchgehen und ich finde es auch nicht sinnvoll, das für das eine Widget zu ändern. Die Kategorie "Vorlagen ohne Dokumentation" ist bisher aber nur für Vorlagen vorhanden, sollte man das ändern? "Vorlagen mit unzureichender Dokumentation" ebenfalls, aber eine unzureichende Dokumentation ist für andere Namensräume als "Vorlage:" unmöglich. | violine1101 (Diskussion) 21:56, 13. Mai 2015 (UTC) Buch und Feder.png