Hilfe:Artikelvorlagen


Aus Macwrench

Wechseln zu: Navigation, Suche
HelpDocument.png
  Help.png Hilfe
 

In diesem Artikel werden die verschiedenen Artikeltypen vorgestellt, die in Macwrench verwendet werden können. Um die ganze Sache zu vereinfachen, werden hier in (hoffentlich) naher Zukunft Vorlagen bereitgestellt, die via Copy&Paste für die Erstellung neuer Artikel verwendet werden können.

Für Artikel rund um das Terminal ist es ratsam, im Anhang des Artikels (Abschnitt "Weiterführende Informationen") die [[wikipedia:de:Manpage|manpages der verwendeten und besprochenen Kommandos aufzuführen. Mehr Informationen sind im zugehörigen Hilfeartikel zur Verwendung von Manpages zu finden.


Inhaltsverzeichnis

Kurztipps

Beschreibung

Unter Kurztipps laufen kleine und kurze Artikel, die ein sehr eingegrenztes und konkretes Problem lösen - beispielsweise die Bildschirmausgabe zu invertieren. Diese Artikel sollten daher im Namen mit dem Text Kurztipp anfangen, damit ...

  • es direkt ersichtlich ist ob es sich um einen ausführlichen Artikel oder einen kurzen Hint handelt
  • die Kurztipps in der Kategorieübersicht gesammelt an einer Stelle zu finden sind

Die Kennzeichnung erfolgt dabei ganz einfach durch Hinzufügen der Präfix

Kurztipp -
zum Artikelnamen. Beispiel:
Kurztipp - Classic-Umgebung entfernen

Vorlage

Quickies

Falls Du einen ganz kurzen Hinweis oder einen wichtigen Tipp bekanntgeben möchtest, der selbst für einen Kurztipp viel zu kurz ist - beispielsweise ein Zweizeiler oder ein Konfigurationshinweis - kann dieser Tipp auch als "Quickie" verfügbar gemacht werden.

Bei den sogenannten "Quickies" handelt es sich um spezielle Artikel einer Kategorie, in denen mehrere solche Hinweise gesammelt werden können. Beispiel: Windows-Quickies

Ressourcen-Artikel

Falls du einige wichtige Links zu einem bestimmten Thema hast, das zu allgemein für einen bestimmten Artikel ist (z.B. Informationsseite zur Softwareenwicklung mit XYZ), kannst du diesen Link in einem sogenannten "Ressourcen-Artikel" hinterlegen.

Das sind - vergleichbar mit den Quickies oben - spezielle Artikel einer Kategorie, in denen zum Thema der Kategorie passende Links zu weiterführenden Informationen gesammelt werden können.

Beispiel: Cocoa Ressourcen

Wichtiger Hinweis:

Dabei muss jedoch beachtet werden, dass Links nicht doppelt aufgenommen werden - im Ressourcen-Artikel und einem bestimmtem Artikel. Dadurch kann es zu Inkonsistenzen kommen, da sich Links doch immer mal wieder ändern können.

In die Ressourcen-Artikel sollten also nur relativ allgemeingültige Links aufgenommen, werden, zu denen noch kein entsprechender Artikel existiert oder deren Themen allgemein genug sind, um zu allen Artikeln der Kategorie zu passen.

Artikel über einzelne Applikationen

Beschreibung

  • enthält Beschreibung und Allgemeine Infos/Tipps
  • Weitere Artikel zum Thema und einzelne Tipps/Lösungen als Links auf Kurztipps und andere Artikel
  • vor allem wenn die Artikel zu umfangreich werden und es umfangreichere Tipps gibt
  • Beispiel: Mail.app, Dashboard, Spotlight
  • Beispielaufteilungen angeben (Beispiele, Skripte, Erweiterungen/PlugIns, etc.)

Vorlage

"normale" Artikel

Beschreibung

Vorlage

Grundlagenartikel (lang)

Beschreibung

To do:

  • Artikel evtl. aufteilen
    • Kurzipps auslagern
    • Subpages erstellen

Vorlage

Bildergalerien / Fotoalben

Beschreibung

Für kleinere Sammlungen an Grafiken und Zeichnungen existieren die Galleries, über die in diesem Artikel mehr zu erfahren ist.

Vorlage

keine vorhanden, es gelten die üblichen Leitlinien zum Verfassen von Artikeln.

Ressourcenartikel / Linklisten

Beschreibung

Ressourcenartikel dienen dazu, verschiedene Links zu weiterführenden Informationen innerhalb einer Kategorie gesammelt darzustellen. Dabei werden nur solche Informationen gesammelt, die für die gesamte Kategorie relevant sind. Diese Artikel sollen dabei in erster Linie die Entstehung von Linksammlungen und unvollständigen Artikeln, die im Wesentlichen nur aus wenigen Informationen und ein paar Links bestehen, verhindern.

Der Aufbau ist dabei sehr einfach, die Überschriften dienen dabei der Strukturierung verschiedener Themengebiete und Unterthemen. Falls die Listen zu groß werden, sollten sie in mehrere Artikel aufgeteilt werden.

Beispiele dafür sind die Artikel Cocoa-Ressourcen und Entwickler-Ressourcen in der Kategorie Programmierung.

Namensgebung

Diese Artikel müssen anhand des Namens erkennbar sein, was durch die Suffix -Ressourcen erfolgt (siehe Beispiele oben).

Vorlage

keine vorhanden, es gelten die üblichen Leitlinien zum Verfassen von Artikeln.

Persönliche Werkzeuge