3.869
Bearbeitungen
Änderungen
→Versionierung von Leitfäden
{{#customtitle:Arbeiten Leitfaden erstellen mit Mediawiki}}{{ILF-TOC limit|43}}
Die folgende Hilfeseite bietet Wiki-Einsteigern Informationen über das Arbeiten mit Wiki.<br />
Hier ein Überblick über die verschiedenen Themen:
= Einstieg ===Beiträge bearbeiten=Einführung =
HL7 Austria setzt sich zum Ziel in diesem Wiki alle relevanten Themen bezüglich eHealth Standards im österreichischen Gesundheitswesen der Gemeinschaft bereitzustellen. Da diese Themen Fachkenntnisse erfordern, hat man sich entschieden, den Betrachtern der Seite die Ansichtsversion zur Verfügung zu stellen, jedoch nicht die Bearbeitungsfunktion.
Weiters bietet die [[Hauptseite|Startseite]] einen Überblick über alle Themen.
===Sidebar anpassen===
Anpassungen können nur eingeloggte Admins vornehmen. Zum Ändern der Sidebar navigieren Sie auf die Seite ''MediaWiki:Sidebar'' und gehen Sie in den Bearbeitungsmodus.
Links erstellen Sie auf der zweiten Ebene mit zwei vorangestellten ** Sternen.
===Reiter-Logo ändern===
In der LocalSetting.php ist in folgender Zeile die Bilddatei zu ändern:
<pre>
</pre>
=Wiki-Seiten bearbeitenMediawiki Grundlagen=
==Neue Wiki-Seite erstellen==
Der erste Buchstabe des Links wird automatisch großgeschrieben. Leerzeichen werden in einen Unterstrich (_) umgewandelt. Man kann den Unterstrich auch selbst einsetzen, dieses wird aber nicht empfohlen.
===Verwendung von Namespaces===Wenn die Seite noch nicht angelegt wurde, kann von einer bestehenden Seite aus mit folgender Syntax eine Seite in einem Namespace (siehe nächstes Kapitel) angelegt werden:
<pre>
//Neue Seite wird im Namespace ILF angelegt
</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.
==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, muss die Unterseite einem Namensraum zugehören.
Weitere Namespaces müssen im LocalSettings.php angelegt werden.
Der Namespace Name darf keine Bindestriche enthalten, der Titel aber schon!
<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.
define("NS_elga_cdaps2062", 3002); // This MUST be even.
define("NS_elga_cdaps2062_DISKUSSION", 3003); // This MUST be the following odd integer.
// Add namespaces.
$wgExtraNamespaces[NS_ILF] = "ILF";
$wgExtraNamespaces[NS_ILF_DISKUSSION] = "ILF_Diskussion";
$wgExtraNamespaces[NS_ elga_cdaps2062] = " elga-cdaps-2.06.2";
$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.
z.B. der Leitfaden für das Patient Summary gehört auch zu elga-cdaps-2.06.2 und ILF
Alle Seiten zu allgemeinen Kapiteln, die für alle Leitfäden gleich sind, gehören zum Namespace ILF.
Alle Seiten zu spezifischen Kapiteln, die nur für diesen Leitfaden gelten, gehören zum Namespace des spezifischen Leitfadens z.B. elga-cdaps-2.06.2.
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>
==Benutzerdefinierter Seitentitel==
Um Unterseiten wieder zu finden sollten sie einer Kategorie zugeordnet werden.
==Webseiten verlinken==
</pre>
==PDF-Generierung==Für die Generierung eines PDF-Dokuments aus einer Wikiseite wird das Tool :'''PRINCE 11''' , free for non-commercial use (https://www.princexml.com/download/) verwendet. Die Version wird lokal auf dem Benutzerrechner gespeichert und das EXE-File aus dem Filesystem heraus aufgerufen. Die Quelle für das Dokument ist immer das Wiki. 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> ===Seitenumbruch (PDF)===
Ein Seitenumbruch für eine PDF-Version/Prince kann eingefügt werden über
<pre>
<p style="page-break-before: always"></p>
</pre>
==Querformat =Seitenausrichtung (PDF)===
Die Ausrichtung einer Seite kann im PDF auf quer geändert werden durch
<pre>
</pre>
Optionen: "landscape" | "portrait"
==Suchmaschinenoptimierung==
Metadaten sind Informationen im Quelltext einer Website, die an Suchmaschinen und Social Media übermittelt werden. Sie sind oftmals nicht direkt in den Inhalten der Website sichtbar, werden dafür aber als Vorschau der Website in Google, Bing, Facebook und Twitter dargestellt.
*Doppelte Metadaten vermeiden!
==Versionierung von Wiki-Seiten==
Die Versionierung erfolgt über [[Hilfe:Flagged Revisions|Flagged Revisions]] und [[Hilfe:Leitfaden_erstellen#Namespace.2FNamensraum|Namespaces]].
Dies ermöglicht es, Seitenversionen zu markieren sowie eine stabile (Reiter "Lesen") und current Seitenversion (Reiter "Revision") festzulegen. Die Seiten werden abschließend von so genannten Sichtern freigegeben.
=Formatierung=Formatierungen==
===Text===
{| class="wikitable"
!Beschreibung
|}
===Bilder===
Normalerweise würde man '''erst ein Bild in das Wiki hochladen''' ''bevor'' man folgenden Wikitext verwendet, um das Bild im Artikel einzubinden. Alternativ zu File: kann auch Datei: verwendet werden.
*<code><nowiki>[[Media:Example.jpg|link text]]</nowiki></code>
====Erweiterte Optionen====
Die komplette Syntax um ein Bild anzuzeigen ist:
<code><nowiki>[[File:{name}|{options}]]</nowiki></code>
Weitere Informationen unter [https://de.wikipedia.org/wiki/Hilfe:Bilder Wikipedia Hilfe Bilder]
===Tabellen===
Tabellen können in Media Wiki Seiten entweder direkt mit HTML Tabellenelementen geschrieben werden oder mit dem Wikicode. HTML Tabellenelemente und ihr Gebrauch werden auf verschiedenen Webseiten beschrieben und deshalb hier nicht besprochen. Der Wikicode nutzt Buchstabensymbole um die Tabellenstruktur im Artikel zu bilden, die in der Ansicht durch HTML Tabellenelemente ersetzt werden.
Generell sollte man die Verwendung von Tabellen vermeiden, außer es geht wirklich nicht anders. Der Tabellenaufbau verkompliziert meist das Bearbeiten von Seiten.
====Zusammenfassung Wiki-Tabellen-Code====
{| cellpadding="5" cellspacing="0" border="1"
*'''Inhalt''' kann (a) nach seiner Zellenmarkierung nach den optionalen XHTML-Eigenschaften in der gleichen Reihe stehen oder (b) unter der Zellenmarkierung. Inhalt, welcher Wiki Formatierung (wie Überschriften, Aufzählungen usw.) nutzt, muss am Anfang einer neuen Zeile stehen.
====Beispiele für Tabellen====
=====Einfache Form=====
Die folgende Tabelle hat keine Ränder oder gute Leerräume. Sie zeigt aber den einfachen Wiki Code für eine Tabellenstruktur
|}
*'''AlternativeForm'''
Für ein mehr tabellarisches Aussehen können im Wiki Markup die Zellen in einer Zeile aufgeführt werden. Die einzelnen Spalten müssen dabei mit || getrennt werden. Jedoch nimmt die Übersichtlichtkeit mit steigendem Textinhalt ab.
|}
=====Tabelle mit HTML-Eigenschaften=====
Durch das Hinzufügen von HTML-Eigenschaften lässt sich das Aussehen der Tabelle verändern.
|}
=====Tabelle mit HTML-Eigenschaften und CSS-Definitionen=====
CSS-Angaben können in Kombination mit oder ohne HTML-Eigenschaften verwendet werden.
|}
=====Tablenüberschriften=====
*'''TH-Kopfzeile'''
TH (HTML-Tabellenkopf) kann mit einem ! vor dem | erstellt werden. Diese Kopfzeile erscheint für gewöhnlich in fett und zentriert.
| colspan="2" |
=====Yummiest=====
|-
|Orange
|}
===Vorlagen===
Unter folgendem Link finden Sie alle existierenden Vorlagen:
https://wiki.hl7.at/index.php?title=Spezial%3APr%C3%A4fixindex&prefix=&namespace=10
====YellowBox====
Wird für themenbezogene Hinweise zur besonderen Beachtung verwendet.<br />
{| width="100%"
|}
====ILFBox====
Wird als Hinweis auf andere Implementierungsleitfäden verwendet.<br />
{| width="100%"
|}
====Code-Beispiele====
Wird für korrekte CDA-Beispielfragmente im XML Format verwendet.<br />
{| width="100%"
|}
====ValueSet Box====
Verweist auf ELGA Value Sets.<br />
{| width="100%"
|}
====Informationsbox /Errata Box====
Verweist auf bekannte Fehler und geplante Verbesserungen.
{| width="100%"
|}
===CSS===
Um benutzerdefinierte Formatierungen ins Wiki einzubinden, kann dies mittels folgendem Code realisiert werden:
<pre>
* [[#Inhaltsverzeichnis|Inhaltsverzeichnis]]
* [[#Strukturbeispiele|Strukturbeispiele]]
* die Kapitelstruktur bildet die typische Gliederung eines Leitfadens ab (TODO: Link zum Kapitel in der [https://confluence.elgawiki.gvhl7.at/pages/viewpageindex.actionphp?pageIdtitle=23791965 GovernaceART-DECOR_Governance Governance für die CDA-Leitfadenerstellung, Kapitel 4.2.4 Inhalt])
Optional stehen folgende Funktion bereit:
.
</pre>
==Versionierung von Leitfäden==
Die Versionierung der Leitfäden erfolgt über den Namespace und [[Hilfe:Flagged Revisions|Flagged Revision]].
== 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 ([[ATCDABBR|https://art-decor.org/art-decor/decor-templates--at-cda-bbr-?section=templates]] bzw. im entsprechenden Art-Decor-Projektrepository), 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 der letzten Version eingebunden ist. Somit werden Änderungen im Art-Decor im Wiki Leitfaden automatisch mittels eines Bots nachgezogen.
Eingebunden können Templates bei dynamischer Verwendung durch folgenden Code:
<pre>
{{:OID-NR/dynamic}}
</pre>
:Beispiel Rehabilitationsziele:
<pre>
{{:1.2.40.0.34.11.2.2.26/dynamic}}
</pre>
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}}
</pre>
:Beispiel eMedikationRezept:
<pre>
{{:1.2.40.0.10.1.4.3.4.1.1.1/static-2013-12-16T000000}}
</pre>
Jedes Template besteht also sozusagen aus verschiedenen Versionen (Static Versionen) und über einen redirect (dynamic) wird auf die aktuellste Version des Templates verwiesen.
