SVG/ Vorlage/ Versionen/ Doku

Aus Wikibooks
Zur Navigation springen Zur Suche springen

Diese Vorlage dient dazu die Unterstützung der SVG-Elemente in verschiedenen Software-Versionen zu dokumentieren.

Einbinden[Bearbeiten]

Parameter (alle optional):

  • svg (dieser Parameter sollte auf jeden Fall angegeben werden)
  • batik (Squiggle/Batik)
  • opera (Opera/Presto)
  • konqueror (KSVG von KDE)
  • firefox (Gecko; auch SeaMonkey, Iceape, Iceweasel etc)
  • safari (WebKit in der Apple-Variante)
  • chrome (WebKit in der Google-Variante)
  • ie (Microsoft internet explorer)
  • rsvg (Bibliothek librsvg, unter anderem bei wikibooks etc verwendet)

Die Vorlage kann zum Beispiel folgendermaßen eingebunden werden:

== beispielelement == {{:SVG/ Vorlage/ Versionen|svg=1.1|rsvg=-|firefox=3.0}}
Erklärung zum Element

Lorem ipsum dolor sit amet, consectetuer sadipscing elitr, 
sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. 
At vero eos et accusam et justo duo dolores et ea rebum. 
Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. 
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, 
sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. 
At vero eos et accusam et justo duo dolores et ea rebum. 
Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. 
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, 
sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. 
At vero eos et accusam et justo duo dolores et ea rebum. 
Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, 
sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. 
At vero eos et accusam et justo duo dolores et ea rebum. 
Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, 
sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. 
At vero eos et accusam et justo duo dolores et ea rebum. 
Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

Ergebnis:

beispielelement

SVG Squiggle (Batik) Opera (Presto) Firefox (Gecko; auch SeaMonkey, Iceape, Iceweasel etc) Konqueror (KSVG) Safari (Webkit) Chrome (Webkit) Microsoft Internet Explorer (Trident) librsvg
1.1 ? ? 3.0 ? ? ? ? -

Erklärung zum Element

Lorem ipsum dolor sit amet, consectetuer sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.


Die Vorlage muss nicht in der selben Zeile wie die Überschrift des Elements eingebunden werden, es macht jedoch Sinn sie möglichst weit oben zu platzieren, damit der Leser sie auf einen Blick im Zusammenhang mit dem Element erfassen kann. Wie oben demonstriert, müssen die Versionen nicht in der Reihenfolge angegeben werden wie sie angezeigt werden, es kann jedoch zur Übersichtlichkeit im Quelltext beitragen.

Das oben gezeigte Beispiel bedeutet, dass das Element in der Version 1.1 in den SVG Standard aufgenommen wurde, in Firefox mindestens seit Version 3.0 unterstützt wird (es ist möglich dass auch frühere Versionen das Element unterstützen – weitere Informationen dazu im Kapitel SVG/ Einführung/ Software) und in den getesteten Versionen von librsvg überhaupt nicht unterstützt wurde. Die anderen Programme wurden nicht getestet (es ist nicht nötig der Vorlage in diesem Fall explizit das Fragezeichen als Parameter zu übergeben, es wird automatisch eingesetzt wenn keine andere Angabe erfolgt ist, die explizite Angabe des Fragezeichens sollte auch im Interesse der Übersichtlichkeit unterlassen werden).

Hinzufügen weiterer Programme[Bearbeiten]

Bevor weitere Programme hinzugefügt werden, sollte überlegt werden, ob diese oft genug benutzt werden. Auch lässt sich die Zahl vielleicht dadurch reduzieren, dass mehrere Programme die gleiche Bibliothek benutzen und somit die gleichen Funktionen unterstützen, in diesem Fall sollte nur die zugrunde liegende Bibliothek aufgeführt werden. Ein Grenzfall ist die von z.B. Safari benutzte WebKit-Engine welche eigentlich nur eine abgewandelte Version der KHTML-Engine ist, die unter anderem von Konqueror benutzt wird. Bei diesen Programmen werden wahrscheinlich ungefähr die gleiche Menge an Elementen unterstützt, jedoch ist die Entwicklung der beiden Engines inzwischen so weit unabhängig voneinander Fortgeschritten, dass die Menge der Elemente die nicht übereinstimmt durchaus nennenswert sein könnte.

Wenn nichts dagegen spricht das Programm hinzuzufügen:

  1. Ein nettes Bild suchen welches das Programm in der Vorlage repräsentiert
    Das hört sich einfacher an als es ist: Viele Bilder entsprechen nicht den Richtlinien die sich das Wikibooks-Projekt gesetzt hat welche im wesentlichen beinhalten, dass die Bilder von jedermann bearbeitet und (auch in der bearbeiteten Version) veröffentlicht werden dürfen, dies ist bei den offiziellen Logos oftmals nicht gegeben (auch bei freier Software kommt es häufiger vor, dass zwar der Quelltext frei ist, die Marke und die Logos jedoch geschützt sind um Plagiate zu verhindern z.B. bei den Produkten der Mozilla Foundation). Die Lösung für diese Problematik sind entweder Logos von Dritten (häufig aus Icon Packs wie beim aktuell verwendeten „Firefox-Symbol“) oder Eigenproduktionen (mit den im Buch erlangten Kenntnissen sollte das ja kein Problem sein ;-)), welche jedoch keine Bearbeitungen des Originals sind und auch nicht versuchen, dieses originalgetreu nachzubilden sondern vielmehr dem Original gerade so nahe kommen, dass sie in dem vorhandenen Kontext richtig zugeordnet werden können (das „Opera-Symbol“ ist z.B. einfach ein rotes O, das Original hat noch diverse Lichtreflexe, die jedoch zum Wiedererkennungswert gerade bei der kleinen Größe und bei dem gegebenen Kontext (Programme mit denen man SVG-Grafiken darstellen kann) nicht viel beitragen).
    Diese Grafiken muss man jedoch häufig nicht selbst erstellen oder hochladen, oft gibt es schon verfügbare Bilder auf Wikimedia Commons oder direkt bei Wikibooks. Man kann auch beim eventuell vorhandenen Wikipedia-Artikel gucken welches Logo dort verwendet wird (oft wird dort jedoch das Original benutzt und sich auf das Fair Use berufen, was jedoch für Artikel auf Wikibooks nicht zutrifft). Sollte man sich dazu entschließen eine Eigenkreation oder ein freies Original hochzuladen, sollte dies möglicherweise (bei Logos ist das sehr wahrscheinlich) direkt bei Commons geschehen, damit sie auf allen Wikimedia-Projekten zur Verfügung stehen (die Anforderungen bezüglich der Lizenz sind dort ungefähr dieselben wie bei Wikibooks).
    Weitere Hilfe findet man auf den entsprechenden Hilfeseiten auf Wikibooks und Wikimedia Commons.
  2. Das neue Programm in die Vorlage einfügen
    Die Vorlage ist im wesentlichen eine Tabelle bei der in der oberen Zeile die Programm-Symbole angezeigt werden und in der unteren Zeile die zugehörigen Versionen. Wenn ein neues Programm hinzugefügt wird, sollte darauf geachtet werden es an einer Position einzufügen, die ungefähr der Anzahl der Nutzer dieses Programms entspricht. Sollte z.B. eine neue Version des Internet Explorers erscheinen die SVG-Grafiken anzeigen kann, wäre der entsprechende Eintrag wahrscheinlich ziemlich weit vorne zu platzieren (der Adobe SVG Viewer ist deshalb so weit hinten platziert, weil die meisten Benutzer des IE das Plugin wahrscheinlich nicht installiert haben und die Nutzerzahl deshalb wohl eher gering ausfallen dürfte).
    In der Vorlage fügt man nun an der gewünschten Position zwischen dem ersten und zweiten |- folgende Zeile ein: ! [[Bild:Bildname |frameless|28px| Programmname]] wobei man Bildname durch den Namen des gewünschte Bilds und Programmname durch den Namen des Programms ersetzt. Dies sorgt dafür, dass das Logo in der oberen Tabellenzeile angezeigt wird und beim Überfahren mit dem Mauszeiger der Programmname angezeigt wird. Damit der Vorlage nun noch die Version als Parameter übergeben werden kann muss zwischen dem zweiten |- und dem |} an der gleichen Position wie oben folgende Zeile eingefügt werden: | {{{kurzname|?}}} hier wird kurzname durch einen kurzen aber prägnanten Namen für das Programm ersetzt welcher benutzt wird um die Version zu übergeben und für den Leser nicht sichtbar ist. Der Kurzname sollte dabei vorzugsweise nur aus Kleinbuchstaben bestehen und bei hinreichend kurzen Wörtern Abkürzungen vermeiden. So wurde firefox nicht mit ff abgekürzt beim Internet Explorer wäre ein ie oder msie jedoch einem internetexplorer vorzuziehen. Es ist unbedingt darauf zu achten, dass sich die eingefügten Zeilen im oberen und unteren Teil an der gleichen Position befinden, andernfalls kommt die Zuordnung der Versionen zu den entsprechenden Programmsymbolen durcheinander. Ob die Zuordnung richtig ist, kann man prüfen indem man z.B. in der gerade eingefügten zweiten Zeile (die mit dem kurznamen) das Fragezeichen durch Test ersetzt und auf „Vorschau zeigen“ klickt. Der Text „Test“ sollte nun unter dem Programm-Symbol erscheinen. Um die Änderung zu speichern ersetzt man das Test wieder durch das Fragezeichen, prüft durch einen weiteren Klick auf „Vorschau zeigen“ ob wieder alles richtig angezeigt wird, gibt im Feld „Zusammenfassung“ eine kurze aber aussagekräftige Beschreibung der Änderung (z.B. „Programm programmname hinzugefügt“) und klickt auf „Seite speichern“.
  3. Testen der neuen Version
    Um sicherzustellen, dass die geänderte Vorlage so funktioniert wie sie es soll, sollten Sie sie testen. Damit der Test klappt muss die neue Version im System durch einen Klick auf „Seite speichern“ gespeichert worden sein, das Anzeigen der Vorschau reicht nicht aus. Ein guter Ort um die Vorlage zu testen ist die Spielwiese. Probieren Sie hier einige Kombinationen der Parameter (wie oben angegeben) aus – auf der Spielwiesen-Seite reicht es die Vorschau zu begutachten, es ist nicht nötig die Seite zu speichern.
  4. Anpassen der Parameterliste auf dieser Seite
    Damit Benutzer auch wissen welchen Kurznamen sie beim Aufrufen als Parameter benutzen müssen.