Änderungen

Wechseln zu: Navigation, Suche

Hilfe:Leitfaden erstellen

713 Bytes entfernt, 10:30, 5. Dez. 2019
K
Aufbau eines Implementierungsleitfadens
{{#customtitle:Leitfaden erstellen}}
Mit dem Wiki Portal von HL7 Austria wird das Ziel verfolgt, alle Implementierungsleitfäden und dazugehörige dazugehörigen Dokumente, Terminologien, Templates und sonstiges im Wiki verfügbar zu machen. Um einen Leitfaden zu veröffentlichen, sind ist eine Reihe von Schritte Schritten durchzuführen und die . Die Leifäden bzw. die zugehörigen Teildokumente müssen nach bestimmten Kriterien erstellt werden, um als Leitfäden oder Teilen als Teil davon erkannt zu werden und um die Extraktionsmöglichkeit als PDF-Dokument zu ermöglichen.
=Workflow=
Die Einbindung eines neuen Leitfadens folgt einen einem vorgegebenen Prozess, dieser ist hier ersichtlich: unter[[Hilfe:Flagged_Revisions#Benutzung_von_Flagged_Revisions|Workflow]].
=Wiki-Hilfe=
Die Wiki Hilfe bietet eine Einführung, wie grundsätzlich mit einem Wiki gearbeitet wird und welche Markups zur Verfügung stehen: [[Hilfe:Wiki|How-to-Wiki]].
=Leitfaden im Wiki erstellen=
==Neue Seite anlegen==
Von einer bestehenden Seite aus kann mit folgender Syntax eine neue Seite angelegt werden: <pre>[[NeueSeite]]</pre><br/>
Sollen sich der Text des Links und der Seitenname unterscheiden , muss folgender Code benutzt werden: <pre>[[NeueSeite | Sichtbarer Text]]</pre> ===Neue Seite in einem Namespace anlegen/verschieben===Wenn die Seite bereits erstellt wurde, kann die Seite unter dem Reiter "Mehr" mit "Verschieben" in den gewünscht Namespace verschoben werden. Einfach statt (Artikel) den gewünschten Namespace auswählen und bestätigen.
==Verwendung von Namespaces==
Wenn die Seite noch nicht angelegt wurde, kann von einer bestehenden Seite aus mit folgender Syntax eine Seite in einem Namespace angelegt werden:
<pre>
[[ILF:NeueSeite]]
</pre>
Wenn die Seite bereits erstellt wurde, kann die Seite unter dem Reiter "Mehr" mit "Verschieben" in den gewünscht Namespace verschoben werden. Einfach (statt Artikel) den gewünschten Namespace auswählen und bestätigen.
==KonfigurationVersionierung von Wiki-Seiten==Alle Seiten des Wiki unterliegen dem [[Hilfe:Flagged_Revisions|Flagged Revisions Verfahren]], das es ermöglicht, Seitenversionen zu markieren sowie eine stabile (Reiter "Lesen") und current Seitenversion (Reiter "Revision") festzulegen (https://www.mediawiki.org/wiki/Extension:FlaggedRevs). Die Seiten werden abschließend von so genannten Sichtern freigegeben.
===Aufbau eines Implementierungsleitfadens===Ein Implementierungsleitfaden teilt sich in einen technischen und einen textlichen Teil auf. Der '''technische Teil''' ist für den Leser nicht sichtbar und beinhaltet folgende Angaben:
* eine [[#Infobox |Infobox ]]
* die BekanntgabeHinweis, das dass sich der Leitfaden [[#Under_ConstructionIn_Bearbeitung.2FUnderConstruction|in Bearbeitung]] befindet 
* [[#Formatierungen|Formatierung]] von Strukturbeispielen und dem Inhaltsverzeichnis
* die [[#Kapitelstruktur|trankludierten separat angelegten Abschnitte]] und [[#Namespace|Namespaces]]
* [[#SEO|Suchmaschinenoptimierung]]
Der '''textliche Teil ''' eines Wiki Leitfadens, beinhaltet den eigentlichen Inhalt(/Beschreibung) eines Implementierungsleitfaden. Implementierungsleitfäden sind sehr lange Dokumente und umfassen meist eine Seitenanzahl von über 200 mehrere Hundert A4 -Seiten. Deshalb ist kann es sinnvoll sein, das Hauptdokument in Teildokumente zu unterteilen. Die Summe der Teildokumente ergibt somit einen Leitfaden.
====Typische Gliederung eines Dokuments=Hauptdokument===Ein Das Hauptdokument bildet den eigentlichen Leitfaden wird typischerweise im Wiki ab und ist in folgende verschiedene Abschnitte gliederteingeteilt. Diese Abschnitte sind im Wiki sogenannten Teildokumente die in Summe den gesamten Leitfaden abbilden. Um die Teildokumente in das richtige Hauptdokument zu transkludieren, müssen dies ebenfalls dem Namensbereich "ILF" zugeordnet sein. Teildokumente werden im Hauptdokument folgendermaßen eingebunden:<br/>* Informationen über dieses Dokument** Allgemeines** Sprachliche Gleichbehandlung** Verbindlichkeit** Zielgruppe** Hinweis auf verwendete Grundlagen** <pre>{{ILF:Danksagung** Hinweise zur Nutzung des Leitfadens** Revisionsliste** Weitere unterstützende Materialien** Bedienungshinweise** Impressum* Harmonisierung* Einleitung** Ausgangssituation** Zweck** Hierarchie der Implementierungsleitfäden* Anwendungsfälle* Administrative Daten (CDA Header)* Fachlicher Inhalt (CDA Body)* Technische Konformitätsprüfung** Schema-Prüfung** Schematron-Prüfung** Online-Validation von CDA-Dokumenten* Anhang** Referenzen** Revisionsliste}}</pre>
====Hauptdokument=Teildokument===Das Hauptdokument bildet Die Teildokumente enthalten den eigentlichen Leitfaden im Wiki ab wiederverwendbare Textteile und ist in verschiedene Abschnitte eingeteilt. Diese Abschnitte sind im Wiki sogenannten Teildokumente die in Summe den gesamten Leitfaden abbilden. Um die Teildokumente in das richtige Hauptdokument zu transkludieren, müssen diese einen gewissen ebenfalls dem Namensbereich "ILF" zugeordnet sein. Teildokumente werden im Wiki folgendermaßen eingebunden: <br/><pre>elga-cdaalf-2.06.2:Harmonisierung</pre>
====Teildokument=Typische Gliederung eines Dokuments===Die Teildokumente enthalten den eigentlichen Text und müssen einem Namensbereich zugeordnet. Diese Namensbereiche werden im Vorhinein definiert und leiten sich aus den Titel des Leitfadens und In der Versionierung ab. Folgende Namensräume sind derzeit in Gebrauch:* Allgemeiner Leitfaden: Elga-cdaalf-2.06.2* XDS Metadaten: Elga-cdaxds-2.06.2* Entlassungsbrief (Ärztlich): Elga-cdaea-2.06.2* Entlassungsbrief (Pflege): Elga-cdaep-2.06.2* Pflegesituationsbericht: Elga-cdapsb-2.06.2* E-Medikation: Elga-cdaem-2.06.2* Laborbefund: Elga-cdalab-2.06.2* Laborbefund Version 2.06.03: Elga-cdalab-2.06.3* Befund Bildgebende Diagnostik: Elga-cdabgdGovernance zur Erstellung von Leitfadenerstellung wird die [[ART-2.06.2* Patient Summary: Elga-cdaps-2.06DECOR_Governance#Typische_Gliederung_eines_Dokuments|Typische Gliederung eines Dokuments]] vorgegeben.2
====Vollständiges Beispiel eines Implementierungsleitfadens====
Beispiel:
<pre>
</pre>
===Under ConstructionIn Bearbeitung/UnderConstruction===Um eine den Leser darauf hinzuweisen, dass dieser Leitfaden noch in Bearbeitung ist, muss die Vorlage „Underconstruction“ verwendet werden. Damit wird die Wiki-Seite visuell als "In Bearbeitung" zu kennzeichnen wird folgender Code verwendet„In Bearbeitung“ gekennzeichnet:
<pre>
{{Underconstruction}}
===Infobox===
Jeder Leitfaden beginnt mit einer hat eine Infobox, die alle zur Erstellung der Druckversion im PDF Format notwendigen Informationen enthält. Sie ist in der Online-Version nicht sichtbar.
<pre>
{{Infobox Dokument
</pre>
Für die Erstellung des PDF-Dokuments werden die Werte für Group, Title, Subtitle, Date, Version und Status übernommen. Die anderen Felder werden zurzeit nicht genutzt.
 
===Kapitelstruktur===
Der Leitfaden wird in einzelne Abschnitte unterteilt, für die jeweils ein eigenes [[#Namespace|Namespace]] im Wiki angelegt wird. Diese Namespaces werden in das Hauptdokument transkludiert. Auf der Hauptseite des Leitfadens werden alle Namespaces inkludiert.
 
Folgende Kategorien sind derzeit in Gebrauch:
* Allgemeiner Leitfaden: Elga-cdaalf-2.06.2
* XDS Metadaten: Elga-cdaxds-2.06.2
* Entlassungsbrief (Ärztlich): Elga-cdaea-2.06.2
* Entlassungsbrief (Pflege): Elga-cdaep-2.06.2
* Pflegesituationsbericht: Elga-cdapsb-2.06.2
* E-Medikation: Elga-cdaem-2.06.2
* Laborbefund: Elga-cdalab-2.06.2
* Laborbefund Version 2.06.03: Elga-cdalab-2.06.3
* Befund Bildgebende Diagnostik: Elga-cdabgd-2.06.2
* Patient Summary: Elga-cdaps-2.06.2
 
Beispielhafter Aufbau eines Wiki-Leitfadens am Beispiel des Entlassungsbrief (Ärztlich):
<pre>
<!--Einleitung>
{{elga-cdaea-2.06.2:Einleitung}}
<!--Anwendungsfälle-->
{{elga-cdaea-2.06.2:Anwendungsfälle}}
 
<!--CDA Header>
{{elga-cdaea-2.06.2:CDA Header}}
</pre>
===Namespace/Namensraum===
Jeder Leitfaden gehört zu einem Namespace, z.B. elga-cdaps-2.06.2 für das Patient Summary. Darüberhinaus gibt es auch den allgemeinen Namespace ILF (Implementierungsleitfäden), der alle Leitfäden vereint. Wenn eine Seite in eine Hauptseite eingebunden werden soll in eine Hauptseite, muss die Unterseite einem Namensraum zugehören.
Weitere Namespaces müssen im LocalSettings.php angelegt werden.
$wgExtraNamespaces[NS_ILF] = "ILF";
$wgExtraNamespaces[NS_ILF_DISKUSSION] = "ILF_Diskussion";
</pre>
 
Der neue Namensraum muss in der FlaggedRevs.php (Verzeichnis: extensions/FlaggedRevs/FlaggedRevs.php) eingefügt werden, ansonsten kann man Seiten, die diesem Namensraum angehören, nicht flaggen. Hierfür die FlaggedRevs.php öffnen und die Zahl, die für den Namespace vergeben wurde, nach an letzter Stelle des Arrays einfügen:
<pre>
# Allowed namespaces of reviewable pages
$wgFlaggedRevsNamespaces = [ NS_MAIN, NS_FILE, NS_TEMPLATE, 3000, 3002, 3004, 3006, 3008, 3010, 3012, 3014, 3016, 3018, 3020, 3030, 3032, 3034, 3036, 3038, 3040, 3042, 3044, 3046, 3048, 3050];
</pre>
Für die Transklusion gibt es zwei Möglichkeiten:<br/>
1. Einbinden eines [[Hilfe:Art-Decor-Tabellen_verstehen|Art-Decor]] Templates '''dynamisch''' (<br/>Die dynamische Möglichkeit stellt sicher, dass immer das Template einer bestimmten der letzten Version transkludiert wird, die Versionierung erfolgt unter Angabe des effectiveDate eingebunden ist. Somit werden Änderungen im Format YYYYArt-MM-DDDecor im Wiki Leitfaden automatisch mittels eines Bots nachgezogen.)Eingebunden können Templates bei dynamischer Verwendung durch folgenden Code:
<pre>
{{:OID-NR/dynamic}}
2. Einbinden eines Art-Decor Templates '''statisch''' (Zeitstempel):
Die statische Möglichkeit sieht vor eine bestimmten Version des Templates anhand des Zeitstempels einzubinden. Der Code hierfür lautet:
<pre>
{{:OID-NR/static-Datum-Zeit}}
{{:1.2.40.0.10.1.4.3.4.1.1.1/static-2013-12-16T000000}}
</pre>
Jedes Template hat eine Hauptseite mit der entsprechenden OID. Dazu gibt es ein bis mehrere Unterseiten mit der Namenskonvention /static-YYYY-MM-DD für die jeweilige statischen besteht also sozusagen aus verschiedenen Versionen (Static Versionen des Templates ) und eine Unterseite /dynamic, die über ein einen redirect (dynamic) wird auf das die aktuellste Template verweistVersion des Templates verwiesen.
==PDF Generierung==
: = elgaspezifisches Stylesheet
=FragenHäufige Probleme===Bei mir werden die Die Änderungen von der Unterseite werden nicht auf der Hauptseite nicht angezeigt==Dazu gehst du gehen Sie auf der Hauptseite auf den Reiter "Bearbeiten" und speicherst speichern den Beitrag gleich wieder mit dem Klick auf "Änderungen speichern". Jetzt werden die Änderungen von der Unterseite in die Hauptseite gezogen und sollten aufscheinen. ==Anlegen neuer Namespaces/Namensräume==Siehe hierzu Punkt [[#Neuen_Namespace_anlegen|Neuen Namespace anlegen]] ==Eingebettete Unterseite wird nicht angezeigt==Wenn eine Unterseite mit folgendem Code eingebettet wird <pre>{{Unterseite}}</pre>und nicht angezeigt wird, dann liegt es daran, dass die Unterseite nicht einem Namensraum zugeordnet ist.Lesen Sie bitte dazu den Schritt: [[#Neue_Seite_in_einem_Namespace_anlegen.2Fverschieben|Seite einem Namensraum zuordnen]]
2.168
Bearbeitungen

Navigationsmenü