Referenz Syntax
Kurzbeschreibung
Die Referenz Syntax ist eine integrierte XML-Schnellreferenz des Developers.
Sie stellt häufig verwendete XML-Strukturen als direkt nutzbare Beispiele bereit und unterstützt Redakteure bei der täglichen Arbeit mit Dokumentvorlagen.
Einordnung
Bereich: Developer
Schwierigkeitsgrad: ⭐☆☆☆☆
Vorkenntnisse: keine
Zweck
Die Referenz Syntax dient als integriertes Nachschlagewerk für häufig verwendete XML-Strukturen.
Sie unterstützt insbesondere Redakteure, die die XML-Syntax nicht täglich verwenden und schnell ein passendes Beispiel suchen möchten.
Im Gegensatz zum XML-Handbuch steht hier nicht die Erklärung einer Funktion im Vordergrund, sondern deren unmittelbare Verwendung.
Aufruf
Die Referenz Syntax kann innerhalb des Developers über die Taste F1 ein- oder ausgeblendet werden.
Sie wird rechts neben dem XML-Editor angezeigt.
Aufbau
Die Referenz besteht aus zahlreichen kleinen XML-Beispielen.
Jedes Beispiel beginnt mit einem <Comment>.
Dieser dient gleichzeitig als Überschrift und Suchbegriff innerhalb der Referenz.
Beispiel:
<Comment>Variable ausgeben</Comment>
<Block>
<Content>
<Variable Path="source.Name">
</Variable>
</Content>
</Block>Suche
Im oberen Bereich befindet sich eine Suchfunktion.
Während der Eingabe werden passende XML-Beispiele gefiltert.
Dadurch lassen sich häufig benötigte XML-Strukturen innerhalb weniger Sekunden finden.
Übernahme von Beispielen
Die dargestellten XML-Beispiele können unmittelbar übernommen werden.
Je nach Arbeitsweise erfolgt dies beispielsweise durch:
- Copy & Paste
- Drag & Drop
Anschließend kann das Beispiel an die eigene Dokumentvorlage angepasst werden.
Zusammenhang mit dem XML-Handbuch
Die Referenz Syntax ergänzt das XML-Handbuch.
Beide verfolgen unterschiedliche Ziele:
| XML-Handbuch | Referenz Syntax |
|---|---|
| Erläutert Funktionen und Konzepte | Zeigt kurze XML-Beispiele |
| Beschreibt Attribute und Best Practices | Zeigt direkt verwendbaren XML-Code |
| Vermittelt Hintergrundwissen | Unterstützt die tägliche Template-Erstellung |
Die Inhalte der Referenz Syntax orientieren sich an den XML-Cookbooks des Handbuchs.
Kundenspezifische Erweiterungen
Die Referenz Syntax ist selbst eine normale intracon:bk-Dokumentvorlage.
Sie kann daher bei Bedarf um weitere XML-Beispiele erweitert werden.
Dadurch lassen sich projektspezifische Konventionen oder häufig verwendete XML-Strukturen direkt innerhalb des Developers bereitstellen.
Empfehlung
Eigene Erweiterungen sollten möglichst am Ende der Referenz ergänzt werden.
Dadurch lassen sich zukünftige Aktualisierungen der Standardreferenz einfacher übernehmen.
Best Practices
- Verwenden Sie die Referenz Syntax als Schnellnachschlagewerk während der Template-Entwicklung.
- Nutzen Sie die Suchfunktion anstelle des manuellen Scrollens.
- Übernehmen Sie Beispiele als Ausgangspunkt und passen Sie diese anschließend an den jeweiligen Anwendungsfall an.
- Nutzen Sie das XML-Handbuch für Hintergrundinformationen und Best Practices.
Developer-Tipp
Die Referenz Syntax ersetzt nicht das XML-Handbuch.
Sie dient vielmehr als integrierter „Spickzettel“ für häufig benötigte XML-Strukturen und ermöglicht einen schnellen Einstieg in die praktische Umsetzung.