Änderungen

Wechseln zu: Navigation, Suche

Hilfe:Leitfaden erstellen

6.219 Bytes hinzugefügt, 15:45, 15. Jul. 2021
keine Bearbeitungszusammenfassung
{{#customtitle:HilfeLeitfaden erstellen mit Mediawiki -> Kann gelöscht werden}}Mit dem Wiki Portal von HL7 Wiki 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 Voraussetzungen zu erfüllen und die Schritten durchzuführen. 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 einem vorgegebenen Prozess, dieser ist ersichtlich unter[[Hilfe:Flagged_Revisions#Benutzung_von_Flagged_Revisions|Workflow]].
=Wiki-Hilfe=
Das Die Wiki Hilfe bietet selbst 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>
==Konfiguration==
Alle Seiten des Wiki unterliegen dem Flagged Revisions Verfahren, das es ermöglicht, Seitenversionen zu markieren sowie eine stabile Seitenversion festzulegen (https://www.mediawiki.org/wiki/Extension:FlaggedRevs). Die Seiten werden abschließend von so genannten Sichtern freigegeben.
Leitfäden sind meist lange Dokumente==Aufbau eines Implementierungsleitfadens==Ein Implementierungsleitfaden teilt sich in einen technischen und einen textlichen Teil auf. Es Der '''technische Teil''' ist deshalb sinnvoll, diese in Teildokumente zu unterteilen, die dann zu einem einzigen Leitfaden zusammengefügt werden. <br/>Das Hauptdokument enthält 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]]
 
Optional stehen folgende Funktion bereit:
* [[#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.  ===Benutzerdefinierter TitelHauptdokument===Ermöglicht 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 Ändern des Seitentitels mittelsrichtige Hauptdokument zu transkludieren, müssen dies ebenfalls dem Namensbereich "ILF" zugeordnet sein. Teildokumente werden im Hauptdokument folgendermaßen eingebunden: <br/><pre>{{#customtitleILF:Neuer TitelDanksagung}}</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.
===SEOVollständiges Beispiel eines Implementierungsleitfadens===[[Hilfe:Wiki#SEO|SEO]] ist eine Maßnahme, um das Ranking in Suchmaschinen zu optimieren. <br/>CodeBeispiel:
<pre>
{{#seo:
|title=LOINCEntlassungsbrief (Ärztlich)
|titlemode=append
|keywords= Entlassungsbrief,Entlassungsbrief Ärztlich,Ärztlicher Entlassungsbrief,CDA, Leitfaden, Leitfäden, LOINC, ELGASpezielle Leitfäden, Arzt, Krankenhaus, Informationsausstausch, Gesundheitsdienstleitster, GDA, Medizin, Patienten|description=Dieser Leitfaden erklärt das Vorgehen beim „Mapping“, Ein Entlassungsdokument enthält die medizinisch relevanten Teile der korrekten Zuordnung von lokalen Laborcodes zu Geschichte eines Patienten und ist für den standardisierten Codes für ELGAInformationsaustausch zwischen Gesundheitsdienstleistern bestimmt.
}}
</pre>{{#customtitle:Entlassungsbrief (Ärztlich)}}
===Under Construction===
Um eine Seite visuell als "In Bearbeitung" zu Kennzeichnen wird folgender Code verwendet:
<pre>
{{Underconstruction}}
</pre!--  Implementierungsleitfaden "Entlassungsbrief (Ärztlich)" >
===Formatierungen===
Damit das [[Hilfe:Wiki#Inhaltsverzeichnis|Inhaltsverzeichnis]] rechts aufscheint und die [[Hilfe:Wiki#Strukturbespiel_einf.C3.BCgen|Strukturbeispiele]] richtig formatiert sind, muss folgender Code eingefügt werden:
<pre>
{{#css:
@media screen{
}
}}
 
{{Infobox Dokument
|Group = ELGA CDA<br/>Implementierungsleitfäden
|Title = HL7 Implementation Guide for CDA<sup>&reg;</sup> R2:<br/>Entlassungsbrief (Ärztlich)
|Subtitle = Zur Anwendung im österreichischen<br/>Gesundheitswesen [1.2.40.0.34.7.1.6.2]
|Short = Entlassungsbrief (Ärztlich)
|Namespace = elga-cdaea-2.06.2
|Type = Implementierungsleitfaden
|Version = 2.06.2
|Submitted = HL7 Austria
|Date = 20. März 2017
|Copyright = 2017-2021
|Status = Entwurf
|Period = n.a.
|OID = n.n.
|Realm = Österreich
}}
 
<!--
{{Infobox Contributors Begin}}
{{Contributor | Logo = Logo.jpg | Name = Abc | Location = Hürth }}
{{Infobox Contributors End}}
>
 
=Informationen über dieses Dokument=
{{ILF:Allgemeines}}
{{ILF:Verbindlichkeit}}
{{ILF:Zielgruppe}}
{{ILF:Hinweis auf verwendete Grundlagen}}
{{ILF:Danksagung}}
{{ILF:Hinweise zur Nutzung des Leitfadens}}
.
.
.
</pre>
 
===Benutzerdefinierter Titel===
Ermöglicht das Ändern des Seitentitels mittels:
<pre>
{{#customtitle:Neuer Titel}}
</pre>
 
===SEO===
[[Hilfe:Wiki#SEO|SEO]] ist eine Maßnahme, um das Ranking in Suchmaschinen zu optimieren. <br/>
Code:
<pre>
{{#seo:
|title=LOINC
|titlemode=append
|keywords= Leitfaden, Leitfäden, LOINC, ELGA, Arzt, Krankenhaus, Informationsausstausch, Gesundheitsdienstleitster, GDA, Medizin, Patienten
|description=Dieser Leitfaden erklärt das Vorgehen beim „Mapping“, der korrekten Zuordnung von lokalen Laborcodes zu den standardisierten Codes für ELGA
}}
</pre>
 
===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>
{{Underconstruction}}
</pre>
 
=== Strukturbeispiele ===
 
Für die [[Hilfe:Wiki#Bekannte_Vorlagen|Strukturbeispiele]] bitte die jeweils entsprechenden Vorlagen verwenden.
 
=== Inhaltsverzeichnis ===
 
Damit das Inhaltsverzeichnis richtig dargestellt wird, die Vorlage [[Hilfe:Wiki#Rechtsausgerichtetes_Inhaltsverzeichnis|ILF-TOC limit]] einbinden:
 
<pre>
{{ILF-TOC limit}}
</pre>
===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, z.B. elga-cdaps-2.06.2 für die jeweils eine eigene Kategorie im Wiki angelegt wird. Diese Kategorien werden in das Hauptdokument transkludiertPatient Summary. Auf Darüberhinaus gibt es auch den allgemeinen Namespace ILF (Implementierungsleitfäden), der alle Leitfäden vereint. Wenn eine Seite in eine Hauptseite des Leitfadens eingebunden werden alle Kapitel inkludiertsoll, muss die Unterseite einem Namensraum zugehören.
Folgende Kategorien sind derzeit in Gebrauch:* Allgemeiner Leitfaden: Elga-cdaalf-2Weitere Namespaces müssen im LocalSettings.06php angelegt werden.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<!--* Allgemeiner Leitfaden: [[Kategorie:Elga-cdaalf-2.06.2|Elga-cdaalf-2.06.2]]* XDS Metadaten: [[Kategorie:Elga-cdaxds-2.06.2|Elga-cdaxds-2.06.2]]* Entlassungsbrief (Ärztlich): [[Kategorie:Elga-cdaea-2.06.2|Elga-cdaea-2.06.2]]* Entlassungsbrief (Pflege): [[Kategorie:Elga-cdaep-2.06.2|Elga-cdaep-2.06.2]]* Pflegesituationsbericht: [[Kategorie:Elga-cdapsb-2.06.2|Elga-cdapsb-2.06.2]]* E-Medikation: [[Kategorie:Elga-cdaem-2.06.2|Elga-cdaem-2.06.2]]* Laborbefund: [[Kategorie:Elga-cdalab-2.06.2|Elga-cdalab-2.06.2]]* Laborbefund Version 2.06.03: [[Kategorie:Elga-cdalab-2.06.3|Elga-cdalab-2.06.3]]* Befund Bildgebende Diagnostik: [[Kategorie:Elga-cdabgd-2.06.2|Elga-cdabgd-2.06.2]]* Patient Summary: [[Kategorie:Elga-cdaps-2.06.2|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===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 können 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===
Die Versionierung der Leitfäden erfolgt über den Namespace und [[Hilfe:Wiki#Flagged_RevisionFlagged Revisions|Flagged Revision]]. Beispiel:<br/>elga-cdaalf-2.06.2 … Allgemeiner Leitfaden V2.06.2 <br/>elga-cdaalf-2.07 … Allgemeiner Leitfaden V2.07
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==
Die Templates für den Leitfaden werden in ArtDecor modelliert (http://art-decor.org/art-decor/decor-project--elga-) und mittels eines Bots ins Wiki übertragen und in den Leitfaden transkludiert. Die Identifizierung der Templates erfolgt über ihre OID, über die sie auch als Wikiseite aufgerufen werden können.
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==
Es kommen drei Stylesheets zur Anwendung:
* [[Media:Common.zip|MediaWiki:Common.css ]] <br/>
: = Stylesheet für das Aussehen des MediaWikis am Bildschirm
* [[Media:Geshi.zip|MediaWiki:Geshi.css]]* [[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=
==Die Änderungen der Unterseite werden nicht auf der Hauptseite angezeigt==
Dazu gehen Sie auf der Hauptseite auf den Reiter "Bearbeiten" und 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]]
3.869
Bearbeitungen

Navigationsmenü