3.869
Bearbeitungen
Änderungen
keine Bearbeitungszusammenfassung
{{#customtitle:Leitfaden erstellenmit Mediawiki -> Kann gelöscht werden}}
Mit dem Wiki Portal von HL7 Austria wird das Ziel verfolgt, alle Implementierungsleitfäden und dazugehörigen Dokumente, Terminologien, Templates und sonstiges im Wiki verfügbar zu machen. Um einen Leitfaden zu veröffentlichen, ist eine Reihe von Schritten durchzuführen. Die Leifäden bzw. die zugehörigen Teildokumente müssen nach bestimmten Kriterien erstellt werden, um als Leitfäden oder als Teil davon erkannt zu werden und die Extraktionsmöglichkeit als PDF-Dokument zu ermöglichen.
=Leitfaden im Wiki erstellen=
* [[#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
Beispiel:
<pre>
</pre>
===in In Bearbeitung/UnderConstruction===
Um 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“ gekennzeichnet:
<pre>
</pre>
===FormatierungenStrukturbeispiele ===Damit das Für die [[Hilfe:Wiki#InhaltsverzeichnisBekannte_Vorlagen|InhaltsverzeichnisStrukturbeispiele]] rechts aufscheint und bitte die jeweils entsprechenden Vorlagen verwenden. === Inhaltsverzeichnis === Damit das Inhaltsverzeichnis richtig dargestellt wird, die Vorlage [[Hilfe:Wiki#Strukturbespiel_einf.C3.BCgenRechtsausgerichtetes_Inhaltsverzeichnis|StrukturbeispieleILF-TOC limit]] richtig formatiert sind, muss folgender Code eingefügt werdeneinbinden:
<pre>
{{#css:@media screen{.orange{ border: thin black solid; backgroundILF-color:#F4C789; padding: 5px 5px 5px 5px; margin-left:6px; width:70%;}.violet{ border: thin black solid; background-color:#E5D0EE; padding: 5px 5px 5px 5px; margin-left:6px; width:70%;}.toc{ width: 20%; float: right !important; margin: 10px 0px 10px 30px !important; border: 1px solid #AAA; background-color: #F9F9F9; display: table; padding: 7px !important;}}TOC limit}}
</pre>
===Versionierung===
Die Versionierung der Leitfäden erfolgt über den Namespace und [[Hilfe:Flagged Revisions|Flagged Revision]].
Wird eine neue Version eines Leitfadens erarbeitet, so muss
* die Seiten der alten Version, die unverändert bleiben, können so inkludiert werden
* die Seiten, die geändert werden müssen, müssen neu angelegt werden
=== Verlinkung von Leitfäden ===
Innerhalb der Leitfäden werden häufig Abschnitte desselben oder von anderen Leitfäden verlinkt. Dabei müssen folgende Regeln eingehalten werden:
* Links, die zu Abschnitten innerhalb desselben Leitfadens führen, müssen in dem Format <code>[#Abschnitt|alternativer Text]</code> angegeben werden. Dadurch ist es für eine neue Hauptversion möglich, den Wiki-Quelltext einfach in eine neue Seite zu kopieren, ohne die Links zu den Abschnitten anpassen zu müssen.
* Links zu anderen Leitfäden müssen auf die entsprechende Hauptversion gesetzt werden (z.B. <code><nowiki>[[ILF:Allgemeiner Implementierungsleitfaden 2020#Wichtige unterstützende Materialien|alternativer Text]]</nowiki></code>).
** Grundsätzlich sollte darauf geachtet werden, dass sich Leitfäden nicht gegenseitig referenzieren. Dh. eine Kette/Hierarchie wäre zulässig, zirkuläre Referenzen nicht.
* Eine Überprüfung der Links für jeden Leitfaden sollte vor der Veröffentlichung vorgenommen werden (z.B. kann im Wiki-Quelltext nach <code>[[</code> gesucht werden). Alternative Vorschläge dafür sind gerne willkommen.
'''Zu beachten:''' jede neue Hauptversion erhält eine eigene neue Wiki-Seite (z.B. Allgemeiner_Implementierungsleitfaden_2020 bzw. die nächste Hauptversion Allgemeiner_Implementierungsleitfaden_2022).
==Art-Decor Templates einbinden==
* [[Media:elga.zip|elga.css]]<br/>
: = elgaspezifisches Stylesheet
Alle nötigen Parameter können beim Programmstart via Skript mitgegeben werden.
Inhalt eines '''Beispiel-Batchfiles (.bat)''' für Wiki-Druck des Allgemeinen Leitfadens 2020 ('''abgenommene Version''' / "stable Version" / "Lese-Ansicht"): (die Pfade sind entsprechend anzupassen):
<br>
<code>
"C:\Program Files (x86)\Prince\engine\bin\prince" "https://wiki.hl7.at/index.php?title=ILF:Allgemeiner_Implementierungsleitfaden_2020" -v --javascript -o "C:\Users\User_x\Downloads\ILF_ALF_2020.pdf" -s "http://wiki.hl7.at/index.php?title=MediaWiki:Common.css&usemsgcache=yes&ctype=text%2Fcss&smaxage=18000&action=raw&maxage=18000" -s "http://wiki.hl7.at/index.php?title=-&action=raw&maxage=18000&gen=css" -s "http://wiki.hl7.at/index.php? title=MediaWiki:Geshi.css&usemsgcache=yes&action=raw&ctype=text/css&smaxage=18000" -s "https://wiki.hl7.at/extensions/ELGA-Prince/elga.css"
</code>
'''Beispiel-Skript''' für Wiki-Druck den des Allgemeinen Leitfadens 2020 - '''Revisions-Version''' (die Pfade sind entsprechend anzupassen, hier muss zusätzlich zu dem Leitfaden-Link "&stable=0" angegeben werden):
<br>
<code>
"C:\Program Files (x86)\Prince\engine\bin\prince" "https://wiki.hl7.at/index.php?title=ILF:Ambulanzbefund&stable=0" -v --javascript -o "C:\Users\User_x\Downloads\ILF_AMB_2020.1_Revsion.pdf" -s "http://wiki.hl7.at/index.php?title=MediaWiki:Common.css&usemsgcache=yes&ctype=text%2Fcss&smaxage=18000&action=raw&maxage=18000" -s "http://wiki.hl7.at/index.php?title=-&action=raw&maxage=18000&gen=css" -s "http://wiki.hl7.at/index.php? title=MediaWiki:Geshi.css&usemsgcache=yes&action=raw&ctype=text/css&smaxage=18000" -s "https://wiki.hl7.at/extensions/ELGA-Prince/elga.css"
</code>
=Häufige Probleme=
