Hilfe:Vorlagenübersicht Handbuchartikel

Aus Deutsches DMXC-Wiki
Zur Navigation springen Zur Suche springen
Books.png Vorlagenübersicht Handbuchartikel

In diesem Artikel werden die wichtigsten Vorlagen genannt, die beim Schreiben eines Handbuchartikels zum Einsatz kommen können. Dabei dient dieser Artikel in erster Linie als Kopiervorlage. Weiterführende Informationen zu den genannten Vorlagen sind in den Beschreibungen der entsprechenden Vorlage selbst zu finden.

Beschreibung Name der Vorlage Übliche Verwendung
Menüleisten
Navigationsmenü Hauptprogramms DMXC3 Manual-Navigation Hauptprogramm Navigationsmenü für Artikel zum Hauptprogramm zu DMXControl 3
Navigationsmenü DDFs DMXC3 DMXC3 Manual-Navigation DDF Navigationsmenü für Artikel zur Dokumentation und Erstellung von DDFs für DMXControl 3
Objekte
Hinweisbox Manual Box Erstellt Textboxen für Hinweise und andere Informationen, die explizit hervorgehoben werden müssen
Vorgefertigte Textelemente
Web-Links DMXCWebLinks Automatische Generierung von Links zu verschiedenen Seiten und Tools wie Forum, Bugtracker, YouTube etc.
Drag & Drop DnD Generiert das vollständig formatierte und somit einheitlich geschriebene Textelement für Drag & Drop
Icon Manual Icon inline Icon oder Bild in einen normalen Fließtext einfügen
Referenzverweis Manual Reference Querverweis direkt im Fließtext zum Beispiel am Ende eines Absatzes
Einstellungsparameter Manual Setting entries Stellt verschiedene, häufig verwendete Listen-Parameter für eine Einstellung zur Verfügung
Fließtextformatierung
Fensterbezeichnung Manual Windowcaption Titel von Fenstern, Name von Funktionen
Objektbezeichnung Manual Objectcaption
Menüs Manual MenuText Menüpunkte und Menüeinträge
Dropdowns Manual Fields Dropdowneinträge, Eingabefelder
Buttons Manual Buttons Beschriftung und Namen von Buttons, Checkboxen, Fader
Tabellen-Kopfzeile Manual TableHeader Kopfzeilen von Spalten und Zeilen einer Tabelle
Dateipfad Manual Filepath Datei- und Verzeichnis-Pfade
Befehle Manual Commands Ein- und Ausgänge von Nodes im Input Assignment
Wert Manual Value Formatierung von verschiedenen Werten wie DMX-Kanal, DMX-Wert etc.
Flags Manual Flags
Keyboard Manual Keyboard Tasten und Tastenkombinationen auf der Tastatur
Tabellenformatierung
Kopfzeilen von Tabellen
Menüleiste DMXC3 Manual-Tableheader Menubars Tabellenkopf die Beschreibung der Icons in einer Menüleiste
Einstellungen DMXC3 Manual-Tableheader Settings Tabellenkopf die Beschreibung von Einstellungen
Effekt-Parameters DMXC3 Manual-Tableheader Effect parameters Tabellenkopf für die Beschreibung der Parameter eines Effekts
Executor-Aktionen DMXC3 Manual-Tableheader Executor actions Tabellenkopf für die Beschreibung von Aktionen der Buttons und Fader von Executoren
IA-Nodes In-Output DMXC3 Manual-Tableheader IA-Nodes In-Output Tabellenkopf für Inputs und Outputs von Nodes im Input Assignment
DDF-Codebeispiele DMXC3 Manual-Tableheader DDF-Code examples Tabellenkopf für Codebeispiele im Bereich der Dokumentation der DDFs
Tabellenzeilen
Tabellenabschnitt DMXC3 Manual-Tablesection Kennzeichnen von Abschnitten innerhalb Tabellen in mehreren Ebenen
Effekte und Filter DMXC3 Manual-Tableentry Effects-Filters Tabelleneintrag in der Übersichtstabelle für Effekte und Filter im gleichnamigen Artikel Effekte und Filter.
IA-Nodes DMXC3 Manual-Tableentry IA-Nodes Tabelleneintrag in der Übersichtstabelle für Nodes des Input Assignment im Artikel Input Assignment.
Icon in Menüleiste DMXC3 Manual-Tableentry Menubars Tabelleneintrag für die Beschreibung eines Icons in einer Menüleiste
Videolink DMXC3 Manual-Tableentry Videolink Tabelleneintrag einen Verweis zu einem Video bei YouTube inklusive Kurzbeschreibung