db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Stanley Bradbury <Stan.Bradb...@gmail.com>
Subject Re: [jira] Commented: (DERBY-408) Fix formatting of manuals in PDF output
Date Mon, 16 Oct 2006 23:50:47 GMT
Hi Kim -
Please do open an issue on WWD (Working With Derby) and correct these 
problems.  Having the lines run together as shown in your comment on 
10/12 is awful.  Several people contributed to the document in the form 
of input and reviews, I did the original contribution and take no 
offense to any changes members of the community deem appropriate (this 
change is more 'badly needed' than 'deem appropriate').  Halley has 
already done some clean-up (see: Derby-1394).  I 'winged' the formatting 
in the <codeblock> sections in hopes it would be easier to read the 
longer interactive examples but I'm not certain it made a big 
difference.  And now, of course, it is broken.

 I also noted Derby-1948 filed today 
(http://issues.apache.org/jira/browse/DERBY-1948 ) caused by the changes 
in the DEMO directory structure - the PROGRAMS folder did not exist in 
early builds of 10.2 - references to $DERBY_HOME/demo/<subdir>  need to 
be changed to $DERBY_HOME/demo/programs/<subdir>.  While you have the 
files open could you correct this as well?  I don't know when I could 
get around to making even such a small correction.

And; Thanks for the kind words about the document.

Kim Haase wrote:
> Hi, Laura,
>
> Thanks for this comment. I've been wondering about the tagging in the
> Working with Derby book -- I think it is often unconventional (should
> output be in italics?? I don't think so). There is a DITA - to - XSL-FO
> problem, as you say, but possibly the formatting should be cleaned up
> too. This would be a separate bug, though. I could file it (and fix it)
> if you think it would be worth while.
>
> I'm sending this offline as I don't know who contributed the WWD book --
> it's good to have it and the content is very useful -- and I don't want
> to hurt their feelings.
>
> Kim
>
> Laura Stewart (JIRA) wrote On 10/16/06 12:25,:
>   
>>     [ http://issues.apache.org/jira/browse/DERBY-408?page=comments#action_12442633
] 
>>             
>> Laura Stewart commented on DERBY-408:
>> -------------------------------------
>>
>> I don't believe that the documentation should use tags like bold <b> to force
line breaks. Infact, in most cases there shouldn't be bold tags inside of codeblocks and syntax.
 Typically uppercase letters are used for the required SQL and lowercase letters for the variables
such as index-name. Sometimes <varname> is used for the variables, which displays the
text in italic.  
>>
>> This sounds like a DITA - to - XSL-FO problem. 
>>
>>     
    ===   SNIP  ==




Mime
View raw message