From owner-freebsd-doc Wed Mar 12 9:55:11 2003 Delivered-To: freebsd-doc@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 64B9737B401 for ; Wed, 12 Mar 2003 09:55:09 -0800 (PST) Received: from smtp.eos.ocn.ne.jp (eos.ocn.ne.jp [211.6.83.117]) by mx1.FreeBSD.org (Postfix) with ESMTP id B0B9C43F3F for ; Wed, 12 Mar 2003 09:55:08 -0800 (PST) (envelope-from hrs@eos.ocn.ne.jp) Received: from mail.allbsd.org (p54141-adsao12honb4-acca.tokyo.ocn.ne.jp [220.96.136.141]) by smtp.eos.ocn.ne.jp (Postfix) with ESMTP id B805F1A0F; Thu, 13 Mar 2003 02:55:07 +0900 (JST) Received: from localhost (alph.allbsd.org [192.168.0.10]) by mail.allbsd.org (8.12.8/3.7W/DomainMaster) with ESMTP id h2CHseqe094688; Thu, 13 Mar 2003 02:54:41 +0900 (JST) (envelope-from hrs@eos.ocn.ne.jp) Date: Thu, 13 Mar 2003 02:52:24 +0900 (JST) Message-Id: <20030313.025224.98423896.hrs@eos.ocn.ne.jp> To: shamrock@cypherpunks.to Cc: doc@FreeBSD.ORG Subject: Re: vs. &man.command.section From: Hiroki Sato In-Reply-To: <00a601c2e8b9$58625bb0$6601a8c0@VAIO650> References: <00a601c2e8b9$58625bb0$6601a8c0@VAIO650> X-PGPkey-fingerprint: BDB3 443F A5DD B3D0 A530 FFD7 4F2C D3D8 2793 CF2D X-Mailer: Mew version 2.2 on Emacs 20.7 / Mule 4.0 (HANANOEN) Mime-Version: 1.0 Content-Type: Text/Plain; charset=us-ascii Content-Transfer-Encoding: 7bit Sender: owner-freebsd-doc@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.org "Lucky Green" wrote in <00a601c2e8b9$58625bb0$6601a8c0@VAIO650>: shamrock> 1) I read section 4.2.5.4 of the Documentation guide, but I still don't shamrock> understand when to use shamrock> shamrock> shamrock> shamrock> gbde shamrock> shamrock> 8 shamrock> shamrock> shamrock> and when to use shamrock> shamrock> &man.gbde.8 shamrock> shamrock> Is the former indexed while the latter is not? What determines whether shamrock> one should choose one format over the other? No. They have the same meaning. The latter (short) form is defined in doc/share/sgml/man-refs.ent. It is something like #define macro in C. If you can find man.xxx.n in man-refs.ent, you should use it. If not, I think it is better to add an entry by yourself or ask someone who is a doc committer, instead of using the former. shamrock> 2) Is it required that every time a FreeBSD command is mentioned the shamrock> command _must_ be surrounded by the tags? I have explanatory shamrock> text paragraphs in which gbde is mentioned multiple times and having all shamrock> these bold instances of gbde in the same paragraph looks strange to me shamrock> (in the html output). Hmmm, could you please show an example? shamrock> 3) Is there a graphical editor that allows tagging of SGML text using (snip) shamrock> 4) Is there an SGML source beautifier script or program that will parse shamrock> the SGML document and based on the parsing perform indentations in shamrock> conformance with the style guide? This is not a graphical one, but I use Emacs+PSGML mode (mentioned in FDP Primer Ch.11). -- | Hiroki SATO / To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message