nicht angemeldet
Doppelgemoppel bzgl. CSS: Doku und Referenz
Hi,
mir fällt gerade im Wiki auf, dass ich die Verteilung der Beschreibung bzgl. CSS-Eigenschaften auf Doku:CSS/Eigenschaften und Referenzen:CSS/Eigenschaftenreferenz nicht sonderlich sinnvoll finde - die bewirkt doch eigentlich nur doppelten Pflegeaufwand?
Bei HTML bspw. halte ich diese Trennung für sinnvoll - HTML-Elemente können ja bspw. einiges an Attributen haben, auf die alle kaum sinnvoll in der Dokumentation zu HTML eingegangen werden kann;
ausserdem schreibt Christian Seiler ja auch, dass die Referenzen zu HTML automatisch aus den DTDs erstellt werden sollen.
Bei CSS ist eine automatische Erstellung einer Referenz m.W. jedoch nicht möglich, so dass das parallele Vorhalten einer Referenz und einer Doku doppelten Aufwand bedeutet.
Ausserdem sehe ich hier in einer zusätzlichen Referenz keinen Mehrwert - die Beschreibung der möglichen Werte einer Eigenschaft und ggf. spezieller Syntax lässt sich gut in der Doku mit unterbringen.
Klar, eine Referenz sollte kurz und knapp sein, und keinen unnötigen Ballast aufweisen - aber ich denke, da hält die Nennung möglicher Eigenschafts-Werte und Beschreibung im Doku-Teil eine gute Balance ein.
Und auch die Gliederung in der Doku unterscheidet sich nicht groß von der in der aktuellen Fassung der Referenz, so dass schnellere Auffindbarkeit in einer Referenz m.E. auch kein Argument ist in diesem Fall.
Deshalb meine Frage:
Wollen wir das so beibehalten, dass wir bzgl. CSS eine Dokumentation *und* eine Referenz parallel vorhalten, die sich letztendlich vom Nährwert her doch nicht groß unterscheiden;
oder seid ihr eher dafür, beides zusammenzulegen (und unter Referenzen:CSS/Eigenschaftenreferenz dann auf Doku:CSS/Eigenschaften zu verweisen)?
Mir erscheint letzteres sinnvoller.
MfG ChrisB
--
“Whoever best describes the problem is the person most likely to solve the problem.” [Dan Roam]
“Whoever best describes the problem is the person most likely to solve the problem.” [Dan Roam]
-
[latex]Mae govannen![/latex]
oder seid ihr eher dafür, beides zusammenzulegen (und unter Referenzen:CSS/Eigenschaftenreferenz dann auf Doku:CSS/Eigenschaften zu verweisen)?
Mir erscheint letzteres sinnvoller.
++i;Cü,
Kai
--
Dank Hixies Idiotenbande geschieht grade eben wieder ein Umdenken in Richtung "Mess up the Web". (suit)
Foren-Stylesheet Site Selfzeug JS-Lookup
SelfCode: sh:( fo:| ch:? rl:( br:< n4:( ie:{ mo:| va:) js:| de:> zu:) fl:( ss:| ls:? -
Hi!
mir fällt gerade im Wiki auf, dass ich die Verteilung der Beschreibung bzgl. CSS-Eigenschaften auf Doku:CSS/Eigenschaften und Referenzen:CSS/Eigenschaftenreferenz nicht sonderlich sinnvoll finde - die bewirkt doch eigentlich nur doppelten Pflegeaufwand?
Das resultiert meines Erachtens auch aus der bisherigen Art der Dokumentation. Sie ist hauptsächlich auf Anfänger ausgerichtet. Der Fortgeschrittene will jedoch vorwiegend schnell sehen, welche Parameter zur Verfügung stehen, die aber im Doku-Teil bisher und größtenteils nur "im Fließtext versteckt" war. Wenn es einen guten Kompromiss zwischen erläuternder Information und Referenzdarstellung gibt, dann sollte man das so machen. Dazu wären sicher ein, zwei Testseiten sinnvoll, an denen man mal sehen kann, wie das Ergebnis aussehen könnte. Das kann gern auch im Test-Wiki geschehen, was den Vorteil hat, dass man dort recht zwanglos rumprobieren kann.
Bei HTML bspw. halte ich diese Trennung für sinnvoll - HTML-Elemente können ja bspw. einiges an Attributen haben, auf die alle kaum sinnvoll in der Dokumentation zu HTML eingegangen werden kann;
ausserdem schreibt Christian Seiler ja auch, dass die Referenzen zu HTML automatisch aus den DTDs erstellt werden sollen.Das ist geschehen und auch schon zu bewundern: https://forum.selfhtml.org/?t=198567&m=1333740. Das Einpflegen in das richtige Wiki kann aber erst nach dem (sich leider noch immer hinziehenden) Versionsupdate von Mediawiki erfolgen.
Wollen wir das so beibehalten, dass wir bzgl. CSS eine Dokumentation *und* eine Referenz parallel vorhalten, die sich letztendlich vom Nährwert her doch nicht groß unterscheiden; oder seid ihr eher dafür, beides zusammenzulegen (und unter Referenzen:CSS/Eigenschaftenreferenz dann auf Doku:CSS/Eigenschaften zu verweisen)?
Zeig, wie es aussehen kann. Dann kann man Vor- und Nachteile der verschiedenen Lösungsmöglichkeiten besser beurteilen.
Lo!
-
Hi,
Wenn es einen guten Kompromiss zwischen erläuternder Information und Referenzdarstellung gibt, dann sollte man das so machen. [...]
Zeig, wie es aussehen kann.So zum Beispiel: http://wiki.selfhtml.org/wiki/Doku:CSS/Eigenschaften/Hintergrundfarben_und_-bilder#Wiederholungseffekt_.28background-repeat.29
Gerade wenn man die möglichen Werte als Liste auszeichnet, sehe ich da den Anspruch des schnellen Überblicks für den Fortgeschrittenen durchaus noch gegeben, selbst wenn sie im beschreibenden Fliesstext nicht an vorderster Stelle stehen. Und wer noch nicht so firm ist, der hat dann auch gleich noch die Erläuterung mit dabei, an der selben Stelle.
MfG ChrisB
--
“Whoever best describes the problem is the person most likely to solve the problem.” [Dan Roam] -
-
Hi!
Vielleicht reicht ja auch die Referenz in der Form des W3C (grüne Boxen*).
Vermutlich wolltest du hier etwas anderes verlinken.
Lo!
-
Om nah hoo pez nyeetz, dedlfix!
Vermutlich wolltest du hier etwas anderes verlinken.
Ja, nämlich grüne Boxen. Matthias
--
-
Hi!
Ja, nämlich grüne Boxen.
Dort stehen ja noch einige Informationen mehr und kompakt(ierbar) an einem Platz, die in der Form weder in der alten noch neuen, weder Doku noch Referenz zu finden sind. Vielleicht wäre das ein Einsatzgebiet für die aus der Wikipedia bekannten Infoboxen (hängen in den Artikelseiten rechts oben in der Ecke, unter anderem bei Ländern).
Lo!
-
-
-
-