DGL Wiki:Hinweise zum Artikel erstellen: Unterschied zwischen den Versionen

Version vom 1. September 2006, 08:42 Uhr

Allgemein

Wenn man noch keine Wiki Erfahrung hat sollte man sich die DGL_Wiki:Editierhilfe durchlesen, bevor man einen Artikel erstellt. (Sie enthält auch tiefergehende Informationen, wie z.B. vorhandene Wikivorlagen) Es kommt nicht darauf an, dass Artikel, die ihr erstellt schon perfekt sind, was auch kaum möglich ist. Wichtig ist, dass ihr überhaupt beim Wiki mithelft und wir es so schnell zu einem umfassenden OpenGL-Nachschlagewerk werden lassen.

Wenn ihr einmal Zweifel habt, wie ein Artikel gebaut sein soll, dann schaut euch einfach einen ähnlichen bestehenden Artikel an. (Einfach auf bearbeiten klicken.)

Auch wenn ihr noch unerfahren im Umgang mit Wikis seid, solltet ihr euch an folgende Konventionen halten:

Namenskonventionen

Wie auf Wikipedia gilt die Singularregel. (Artikelnamen immer in der Einzahl)

Bilder

Bilder sind in diesem Wiki hoch willkommen. Schließlich ist OpenGL ein Mittel zur visuellen Darstellung.
Wenn ihr Bilder hochladen wollt, dann fügt in diese bitte unser DGL-Wiki-Wasserzeichen ein. Bitte beachtet, dass ihr keine Bilder nutzt, deren Copyright ihr nicht besitzt oder deren Copyright nicht der der "GNU Freie Dokumentationslizenz" entspricht. Bilder hochladen können nur angemeldete Mitglieder (Über den Link bei "Werkzeuge" (links unten)). Nach dem Hochladen erhaltet ihr Informationen wie das Bild in einem Artikel benutzt werden kann. (Mehr Informationen zur Benutzung von Bildern findet ihr in der DGL_Wiki:Editierhilfe und in der Wikipediahilfe).

Nachfolgend ein paar (unverbindliche) Gestaltungsregeln:

• Hintergrund

Der Hintergrund sollte weiß sein, da sich dadurch das Bild harmonisch in die Seite einfügt. (Seitenhintergrund ist ja auch weiß)

• Objektfarbe/Objektgestaltung

Die Objekte sollten guten Kontrast zum Hintergrund bieten. Idealerweiße sollten Objekte die räumlich sind/dargestellt sind, mit aktiver Beleuchtung gerendert werden, da dadurch die "Tiefe" besser sichtbar wird.

• Parameter erklären

Falls das Bild eine glFunktion erklären soll, sollten die Parameter bzw. deren Wirkung im Bild kenntlich gemacht werden. (Siehe z.B. glRotate, glScale, glTranslate)

• Wasserzeichen

Das DGL Wasserzeichen sollte auf alle Bilder aufgebracht werden um ihre Herkunft zu dokumentieren. Das WZ sollte so angebracht werden, dass ein entfernen schierig wird.

• Texturen

Falls Texturen verwendet werden, sollte (wenn möglich/sinnvoll) das Wikilogo benutzt werden. Auf diese Weise schützt man das Bild effektiv vor Inhalteklau. Das Wasserzeichen kann dann entfallen.

Ich möchte einen Artikel über eine OpenGL/SDL Funktion erstellen

Bitte nehmt in diesem Fall die Funktionsvorlage (für SDL die SDL_Funktionsvorlage) als Grundlage für den Artikel, damit eine einheitliche Erscheinung der Artikel gewährleistet ist.
Eine einheitliche Formatierung der Artikel ist nicht nur schick sondern hilft später auch Informationen schnell zu finden. Die englischen orginal Spezifikationen von OpenGL.org können als Nachschlage Werk bei der Artikelerstellung helfen (Für SDL ist das englische Dokumentationswiki bei libSDL.org hilfreich). Weitere Quellen für Orginalspezifikationen findet ihr bei den Links. Erst wenn die Basisinfos vorhanden sind sollte man Zusatzinfos wie häufige Fehlerquellen eintragen. Das bedeutet, dass alle Informationen der orginal Specs vorhanden sein müssen. Es darf zu keinem Informationsverlust kommen.

Weitere Regeln:

• Tritt irgendwo im Text der Name der Funktion auf, zu welcher der Text gehört, wird der Funktionsname fett geschrieben.
• Tritt irgendwo im Text der Name eines Parameters auf, welcher zur Funktion gehört, wird der Parametername kursiv geschrieben.
• Tritt irgendwo im Text eine OpenGL/SDL-Konstante auf, wird die OPENGL_ODER_SDL_KONSTANTE komplett groß und fett geschrieben.
• Vermeidet Sackgassenartikel. Das heißt, jeder Artikel sollte auf weitere verwandte Artikel verlinken.

Solltet ihr Teile nicht übersetzen können kopiert ihr diese bitte direkt in den Artikel und markiert sie entsprechend (siehe folgende Hinweise).

Ich möchte einen Artikel über eine OpenGL Extension erstellen

Bitte nehmt in diesem Fall die Extensionvorlage als Grundlage für den Artikel, damit eine einheitliche Erscheinung der Artikel gewährleistet ist.
Eine einheitliche Formatierung der Artikel ist nicht nur schick sondern hilft später auch Informationen schnell zu finden. Auch hier gilt: Haltet euch an die Informationen der Orginalspezifikation bevor ihr weitere Infos hinzufügt.

Mein Artikel ist nicht vollständig

Dies stellt kein Problem dar, denn auch ein unvollständiger Artikel bringt das Wiki weiter. Bitte tragt dann auf dieser Seite ein, was noch gemacht werden muss, damit andere Autoren ihn vervollständigen können.
Außerdem solltet ihr in die erste Zeile des Artikels den Wikikode

{{Unvollständig}}

eintragen. Dadurch wird ein Hinweis angezeigt, dass der Artikel von euch als noch unvollständig angesehen wird. Vorallem soll dieser Hinweis angegeben werden, wenn Teile des Artikels noch nicht übersetzt sind.

Teile des Artikels sind noch nicht übersetzt

Zusätzlich zu obigen Sachen soll der unübersetzte Teil des Texts kursiv und fett markiert werden:

Ich möchte Artikel offline schreiben

Falls ihr einen Artikel offline schreiben wollt so editiert diesen Artikel und fügt diesen Text ein:

{{Offline}}

Auf diese Weise wird verhindert das in der zwischenzeit jemand anders den Artikel erstellt oder bearbeitet.
Wenn Ihr es euch doch wieder anders überlegt habt dann ersetzt den Hinweis bitte durch {{Unvollständig}} und tragt ihn in der oben genannten Übersicht ein.