db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-1972) Working With Derby needs some formatting fixes and other minor cleanup
Date Wed, 06 Dec 2006 18:35:23 GMT
    [ http://issues.apache.org/jira/browse/DERBY-1972?page=comments#action_12456158 ] 
Kim Haase commented on DERBY-1972:

Thanks, Laura! I'm glad we are in agreement about what doc conventions are normal. I agree
with proposing to the list that we update Getting Started to use what we might call "conventional
conventions" and that we incrementally update the docs to use them. 

So if we can do that, then filepath and cmdname should be in code font. And as you say, userinput
should be in bold code font instead of the current plain code font. 

I have learned a little XSL in my time, but it gets me only so far with the toolkit, whose
organization is rather baroque. However, I think I have actually found the files that we could
change for both the HTML and the PDF/monohtml output: DITA-OT1.1.2.1/xsl/xslhtml/sw-d.xsl
and DITA-OT1.1.2.1/xsl/xslfo/domains2fo.xsl.

I'll work with your comments in the meantime.

> 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
>         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


View raw message