db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Laura Stewart (JIRA)" <derby-...@db.apache.org>
Subject [jira] Commented: (DERBY-1972) Working With Derby needs some formatting fixes and other minor cleanup
Date Wed, 18 Oct 2006 17:42:36 GMT
    [ http://issues.apache.org/jira/browse/DERBY-1972?page=comments#action_12443311 ] 
Laura Stewart commented on DERBY-1972:

I think that the topbot attribute should be removed from all of the <codeblock> tags
in the WWD book.  
None of the other books use that convention. The PDF and monohtml have gray backgrounds for
codeblocks to set off examples.
Also, instead of using stepxml and dl for the different operating systems, I recommend using
a choice table.  For example:

<chhead><choptionhd>Operating System</choptionhd><chdeschd>Step</chdeschd>
<chrow><choption>On Linux</choption><chdesc></chdesc></chrow>
<chrow><choption>On Windows</choption><chdesc></chdesc></chrow>

> 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:
>            Reporter: Kim Haase
>         Assigned To: Kim Haase
>            Priority: Minor
> 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


View raw message