Mercurial > hg > nginx-site

view dtd/module.dtd @ 76:4a4caa566120

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Russian documentation import. Changes in module.dtd: <example> now allowed to contain <value> and <emphasis> elements (we need this to show important parts in examples), less strict checking of <directive> syntax (we don't want to fully document some directives, notably deprecated ones). Known issues: 1. <syntax> elements are preserved as is, they will require manual conversion (likely to some not-yet-existed format a la DocBook cmdsynopsis, as currently used one seems to be incomplete); 2. <value> no longer corresponds to replaceable content, and it's use in examples isn't correct; 3. <link doc="document#fragment"> doesn't work with current xslt, either should be supported or changed to <link doc="document" id="fragment">. The following files are intentionally omitted: maillists.xml (support.xml should be used instead), experimental.xml (obsolete), faq.xml (conflicts with existing one, needs discussion). Not yet linked to site.
author Maxim Dounin <mdounin@mdounin.ru>
date Tue, 11 Oct 2011 12:57:50 +0000
parents 8213f3f1c93d
children b8fd014ec712
line wrap: on
line source


<!ELEMENT   module      (section+) >
<!ATTLIST   module
            name        CDATA #REQUIRED
            link        CDATA #REQUIRED
            lang        CDATA #REQUIRED
>

<!ELEMENT   section     (directive | para)+ >
<!ATTLIST   section
            name        CDATA #REQUIRED
            id          ID #IMPLIED
>

<!ELEMENT   directive   (syntax+, default?, context*, para+) >
<!ATTLIST   directive
            name        ID #REQUIRED
            appeared-in CDATA #IMPLIED
>

<!ELEMENT   syntax      (#PCDATA | argument | code | parameter | value)* >

<!ELEMENT   default     (#PCDATA | code)* >

<!ELEMENT   context     (#PCDATA)* >

<!ELEMENT   para        (#PCDATA | argument | c-def | c-func | code | command |
                         dq | emphasis | example | header | http-status | link |
                         list | note | parameter | pathname | value | var)* >

<!ELEMENT   argument    (#PCDATA)* >

<!ELEMENT   c-def       (#PCDATA)* >

<!ELEMENT   c-func      (#PCDATA)* >

<!ELEMENT   code        (#PCDATA | value)* >

<!ELEMENT   command     (#PCDATA)* >

<!ELEMENT   dq          ANY >

<!ELEMENT   emphasis    (#PCDATA | value)* >

<!ELEMENT   example     (#PCDATA | value | emphasis)* >

<!ELEMENT   header      (#PCDATA | argument)* >

<!ELEMENT   http-status EMPTY >
<!ATTLIST   http-status
            code        CDATA #REQUIRED
            text        CDATA #IMPLIED
>

<!ELEMENT   link        (#PCDATA)* >
<!ATTLIST   link
            doc         CDATA #IMPLIED
            id          CDATA #IMPLIED
            url         CDATA #IMPLIED
>

<!ELEMENT   list        (listitem+ | (tag-name | tag-desc)+) >
<!ATTLIST   list
            type        (bullet | enum | tag) #REQUIRED
>

<!ELEMENT   listitem    ANY >
<!ELEMENT   tag-name    ANY >
<!ELEMENT   tag-desc    ANY >

<!ELEMENT   note        ANY >

<!ELEMENT   parameter   (#PCDATA)* >

<!ELEMENT   pathname    (#PCDATA)* >

<!ELEMENT   value       (#PCDATA)* >

<!ELEMENT   var         (#PCDATA)* >

<!ENTITY    nbsp        "&#xA0;" >
<!ENTITY    mdash       "&nbsp;- " >
<!ENTITY    lsquo       "&#8216;">
<!ENTITY    rsquo       "&#8217;">
<!ENTITY    ldquo       "&#8220;">
<!ENTITY    rdquo       "&#8221;">