Suggested Writing Style

Hi,

Is there any suggested writing style for DocBook?
May I know what the main stream is for this following:

(a)
<para>Blah... Blah... Blah sentences.</para>

(b)
<para>
Blah... Blah... Blah... sentences.
</para>

(c)
<para>
   Blah... Blah...
   Blah... sentences.
</para>

(d)
Other:
. . .

How about itemized sentences?

regards,

-- 
EL6

------------------------------------------------------------
---------
To unsubscribe, e-mail: docbook-apps-unsubscribelists.oasis-open.org
For additional commands, e-mail: docbook-apps-helplists.oasis-open.org

On Thursday 10 August 2006 14:07, Euis Luhuanam wrote:
> <para>Blah... Blah... Blah
sentences.</para>

This way is correct. Any other will induce spaces into the
before and after of 
the element value.
-- 
Ask me about the Monkey.

Sean Wheller
Technical Author
seaninwords.co.za
+27-84-854-9408
http://www.inwords.co.za

------------------------------------------------------------
---------
To unsubscribe, e-mail: docbook-apps-unsubscribelists.oasis-open.org
For additional commands, e-mail: docbook-apps-helplists.oasis-open.org

Sean Wheller wrote:
>> <para>Blah... Blah... Blah
sentences.</para>
> This way is correct. Any other will induce spaces into
the before and after of
> the element value.

Thank you! This brings me to the second issue:
"Does the space matter"?

CMIIW: It seems that xsltproc cares less then when I was
using
SGML with Jade tools,

-- 
EL6.

------------------------------------------------------------
---------
To unsubscribe, e-mail: docbook-apps-unsubscribelists.oasis-open.org
For additional commands, e-mail: docbook-apps-helplists.oasis-open.org

On Thursday 10 August 2006 16:04, Euis Luhuanam wrote:
> Sean Wheller wrote:
> >> <para>Blah... Blah... Blah
sentences.</para>
> >
> > This way is correct. Any other will induce spaces
into the before and
> > after of the element value.
>
> Thank you! This brings me to the second issue:
> "Does the space matter"?
>
> CMIIW: It seems that xsltproc cares less then when I
was using
> SGML with Jade tools,

Yes it does, if you want to consider that your files may be
portable across 
systems. To be safe, just keep to the above.
-- 
Ask me about the Monkey.

Sean Wheller
Technical Author
seaninwords.co.za
+27-84-854-9408
http://www.inwords.co.za

------------------------------------------------------------
---------
To unsubscribe, e-mail: docbook-apps-unsubscribelists.oasis-open.org
For additional commands, e-mail: docbook-apps-helplists.oasis-open.org

So, based on Sean's response and Bob's elaboration about
elements
allowing PCDATA, let me ask about another case. Let's say I
have a
paragraph with footnotes...

Should I have (1):

<para>This is text.<footnote><para>This is
a
footnote.</para></footnote>  This is more
text.</para>

Or should I have (2):

<para>This is text.
<footnote>
<para>This is a footnote.</para>
</footnote>
This is more text.</para>

Or what if I have a footnote for the last sentence of a
paragraph (3)?

<para>This is the first sentence. This is the last
sentence.<footnote><para>This is the
footnote.</para></footnote></para>

Or this (4):

<para>This is the first sentence. This is the last
sentence.
<footnote>
<para>This is the footnote.</para>
</footnote></para>

Or this (5):
<para>This is the first sentence. This is the last
sentence.
<footnote>
<para>This is the footnote.</para>
</footnote>
</para>

If I read Sean and Bob right, (1) and (2) should be
equivalent and
should produce a nicely formatted paragraph and footnote
without
extraneous spaces? But (4) and (5) may introduce a trailing
space?

Mike

----------------------------
Mike Broschinsky
Administrative Code Editor
Utah State Division of Administrative Rules
801-538-3003
mbroschiutah.gov

>>> Sean Wheller <seaninwords.co.za>
08/10/2006 06:30 >>>
On Thursday 10 August 2006 14:07, Euis Luhuanam wrote:
> <para>Blah... Blah... Blah
sentences.</para>

This way is correct. Any other will induce spaces into the
before and
after of 
the element value.
-- 
Ask me about the Monkey.

Sean Wheller
Technical Author
seaninwords.co.za 
+27-84-854-9408
http://www.inwords.co.za


------------------------------------------------------------
---------
To unsubscribe, e-mail: docbook-apps-unsubscribelists.oasis-open.org 
For additional commands, e-mail: docbook-apps-helplists.oasis-open.org



------------------------------------------------------------
---------
To unsubscribe, e-mail: docbook-apps-unsubscribelists.oasis-open.org
For additional commands, e-mail: docbook-apps-helplists.oasis-open.org

> If I read Sean and Bob right, (1) and (2) should be
equivalent and
> should produce a nicely formatted paragraph and
footnote without
> extraneous spaces? But (4) and (5) may introduce a
trailing space?

I am curious. Why not just run a transformation with each of
your senarios and 
investigate the result to see what will happen?


<?xml version="1.0"
encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML
V4.4//EN"
                         "http://ww
w.docbook.org/xml/4.4/docbookx.dtd">
<article>
	<title>Article Title</title>
	<!--So, based on Sean's response and Bob's elaboration
about elements
	allowing PCDATA, let me ask about another case. Let's say
I have a
	paragraph with footnotes...-->
	
	<!--Should I have (1):-->
	
	<para>This is text.<footnote><para>This
is a
		footnote.</para></footnote>  This is more
text.</para>
	
	<!--Or should I have (2):-->
	
	<para>This is text.
		<footnote>
			<para>This is a footnote.</para>
		</footnote>
		This is more text.</para>
	
	<!--Or what if I have a footnote for the last sentence
of a paragraph (3)?-->
	
	<para>This is the first sentence. This is the last
		sentence.<footnote><para>This is the
footnote.</para></footnote></para>
	
	<!--Or this (4):-->
	
	<para>This is the first sentence. This is the last
sentence.
		<footnote>
			<para>This is the footnote.</para>
		</footnote></para>
	
	<!--Or this (5):-->
	<para>This is the first sentence. This is the last
sentence.
		<footnote>
			<para>This is the footnote.</para>
		</footnote>
	</para>
	
	<!--If I read Sean and Bob right, (1) and (2) should be
equivalent and
	should produce a nicely formatted paragraph and footnote
without
	extraneous spaces? But (4) and (5) may introduce a trailing
space?-->
</article>


This will produce
-- 
Ask me about the Monkey.

Sean Wheller
Technical Author
seaninwords.co.za
+27-84-854-9408
http://www.inwords.co.za

------------------------------------------------------------
---------
To unsubscribe, e-mail: docbook-apps-unsubscribelists.oasis-open.org
For additional commands, e-mail: docbook-apps-helplists.oasis-open.org