blob: 4c734bffe67b10713156d1612bb7c4cac81f08d7 (
plain) (
blame)
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
#use wml::debian::ddp title="DDP Documentation Policy"
<p>
This manual is quite outdated and there is an incomplete effort to fix it on
the <a href="https://lists.debian.org/debian-doc/">debian-doc mailing list</a>.
See the current draft of the <a href="manuals/ddp-policy/ddp-policy">new
policy</a>. Use of <strong>DocBook XML</strong> instead of
<strong>debiandoc-sgml</strong> is recommended for all new contributions.</p>
<p>Here is a list of decisions that were made on our mailing list and
approved by the project members and former Documentation Manager (retired),
Susan G. Kleinmann.</p>
<ul>
<li>All manuals of the Debian Documentation Project (DDP) will be
released under DFSG-compliant licenses, most likely GPL.
</li>
<li>We'll use the following directory structure:
<p>Filesystem:</p>
<pre>
/usr/share/doc/manuals/<var>somemanual</var>/index.html
/usr/share/doc/manuals/<var>somemanual</var>.ps.gz (optional)
</pre>
<p>WWW server:</p>
<pre>
http://www.debian.org/doc/manuals/<var>somemanual</var>/
</pre>
<p>FTP server:</p>
<pre>
http://ftp.debian.org/debian/doc/manuals/<var>somemanual</var>.html.tar.gz
http://ftp.debian.org/debian/doc/manuals/<var>somemanual</var>.text.gz
http://ftp.debian.org/debian/doc/manuals/<var>somemanual</var>.dvi.gz
http://ftp.debian.org/debian/doc/manuals/<var>somemanual</var>.ps.gz
http://ftp.debian.org/debian/doc/manuals/<var>somemanual</var>.sgml.tar.gz
</pre>
<p>Please note that this part of the policy hasn't been universally
accepted yet, so those URIs may not work. The real locations of
documents may vary for backwards compatibility.</p>
</li>
<li>We will use SGML as the source format for our documents, preferably using
Docbook XML.
<p>Note that this does not mean that users have to learn SGML or XML to submit
changes to our documents. We accept all other formats as well. However,
they will be translated into SGML by one of members of the group.</p>
<p>Please note that some older documents maintained by the group are still
in debiandoc-sgml format. These are being transformed, as time permits, into
DocBook XML documents. The debiandoc-sgml format is considered obsolete.</p>
<p><small>The other options were: LaTeX, HTML, Texinfo, and several other
minor formats.</small></p>
</li>
<li>We will ease the translator's task by using PO.
<p>By using the <em>po4a</em> tools we will make sure that translators
that want to keep track of translations using the PO format are given
the proper tools to do so.</p>
</li>
<li>Every Debian document will have a single person listed as
<em>Maintainer</em> and might also have additional people listed as
<em>Co-Maintainers</em>.</li>
</ul>
|
