Date: Thu, 13 Mar 2003 02:52:24 +0900 (JST) From: Hiroki Sato <hrs@eos.ocn.ne.jp> To: shamrock@cypherpunks.to Cc: doc@FreeBSD.ORG Subject: Re: <citerefentry> vs. &man.command.section Message-ID: <20030313.025224.98423896.hrs@eos.ocn.ne.jp> In-Reply-To: <00a601c2e8b9$58625bb0$6601a8c0@VAIO650> References: <00a601c2e8b9$58625bb0$6601a8c0@VAIO650>
next in thread | previous in thread | raw e-mail | index | archive | help
"Lucky Green" <shamrock@cypherpunks.to> 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> <citerefentry> shamrock> <refentrytitle> shamrock> gbde shamrock> </refentrytitle> shamrock> <manvolume>8</<manvolume> shamrock> </citerefentry> 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 <command> 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 <hrs@eos.ocn.ne.jp> / <hrs@FreeBSD.org> To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20030313.025224.98423896.hrs>