Re: [Cdk-jchempaint] Help generation

[Konstantin T. <an...@ya...>]

29.04.10, 10:59, "Stefan Kuhn" <ste...@eb...>:

> Hi Konstantin,
>  many thanks for looking at that. Help was a real problem. Another thing which 
>  I think we should have is
>  - a table of contents, which could be done manually
>  - an index, which can not be done manually
>  JavaHelp would take care of that, but JavaHelp is incompatible with our 
>  license. Does anybody have an idea about something like JavaHalp compatible 
>  with LGPL? 

IANAL, bu I don't think GPL license of JDK is really a problem, since you want only use it as helper tool. I's sources and binaries are nott components of end-product. Unfortunately, html generator I've committed is also under GPL, but I think we can use it for html generation (it's classes are not used in sources of JCP), maybe I should remove it from SVN (or ask the author for permission)

> Or have another idea about how to have toc/index?

Did you look at HtmlExample.java? We could have special method or class for generation of each page, and it won't e difficult to index them all automatically. 

>  Stefan
>  
>  On Wednesday 28 April 2010 17:32:50 Konstantin Tokarev wrote:
>  > HTML help in JCP has many drawbacks: many HTML errors, needs manual
>  > correction when icon names change, difficult to maintain translations
>  >
>  > I propose to use HTML generation instead. I've added new target
>  > generateHelp, which currently executes class HtmlExample from src/util, it
>  > produces file example.html in
>  > dist/classes/org/openscience/jchempaint/resources/userhelp_jcp/en_US/exampl
>  >e.html. It's almost identical to jcp.html, but: a) is valid
>  > b) style of contents could be easily customized since all elements are
>  > generated by function contentsEntry() c) is potentially translatable with
>  > GT
>  >
>  > But I couldn't set up i18n, GT produces crap (should return the same
>  > english strings because they have no translations) Maybe, it's possible to
>  > use separate po directory for help translation
>  
>  
>  
>  

-- 
Regards,
Konstantin

Яндекс.Почта. Письма есть. Спама - нет. http://mail.yandex.ru/nospam/sign