os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

+ Edit paragraphs to remove the use of LinuxDoc with info

Browse source 
taken from the FDP Primer book.
+ Remove some contractions and s/generalised/generalized/.

Submitted by:	Jesus R. Camou <jcamou@cox.net>
PR:		www/77925
This commit is contained in:
Giorgos Keramidas 2005-03-02 00:48:42 +00:00
parent 457cbf9a78
commit 2a1ef6ee44
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/www/; revision=23969
1 changed files with 11 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

30
en/docproj/sgml.sgml
View file

@ -1,6 +1,6 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" [
<!ENTITY base CDATA "..">
<!ENTITY date "$FreeBSD: www/en/docproj/sgml.sgml,v 1.22 2003/07/15 14:34:30 ceri Exp $">
<!ENTITY date "$FreeBSD: www/en/docproj/sgml.sgml,v 1.23 2004/04/01 19:32:56 linimon Exp $">
<!ENTITY title "FreeBSD Documentation Project: SGML">
<!ENTITY % includes SYSTEM "../includes.sgml"> %includes;
]>
@ -11,7 +11,7 @@
<p>The Documentation Project uses SGML as the standard method
of representing the documentation.</p>
<p>SGML is the <b>S</b>tandard <b>G</b>eneralised <b>M</b>arkup
<p>SGML is the <b>S</b>tandard <b>G</b>eneralized <b>M</b>arkup
<b>L</b>anguage.</p>
<p>In a nutshell (and apologies to any SGML purists in the audience that
@ -24,16 +24,12 @@
defined using SGML.</p>
<p>There are many, many markup languages that are defined using SGML. HTML
is one of them. Another is called "LinuxDoc". As you can probably guess,
it was originally created by the Linux documentation group to write
their documentation, and the FreeBSD Documentation Project adopted it as
well.</p>
<p>Another markup language defined using SGML is called "DocBook". This
is a language designed specifically for writing technical
documentation, and as such it has many tags (the things inside the
&lt;...&gt;) to describe technical documentation related things.</p>
is one of them. Another is called "DocBook". This is a language designed
specifically for writing technical documentation, and as such it has many
tags (the things inside the &lt;...&gt;) to describe technical
documentation related things. The FreeBSD Documentation Project adopted
it and added some new elements to make it more precise.</p>
<p>For example, this is how you might write a brief paragraph in HTML
(do not worry about the content, just look at the tags):</p>
@ -101,16 +97,12 @@
<li><p>The conversion process is not that simple.</p></li>
</ul>
<p>Right now, the Project is still using LinuxDoc for the Handbook and the
FAQ. That's changing, and in particular there's a project underway
to convert the documentation to DocBook.</p>
<h2>What if you don't know LinuxDoc/DocBook? Can you still
<h2>What if you do not know DocBook? Can you still
contribute?</h2>
<p>Yes you can. Quite definitely. Any documentation is better than no
documentation. If you've got some documentation to contribute and it's
not marked up in LinuxDoc or DocBook, don't worry.</p>
documentation. If you have got some documentation to contribute and it is
not marked up in DocBook, do not worry.</p>
<p><a href="submitting.html">Submit</a> the documentation as
normal. Someone else on the Project will grab your committed