Vorlage:RpgDevStandardDiagram

[Bearbeiten] Vorlagen-Dokumentation

Stellt eine Schnittstelle für vereinheitlichte Diagramme zur Verfügung. Dabei verwaltet die Vorlage alle verschiedenen möglichen Rendering-Engines wie Graphviz und Graph::Easy in denen das jeweilige Diagramm gerendert werden kann. Jedes Diagramm das diese Flexibilität nutzen soll muss diese Vorlage einbinden und entsprechende Unterseiten für den Rendering-Prozess zur Verfügung stellen.

Kopiervorlage

{{RpgDevStandardDiagram
| Diagram-Name = 
| Diagram-Template = 
| Diagram-TemplateParams = param1={{{param1|}}} {{!}}param2={{{param3|}}} {{!}}param3=val3 ...
<!-- Benutzer-Parameter durch reichen -->
| Color = {{{Farbe|}}}
| Direction = {{{Ausrichtung|}}}
| Renderer = {{{Renderer|}}}
| Format = {{{Format|}}}
| Output = {{{Output|}}}
| Output-Box visible = {{{Output-Box zeigen|}}}
| SourceInjectStart = {{{SourceInjectStart|}}}
| SourceInjectDefaultOptions = {{{SourceInjectDefaultOptions|}}}
| SourceInjectOptions = {{{SourceInjectOptions|}}}
| SourceInjectEnd = {{{SourceInjectEnd|}}}
}}

Anwendung

Soll diese Vorlage verwendet werden um ein Diagramm mit verschiedenen Rendering-Engines und mit RPG-Dev-einheitlichem Design und Bedienung zu ermöglichen, so ist Voraussetzung dass diese Vorlage auf der Vorlagen-Seite eingebunden wird, die später vom Anwender verwendet werden soll um das Diagramm auszugeben.

Für jede Rendering-Engine mit der das Diagramm ausgegeben werden können soll muss eine Unterseite für die Vorlagenseite existieren in der der Code für diese Engine speziell generiert wird. Momentan sind die zwei möglichen Engines:

• Graphviz
• Graph::Easy

Der Anwender kann dann über den Parameter Renderer eine der Engines auswählen. Standardmäßig ist GraphViz der Standard-Renderer.

Allgemeine, vorbereitende Operationen können bereits in der Haupt-Vorlage ausgeführt werden und dann als globale Variable der Unter-Vorlage zur Verfügung gestellt werden.

Kommunikation mit Unterseiten

Es werden einige globale Variablen zur Verfügung gestellt, die in den Unterseiten gefüllt werden können um ein bestimmtes Verhalten im Renderer zu definieren. Folgende Variablen existieren zur Zeit:

<G:RpgDevStandardDiagram>builderOptions

Wird unterhalb der SourceInjectDefaultOptions und oberhalb der SourceInjectOptions eingefügt.

<G:RpgDevStandardDiagram>defaultFormat

Ermöglicht Standard-Format anzugeben. In dem Fall, dass der Parameter Format nicht übergeben wurde wird dann dieses Format vom Renderer genutzt.

Vorschau

Eine Graph-Vorschau kann mit Hilfe von Vorlage:RpgDevStandardDiagram-Preview angezeigt werden. Eignet sich besonders dazu auf den jeweiligen Renderer-Unterseiten direkt eine Vorschau zu erhalten.

Parameter

Fett markierte Parameter sind Pflichtangaben, die unbedingt einen Wert enthalten müssen, um die Vorlage sinnvoll verwenden zu können. An einige Parameter können mehrere Werte übergeben werden, in der Regel getrennt durch ein Komma. Diese Werte werden im Nachfolgenden durch eine Unterstreichung hervorgehoben.

Eine Übersicht über die anderen Parameter die als Standard-Parameter in allen Diagramm-Vorlagen verfügbar sein können die diese Vorlage nutzen gibt es unter Vorlage:RpgDevStandardDiagram/Doku/StandardParameter. Diese Seiten kann für alle Vorlagen-Dokus eingebunden werden die Vorlagen dokumentieren die auf dieser Vorlage basieren.

Diese Dokumentation wird von einer Unterseite eingebunden. Anwendungsbeispiele und Funktionalitätsprüfungen können auf der Testseite gemacht werden. Verwendung der Vorlage in Artikeln.