Einhaltung des HTML Document Object Model

[Prof. Dr. Peter Henning]

Die bisherigen Bestandteile der commandref.html enthalten an sehr vielen Stellen HTML-Code, der z.B. so aussieht:

<ul>
                    <code>define ... /code>
                    <br><br>
                    ...


Das entspricht nicht dem HTML-Standard (dem Document Object Model HTML), denn nach diesem dürfen die Kinder von <ul> nur Elemente des Typs <li> sein.

Gängige Browser stellen zwar den bisherigen HTML-Code irgendwie dar, doch validierende XML-Parser steigen dabei aus. Lösungsvorschlag: Sektionierung der Bestandteile mit Überschriften <h2>  <h3>  <h4>. Definition von Einrückungen im Cascading Stylesheet.

LG

pah            

[Reinerlein]

Hallo,

das ist mir auch schon mal aufgefallen. Habe aber die Doku zu meinem Modul einfach noch nicht angefangen, und damit das Problem verschoben :-)
Gibt es eigentlich irgendwo ein sauberes Skeleton, an dem man seine Doku dran ausrichten kann?

Ich hatte so beim Stöbern nichts dazu gefunden, und hatte mich einfach an bestehenden Modulen orientiert...

Grüße Reinerlein

[Prof. Dr. Peter Henning]

Meines Wissens nicht. Möglicherweise irgendwo versteckt. Vorschlag - noch nicht wirklich sauber, validiert aber:

 <a name="MODUL"></a>
        <h3>MODUL</h3>
        <p>Kurze Beschreibung </p>
        <h4>Example</h4>
        <p>
            <code>define </code>
            <br />
            <code>attr </code>
            <br />
        </p>
        <br />
        <a name="MODULdefine"></a>
        <h4>Define</h4>
        <code>define &lt;name&gt; MODUL [&lt;model&gt;] &lt;id&gt; </code>
        <p>
            <code>[&lt;model&gt;]</code><br /> Kurze Beschreibung </p>
        <ul>
            <li>model xxx (default if the model parameter is omitted)</li>
            <li>model yyy</li>
            <li>model zzz</li>
        </ul>
        <p>
            <code>&lt;id&gt;</code>
            <br />Beschreibung </p>
        <p>
            <code>&lt;interval&gt;</code>
            <br /> Beschreibung </p>
        <br />
        <br />
        <a name="MODULset"></a>
        <h4>Set</h4>
        <ul>
            <li><a name="modul_setter">
                    <code>set &lt;name&gt; interval &lt;int&gt;</code></a><br /> Beschreibung</li>

        </ul>
        <br />
        <a name="MODULget"></a>
        <h4>Get</h4>
        <ul>
            <li><a name="modul_getter">
                    <code>get &lt;name&gt; id</code></a>
                <br /> Beschreibung </li>
        </ul>
        <br />
        <a name="MODULattr"></a>
        <h4>Attributes</h4>
        <ul>
            <li><a name="modul_attribut"><code>attr &lt;name&gt; stateAL &lt;string&gt;</code>
                </a> Beschreibung </li>
            <li>Standard attributes <a href="#alias">alias</a>, <a href="#comment">comment</a>, <a
                    href="#event-on-update-reading">event-on-update-reading</a>, <a
                    href="#event-on-change-reading">event-on-change-reading</a>, <a href="#room"
                    >room</a>, <a href="#eventMap">eventMap</a>, <a href="#loglevel">loglevel</a>,
                    <a href="#webCmd">webCmd</a></li>
        </ul>

LG

pah