Hinweise

Aus Elexis-Wiki
Wechseln zu: Navigation, Suche

Aufbau der Dokumentation

Als Beispiele wie was aussehen könnte, dient die Seite zu Docbox" an.

Hier werden sowohl die OpenSource als auch die proprietären Plugin der Medelexis AG dokumentiert, damit nicht zu viel Reibungsverluste entstehen. Der Server auf dem das Wiki läuft wird von der Firma Medelexis gesponsort.

Konventionen

  • Es dürfen folgende Formate für die Bilder verwendet werden: PNG/JPG/GIF.
  • Bildernamen sollen
    • immer klein geschrieben werden.
    • Zur besseren Lesbarkeit kann man ein '_' einfügen
    • Bei Namenskolissionen mit schon vorhanden Bildern (z.B. einstellungen.png), Namen mit dem Kürzel des Projektes, gefolgt von '-' beginnen, z.B.
    • icpc-einstellung_dialog.png
  • Namen für die Dokumentation einer View/Feature/Perspektive brauchen den technischen Namen (mit Grossbuchstaben beginnen) also z.B. Ch.elexis.agenda und nicht einfach Agenda. Im Zweifelsfall Entwickler fragen. Niklaus wird sein Script nocht so anpassen, dass für alle notwendigen Teile automatisch Vorlagen erstellt werden.

Ideen

  • Namen, welche mit feature.feature.group enden auf feature kürzen (lesbarer). Evtl. mit Weiterleitungen oder eine Mediawiki-Regel umsetzen.
  • Niklaus möchte per Jubula GUI-Tests automatisch immer Schnapschüsse aller Views und Perspektien erstellen. Leider läuft dies nur beim manuellen Jubula-Durchlauf. Deshalb muss auf diese Idee zur Zeit verzichtet werden.
  • Das Plugin-Iatrix-Hilfe reaktivieren, damit aus jeder View/Perspektive direkt die Hilfe auf dem Wiki angesprungen werden kann. Evtl. sogar einloggen, damit man kleine Fehler sofort korrigieren kann.
  • Aufgrund einer Liste der installierten PlugIns ein Handbuch (z.B. als PDF erstellen). Für nicht installierte PlugIn jeweils ein Beschreibung was es kann und wann/wo der Einsatz sinnvoll ist

Bekannte Mängel

  • Vieles stammt noch aus der Elexis Version 1.4
  • Vereinheitlichung
  • Dokumentation einiger Plug-in fehlt ganz
  • Neue Kapitel/Anleitung für folgende Punkte
    • Aufsetzen einer Elexis-Installation
    • Best practices für Installation von Elexis im Netzwerk
    • Aktualisierung Stammdaten (für OpenSource)
    • Upgrade OpenSource von 2.1.7 auf 3.0 und Benutzung des Artikelstamms
    • Vor/Nachteile der verschiedenen KGs (Gerry, Hilotec, KG-Iatrix)
    • Vor/Nachteile der verschiedenen Textanbindungen (Noatext, OpenDocument, Text-Templator, MsWord)

Offene Fragen:

    • Nicht vergessen möchte ich, dass mehrere Sprachen (fr/it) und/oder ander Länder wie Oesterreich von der Dokumentation profitieren können. Ideen dazu sind
    • Auch hier Anforderungen für Mehrsprachigkeit, andere Länder berücksichtigen