[ 
http://issues.apache.org/jira/browse/DERBY-1972?page=comments#action_12456569 ] 
            
Kim Haase commented on DERBY-1972:
----------------------------------

Now I remember why I used <pre> instead of <codeblock> when according to the 
DITA spec they work identically. The reason is that with our toolkit, they 
don't.

If I use <codeblock> for multi-line output that contains line breaks between 
tags, the toolkit ignores the line breaks when generating monohtml and PDF 
output. If I use <pre>, the line breaks are preserved. 

Tags followed by plain text are fine. For example, the following results in 
preserved line breaks:

<codeblock>
<b><userinput>java MyProgram</userinput></b>

program output
</codeblock>

But the following does not:

<codeblock>
<b><userinput>java MyProgram</userinput></b>

<systemoutput>program output</systemoutput>
</codeblock>

I've looked in the xsl files and the generated monohtml source and I can't 
figure out why this happens. But it definitely does. It's a bug, but until it's 
fixed we should either use <pre> if we want to preserve line breaks, or else 
use plain text instead of <systemoutput> to indicate system output. Do you have 
a preference?

I suspect this is the same bug that results in consecutive tags in plain text 
being munged together in the monohtml and PDF. For example, if you want to talk 
about the Derby ij tool, and you use the usual <ph> tag for Derby and then 
enclose "ij" in a <codeph> --

<ph conref="wwdconrefs.dita#prod/productshortname"></ph> <codeph>ij</codeph> 

The processor removes the space between </ph> and <codeph>, resulting in 
"Derbyij".

I reopened DERBY-408 to describe this problem back in October, but it has not 
been dealt with.

> Working With Derby needs some formatting fixes and other minor cleanup
> ----------------------------------------------------------------------
>
>                 Key: DERBY-1972
>                 URL: http://issues.apache.org/jira/browse/DERBY-1972
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.2.1.6
>            Reporter: Kim Haase
>         Assigned To: Kim Haase
>            Priority: Minor
>         Attachments: DERBY-1747.diff, DERBY-1972-2-dita.zip, 
> DERBY-1972-2.diff, DERBY-1972-2.zip, DERBY-1972.zip, DERBY_1972.diff
>
>
> The Working With Derby book uses DITA tags in ways that are not always 
> consistent with the usage in other books and that lead to some problems in 
> the processed output. Some examples are the use of the <varname> tag in 
> inappropriate places and the use of formatting tags within <codeblock> tags.
> There are also a few minor punctuation and syntax issues worth fixing.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: 
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Reply via email to