From owner-freebsd-doc  Mon Nov  6  7:39:32 2000
Delivered-To: freebsd-doc@freebsd.org
Received: from nothing-going-on.demon.co.uk (unknown [194.128.198.234])
	by hub.freebsd.org (Postfix) with ESMTP id A797E37B479
	for <freebsd-doc@freebsd.org>; Mon,  6 Nov 2000 07:39:29 -0800 (PST)
Received: (from nik@localhost)
	by nothing-going-on.demon.co.uk (8.11.0/8.11.0) id eA6FeX702080;
	Mon, 6 Nov 2000 15:40:33 GMT
	(envelope-from nik)
Date: Mon, 6 Nov 2000 15:40:33 +0000
From: Nik Clayton <nik@freebsd.org>
To: Murray Stokely <murray@osd.bsdi.com>
Cc: freebsd-doc@freebsd.org
Subject: Re: <programlisting> woes
Message-ID: <20001106154033.A2012@canyon.nothing-going-on.org>
References: <Pine.BSF.4.21.0011060307410.5211-100000@pike.osd.bsdi.com>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
User-Agent: Mutt/1.2.5i
In-Reply-To: <Pine.BSF.4.21.0011060307410.5211-100000@pike.osd.bsdi.com>; from murray@osd.bsdi.com on Mon, Nov 06, 2000 at 03:12:03AM -0800
Organization: FreeBSD Project <URL:http://www.freebsd.org/>
Sender: owner-freebsd-doc@FreeBSD.ORG
Precedence: bulk
X-Loop: FreeBSD.org

On Mon, Nov 06, 2000 at 03:12:03AM -0800, Murray Stokely wrote:
>   What's the best way to include source code within DocBook?
> Currently I'm using <programlisting> but I don't want to have to
> enclose my header files, and pointers within <literal> tags so that
> Jade doesn't think I'm referring to non existant sgml tags (like
> sys/types.h) or unknown entities (like &buffer).
>   I don't think that the actual code in a program listing should be
> marked up, should it?  For some reason I assumed a programlisting
> would contain nothing but character data.

Either;

 1.  Wrap the code in a CDATA marked section, like this;

     <programlisting><![ CDATA [#include <stdio.h>
     
     int main(void) { printf("hello, world\n"); }]]></programlisting>

     This won't work if the code you're including has ']]>' in it somewhere.

 2.  s/</&lt;/g in the code you include.

 3.  Keep it as a separate file, and use a gross hack in the stylesheets.

     <programlisting><inlinegraphic format="linespecifc fileref="filename.c">
     </inlinegraphic></programlisting>

     which will pull in filename.c as the output is being processed, and
     do the right thing.

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