Änderungen

Wechseln zu: Navigation, Suche

Hilfe:Leitfaden erstellen

1.607 Bytes hinzugefügt, 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>
==KonfigurationVerwendung von Namespaces==Alle Seiten des Wiki unterliegen dem Flagged Revisions VerfahrenWenn die Seite noch nicht angelegt wurde, das es ermöglicht, Seitenversionen zu markieren sowie kann von einer bestehenden Seite aus mit folgender Syntax eine stabile Seitenversion festzulegen (httpsSeite in einem Namespace angelegt werden:<pre>//Neue Seite wird im Namespace ILF angelegt[[ILF:NeueSeite]]</wwwpre>Wenn die Seite bereits erstellt wurde, kann die Seite unter dem Reiter "Mehr" mit "Verschieben" in den gewünscht Namespace verschoben werden.mediawiki.org/wiki/Extension:FlaggedRevsEinfach (statt Artikel). Die Seiten werden abschließend von so genannten Sichtern freigegebenden gewünschten Namespace auswählen und bestätigen.
Leitfäden sind meist lange Dokumente. Es ist deshalb sinnvoll==Versionierung von Wiki-Seiten==Alle Seiten des Wiki unterliegen dem [[Hilfe:Flagged_Revisions|Flagged Revisions Verfahren]], diese in Teildokumente zu unterteilendas es ermöglicht, die dann Seitenversionen zu einem einzigen Leitfaden zusammengefügt markieren sowie eine stabile (Reiter "Lesen") und current Seitenversion (Reiter "Revision") festzulegen (https://www.mediawiki.org/wiki/Extension:FlaggedRevs). Die Seiten werdenabschließend von so genannten Sichtern freigegeben.
===Hauptdokument=Aufbau eines Implementierungsleitfadens==Das Ein Implementierungsleitfaden teilt sich in einen technischen und einen textlichen Teil auf. Der '''Hauptdokumenttechnische Teil''' enthält ist für den Leser nicht sichtbar und beinhaltet folgende verpflichtend anzugebenden TeileAngaben:
* 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 mehrere Hundert A4-Seiten. Deshalb kann es sinnvoll sein, das Hauptdokument in Teildokumente zu unterteilen. Die Summe der Teildokumente ergibt somit einen Leitfaden.
 
===Hauptdokument===
Das Hauptdokument bildet den eigentlichen Leitfaden im Wiki ab 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 dies ebenfalls dem Namensbereich "ILF" zugeordnet sein.
Teildokumente werden im Hauptdokument folgendermaßen eingebunden: <br/>
<pre>{{ILF:Danksagung}}</pre>
 
===Teildokument===
Die Teildokumente enthalten den wiederverwendbare Textteile und müssen ebenfalls dem Namensbereich "ILF" zugeordnet werden.
 
===Typische Gliederung eines Dokuments===
In der Governance zur Erstellung von Leitfadenerstellung wird die [[ART-DECOR_Governance#Typische_Gliederung_eines_Dokuments|Typische Gliederung eines Dokuments]] vorgegeben.
 
===Vollständiges Beispiel eines Implementierungsleitfadens===
Beispiel:
<pre>
.
</pre>
 
===Teildokumente===
Jedes Teildokument enthält den eigentlichen Text. Zu beachten ist, dass Teildokumente in einem eigenen Namespace pro Leitfaden (Teildokumenten-Namespace) unterzubringen sind. <br/>
Beispiel: Inhalt des Dokuments elga-cdaalf-2.06.2:Harmonisierung
<pre>
=Harmonisierung=
'''Erarbeitung des Implementierungsleitfadens''' <br/>
Dieser Implementierungsleitfaden entstand durch die Harmonisierungsarbeit der „Arbeitsgruppe“ in den Jahren 2008-2012, bestehend aus nachfolgend genannten Personen:
</pre>
 
===Typische Gliederung eines Dokuments===
Ein typischer Leitfaden hat die folgenden Abschnitte bzw. Kapitel:
* Informationen über dieses Dokument
** Allgemeines
** Sprachliche Gleichbehandlung
** Verbindlichkeit
** Zielgruppe
** Hinweis auf verwendete Grundlagen
** 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
===Benutzerdefinierter Titel===
</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
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.
===KapitelstrukturNamespace/Namensraum===Der Jeder Leitfaden wird in einzelne Abschnitte unterteiltgehört zu einem Namespace, für die jeweils ein eigenes [[#Namespace|Namespace]] im Wiki angelegt wird. Diese Namespaces werden in das Hauptdokument transkludiertz. Auf der Hauptseite des Leitfadens werden alle Namespaces inkludiertBFolgende Kategorien sind derzeit in Gebrauch:* Allgemeiner Leitfaden: Elgaelga-cdaalfcdaps-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* für das Patient Summary: Elga-cdaps-2.06.2 Beispielhafter Aufbau eines Wiki-Leitfadens am Beispiel des Entlassungsbrief Darüberhinaus gibt es auch den allgemeinen Namespace ILF (ÄrztlichImplementierungsleitfäden):<pre><!--Einleitung>{{elga-cdaea-2, der alle Leitfäden vereint.06Wenn eine Seite in eine Hauptseite eingebunden werden soll, muss die Unterseite einem Namensraum zugehören.2:Einleitung}}<!--Anwendungsfälle-->{{elga-cdaea-2.06.2:Anwendungsfälle}} <!--CDA Header>{{elga-cdaea-2.06.2:CDA Header}}</pre>
===Namespace===
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.
Weitere Namespaces müssen im LocalSettings.php angelegt werden.
Die Der Namespace Name darf keine Bindestriche enthalten, der Titel aber schon!
<pre>
// Define constants for additional namespaces.
$wgExtraNamespaces[NS_ elga_cdaps2062_DISKUSSION] = " elga-cdaps-2.06.2_Diskussion";
</pre>
 
Im Generellen ist die Struktur der Namensräume folgendermaßen aufgebaut:
 
elga-cda | Abkürzung des Titels des Leitfadens | Version
Jeder Leitfaden gehört zu seinem eigenen Namespace und zum Namespace ILF.
Werden Seiten zu Kapitel aus anderen Leitfäden übernommen, so gehören sie zum Namespace des anderen Leitfadens.
 
====Neuen Namespace anlegen====
Um weitere Namensräume anzulegen, müssen diese in den LocalSettings.php definiert und eingefügt werden.
<pre>
// Define constants for additional namespaces.
define("NS_ILF", 3000); // This MUST be even.
define("NS_ILF_DISKUSSION", 3001); // This MUST be the following odd integer.
odd integer.
// Add namespaces.
$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>
===Versionierung===
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ü