[Laszlo-dev] Handling of the docs

Tue Jan 15 05:45:41 PST 2008

Hi Ono,

Ben has left Laszlo to pursue other opportunities. I had hoped that he 
would still be responding on the community mailing lists, but perhaps he 
is too busy. We are working on transitioning the doctools work to other 
developers in the group. I will find you another contact to help, but it 
may take a day or so.

Best,

-- Amy

On Mon, Jan 14, 2008 at 11:54 PM, keiji Ono wrote:

Ben, Ben ..... where have you gone ?
I have a ton of questions how to make JP doc.

ono

keiji Ono wrote: Ok ben,
The js2doc.rng target in $LPS_HOME/docs/src/build.xml could not work 
correctly.
So i have to build js2doc.rng by using $LPS_HOME/WEB-INF/lps/server 
before it.
I guess the reason why there are not js2doc.rng at the first time of the 
documents build,
The procedure i did as following,
     1. cd $LPS_HOME/WEB-INF/lps/server
     2. ant js2doc.rng
     3. cd $LPS_HOME/docs/src
     4. ant developers

Unfortunately i am not familiar with the description of build.xml.
So i could not send you any patch of build.xml. I just report to jira.
That was OBI-59. But i am not sure this report has been registerd right 
project.
Please check it.

Next, the issue of  building "developers-jp" has some trouble.
　　−before building
　　   need a procedure copy 'tutorial' directory from 'developers' to 
'*-jp'

　　−result of building
　　   some directories, 'data', 'images' and so on, were created in 
'docs/developers-jp' correctly
　     but all *.html files were created in 'docs/developers', not in 
'docs/developers-jp'

I guess the environment variable '${ local.output.dir }' was described 
in any files, but i could not
find it.

Thanks in advance.

Best,
ono

keiji Ono wrote: Hi Ben,

Sorry for late my reply and thank you for your detailed explanation.
I have tried it with doing *ant developers* simply for process
confirmation, before
make *jp*, but gotten error as following.

developers.preprocess:
build.xml:1143: Warning: Could not find file
<path>\lps\server\lib\js2doc.rnc to copy.

But the js2doc.rnc exist at the path.
I saw it when was building LPS too.
I am using Cygwin and revision 7781.

Thanks in advance.

Keiji Ono

Benjamin Shine wrote: Ono-san, I've prepared documentation that will 
help you create the
Japanese developer's guide using the documentation toolchain.

This is the chapter where you should start: 
http://labs.openlaszlo.org/trunk-nightly/docs/developers/doc 
<http://labs.openlaszlo.org/trunk-nightly/docs/developers/doc> -
toolchain.html

These sections in particular: 
http://labs.openlaszlo.org/trunk-nightly/docs/developers/doc 
<http://labs.openlaszlo.org/trunk-nightly/docs/developers/doc> -
toolchain.html#docbook-is-central 
http://labs.openlaszlo.org/trunk-nightly/docs/developers/doc 
<http://labs.openlaszlo.org/trunk-nightly/docs/developers/doc> -
toolchain.html#developers-guide-toolchain 
http://labs.openlaszlo.org/trunk-nightly/docs/developers/doc 
<http://labs.openlaszlo.org/trunk-nightly/docs/developers/doc> -
toolchain.html#docbook-to-output
and http://labs.openlaszlo.org/trunk-nightly/docs/developers/doc 
<http://labs.openlaszlo.org/trunk-nightly/docs/developers/doc> -
toolchain.html#how-ant-drives
See http://labs.openlaszlo.org/trunk-nightly/docs/developers/doc 
<http://labs.openlaszlo.org/trunk-nightly/docs/developers/doc> -
toolchain.html#directory-structure
for details of the directory structure

The basic approach I recommend for building the developer's guide in
Japanese is to duplicate the (english) developers build using a
parallel directory structure and parallel ant tasks.

Make a directory
docs/src/developers-jp
(It is very important that the developer's guide japanese directory is
a sibling to the developer's guide english directory. Do not make
docs/src/japanese/developers -- trust me that this will cause problems.)
Copy
docs/src/developers/index.dbk
into
docs/src/developers-jp/index.dbk
and copy each of the chapters from docs/src/developers/*.dbk into
docs/src/developers-jp/

In docs/src/build.xml, make a copy of these ant tasks, renaming them
with .jp:
developers --> developers.jp
developers.resources --> developers.jp.resources
developers.preprocess --> developers.jp.preprocess
developers.html.generate --> developers.jp.html.generate
developers.examples.preprocess --> developers.jp.examples.preprocess

Those ant tasks are parameterized with directories for docbook
sources, intermediate files, and output files. Make your jp versions
of these tasks refer to the developers-jp directories. For example,
the ant property
developers.src.dir is set to $LPS_HOME/docs/src/developers, so you
should make developers.jp.src.dir with the value $LPS_HOME/docs/src/
developers-jp.

Once you have taken all of these steps, you should be able to say "ant
developers.jp" and create $LPS_HOME/docs/developers-jp/ index.html.
Then you will be ready to put actual Japanese content into the docbook
files in docs/src/developers-jp/

I hope this helps! Let us know how it goes!

-ben

On Dec 25, 2007, at 4:35 AM, keiji Ono wrote: Hi Ben,

Now i am working in 4.0.7 devguide.
I have known there were some differences between 4.0.7 and nightly even
content.
It is hardly to catch up on every version to translate manually.
Maybe it is good for me to work with your tools.
I have never experienced with both xsl and docbook, but if circumstances
require,
i will do them.

Best regards,
Keiji Ono

Benjamin Shine wrote: Sorry, Ono-san, our servers were down last night. 
Please try those
URLs again, and let me know how far your current Japanese version is
from those.

To communicate about the tools, it will help me to know how much, if
anything, you know about xsl, docbook, and ant. Do you have any
experience with any of those?

Thanks!
-ben

On Dec 20, 2007, at 12:04 AM, keiji Ono wrote: Hi Ben,

Thank you for your reply, Ben.
It is good for us to be built the document by *tools*.
In fact, the working of translation is hard and it contains some
troubles by
version up.
We are always finding the OpenLaszlo documents quite impressive.
They have described in detail and very useful, so we did not need
another one.
But, for getting more OpenLaszlo user in Japan, we have to meet the
need
now.

By the way, could you check the ULRs that you said to me?
They were 404( not found ).

Best regards,
Keiji Ono

Benjamin Shine wrote: Ono-san,

I'd like to help make sure that the Japanese developer's guide is
based on the most recent, best English developer's guide. I'll be
your
contact on this issue for now. We've been working a lot on the
developer guide and documentation tools for the last six months.
We've
changed the workflow for developer's guide chapters a lot; now the
source is written in formal docbook files. Let me help you get up to
date using the new documentation tools, and work with you on the ant
files to make them build the developer's guide Japanese version
properly.

Unfortunately, these tools are not well-documented yet; I'll be
working on that in the next two weeks.

To check where you are right now, please look at, for instance, 
http://labs.openlaszlo.org/trunk-nightly/docs/developers/ 
<http://labs.openlaszlo.org/trunk-nightly/docs/developers/> 
architecture.html
and http://labs.openlaszlo.org/trunk-nightly/docs/developers/ 
<http://labs.openlaszlo.org/trunk-nightly/docs/developers/> 
compiler.html

How different are these from what you're working on in Japanese?

best,
ben

On Dec 17, 2007, at 12:59 AM, keiji Ono wrote: Hi,
I am working translation Dev's Guide to Japanese now.
And i worry about how to know changing part of it in next version.
Adding it, what is going on LZX Ref ?
I would appreciate it if John took care of this issue.

Regards,
Keiji Ono
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://www.openlaszlo.org/pipermail/laszlo-dev/attachments/20080115/3352fbaa/attachment-0001.html