<?xml version = "1.0" encoding = "utf-8"?>
<?xml-stylesheet href="/pool/rng_ht.xslt" type="application/xml"?>
<!-- file KLEIDER/web/src/pinw/docframejs.rng -->
<!--
  Daten zum Dokumentationsrahmen für ECMAScript
  "http://herbaer.de/xmlns/20200620/docframejs/"
  2020 Herbert Schiemann <h.schiemann@herbaer.de>
  Borkener Str. 167, 46284 Dorsten, Germany
  GPL Version 2 oder neuer
  Jede Gewährleistung ist ausgeschlossen.

  Das Schema folgt den folgenden Richtlinien:
  - Jedes Attribut und jedes Element wird in einem
    <define>-Element spezifiziert
  - Jedes <define>-Element spezifiziert höchstens ein Attribut oder Element
  - Die Namen der Muster ("Pattern"), die ein Attribut spezifizieren,
    beginnen mit "att_".
  - Die Namen der Muster, die ein Element spezifizieren,
    beginnen mit "el_".
  - Die Dokumentation ist in den define-Elementen enthalten und benutzt
    DocBook-XML-artige Markierungen des Namensraums
    http://herbaer.de/xmlns/20051201/doc
-->
<grammar
  xmlns   = "http://relaxng.org/ns/structure/1.0"
  xmlns:d = "http://herbaer.de/xmlns/20051201/doc"
  ns      = "http://herbaer.de/xmlns/20200620/docframejs/"
>

<d:info xmlns="http://herbaer.de/xmlns/20051201/doc">
  <title>docframejs.rng</title>
  <subtitle>Daten zum Dokumentationsrahmen für ECMAScript</subtitle>
  <date>2020-06-20</date>
  <author>
    <personname>
      <firstname>Herbert</firstname>
      <surname>Schiemann</surname>
    </personname>
    <email>h.schiemann@herbaer.de</email>
  </author>
</d:info>

<start>
  <ref name = "el_docframejs"/>
</start>

<define name = "anything">
  <d:para>
    Beliebiger Inhalt
  </d:para>
  <zeroOrMore>
    <choice>
      <element>
        <anyName/>
        <ref name="anything"/>
      </element>
      <attribute>
        <anyName/>
      </attribute>
      <text/>
    </choice>
  </zeroOrMore>
</define><!-- anything -->

<define name = "foreign_att">
  <d:para>
    Attribute anderer XML-Namensräume
  </d:para>
  <zeroOrMore>
    <attribute>
      <anyName>
        <except>
          <nsName ns = ""/>
          <nsName ns = "http://herbaer.de/xmlns/20200620/docframejs/"/>
        </except>
      </anyName>
    </attribute>
  </zeroOrMore>
</define><!-- foreign_att -->

<define name = "foreign_el">
  <d:para>
    Elemente anderer XML-Namensräume
  </d:para>
  <zeroOrMore>
    <element>
      <anyName>
        <except>
          <nsName ns = "http://herbaer.de/xmlns/20200620/docframejs/"/>
        </except>
      </anyName>
      <ref name = "anything"/>
    </element>
  </zeroOrMore>
</define><!-- foreign_el -->

<define name = "el_docframejs">
  <d:para>
Das XML-Wurzelelement des Dokuments:
  </d:para>
  <element name = "docframejs">
    <ref name = "foreign_att"/>
    <interleave>
      <optional>
        <ref name = "el_time"/>
      </optional>
      <optional>
        <ref name = "el_path"/>
      </optional>
      <optional>
        <ref name = "el_basename"/>
      </optional>
      <ref name = "el_entries"/>
      <ref name="foreign_el"/>
    </interleave>
  </element>
</define><!-- el_imgindex -->

<define name = "el_time">
  <d:para>
Zeit der Erstellung der Datei
  </d:para>
  <element name = "time">
    <ref name = "foreign_att"/>
    <data type = "time"/>
  </element>
</define>

<define name = "el_path">
  <d:para>
Dateipfad der ECMAScript-Datei
  </d:para>
  <element name = "path">
    <ref name = "foreign_att"/>
    <data type = "string"/>
  </element>
</define>

<define name = "el_basename">
  <d:para>
Basis-Dateiname
  </d:para>
  <element name = "basename">
    <ref name = "foreign_att"/>
    <data type = "word"/>
  </element>
</define>

<define name = "el_entries">
  <d:para>
Liste von Einträgen zu Variablen, Funktionen, Methoden
  </d:para>
  <element name = "entries">
    <ref name = "foreign_att"/>
    <interleave>
      <zeroOrMore>
        <ref name = "el_entry"/>
      </zeroOrMore>
      <ref name="foreign_el"/>
    </interleave>
  </element>
</define><!-- el_imgindex -->

<define name = "el_entry">
  <d:para>
Ein Eintrag zu einem Script-Element, das zu dokumentieren ist
  </d:para>
  <element name = "entry">
    <ref name = "foreign_att"/>
    <interleave>
      <ref name = "el_type"/>
      <ref name = "el_key"/>
      <optional>
        <ref name = "el_class"/>
      </optional>
      <optional>
        <ref name = "el_args"/>
      </optional>
      <ref name="foreign_el"/>
    </interleave>
  </element>
</define><!-- el_entry -->

<define name = "el_type">
  <d:para>
Der Typ des zu dokumentierenden Script-Elements
  </d:para>
  <d:variablelist>
    <d:varlistentry>
      <d:term>var</d:term>
      <d:listitem>
        <d:para>eine (globale) Variable</d:para>
      </d:listitem>
    </d:varlistentry>
    <d:varlistentry>
      <d:term>func</d:term>
      <d:listitem>
        <d:para>eine Funktion</d:para>
      </d:listitem>
    </d:varlistentry>
    <d:varlistentry>
      <d:term>method</d:term>
      <d:listitem>
        <d:para>
eine Klassen-Methode.
In diesem Fall sollte das Elternelement auch ein
<d:tag class = "element">class</d:tag>-Element enthalten.
        </d:para>
      </d:listitem>
    </d:varlistentry>
  </d:variablelist>
  <element name = "type">
    <ref name = "foreign_att"/>
    <choice>
      <value>var</value>
      <value>func</value>
      <value>method</value>
    </choice>
  </element>
</define><!-- el_filename -->

<define name = "el_key">
  <d:para>
Der Name einer Variablen, Funktion oder Methode
  </d:para>
  <element name = "key">
    <ref name = "foreign_att"/>
    <data type = "word"/>    
  </element>
</define>

<define name = "el_class">
  <d:para>
Der Name einer "Klasse" zu einer Methode
  </d:para>
  <element name = "class">
    <ref name = "foreign_att"/>
    <data type = "word"/>    
  </element>
</define>

<define name = "el_args">
  <d:para>
Liste der Argumente einer Funktion oder Methode
  </d:para>
  <element name = "args">
    <ref name = "foreign_att"/>
    <interleave>
      <zeroOrMore>
        <ref name = "el_arg"/>
      </zeroOrMore>
      <ref name="foreign_el"/>
    </interleave>
  </element>
</define>

<define name = "el_arg">
  <d:para>
Der Name eines formalen Arguments einer Funktion oder Methode
  </d:para>
  <element name = "arg">
    <ref name = "foreign_att"/>
    <data type = "word"/>    
  </element>
</define>

</grammar>
<!-- end of file KLEIDER/web/src/pinw/docframejs.rng -->
