|
Lines 11-17
Link Here
|
| 11 |
<p>The Documentation Project uses SGML as the standard method |
11 |
<p>The Documentation Project uses SGML as the standard method |
| 12 |
of representing the documentation.</p> |
12 |
of representing the documentation.</p> |
| 13 |
|
13 |
|
| 14 |
<p>SGML is the <b>S</b>tandard <b>G</b>eneralised <b>M</b>arkup |
14 |
<p>SGML is the <b>S</b>tandard <b>G</b>eneralized <b>M</b>arkup |
| 15 |
<b>L</b>anguage.</p> |
15 |
<b>L</b>anguage.</p> |
| 16 |
|
16 |
|
| 17 |
<p>In a nutshell (and apologies to any SGML purists in the audience that |
17 |
<p>In a nutshell (and apologies to any SGML purists in the audience that |
|
Lines 24-39
Link Here
|
| 24 |
defined using SGML.</p> |
24 |
defined using SGML.</p> |
| 25 |
|
25 |
|
| 26 |
<p>There are many, many markup languages that are defined using SGML. HTML |
26 |
<p>There are many, many markup languages that are defined using SGML. HTML |
| 27 |
is one of them. Another is called "LinuxDoc". As you can probably guess, |
27 |
is one of them. Another is called "DocBook". This is a language designed |
| 28 |
it was originally created by the Linux documentation group to write |
28 |
specifically for writing technical documentation, and as such it has many |
| 29 |
their documentation, and the FreeBSD Documentation Project adopted it as |
29 |
tags (the things inside the <...>) to describe technical |
| 30 |
well.</p> |
30 |
documentation related things. The FreeBSD Documentation Project adopted |
| 31 |
|
31 |
it and added some new elements to make it more precise.</p> |
| 32 |
<p>Another markup language defined using SGML is called "DocBook". This |
32 |
|
| 33 |
is a language designed specifically for writing technical |
|
|
| 34 |
documentation, and as such it has many tags (the things inside the |
| 35 |
<...>) to describe technical documentation related things.</p> |
| 36 |
|
| 37 |
<p>For example, this is how you might write a brief paragraph in HTML |
33 |
<p>For example, this is how you might write a brief paragraph in HTML |
| 38 |
(do not worry about the content, just look at the tags):</p> |
34 |
(do not worry about the content, just look at the tags):</p> |
| 39 |
|
35 |
|
|
Lines 101-116
Link Here
|
| 101 |
<li><p>The conversion process is not that simple.</p></li> |
97 |
<li><p>The conversion process is not that simple.</p></li> |
| 102 |
</ul> |
98 |
</ul> |
| 103 |
|
99 |
|
| 104 |
<p>Right now, the Project is still using LinuxDoc for the Handbook and the |
100 |
<h2>What if you do not know DocBook? Can you still |
| 105 |
FAQ. That's changing, and in particular there's a project underway |
|
|
| 106 |
to convert the documentation to DocBook.</p> |
| 107 |
|
| 108 |
<h2>What if you don't know LinuxDoc/DocBook? Can you still |
| 109 |
contribute?</h2> |
101 |
contribute?</h2> |
| 110 |
|
102 |
|
| 111 |
<p>Yes you can. Quite definitely. Any documentation is better than no |
103 |
<p>Yes you can. Quite definitely. Any documentation is better than no |
| 112 |
documentation. If you've got some documentation to contribute and it's |
104 |
documentation. If you have got some documentation to contribute and it is |
| 113 |
not marked up in LinuxDoc or DocBook, don't worry.</p> |
105 |
not marked up in DocBook, do not worry.</p> |
| 114 |
|
106 |
|
| 115 |
<p><a href="submitting.html">Submit</a> the documentation as |
107 |
<p><a href="submitting.html">Submit</a> the documentation as |
| 116 |
normal. Someone else on the Project will grab your committed |
108 |
normal. Someone else on the Project will grab your committed |