Hilfe:Vorlagenübersicht Handbuchartikel: Unterschied zwischen den Versionen

Aus Deutsches DMXC-Wiki
(Die Seite wurde neu angelegt: „{{Kapitelüberschrift}} In diesem Artikel werden die wichtigsten Vorlagen genannt, die beim Schreiben eines Handbuchartikels zum Einsatz kommen können. Dabe…“)
 
Keine Bearbeitungszusammenfassung
 
(17 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 3: Zeile 3:
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.
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.


{| class="wikitable"
{| class="wikitable toptextcells"
|- class="hintergrundfarbe10"
|- class="hintergrundfarbe10"
!! style="width: 175px;" | Beschreibung !! style="width: 175px;" | Name der Vorlage !! Übliche Verwendung
!! style="width: 175px;" | Beschreibung !! style="width: 300px;" | Name der Vorlage !! Übliche Verwendung
 
{{DMXC3 Manual-Tablesection | S1 | 3 | Menüleisten}}
 
! style="text-align:left" | [[Vorlage:DMXC3 Manual-Navigation Hauptprogramm|Navigationsmenü Hauptprogramms]]
| <code><nowiki>DMXC3 Manual-Navigation Hauptprogramm</nowiki></code> || Navigationsmenü für Artikel zum Hauptprogramm zu DMXControl 3
|-
|-
| Fensterbezeichnung || <code><nowiki>Manual Windowcaption</nowiki></code> || Titel von Fenstern, Name von Funktionen
 
! style="text-align:left" | [[Vorlage:DMXC3 Manual-Navigation DDF|Navigationsmenü DDFs DMXC3]]
| <code><nowiki>DMXC3 Manual-Navigation DDF</nowiki></code> || Navigationsmenü für Artikel zur Dokumentation und Erstellung von DDFs für DMXControl 3
|-
|-
| Objektbezeichnung || <code><nowiki>Manual Objectcaption</nowiki></code>
 
{{DMXC3 Manual-Tablesection | S1 | 3 | Objekte}}
 
! style="text-align:left" | [[Vorlage:Manual Header|Artikelüberschrift]]
| <code><nowiki>Manual Header</nowiki></code> || Box mit Artikelüberschrift, Icon und optionalen Versionshinweis
|-
|-
| Buttons || <code><nowiki>Manual Buttons</nowiki></code> || Beschriftung und Namen von Buttons, Checkboxen, Fader
! style="text-align:left" | [[Vorlage:Manual Box|Hinweisbox]]
| <code><nowiki>Manual Box</nowiki></code> || Erstellt Textboxen für Hinweise und andere Informationen, die explizit hervorgehoben werden müssen
|-
|-
| Dropdowns || <code><nowiki>Manual Fields</nowiki></code> || Dropdowneinträge, Eingabefelder
 
{{DMXC3 Manual-Tablesection | S1 | 3 | Vorgefertigte Textelemente}}
 
! style="text-align:left" | [[Vorlage:DMXCWebLinks|Web-Links]]
| <code><nowiki>DMXCWebLinks</nowiki></code> || Automatische Generierung von Links zu verschiedenen Seiten und Tools wie Forum, Bugtracker, YouTube etc.
|-
|-
| Menüs || <code><nowiki>Manual MenuText</nowiki></code> || Menüpunkte und Menüeinträge
! style="text-align:left" | [[Vorlage:Manual Information texts|Allgemeine Informationstexte]]
| <code><nowiki>Manual Information texts</nowiki></code> || Vorlage für verschiedene Hinweistexte wie zum Beispiel "Artikel ist in Bearbeitung" oder "Artikel beschreibt eine zukünftige Version"
|-
|-
| Dateipfad || <code><nowiki>Manual Filepath</nowiki></code> || Datei- und Verzeichnis-Pfade
! style="text-align:left" | [[Vorlage:Manual Setting entries|Einstellungsparameter]]
| <code><nowiki>Manual Setting entries</nowiki></code> || Stellt verschiedene, häufig verwendete Listen-Parameter für eine Einstellung zur Verfügung
|-
|-
| Befehle || <code><nowiki>Manual Commands</nowiki></code> ||
! style="text-align:left" | [[Vorlage:DnD|Drag & Drop]]
| <code><nowiki>DnD</nowiki></code> || Generiert das vollständig formatierte und somit einheitlich geschriebene Textelement für {{DnD}}
|-
|-
| Flags || <code><nowiki>Manual Flags</nowiki></code> ||
! style="text-align:left" | [[Vorlage:Ja|Ja]]
| <code><nowiki>Ja</nowiki></code> || Stellt ein {{Ja}} sowohl mit einem Symbol und Text als auch nur als einfaches Symbol {{Ja|-}} zur Verfügung.
|-
|-
| Keyboard || <code><nowiki>Manual Keyboard</nowiki></code> || Tasten und Tastenkombinationen auf der Tastatur
! style="text-align:left" | [[Vorlage:Nein|Nein]]
| <code><nowiki>Nein</nowiki></code> || Stellt ein {{Nein}} sowohl mit einem Symbol und Text als auch nur als einfaches Symbol {{Nein|-}} zur Verfügung.
|-
! style="text-align:left" | [[Vorlage:Manual Icon inline|Icon]]
| <code><nowiki>Manual Icon inline</nowiki></code> || Icon oder Bild in einen normalen Fließtext einfügen
|-
! style="text-align:left" | [[Vorlage:Manual Reference|Referenzverweis]]
| <code><nowiki>Manual Reference</nowiki></code> || Querverweis direkt im Fließtext zum Beispiel am Ende eines Absatzes
|-
 
 
{{DMXC3 Manual-Tablesection | S1 | 3 | Fließtextformatierung}}
 
! style="text-align:left" | [[Vorlage:Manual Windowcaption|Fensterbezeichnung]]
| <code><nowiki>Manual Windowcaption</nowiki></code> || Titel von Fenstern, Name von Funktionen
|-
! style="text-align:left" | [[Vorlage:Manual Objectcaption|Objektbezeichnung]]
| <code><nowiki>Manual Objectcaption</nowiki></code>
|-
! style="text-align:left" | [[Vorlage:Manual MenuText|Menüs]]
| <code><nowiki>Manual MenuText</nowiki></code> || Menüpunkte und Menüeinträge
|-
! style="text-align:left" | [[Vorlage:Manual Fields|Dropdowns]]
| <code><nowiki>Manual Fields</nowiki></code> || Dropdowneinträge, Eingabefelder
|-
! style="text-align:left" | [[Vorlage:Manual Buttons|Buttons]]
| <code><nowiki>Manual Buttons</nowiki></code> || Beschriftung und Namen von Buttons, Checkboxen, Fader
|-
! style="text-align:left" | [[Vorlage:Manual TableHeader|Tabellen-Kopfzeile]]
| <code><nowiki>Manual TableHeader</nowiki></code> || Kopfzeilen von Spalten und Zeilen einer Tabelle
|-
! style="text-align:left" | [[Vorlage:Manual Filepath|Dateipfad]]
| <code><nowiki>Manual Filepath</nowiki></code> || Datei- und Verzeichnis-Pfade
|-
! style="text-align:left" | [[Vorlage:Manual Commands|Befehle]]
| <code><nowiki>Manual Commands</nowiki></code> || Ein- und Ausgänge von Nodes im Input Assignment
|-
! style="text-align:left" | [[Vorlage:Manual Value|Wert]]
| <code><nowiki>Manual Value</nowiki></code> || Formatierung von verschiedenen Werten wie DMX-Kanal, DMX-Wert etc.
|-
! style="text-align:left" | [[Vorlage:Manual Flags|Flags]]
| <code><nowiki>Manual Flags</nowiki></code> ||
|-
! style="text-align:left" | [[Vorlage:Manual Keyboard|Keyboard]]
| <code><nowiki>Manual Keyboard</nowiki></code> || Tasten und Tastenkombinationen auf der Tastatur
|-
{{DMXC3 Manual-Tablesection | S1 | 3 | Tabellenformatierung}}
 
{{DMXC3 Manual-Tablesection | S2 | 3 | Kopfzeilen von Tabellen}}
 
! style="text-align:left" | [[Vorlage:DMXC3 Manual-Tableheader Menubars|Menüleiste]]
| <code><nowiki>DMXC3 Manual-Tableheader Menubars</nowiki></code> || Tabellenkopf die Beschreibung der Icons in einer Menüleiste
|-
! style="text-align:left" | [[Vorlage:DMXC3 Manual-Tableheader Settings|Einstellungen]]
| <code><nowiki>DMXC3 Manual-Tableheader Settings</nowiki></code> || Tabellenkopf die Beschreibung von Einstellungen
|-
! style="text-align:left" | [[Vorlage:DMXC3 Manual-Tableheader Effect parameters|Effekt-Parameters]]
| <code><nowiki>DMXC3 Manual-Tableheader Effect parameters</nowiki></code> || Tabellenkopf für die Beschreibung der Parameter eines Effekts
|-
! style="text-align:left" | [[Vorlage:DMXC3 Manual-Tableheader Executor actions|Executor-Aktionen]]
| <code><nowiki>DMXC3 Manual-Tableheader Executor actions</nowiki></code> || Tabellenkopf für die Beschreibung von Aktionen der Buttons und Fader von [[Executor DMXC3 | Executoren]]
|-
! style="text-align:left" | [[Vorlage:DMXC3 Manual-Tableheader IA-Nodes In-Output|IA-Nodes In-Output]]
| <code><nowiki>DMXC3 Manual-Tableheader IA-Nodes In-Output</nowiki></code> || Tabellenkopf für Inputs und Outputs von Nodes im [[Input Assignment DMXC3 | Input Assignment ]]
|-
! style="text-align:left" | [[Vorlage:DMXC3 Manual-Tableheader Softdesk controls In-Output|Softdesk controls In-Output]]
| <code><nowiki>DMXC3 Manual-Tableheader Softdesk controls In-Output</nowiki></code> || Tabellenkopf für Inputs und Outputs von Controls im [[Softdesk DMXC3 | Softdesk ]]
|-
! style="text-align:left" | [[Vorlage:DMXC3 Manual-Tableheader DDF-Code examples|Codebeispiele für Funktionen in DDFs]]
| <code><nowiki>DMXC3 Manual-Tableheader DDF-Code examples</nowiki></code> || Tabellenkopf für Codebeispiele im Bereich der Dokumentation der [[DDF DMXC3 | DDFs]]
|-
! style="text-align:left" | [[Vorlage:DMXC3 Manual-Tableheader DDF-Code attributes|Attributswerte für Funktionen]]
| <code><nowiki>DMXC3 Manual-Tableheader DDF-Code attributes</nowiki></code> || Tabellenkopf für mögliche und zulässige Attributswerte der Funktionen in [[DDF DMXC3 | DDFs]]
|-
{{DMXC3 Manual-Tablesection | S2 | 3 | Tabellenzeilen}}
 
! style="text-align:left" | [[Vorlage:DMXC3 Manual-Tablesection|Tabellenabschnitt]]
| <code><nowiki>DMXC3 Manual-Tablesection</nowiki></code> || Kennzeichnen von Abschnitten innerhalb Tabellen in mehreren Ebenen
|-
! style="text-align:left" | [[Vorlage:DMXC3 Manual-Tableentry Effects-Filters|Effekte und Filter]]
| <code><nowiki>DMXC3 Manual-Tableentry Effects-Filters</nowiki></code> || Tabelleneintrag in der Übersichtstabelle für Effekte und Filter im gleichnamigen Artikel [[Effects and Filters DMXC3|Effekte und Filter]].
|-
! style="text-align:left" | [[Vorlage:DMXC3 Manual-Tableentry IA-Nodes|IA-Nodes]]
| <code><nowiki>DMXC3 Manual-Tableentry IA-Nodes</nowiki></code> || Tabelleneintrag in der Übersichtstabelle für Nodes des Input Assignment im Artikel [[Input Assignment DMXC3|Input Assignment]].
|-
! style="text-align:left" | [[Vorlage:DMXC3 Manual-Tableentry Menubars|Icon in Menüleiste]]
| <code><nowiki>DMXC3 Manual-Tableentry Menubars</nowiki></code> || Tabelleneintrag für die Beschreibung eines Icons in einer Menüleiste
|-
! style="text-align:left" | [[Vorlage:DMXC3 Manual-Tableentry Videolink|Videolink]]
| <code><nowiki>DMXC3 Manual-Tableentry Videolink</nowiki></code> || Tabelleneintrag einen Verweis zu einem Video bei YouTube inklusive Kurzbeschreibung
 
{{DMXC3 Manual-Tablesection | S1 | 3 | Vorlagen zur allgemeinen Organisation}}
 
! style="text-align:left" | [[Vorlage:Begriffsklärung|Begriffsklärung]]
| <code><nowiki>Begriffsklärung</nowiki></code> || Textbox mit Hinweis, dass dieser Artikel auf verschiedene Begriffe mit dem selben Namen verweist
|-
! style="text-align:left" | [[Vorlage:Veraltet|Veraltet]]
| <code><nowiki>Veraltet</nowiki></code> || Hinweis auf einen veralteten Artikel
 
|}
|}

Aktuelle Version vom 9. November 2024, 18:34 Uhr

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
Artikelüberschrift Manual Header Box mit Artikelüberschrift, Icon und optionalen Versionshinweis
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.
Allgemeine Informationstexte Manual Information texts Vorlage für verschiedene Hinweistexte wie zum Beispiel "Artikel ist in Bearbeitung" oder "Artikel beschreibt eine zukünftige Version"
Einstellungsparameter Manual Setting entries Stellt verschiedene, häufig verwendete Listen-Parameter für eine Einstellung zur Verfügung
Drag & Drop DnD Generiert das vollständig formatierte und somit einheitlich geschriebene Textelement für Drag & Drop
Ja Ja Stellt ein Ja Ja sowohl mit einem Symbol und Text als auch nur als einfaches Symbol Ja  zur Verfügung.
Nein Nein Stellt ein Nein Nein sowohl mit einem Symbol und Text als auch nur als einfaches Symbol Nein  zur Verfügung.
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
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
Softdesk controls In-Output DMXC3 Manual-Tableheader Softdesk controls In-Output Tabellenkopf für Inputs und Outputs von Controls im Softdesk
Codebeispiele für Funktionen in DDFs DMXC3 Manual-Tableheader DDF-Code examples Tabellenkopf für Codebeispiele im Bereich der Dokumentation der DDFs
Attributswerte für Funktionen DMXC3 Manual-Tableheader DDF-Code attributes Tabellenkopf für mögliche und zulässige Attributswerte der Funktionen in 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
Vorlagen zur allgemeinen Organisation
Begriffsklärung Begriffsklärung Textbox mit Hinweis, dass dieser Artikel auf verschiedene Begriffe mit dem selben Namen verweist
Veraltet Veraltet Hinweis auf einen veralteten Artikel
Abgerufen von „https://wiki-de.dmxcontrol-projects.org/index.php?title=Hilfe:Vorlagenübersicht_Handbuchartikel&oldid=18173“
Zuletzt geändert
Diese Seite wurde zuletzt am 9. November 2024 um 18:34 Uhr bearbeitet.