From owner-freebsd-www@FreeBSD.ORG Tue Feb 22 13:50:36 2005 Return-Path: Delivered-To: freebsd-www@hub.freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 311A316A4FC for ; Tue, 22 Feb 2005 13:50:36 +0000 (GMT) Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21]) by mx1.FreeBSD.org (Postfix) with ESMTP id AAFAD43D60 for ; Tue, 22 Feb 2005 13:50:25 +0000 (GMT) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) by freefall.freebsd.org (8.13.1/8.13.1) with ESMTP id j1MDoP32086681 for ; Tue, 22 Feb 2005 13:50:25 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.13.1/8.13.1/Submit) id j1MDoPFW086680; Tue, 22 Feb 2005 13:50:25 GMT (envelope-from gnats) Resent-Date: Tue, 22 Feb 2005 13:50:25 GMT Resent-Message-Id: <200502221350.j1MDoPFW086680@freefall.freebsd.org> Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer) Resent-To: freebsd-www@FreeBSD.org Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org, "Jesus R. Camou" Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 9A82616A4CE for ; Tue, 22 Feb 2005 13:42:46 +0000 (GMT) Received: from fed1rmmtao08.cox.net (fed1rmmtao08.cox.net [68.230.241.31]) by mx1.FreeBSD.org (Postfix) with ESMTP id 3EB4043D5A for ; Tue, 22 Feb 2005 13:42:46 +0000 (GMT) (envelope-from jcamou@opensea.mephis.org) Received: from opensea.mephis.org ([68.0.141.123]) by fed1rmmtao08.cox.net (InterMail vM.6.01.04.00 201-2131-118-20041027) with ESMTP <20050222134245.BQBK14932.fed1rmmtao08.cox.net@opensea.mephis.org> for ; Tue, 22 Feb 2005 08:42:45 -0500 Received: from opensea.mephis.org (localhost [127.0.0.1]) by opensea.mephis.org (8.13.1/8.13.1) with ESMTP id j1MDjjit032502 for ; Tue, 22 Feb 2005 06:45:45 -0700 (MST) (envelope-from jcamou@opensea.mephis.org) Received: (from jcamou@localhost) by opensea.mephis.org (8.13.1/8.13.1/Submit) id j1MDjj7C032501; Tue, 22 Feb 2005 06:45:45 -0700 (MST) (envelope-from jcamou) Message-Id: <200502221345.j1MDjj7C032501@opensea.mephis.org> Date: Tue, 22 Feb 2005 06:45:45 -0700 (MST) From: "Jesus R. Camou" To: FreeBSD-gnats-submit@FreeBSD.org X-Send-Pr-Version: 3.113 Subject: www/77925: [PATCH] www/en/docproj/sgml.sgml: The FDP no longer uses LinuxDoc X-BeenThere: freebsd-www@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list Reply-To: "Jesus R. Camou" List-Id: FreeBSD Project Webmasters List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 22 Feb 2005 13:50:36 -0000 >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 @@

The Documentation Project uses SGML as the standard method of representing the documentation.

-

SGML is the Standard Generalised Markup +

SGML is the Standard Generalized Markup Language.

In a nutshell (and apologies to any SGML purists in the audience that @@ -24,16 +24,12 @@ defined using SGML.

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.

- -

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.

- + 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.

+

For example, this is how you might write a brief paragraph in HTML (do not worry about the content, just look at the tags):

@@ -101,16 +97,12 @@

  • The conversion process is not that simple.

    • -

    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.

    - -

    What if you don't know LinuxDoc/DocBook? Can you still +

    What if you do not know DocBook? Can you still contribute?

    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.

    + documentation. If you have got some documentation to contribute and it is + not marked up in DocBook, do not worry.

    Submit the documentation as normal. Someone else on the Project will grab your committed --- sgml.diff ends here --- >Release-Note: >Audit-Trail: >Unformatted: