[prev in list] [next in list] [prev in thread] [next in thread]
List: freebsd-www
Subject: www/77925: [PATCH] www/en/docproj/sgml.sgml: The FDP no longer uses
From: "Jesus R. Camou" <jcamou () cox ! net>
Date: 2005-02-22 13:45:45
Message-ID: 200502221345.j1MDjj7C032501 () opensea ! mephis ! org
[Download RAW message or body]
> Number: 77925
> Category: www
> Synopsis: [PATCH] www/en/docproj/sgml.sgml: The FDP no longer uses LinuxDoc
> Confidential: no
> Severity: non-critical
> Priority: medium
> Responsible: freebsd-www
> State: open
> Quarter:
> Keywords:
> Date-Required:
> Class: update
> Submitter-Id: current-users
> Arrival-Date: Tue Feb 22 13:50:25 GMT 2005
> Closed-Date:
> Last-Modified:
> Originator: Jesus R. Camou
> Release: FreeBSD 4.11-STABLE i386
> Organization:
> Environment:
System: FreeBSD opensea.mephis.org 4.11-STABLE FreeBSD 4.11-STABLE #0: Sun Feb 13 \
21:22:53 MST 2005 jcamou@opensea.mephis.org:/usr/obj/usr/src/sys/HACKED i386
> Description:
o Edit paragraphs to remove the use of LinuxDoc with info
taken from the FDP Primer book.
o While here, s/Generalised/Generalized and remove some
contractions.
> How-To-Repeat:
> Fix:
--- sgml.diff begins here ---
Index: sgml.sgml
===================================================================
RCS file: /home/ncvs/www/en/docproj/sgml.sgml,v
retrieving revision 1.23
diff -u -r1.23 sgml.sgml
--- sgml.sgml 1 Apr 2004 19:32:56 -0000 1.23
+++ sgml.sgml 22 Feb 2005 13:36:17 -0000
@@ -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
- <...>) 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 <...>) 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
--- sgml.diff ends here ---
> Release-Note:
> Audit-Trail:
> Unformatted:
_______________________________________________
freebsd-www@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/freebsd-www
To unsubscribe, send any mail to "freebsd-www-unsubscribe@freebsd.org"
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic