Änderungen

Wechseln zu: Navigation, Suche

Hilfe:Leitfaden erstellen

134 Bytes hinzugefügt, 15:45, 15. Jul. 2021
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=
==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>
==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>
//Neue Seite wird im Namespace ILF angelegt
[[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.
 
==Versionierung 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==
===Versionierung===
Die Versionierung der Leitfäden erfolgt über den Namespace und [[Hilfe:Flagged 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==
Alle nötigen Parameter können beim Programmstart via Skript mitgegeben werden.
Inhalt eines '''Beispiel-Skript Batchfiles (.bat)''' für Wiki-Druck des Allgemeinen Leitfadens 2020(''' (abgenommene Version ''' / "stable Version" / "Lese-Ansicht"): (die Pfade sind entsprechend anzupassen):
<br>
<code>
</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>
3.869
Bearbeitungen

Navigationsmenü