Re: Re-write of documentation tree build process

[John Mandereau]

John Mandereau wrote:
> Han-Wen Nienhuys wrote: 
> > > diff --git a/stepmake/bin/add-html-footer.py 
> > > b/stepmake/bin/add-html-footer.py
> > > index 08ff5ff..9a28237 100644
> > > --- a/stepmake/bin/add-html-footer.py
> > > +++ b/stepmake/bin/add-html-footer.py
> > > @@ -13,7 +13,7 @@ import getopt
> > >  index_url=''
> > >  top_url=''
> > >  changelog_file=''
> > > -content_negotiation = False
> > > +targets = []
> > 
> > I think that this script could be cleaned up a lot if didn't try to do
> > two targets in one go. Can you look into doing something like
> > 
> >   find  online-root -name '*.html' | xargs $(footify)
> >   find  offline-root -name '*.html' | xargs $(footify)
> 
> It's easily doable if:
> -- all .html are hardlinked in both targets by build-trees, so the
> "specific files" (ie. HTML files) stuff could be dropped.
> -- add-html-footer is called for each target; for each .html file, it
> reads it, unlink it, process the page and write it.
> So, let's change to that.

Finally, doing one or both targets in add-html-footer doesn't change
things much: i18n() has to take a target argument and may needs return
several page flavors anyway, since the link tweaking (like '.html'
stripping in href's) is done in this function.



> I'm sending another patch according to your comments asap.

Here's finally the patch, against current stable/2.10 branch.
add-html-footer.py and build-trees.py are rewritten as modules, and
renamed respectively to add_html_footer.py and mirrortree.py.
I've moved most stuff from GNUmakefile.in:local-WWW-post to
stepmake/bin/www_post.py.

I've also put the language definitions in a new module langdefs.py,
since it could be shared with other scripts.
Thus, adding/disabling/enabling a language translation could be done by
editing only this file -- currently, there are also language defs in
html-gettext, and translated docs are enabled in
Documentation/GNUmakefile.

Before the next release including this patch, may I also add a link to
the French tutorial in index.html.in?

For the coming days/weeks, here's my to-do list for the docs i18n:
1) centralize language definitions and enabling (see above)

2) fix html-gettext.py so it really translates all node names

3) i18n add_html_footer, index.html.in and examples.html. This is
certainly much work relatively to the word count of these items, but
that's worth it IMO.

4) write TRANSLATION text file, giving hints to documentation editors
and translators: technical aspects, style guidelines in addition to
README.txt, ...

If you don't think these tasks are too urgent (you already know I'm not
very quick ;-), I'll work on them.


Regarding French translation of the user manual, introduction.itely
awaits for final polishing and validation, and Frédéric Chiasson has
started translating basic-notation.itely.

Cheers,
-- 
John Mandereau <address@hidden>

www-post.patch
Description: Text Data