File: readme.xml

package info (click to toggle)
libfizmo 0.7.15-2.2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,312 kB
  • sloc: ansic: 19,107; sh: 1,540; xml: 807; cpp: 261; makefile: 158
file content (36 lines) | stat: -rw-r--r-- 1,492 bytes parent folder | download | duplicates (16)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
<?xml version="1.0" encoding="UTF-8"?>
<document>

  <section title="About tiny-xml-doc-tools v0.1.4">
    <p>The tiny-xml-doc-tools are a set of XSLT and script files used by the fizmo modules to provide documentation in various output formats. It invokes xsltproc to perform the actual conversion.</p>
  </section>

  <section title="List of document elements">
    <p>The following elements can be used in regular XML documentation files:</p>
    <ul>
      <li>&lt;document&gt; – Root element</li>
      <li>&lt;section&gt; — Section container</li>
      <li>&lt;ul&gt;, &lt;ol&gt; and &lt;li&gt; — Lists and items</li>
      <li>&lt;p&gt; — Text paragraph</li>
      <li>&lt;code&gt; — Code section</li>
      <li>&lt;a&gt; with @href — Hyperlink</li>
      <li>&lt;i&gt; — Italics</li>
      <li>&lt;b&gt; — Bold</li>
      <li>&lt;tt&gt; — Monospaced</li>
      <li>&lt;br&gt; — Linebreak</li>
    </ul>
  </section>

  <section title="List of changelog elements">
    <p>The following elements can be used for changelogs:</p>
    <ul>
      <li>&lt;changelog&gt; — Root element</li>
      <li>&lt;change&gt; with @version — Version container</li>
      <li>&lt;datetime&gt; with @day-of-week, @month, @day, @hour, @minute, @second, @timezone and @year — denotes parent's change date.</li>
      <li>&lt;logentry&gt; — Describes change, used inside change element.</li>
      <li>&lt;a&gt; with @href — Hyperlink</li>
    </ul>
  </section>

</document>