Hilfetext editieren

Table of contents

1 XML Article

Ein XML-Article ist wie folgt aufgebaut:

Ein Beispiel:

 
        <body>
   <section id="history">
            <title></title>
            <para>
             Siehe <link ref="/IAR/PAF/PAF00000000000002938">Importanbindung</link>
            </para>
          </section>
          <section id="solution">
            <title></title>
            <para></para>
            <subsection id="solution-sub-modul">
              <title></title>
              <para></para>
              <list>
                <elem>Sample</elem>
              </list>
              <image src="architek:///IAR/PNG/$PAF02938-DEPLOYMENT/DEU"/>
            </subsection>
          </section>
          <section id="test">
            <title></title>
            <list>
              <def><tag>Teilnehmer</tag><desc>Christian, Heiko, Jens J., Klaus, Oliver</desc></def>
              <def><tag>Dauer</tag><desc>10:00 - 14:00</desc></def>
            </list>
          </section>
        </body>

Ein Article baut sich aus sogenannten Tags auf. Ein Beispiel fuer einen Tag sieht man im obigen Beispiel: <body>...</body>. Zu erkennen ist ein Teil mit und ohne Slash. Der Teil <body> ohne slash ist der Anfang. Der Teil </body> mit slash ist das Ende. Nur mit Anfang und Ende ist das Tag gültig.

Der Body fängt im Beispiel ab <body> an und endet bei </body>

Es ist erlaubt Tags zu schachteln (wie (Klammern)). Dabei ist darauf zu achten, dass immer der richtige Anfangs-Tag mit dem richigen End-Tag korrespondiert. Das Beispiel zeigt: in den <body>...</body> Tag ist ein Section-Tag geschachtelt.

 
          <body>
            <section id="xml-article">
            </section>
          </body>

Das Section-Tag hat ein sogenanntes Attribut id mit der Wertigkeit "xml-article". Attribute befinden sich immer im Begin-Tag: <section id="A" ></section>

Wer bestimmt nun wie die Tags in einander geschachtelt werden?

Wir haben hierzu eine Struktur speziell für unsere (Hilfe)-Texte und Dokumente entwickelt.Die Definition steht in der Datei article.xsd und section.xsd. Anhand dieser Definition kann IDLKONSIS die exakte Syntax überprüfen.

2 Spezielle-Zeichen und Zeichen-Ketten im XML

Im XML müssen bestimmte Zeichen speziell codiert werden.

< Zeichen
coding im XML &lt;
& Zeichen
coding im XML &amp;
IDL mit spezifischer Formatierung
coding im XML &company; (im Plaintext Editor auf Syntax achten! Wenn es nicht geht muß unter Umständen der Plaintext-Editor in der INI-Datei freigeschaltet werden und der TEXT berichtigt werden !!!)
IDL KONSIS ODER!!! IDL WINKONS mit spezifischer Formatierung
coding im XML &product; Zu verwenden wenn das eigentliche Produkt benannt werden soll !!! (im Plaintext Editor auf Syntax achten! Wenn es nicht geht muß unter Umständen der Plaintext-Editor in der INI-Datei freigeschaltet werden und der TEXT berichtigt werden !!!)
IDL PLUS mit spezifischer Formatierung
coding im XML &plus; (im Plaintext Editor auf Syntax achten! Wenn es nicht geht muß unter Umständen der Plaintext-Editor in der INI-Datei freigeschaltet werden und der TEXT berichtigt werden !!!)
IDL FORECAST mit spezifischer Formatierung
coding im XML &forecast; (im Plaintext Editor auf Syntax achten! Wenn es nicht geht muß unter Umständen der Plaintext-Editor in der INI-Datei freigeschaltet werden und der TEXT berichtigt werden !!!)
IDL IMPORTER mit spezifischer Formatierung
coding im XML &importer; (im Plaintext Editor auf Syntax achten! Wenn es nicht geht muß unter Umständen der Plaintext-Editor in der INI-Datei freigeschaltet werden und der TEXT berichtigt werden !!!)
IDL COCKPIT mit spezifischer Formatierung
coding im XML &cockpit; (im Plaintext Editor auf Syntax achten! Wenn es nicht geht muß unter Umständen der Plaintext-Editor in der INI-Datei freigeschaltet werden und der TEXT berichtigt werden !!!)
IDL CONNECTOR mit spezifischer Formatierung
coding im XML &connector; (im Plaintext Editor auf Syntax achten! Wenn es nicht geht muß unter Umständen der Plaintext-Editor in der INI-Datei freigeschaltet werden und der TEXT berichtigt werden !!!)
IDL KONSIS / IDL WINKONS mit spezifischer Formatierung (die Produkte, für die es den Connector gibt)
coding im XML &connectorproducts; (im Plaintext Editor auf Syntax achten! Wenn es nicht geht muß unter Umständen der Plaintext-Editor in der INI-Datei freigeschaltet werden und der TEXT berichtigt werden !!!)

3 Die XML-Artikel-Tags

Von den XML Hilfe-Artikel sehen wir nur den Bereich ab dem Body-Tag. Um den Rest kümmert sich die IDLKONSIS-GUI ;-)

Im der folgenen Sektion werden die einzelnen Tags aufgeführt. Es wird beschrieben ob ein spezelles Attribut verlangt wird und welche Tags hineingeschachtelt werden können oder müssen.

body
Der Body kann 0 oder mehrere sectionen tags enthalten oder alternative tags. Diese alternativen Tags sind das para, code, list, table und das image tag. Die Alternativen dürfen beliebig häufig angewendet werden. Beispiel: <body>...</body>
caption
Dieses Tag kann beliebigen Text haben. Beispiel: <caption>...</caption>
cell
Ein cell Tag kann freien Text oder eines der folgenden Tags enthalten: emph, link oder comment Beispiel: <cell>...</cell>
code
Ein code Tag kann freien Text oder eines der folgenden Tags enthalten: emph, link oder comment Beispiel: <code>...</code>
col
Das folgende Element ist wegen fehlender Funktionalität in FOP notwendig. Beispiel: <col>...</col>
comment
Ein link Attribut ist notwendig. Dieses Tag kann beliebigen Text haben.
datetime
Dieses Tag kann beliebigen Text haben.
def
Ein type Attribut kann angegeben werden. Das type Attribut darf die Werte simple oder ordered annehmen. Der Defaultwert (wenn nichts angegeben wird)ist simple. Ein def Tag enthält ein tag Tag und ein desc Tag zwingend. Beispiel: <def><tag></tag><desc></desc></def>
desc
Ein desc Tag kann freien Text oder eines der folgenden Tags enthalten: emph, link oder comment Beispiel: <desc><link></link></desc>
elem
Ein elem Tag kann freien Text oder eines der folgenden Tags enthalten: emph, link oder comment Beispiel: <elem><link></link></elem>
emph
Dieses Tag kann beliebigen Text haben. Beispiel: <emph></emph>
hcell
Dieses Tag kann beliebigen Text haben. Beispiel: <hcell></hcell>
header
Ein header Tag hat kein oder mehrere hcell Tags. Beispiel: <header> <hcell></hcell> </header>
image
Das image Tag besitzt eine oder keine caption. Beispiel: <image src="architek:///KON/PNG/DKINS.DB2INSTALLA002"><caption>Textbeispiel</caption></image>
link
Dieses Tag kann beliebigen Text haben. Beispiel: <link ref="/KON/MEN/BELE">Einzelsatzverarbeitung (BELE)</link>
list
Ein list Tag kann elem oder def Tags enthalten. Beispiel: <list> <desc></desc> </list>
para
Ein para Tag kann freien Text oder eines der folgenden Tags enthalten: emph, link oder comment Beispiel: <para> <link></link> </para>
row
Ein row Tag hat kein oder mehrere cell Tags. Beispiel: <row> </row>
section
Ein section Tag enthält zwingend ein titel Tag. Alternativ können subsection Tags oder weitere Tags verwendet werden. Die weiteren Tags sind para, code, list, table oder image Tags Beispiel: <section id="xml-beschreibung"><titel>XML-Beschreibung</titel> <para></para> </section>
subsection
Ein id Attribut ist zwingend erforderlich. Das erste Zeichen darf keine Ziffer sein. Ein subsection Tag enthält zwingend ein titel Tag. Weiter sind para, code, list, table oder image Tags erlaubt. Beispiel: <subsection id="xml-beschreibung"><titel>XML-Beschreibung</titel> <para></para> </subsection>
table
Ein table Tag kann ein oder kein caption Tag und keins oder mehrere col Tags enthalten. Desweiteren kann es ein oder kein header Tag und keins oder mehrere row Tags enthalten. Beispiel: <table></table>
tag
Ein tag Tag kann freien Text oder eines der folgenden Tags enthalten: emph, link oder comment Beispiel: <tag>Eine Beschreibung</tag>
Letzte Änderung: RODENHAG 27.08.2010 11:38