Gesamtstruktur

Gesamtstruktur

Beitragvon Sebastian Raring » 05 Mär 2013, 18:14

Hallo,

vielen Dank an Gerd Bernau für die Bereitstellung des Wiki.

Als Struktur würde ich vorschlagen uns an den besprochenen neuen Bezeichnungen zu orientieren:
  • B2BOptic Lenscatalog (SF6)
    • Einleitung
    • Allgemeine Spezifikationen
    • ... (entsprechend der PDF-Dokumentation)
  • B2BOptic Lensorder
    • Einleitung
    • Allgemeine Spezfikationen
    • header
      • timeStamps
      • orderParties
      • software
    • item
      • parties
      • pair
        • ... (entsprechend XSD)
      • stockLens
  • B2BOptic Info
    • Einleitung
    • Allgemeine Spezifikationen
    • ... (entsprechend XSD)
  • B2BOptic Request
    • Einleitung
    • Allgemeine Spezifikationen
    • ... (entsprechend XSD)
  • B2BOptic Webservice
    • Einleitung
    • Allgemeine Spezifikationen
    • ... (entsprechend XSD)

Bei der Orientierung am XSD habe ich bewußt die "tags" und nicht die ComplexTypes verwendet, da ein ComplexType mehrfalls in unterschiedlichen Zusammenhängen verwendet werden kann und ja auch soll. In einer Dokumentation muß man aber die Verwendung in einem bestimmten Zusammenhang beschreiben. Außerdem erleichtert es den Überblick, wenn man im XML einfach von oben nach unten durch die Struktur geht.

Die Version als Zwischenebene habe ich hier nicht verwendet.
Dafür und dagegen gibt es sicher verschiedene Argumente:
Für die Version spricht sicher ein einfacher Zugriff auf eine Dokumentation, die nur die Informationen für diese spezielle Version bietet. Außerdem vermutlich ein leichter Export in ein PDF.
Dagegen könnte sprechen, daß bei jeder neuen Version der komplette Baum kopiert werden muß. Gibt es hier schon erste Erfahrungen, wie einfach dies ist?
Das MediaWiki scheint ja intern eine Versionsverwaltung zu haben. Kann man dem Benutzer auch Links auf bestimmte Versionsstände anbieten? Also das man einen "tag" z.B. 6.10.1 beim Release erstellt und die Pflege dann einfach im Entwicklungszweig weitergeht, ohne das der Baum wirklich kopiert werden muß?
Sebastian Raring
 
Beiträge: 295
Registriert: 25 Okt 2007, 16:59
Wohnort: Leonberg

Re: Gesamtstruktur

Beitragvon Gerd Bernau » 05 Mär 2013, 19:16

Ja, hatte vergessen SF6 in Lenscatalog umzubenennen. Soll ja, wie beim letzten Treffen besprochen in b2bOptic übergehen.

Wenn ich es richtig verstehe, willst du die Tags links in der Sidebar darstellen. Durch die tiefe Verschachtelung ist dann nicht mehr wirklich Platz für den Content.

Ich würde nur die wichtigsten Informationen in die Sidebar aufnehmen:

  • B2BOptic Lenscatalog (SF6)
    • Einleitung
    • Allgemeine Spezifikationen
    • ... (entsprechend der PDF-Dokumentation)
  • B2BOptic Lensorder
    • Einleitung
    • Allgemeine Spezfikationen
    • Version 1.6.1 - Aktuell
      • simpleTypes
      • complexTypes
      • root
    • Version 1.6.2 - Beta
      • simpleTypes
      • complexTypes
      • root
  • B2BOptic Info
    • Einleitung
    • Allgemeine Spezifikationen
    • ... (entsprechend XSD)
  • B2BOptic Request
    • Einleitung
    • Allgemeine Spezifikationen
    • ... (entsprechend XSD)
  • B2BOptic Webservice
    • Einleitung
    • Allgemeine Spezifikationen
    • ... (entsprechend XSD)


Die gesamte XML-Strukur kann man dann auf der Seite "root" anschauen

Die Versionen habe ich Verwendet, damit eine aktuelle Version angezeigt wird und die zukünftige Version im Entwicklungsstand verfolgt werden kann. Ältere Versionen kann man Zeigen, muss man natürlich nicht.

Das gesamte WIKI wird im Gegensatz zu Mediawiki nicht in eine SQL-Datenbank gespeichert, sonder in einer Dateistruktur. Damit kann ein Revisionsstand einfach kopiert werden und in einen neuen Baum gehangen werden. Natürlich müssen wegen der Links noch ein paar arbeiten durchgeführt werden, ist aber nicht so aufwändig. Die Versionsverwalung habe ich in Mediawiki so wie du Sie angesprochen hast leider nicht gesehen.

Das Wiki arbeitet sehr gut mit Namespaces. Deshalb kann man innerhalb des WIKI mehrmals z.B. LensOrder.Dat als Seite anlegen. Eine Seite hat dann folgenden Namen

[[en:b2bOptic:lensorder:Version010601:Header.Dat|Header.dat]]
[[en:b2bOptic:lensorder:Version010602:Header.Dat|Header.dat]]


Hier hat man das Element Header.Dat auf zwei verschiedenen Seiten.

Im Hinblick der Internationalen Ausrichtung fand ich die Sprachenverwaltung hier sehr einfach.
Gerd Bernau
Site Admin
 
Beiträge: 766
Registriert: 09 Jun 2003, 20:56
Wohnort: Köln

Re: Gesamtstruktur

Beitragvon Gerd Bernau » 05 Mär 2013, 19:22

Zum Test der Sidebar habe ich mal eine neue Sprache zugefügt. Kann ja später wieder gelöscht werden.

http://wiki.b2boptic.com/us:sidebar

Dort kannst du mal die Struktur aufbauen, wie du es denkst.
Gerd Bernau
Site Admin
 
Beiträge: 766
Registriert: 09 Jun 2003, 20:56
Wohnort: Köln

Re: Gesamtstruktur

Beitragvon Sebastian Raring » 05 Mär 2013, 21:45

Gerd Bernau hat geschrieben:Zum Test der Sidebar habe ich mal eine neue Sprache zugefügt. Kann ja später wieder gelöscht werden.
http://wiki.b2boptic.com/us:sidebar
Dort kannst du mal die Struktur aufbauen, wie du es denkst.


Ich hatte mich schon gewundert, daß auf einmal eine Sprache mehr da war. Dachte schon, ich hätte zuviel ausprobiert. :wink:

Gerd Bernau hat geschrieben:Wenn ich es richtig verstehe, willst du die Tags links in der Sidebar darstellen. Durch die tiefe Verschachtelung ist dann nicht mehr wirklich Platz für den Content.
Ich würde nur die wichtigsten Informationen in die Sidebar aufnehmen:
[...]
Die gesamte XML-Strukur kann man dann auf der Seite "root" anschauen


Unter dem obigen Link habe ich mal eine größere Struktur vom Lensorder-XSD angelegt. Die Sidebar wird nun bei tiefer Verschachtelung bis auf 2 Buchstaben pro Zeile umgebrochen. :shock: Auch die Länge ist so natürlich nicht brauchbar.
Eine Lösung könnte eventuell dieses Plugin sein: https://www.dokuwiki.org/plugin:indexmenu
Sonst muß man sich wirklich auf 2-3 Root-Seiten pro Version beschränken, die dann selbst ein Art Inhaltsverzeichnis haben und auf die einzelnen Seiten verlinken.

Gerd Bernau hat geschrieben:Die Versionen habe ich Verwendet, damit eine aktuelle Version angezeigt wird und die zukünftige Version im Entwicklungsstand verfolgt werden kann. Ältere Versionen kann man Zeigen, muss man natürlich nicht.


Wenn dies als Dateien abgelegt wird und du die einfach kopieren kannst, ist dies natürlich eine gute Lösung.
Ich halte es grundsätzlich auch für sehr sinnvoll, daß man die Dokumentation von alten Versionen sich jederzeit wieder anschauen kann und diese öffentlich zugänglich sind. Es sind ja eigentlich immer mehrere Versionen parallel produktiv im Einsatz.
Ich würde vorschlagen, später im Echtbetrieb alle Versionen die einen Release-Status erreicht haben, auf Read-Only zu schalten, damit keine Änderungen mehr vorgenommen werden können und die Doku eingefroren ist.

Gerd Bernau hat geschrieben:Die Versionsverwalung habe ich in Mediawiki so wie du Sie angesprochen hast leider nicht gesehen.


Ich wollte eigentlich DokuWiki schreiben.
Mit Versionsverwaltung meinte ich dieses Changelog wo man bei jeder Seite drauf zugreifen kann. Aber das ist dann wirklich nicht mehr, als ein Änderungsprotokoll. Die Frage hat sich somit erledigt.
Sebastian Raring
 
Beiträge: 295
Registriert: 25 Okt 2007, 16:59
Wohnort: Leonberg

Re: Gesamtstruktur

Beitragvon Gerd Bernau » 06 Mär 2013, 09:35

Ich habe das Plugin mal installiert. Kannst ja mal testen.

In der us:sidebar, habe ich es mal eigefügt.

Konfigurier mal die Sidebar so, wie du es denkst.
Gerd Bernau
Site Admin
 
Beiträge: 766
Registriert: 09 Jun 2003, 20:56
Wohnort: Köln

Re: Gesamtstruktur

Beitragvon Gerd Bernau » 08 Mär 2013, 12:14

Habe herausgefunden, daß man für jeden Namespace eine eigene Sidebar anlegen kann.

Wenn ich z.B. unter "http://wiki.b2boptic.com/de:sf6:sidebar" eine Seite anlege, dann wird für alle Seiten, die unter dem Namespace "http://wiki.b2boptic.com/de:sf6" liegen diese Sidebar angezeigt.

Somit könnte dann unter "http://wiki.b2boptic.com/de:b2boptic:lensorder:version010502:Sidebar" eine Sidebar nur für die Version 1.5.2 angelegt werden und dort die XML struktur der einen Version angelegt werden.

Damit kann man es vermeiden eine "riesigen" Baum für alle WIKI-Themen anzulegen.
Gerd Bernau
Site Admin
 
Beiträge: 766
Registriert: 09 Jun 2003, 20:56
Wohnort: Köln

Re: Gesamtstruktur

Beitragvon Gerd Bernau » 11 Mär 2013, 13:18

Ich habe beispielhaft noch mal die Struktur der Sidebar geändert.

Auf der Hauptseite werden alle B2bOptic-Strukturen und weitere allgemeinen Infos aufgelistet.

http://wiki.b2boptic.com/de:start

Sobald man in einen detailierteren Bereich kommt, verringert sich die allgemeine Übersicht und es werden in der Sidebar weitere Detailinformationen zu dem ausgewählten Bereich angezeigt.

http://wiki.b2boptic.com/de:lenscatalog ... 1001:index
http://wiki.b2boptic.com/de:lensorder:v ... 0601:index

Die XML-Struktur in der Sidebar finde ich persönlich zu vollgepackt zun zu unübersichtlich. Daher würde ich der XML-Struktur eine eigene Seite gönnen

http://wiki.b2boptic.com/de:lensorder:v ... 1:struktur

Wobei ja nicht mein Geschmack zählen soll, sonder die Allgemeinheit sollte dies bestimmen.

Sagt mal wasmIhr davon haltet.
Gerd Bernau
Site Admin
 
Beiträge: 766
Registriert: 09 Jun 2003, 20:56
Wohnort: Köln

Re: Gesamtstruktur

Beitragvon Sebastian Raring » 12 Mär 2013, 21:58

Gerd Bernau hat geschrieben:Ich habe beispielhaft noch mal die Struktur der Sidebar geändert.

Auf der Hauptseite werden alle B2bOptic-Strukturen und weitere allgemeinen Infos aufgelistet.

http://wiki.b2boptic.com/de:start

Sobald man in einen detailierteren Bereich kommt, verringert sich die allgemeine Übersicht und es werden in der Sidebar weitere Detailinformationen zu dem ausgewählten Bereich angezeigt.

http://wiki.b2boptic.com/de:lenscatalog ... 1001:index
http://wiki.b2boptic.com/de:lensorder:v ... 0601:index


Die Idee finde ich nicht schlecht.
Ein Nachteil ist, daß es pro Version und Format (Catalog, Order, Info,...) eine Sidebar gibt. Bei Änderungen wie z.B. eine neue Version, müssen dann immer mehrere angepasst werden. Der Aufwand dürfte allerdings überschaubar sein.

Ich habe mir erlaubt an der Seite http://wiki.b2boptic.com/de:lensorder:version010601:sidebar drei Änderungen vorzunehmen:
  • aktueller Eintrag fett
  • zwei Linien zur besseren optischen Abgrenzung nach unten
  • leere Seite für SimpleTypes, da bei Struktur ein Zahlendreher im Namespace ist und somit die globale Sidebar angezeigt wird

Optisch fand ich es erst etwas komisch, daß das Detailmenü unter dem Hauptmenü steht.
Deshalb habe ich als Test eine Sidebar-Seite für "LensInfo" angelegt, wo das Detailmenü im Hauptmenü erscheint: http://wiki.b2boptic.com/de:lensinfo:version010601:index
Dort habe ich auch mal die horizontalen Linien im Menü entfernt. Für meinen Geschmack ist es ohne diese "Zwischenlinien" angenehmer, da die Einrückung schon die Struktur hervorhebt.

Gerd Bernau hat geschrieben:Die XML-Struktur in der Sidebar finde ich persönlich zu vollgepackt zun zu unübersichtlich. Daher würde ich der XML-Struktur eine eigene Seite gönnen

http://wiki.b2boptic.com/de:lensorder:v ... 1:struktur


Bei der gesamten XML-Struktur gebe ich dir recht. Allerdings finde ich den Einstieg über zumindest eine Teil-Struktur näher an der Praxis. Dem Benutzer des XML, also dem Programmierer der dies umsetzt oder der Support-Mitarbeiter der ein XML lesen möchte, interessiert sich meiner Meinung nach nicht für die XSD-Umsetzung von dem XML. Der geht durch den Baum und möchte wissen, wie der Zweig "orderParties" verwendet wird. Der weiß aber nicht, daß der vom ComplexType "Account" ist und er dort eine Dokumentation dazu und zu den anderen Stellen bekommt, wo dieser ComplexType verwendet wird.
Deshalb wäre mein Vorschlag, die oberen Ebenen der XML-Struktur mit in das Menü aufzunehmen. Zur tieferen Struktur kann man dann einerseits durch die von dir vorgeschlagene Struktur-Gesamtübersicht (als Seite) gelangen, oder über die jeweils tiefste Menüseite (z.B. lens zeigt den Baum unterhalb dieses Elements).
Den Einstieg über die Complex- oder Simpletypes würde ich als Index realisieren. d.h. eine Liste mit den Types und dahinter Links zu den Seiten, wo diese verwendet werden.
  • Account: orderParties, parties, patient
Sebastian Raring
 
Beiträge: 295
Registriert: 25 Okt 2007, 16:59
Wohnort: Leonberg

Re: Gesamtstruktur

Beitragvon Sebastian Raring » 13 Mär 2013, 01:14

Gerd Bernau hat geschrieben:Ich habe das Plugin mal installiert. Kannst ja mal testen.
In der us:sidebar, habe ich es mal eigefügt.
Konfigurier mal die Sidebar so, wie du es denkst.


Ich habe das Menü mal etwas getestet und mir die Doku dazu durchgelesen.
Der Nachteil scheint zu sein, daß nur Seiten angezeigt werden, die auch angelegt wurden. Das bedeutet, daß man eine neue Seite direkt auch für alle Sprachen anlegen muß, da diese sonst dort im Menü fehlt.

Damit das Menü auch richtige Titel anzeigt, muß man sich an ein paar Regeln halten und Optionen setzen:
  • Mit der globalen Option "useheading" (https://www.dokuwiki.org/config:useheading) wird durch den Wert "navigation" oder "1" die Verwendung des Titels als Bezeichnung für eine Seite eingeschaltet. Momentan wird hier quasi der Dateiname angezeigt.
  • Mit der Plugin-Option "headpage" (https://www.dokuwiki.org/plugin:indexmenu#namespaces_title_and_link_headpages) wird festgelegt, wie Dateiname der Titelseite für einen Namespace ist. Daraus wird dann wieder der Titel verwendet. Dies können auch versteckte Dummy-Seiten (Option "hide_headpage") sein, die nur einen Titel beinhalten.
  • Mit "Skip Namespaces in index" und "Skip Files in index" können mit Hilfe von Regulären Ausdrücken Einträge im Menü versteckt werden.
  • Die Reihenfolge der Seiten im Menü kann man nach verschiedenen Kriterien festlegen oder mit einem versteckten Kommando innerhalb der Seite überschreiben.
Sebastian Raring
 
Beiträge: 295
Registriert: 25 Okt 2007, 16:59
Wohnort: Leonberg

Re: Gesamtstruktur

Beitragvon Gerd Bernau » 13 Mär 2013, 12:52

Den kurzen XML-Abschnit, wie du ihn hier http://wiki.b2boptic.com/de:lensinfo:ve ... 0601:index eigefügt hat, finde ich OK. Man hat dadurch mehr Bezug zur Version.

Das aufklappbare Menü finde ich immer unsympatischer. Man klickt es sich zurecht, geht auf eine neue Seite und dann muss man die gewünschten Stellen wieder aufklappen. Wenn diese von vornherein aufgeklappt sind, dann ist die aufklappbare Variante wieder sinnlos.
Gerd Bernau
Site Admin
 
Beiträge: 766
Registriert: 09 Jun 2003, 20:56
Wohnort: Köln

Re: Gesamtstruktur

Beitragvon Gerd Bernau » 13 Mär 2013, 13:23

Sebastian Raring hat geschrieben: Dem Benutzer des XML, also dem Programmierer der dies umsetzt oder der Support-Mitarbeiter der ein XML lesen möchte, interessiert sich meiner Meinung nach nicht für die XSD-Umsetzung von dem XML.


Sehe ich genau anders. In der XSD stecken die wahren Informationen. Also muss die XSD beschrieben werden. Mann kann dann 2-3 Beispielbestellungen in eine Seite einfügen und bei jedem Element einen Verweis auf die XSD machen.

Andere Sache: Es gibt ein syntaxhighlighter für XML.

Schau mal hier: http://wiki.b2boptic.com/de:testpages:testpage2

Allerdings kann man da keine Links reinsetzen :-(
Gerd Bernau
Site Admin
 
Beiträge: 766
Registriert: 09 Jun 2003, 20:56
Wohnort: Köln


Zurück zu b2bOptic - WIKI

Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 1 Gast

cron