Hilfe:Vorlage Handbuchartikel

Aus Deutsches DMXC-Wiki
Zur Navigation springen Zur Suche springen
Books.png Vorlage Handbuchartikel Artikel beschreibt
DMXControl 3.2.0
Inhaltsverzeichnis

A

B

C

D

E

F

G

H

K

L

M

N

O

P

R

S


Wichtiger Hinweis Diese Vorlage dient der Erstellung von neuen Artikel zum Handbuch für DMXControl 3 und allen zugehörigen Programmen, abgesehen von den Funktionsbeschreibungen der Nodes des Input Assignments. Alle kursiv gezeichneten Absätze geben einen kurzen Überblick, was in dem jeweiligen Abschnitt zu finden sein soll, sofern dieser für die Beschreibung der Funktion hilfreich ist. Diese sind, wie auch dieser Hinweis bei der Verwendung der Vorlage zu entfernen.

Im Einleitungstext eines Artikels wird dieser grob zusammengefasst, sodass man beim Betrachten der Vorschau zum Querverweis in einem anderen Artikel bereits eine grobe Idee von der Funktion erhält.


Überblick

Im Abschnitt Überblick erhält man als Leser einen etwas ausführlichen Einstieg in die Funktion und insbesondere des Zwecks, der hinter diese Funktion steht. Hierbei werden aber keine bestimmte Funktionen im Detail erläutert. Dies geschieht nur im Abschnitt "Nutzung".

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.

Wichtige Merkmale

Bei den wichtigen Merkmalen sind Punkte aufgeführt, die für das richtige Verständnis erforderlich sind oder besondere Merkmale zeigen.

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.

Bedienelemente

Verfügt eine Funktion über zahlreiche Bedienelemente wie Menüleisten, Buttons etc. werden diese im Abschnitt Bedienelemente vorgestellt und deren Funktion daher meist tabellarisch erläutert.

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.

No-photo.jpg

Menüleiste

Das erste Unterkapitel beschreibt immer die Menüleiste des betreffenden Fensters inklusive der zugehörigen Untermenüs eines jeweiligen Buttons.

Kontextmenüs

Die Kontextmenüs werden immer als Ganzes darstellt, sollte der Inhalt variabel sein.

Tastaturbefehle

Für die Auflistung der Tastaturbefehle wird ebenfalls eine Tabelle verwendet.

Nutzung

Der Abschnitt Nutzung erläutert in erster Linie die verschiedenen Arbeitsweisen der Funktion und wie man diese aufruft.

  • Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam
  • Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam
  • Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam
  • Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam
  • Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam

Externe Ansteuerung

Hier werden Möglichkeiten aufgeführt, wie sich die Funktion neben den zuvor beschriebenen Bedienelementen auch auf weiteren Wegen, zum Beispiel über das Input Assignment ansprechen lässt.

Optionen

In diesem Abschnitt werden alle Optionen und Einstellungsmöglichkeiten aufgeführt, welche diese Funktion betreffen. Die Erläuterung erfolgt tabellarisch. Sind die verfügbaren Optionen nicht für die Funktion spezifisch, sondern werden an anderen Stellen ebenfalls angeboten, so wird auf den Artikel Settings verwiesen.

Tipps und Tricks

Der Abschnitt Tipps und Tricks skizziert grob vereinzelte Beispiele, wie die beschriebene Funktion die tägliche Arbeit mit DMXControl 3 sinnvoll ergänzt. Ausführliche Tutorials sollen hier aber nicht eingefügt werden.

In diesem Satz gibt es eine Anmerkung zum Text[1], welche den Lesefluss nicht beeinträchtigen oder nur optional ergänzen soll.

Links und Referenzen

  1. Beispiel für eine Fußnote mit einem Querverweis zur Stage View