Hilfe:Implementierungsleitfaden: Unterschied zwischen den Versionen
| Zeile 7: | Zeile 7: | ||
Das Hauptdokument enthält folgende verpflichtend anzugebenden Teile: | Das Hauptdokument enthält folgende verpflichtend anzugebenden Teile: | ||
| − | * eine Infobox Dokument (auszufüllende Vorlage) | + | * eine [[Vorlage:Infobox_Dokument|Infobox Dokument]] (auszufüllende Vorlage) |
| − | * bei Bedarf eine Infobox Ballot mit den bisherigen Stufen des Dokuments im Abstimmungsprozess | + | * bei Bedarf eine Infobox Ballot (als Begin und End Vorlage) mit den bisherigen Stufen des Dokuments im Abstimmungsprozess |
| − | * die trankludierten separat angelegten Abschnitte, eingefügt mit der Vorlage HL7transclude | + | * die trankludierten separat angelegten Abschnitte, eingefügt mit der Vorlage [[Vorlage:HL7transclude|HL7transclude]] |
* ein abschließendes <nowiki><references/></nowiki> Tag zum Aufführen aller in Haupt- und Nebendokumenten erwähnten Referenzen. | * ein abschließendes <nowiki><references/></nowiki> Tag zum Aufführen aller in Haupt- und Nebendokumenten erwähnten Referenzen. | ||
aus werden die einzelnen Teildokumente transkludiert. | aus werden die einzelnen Teildokumente transkludiert. | ||
Version vom 9. Juli 2011, 15:10 Uhr
Inhaltsverzeichnis
Wie erstelle ich einen Implementierungsleitfaden
Einleitung
HL7 hat sich zum Ziel gesetzt, alle Implementierungsleitfäden und dazugehörige Dokumente, Terminologien, Templates und sonstiges im Wiki verfügbar zu machen. Um einen Leitfaden hier zu veröffentlichen, sind eine Reihe von Voraussetzungen zu erfüllen und die Leifäden bzw. die zugehörigen Teildokumente müssen nach bestimmten Kriterien erstellt werden, um als Leitfäden oder Teilen davon erkannt zu werden und um die Extraktionsmöglichkeit als PDF-Dokument zu ermöglichen.
Grundsätzliches und Gute Praxis der Wiki-Leitfäden
Leitfäden sind meist lange Dokumente. Es ist deshalb sinnvoll, diese in Teildokumente zu unterteilen, die dann zu einem einzigen Leitfaden zusammengefügt werden.
Das Hauptdokument enthält folgende verpflichtend anzugebenden Teile:
- eine Infobox Dokument (auszufüllende Vorlage)
- bei Bedarf eine Infobox Ballot (als Begin und End Vorlage) mit den bisherigen Stufen des Dokuments im Abstimmungsprozess
- die trankludierten separat angelegten Abschnitte, eingefügt mit der Vorlage HL7transclude
- ein abschließendes <references/> Tag zum Aufführen aller in Haupt- und Nebendokumenten erwähnten Referenzen.
aus werden die einzelnen Teildokumente transkludiert.
Voraussetzungen
Namespaces
Jeder Leitfaden ist ein eigenständiges Dokument, dass im Wiki-Namespace "IG:" anzulegen und zu pflegen ist.
Beispiel: Das Hauptdokument des Leitfadens "Digitaler Mutterpass auf der Basis von CDA R2" ist angelegt als
IG:HL7_CDA_Mutterpass
Alle zugehörigen Dokumente sind in einem eigenen Wiki-Namespace unterzubringen.
 |
Dazu ist es nicht ausreichend, dass den Dokumenten ein Präfix mit abschließendem ":" vorangestellt wird, sondern die ausgezeichneten Wiki-Namespaces müssen gesondert vom Administrator eingetragen werden, damit sie als solche bekannt sind. |
Beispiel:
cdaemp:
ist der ausgezeichneten Wiki-Namespace für alle Dokumente zum Leitfaden "Digitaler Mutterpass auf der Basis von CDA R2". Alle zu diesem Leitfaden gehörenden Dokumente sind mit diesem Namespace-Präfix zu versehen. Das Hauptdokument des Leitfadens selbst ist im Namespace "IG:" angelegt.
Aufteilen der Dokumente
Der gesamte Leitfaden sollte in kleinere Abschnitte unterteilt werden. Sehr sinnvoll ist hier zum Beispiel das teilen in Kapitel oder in logische Abschnitte.
Beispiele: Der Leitfaden "Digitaler Mutterpass auf der Basis von CDA R2" ist in seine Kapitel aufgeteilt. Bei Leitfaden "Datentypen" ist die ebenso der Fall, zusätzlich sind hier die Beschreibungen der einzelnen Datentypen auch noch als kleine Teildokumente vorhanden, damit man ihren Text in anderen Dokumenten transkludieren oder referenzieren kann.
