Re: [Chicken-users] wiki->texi converter

[felix winkelmann]

On 7/29/07, Ivan Raikov <address@hidden> wrote:
>
> Hi all,
>
>    I have further improved the wiki->texi converter, to the point
> where it is able to produce a usable Chicken manual in Texinfo
> format. I have created a ticket on trac.calcc.org that includes a
> texinfo-related patch to stream-wiki, and an example script to
> generate the manual:
>
> http://trac.callcc.org/ticket/289
>

Excellent, Ivan! This was much needed and I hope we can get this
integrated soon.  I'll look at this and get back to you.

>
> There are still the following restrictions remaining:
>
> 1. The input files need to be ordered according to their logical
> order. Apparently the Texinfo conventions require that the sectional
> units are in the order suggested by their navigational links. So a
> Texinfo document that consists of sectional units ordered in
> e.g. alphabetical order, is not permitted to have navigational links
> that impose a different order.

That applies to the bottom "Prev/Next" links on each page, right?

>
> 2. All the references in the wiki documents must refer to sectional
> units, such as chapters, sections, and subsections. Whereas in a wiki
> document you could have a link like [[User's manual]], which points to
> a wiki _page_ of that title, the wiki->texi converter does not know
> about wiki pages (because the stream-wiki driver API is
> stream-oriented, not page-oriented) so in order for a link to be valid
> in the Texinfo document, it must point to a section or subsection.
>

Would the translation have to modify existing links or can it convert them?

>    The wiki->texi converter also requires that all wiki (local)
> references point to sectional units that are present in the input wiki
> stream. So I have changed all references to eggs in the Chicken wiki
> manual from e.g. [[tinyclos]] to
> [[http://www.call-with-current-continuation.org/tinyclos.html]],
> otherwise the Chicken manual would also have to include the
> documentation for the eggs it refers to.
>


cheers,
felix