From owner-freebsd-doc  Tue Aug  8 11:25:41 2000
Delivered-To: freebsd-doc@freebsd.org
Received: from nothing-going-on.demon.co.uk (nothing-going-on.demon.co.uk [193.237.89.66])
	by hub.freebsd.org (Postfix) with ESMTP
	id E2E2237BD03; Tue,  8 Aug 2000 11:25:23 -0700 (PDT)
	(envelope-from nik@nothing-going-on.demon.co.uk)
Received: (from nik@localhost)
	by nothing-going-on.demon.co.uk (8.9.3/8.9.3) id TAA99597;
	Tue, 8 Aug 2000 19:24:35 +0100 (BST)
	(envelope-from nik)
Date: Tue, 8 Aug 2000 19:24:34 +0100
From: Nik Clayton <nik@freebsd.org>
To: Mark Ovens <marko@freebsd.org>
Cc: doc@freebsd.org
Subject: Re: Contradiction in the FDP-Primer?
Message-ID: <20000808192434.B99380@catkin.nothing-going-on.org>
References: <20000808182543.G250@parish>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
User-Agent: Mutt/1.2.4i
In-Reply-To: <20000808182543.G250@parish>; from marko@freebsd.org on Tue, Aug 08, 2000 at 06:25:44PM +0100
Organization: FreeBSD Project <URL:http://www.freebsd.org/>
Sender: owner-freebsd-doc@FreeBSD.ORG
Precedence: bulk
X-Loop: FreeBSD.org

On Tue, Aug 08, 2000 at 06:25:44PM +0100, Mark Ovens wrote:
> Just been tidying up some markup in the handbook using the FDP primer
> as a guide for the correct way to do things and came across what
> appears to be contradictions.
> 
> 10.1.3.2. Special tags
> 
> Some tags just don't follow the indenting rules of the previous section; 
> <screen> and <programlisting> should always be left-aligned.

Not sure when that crept in.  IMHO it's wrong.

    <programlisting>#!/bin/sh

echo Hello, world</programlisting>

is how I'd do things.

Feel free to nuke 10.1.3.2.

> The example above also highlights another apparent contradiction. This
> shows the use of <screen> and <userinput> but in "3.1 Overview" it
> uses:
> 
> More precisely, they need help identifying what is what. You or I can look at
> 
>       To remove /tmp/foo use rm(1).
> 
>           % rm /tmp/foo
> 
> [snip]
> 
> The previous example is actually represented in this document like this;
> 
>     <para>To remove <filename>/tmp/foo</filename> use &man.rm.1;.</para>
>     
>     <para><command>rm /tmp/foo</command></para>
> 
> So, which is the correct (or preferred) way to show something like
> 
>     % rm /tmp/foo

3.1 is wrong, I'm fixing it now.  Use <screen> and <userinput>

N
-- 
Internet connection, $19.95 a month.  Computer, $799.95.  Modem, $149.95.
Telephone line, $24.95 a month.  Software, free.  USENET transmission,
hundreds if not thousands of dollars.  Thinking before posting, priceless.
Somethings in life you can't buy.  For everything else, there's MasterCard.
  -- Graham Reed, in the Scary Devil Monastery


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message