Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 27 Aug 1999 10:50:43 +0100
From:      Nik Clayton <nik@freebsd.org>
To:        "Matthew D. Fuller" <fullermd@futuresouth.com>
Cc:        Nik Clayton <nik@FreeBSD.ORG>, Tim Vanderhoek <vanderh@ecf.utoronto.ca>, Motoyuki Konno <motoyuki@snipe.rim.or.jp>, freebsd-doc@FreeBSD.ORG
Subject:   Re: DocBook formatting style?
Message-ID:  <19990827105043.A15526@kilt.nothing-going-on.org>
In-Reply-To: <19990826141141.F24968@futuresouth.com>; from Matthew D. Fuller on Thu, Aug 26, 1999 at 02:11:42PM -0500
References:  <19990822200737.A65807@ppp18344.on.bellglobal.com> <19990823141611.A1770@catkin.nothing-going-on.org> <19990823172005.C42397@ppp18344.on.bellglobal.com> <19990824172812.L65430@kilt.nothing-going-on.org> <199908250049.JAA00382@rei.snipe.rim.or.jp> <19990825115510.A96398@kilt.nothing-going-on.org> <19990825194348.G18970@ppp18415.on.bellglobal.com> <19990826111447.C66300@kilt.nothing-going-on.org> <19990826141141.F24968@futuresouth.com>

next in thread | previous in thread | raw e-mail | index | archive | help
On Thu, Aug 26, 1999 at 02:11:42PM -0500, Matthew D. Fuller wrote:
> On Thu, Aug 26, 1999 at 11:14:47AM +0100, a little birdie told me
> that Nik Clayton remarked
> > 
> >   <para>For all the hype about open standards, getting a program to work on
> >     different versions of Unix in the real world can be a tedious and tricky

<snip>

> I'm in favor of putting markup tags on their own line.  Thus:
> 	<para>
> 	For all the hype about open standards, getting a program to work on
> 	different versions of Unix in the real world can be a tedious and
> 	tricky business, as anyone who has tried it will know
> 	...
> 	With most programs, you will find yourself doing a fair bit of
> 	head-scratching, and there are quite a few programs that will result
> 	in premature greying, or even chronic alopecia...
> 	</para>
> 
> But that may just be a personal quirk.

We probably shouldn't, as within some elements the whitespace is 
significant (<programlisting> and <screen> come to mind).  Note that the
advice currently given in the primer is wrong about this, and I'll be
fixing it tonight.

This means you should be writing things like

        <programlisting>#!/usr/bin/perl

    print "hello, world\n";</programlisting>

(assume that column 0 in the docs is column 4 above) instead of

        <programlisting>
    #!/usr/bin/perl

    print "hello, world\n";
    </programlisting>

N
-- 
 [intentional self-reference] can be easily accommodated using a blessed,
 non-self-referential dummy head-node whose own object destructor severs
 the links.
    -- Tom Christiansen in <375143b5@cs.colorado.edu>


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?19990827105043.A15526>