From owner-freebsd-ports@FreeBSD.ORG  Mon Jul  7 14:36:56 2014
Return-Path: <owner-freebsd-ports@FreeBSD.ORG>
Delivered-To: freebsd-ports@freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits))
 (No client certificate requested)
 by hub.freebsd.org (Postfix) with ESMTPS id C418244B
 for <freebsd-ports@freebsd.org>; Mon,  7 Jul 2014 14:36:56 +0000 (UTC)
Received: from wonkity.com (wonkity.com [67.158.26.137])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client CN "wonkity.com", Issuer "wonkity.com" (not verified))
 by mx1.freebsd.org (Postfix) with ESMTPS id 6C7DD2C4E
 for <freebsd-ports@freebsd.org>; Mon,  7 Jul 2014 14:36:56 +0000 (UTC)
Received: from wonkity.com (localhost [127.0.0.1])
 by wonkity.com (8.14.9/8.14.9) with ESMTP id s67EapWo010061
 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=NO);
 Mon, 7 Jul 2014 08:36:51 -0600 (MDT)
 (envelope-from wblock@wonkity.com)
Received: from localhost (wblock@localhost)
 by wonkity.com (8.14.9/8.14.9/Submit) with ESMTP id s67EapeN010058;
 Mon, 7 Jul 2014 08:36:51 -0600 (MDT)
 (envelope-from wblock@wonkity.com)
Date: Mon, 7 Jul 2014 08:36:51 -0600 (MDT)
From: Warren Block <wblock@wonkity.com>
To: Patrick Powell <papowell@astart.com>
Subject: Re: Some suggestions about PKGNG documentation
In-Reply-To: <53BA10EE.2000302@astart.com>
Message-ID: <alpine.BSF.2.11.1407070832090.8463@wonkity.com>
References: <201407051018.s65AIAsn011613@chilled.skew.org>
 <53BA10EE.2000302@astart.com>
User-Agent: Alpine 2.11 (BSF 23 2013-08-11)
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII; format=flowed
X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.4.3
 (wonkity.com [127.0.0.1]); Mon, 07 Jul 2014 08:36:52 -0600 (MDT)
Cc: freebsd-ports@freebsd.org
X-BeenThere: freebsd-ports@freebsd.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: Porting software to FreeBSD <freebsd-ports.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/options/freebsd-ports>,
 <mailto:freebsd-ports-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-ports/>
List-Post: <mailto:freebsd-ports@freebsd.org>
List-Help: <mailto:freebsd-ports-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-ports>,
 <mailto:freebsd-ports-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Mon, 07 Jul 2014 14:36:56 -0000

On Sun, 6 Jul 2014, Patrick Powell wrote:
> On 07/05/14 03:18, Mike Brown wrote:
>> Warren Block wrote:
>>> The documentation team has a standing offer to either assist with markup
>>> or accept content-only submissions and do the markup on them.
>> That's good to know. I was under the impression it had to be submitted as
>> DocBook XML. Thanks!
>> 
> OK.  Its been 10 years since I lasted looked at the FBSD documents. Nowever, 
> I know SGML, XML,
> and have written documents in them.
>
> 1. Point me to the source of one of the documents as a starting point.
> 2. Point me to the tools that I need to use to massage the document.
>    (There used to be a Documenter's Handbook, is it still around?)
>
> I will take one of these documents as a starting point and then update it.
>
> HOWEVER...  I am hoping that one of the document team will 'proof' this for 
> format and content.

The books and articles are in DocBook XML 5.

http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/index.html

Chapter 9 shows examples of DocBook markup.

Articles are simpler than books.  For example:
http://svnweb.freebsd.org/doc/head/en_US.ISO8859-1/articles/cups/article.xml?revision=44687&view=markup