XML-Technologien

XML-Technologien

Posts 1-2 of 2
  • Michael Voigt
    Michael Voigt    Premium Member
    The company name is only visible to registered members.
    XML Dokumentation
    Hallo,

    aktuell habe ich immer mit XML Dokumentationen im Wiki vorlieb nehmen müssen die keiner mehr pflegt :-(

    Ich bin heute auf eine Webseite gestoßen die Ihr Format auch online dokumentiert und finde deren Doku sehr übersichtlich, da es immer ein Beispiel gibt etc. Wie als wenn ich mein Rails code mit Rdoc dokumentiere.

    Hier der besagte Link:
    http://www.lenex.de/rules/lnxobjrul.html

    Dies haben die sicher nicht per Hand erstellt, hat da jemand einen Tipp?

    Herzliche Grüße,
    Michael
    • 20 Apr 2008, 7:14 pm
  • Karsten Kraus
    Karsten Kraus
    The company name is only visible to registered members.
    Re: XML Dokumentation
    Hallo,

    eine konkrete Software die sowas macht kenne ich leider auch nicht. Im Prinzip sollte sowas aber mit einer Kombination aus XML-Schema und XSLT machbar sein indem man die Schema-Definition entweder über "normale" XML-Kommentare dokumentiert

    z.B. <xs:element name="full_name" type="xs:string"><!-- Name und Vorname --></xs:element>

    oder über Attribute/Elemente in einem eigenen Namespace

    z.B. <xs:element name="full_name" type="xs:string" doc:description="Name und Vorname"/> bzw.

    <xs:element name="person">
    <doc:description>
    <![CDATA[Definiert alle Attribute einer Person blablablabla]]>
    </doc:description>
    </xs:element>

    Welche Felder Pflichtfelder etc. sind lässt sich aus dem Schema ja so schon auslesen.

    Jetzt braucht man "nur noch" ein entsprechendes XSLT, das den Dokumentationsanteil des Schemas in HTML/PDF/whatever transformiert.


    Gruß

    Karsten
    P.S.: Kaum habe ich beschrieben/überlegt, wie das gehen könnte, fallen mir auch schon die richtigen Suchbegriffe ein, so dass wir die Arbeit anderer nutzen können: XSDDoc (http://xframe.sourceforge.net/xsddoc/examples.html) macht das.
    P.P.S.: Man kann natürlich auch Geld ausgeben: TechWriter for XML Schemas (http://www.adivo.com/techwriter-for-xml-schemas.aspx) oder Stylus Studio (http://www.stylusstudio.com/xml_schema_doc_gen.html) bieten das Gleiche und mehr mit ner Windows-GUI.
    This post was modified on 20 Apr 2008 at 08:02 pm.
    • 20 Apr 2008, 7:51 pm