OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

docbook-apps message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: RE: [docbook-apps] Suggested Writing Style


I typically include the programlisting as a child of the para if the para introduces it.  I consider it good structuring and it makes content reuse easier (pull the para and get the programlisting it describes as part of the operation).  I typically start the first line of the program on the same line as the opening programlisting tag and end the listing on the same line as the closing tag. unless there is a reason to want the extra space before and after the listing.  By providing IDs on both the listing and the parent para it is possible to extract the programlisting for reuse if required, but the more common operation of including the listing with the introductory paragraph is simplified.  I have never run into needing the intro para without the listing, since it always refers to the listing and ends with a colon as a hint to the reader that something is coming up.

Larry Rowland

-----Original Message-----
From: Jeroen Ruigrok/asmodai [mailto:asmodai@in-nomine.org] 
Sent: Wednesday, August 16, 2006 6:48 AM
To: Sean Wheller
Cc: docbook-apps@lists.oasis-open.org; Bob Stayton
Subject: Re: [docbook-apps] Suggested Writing Style

-On [20060816 11:35], Sean Wheller (sean@inwords.co.za) wrote:
>I never use it this way. I do:
>
><para>this example consists of:</para>
>	<programlisting>
>testing
>	</programlisting>
><para>more text</para>

Sure, fair enough.

However <para> does allow a <programlisting> as a child though.

Which makes me wonder if it might not just be a stylesheet issue. Hopefully
Bob can confirm or deny that. :)

-- 
Jeroen Ruigrok van der Werven <asmodai(-at-)in-nomine.org> / asmodai
イェルーン ラウフロック ヴァン デル ウェルヴェン
http://www.in-nomine.org/
If you would thoroughly know anything, teach it to others...

---------------------------------------------------------------------
To unsubscribe, e-mail: docbook-apps-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: docbook-apps-help@lists.oasis-open.org


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]