@ref into @seealso

John W. Eaton jwe at bevo.che.wisc.edu
Tue Oct 21 09:57:49 CDT 2008


On 21-Oct-2008, Søren Hauberg wrote:

| tir, 21 10 2008 kl. 09:15 +0100, skrev David Bateman:
| > Thorsten Meyer wrote:
| > > Hi,
| > >
| > > I think that it would be quite useful to transform the references in the
| > > @seealso sections in the documentation of the octave functions into
| > > texinfo references (e.g. @ref).
| > > I would like to do it like that:
| > >  - add a perl script to the make sequence of the octave documentation,
| > > that does the following:
| > > - parse the .txi files to collect information on which file  	  contains
| > > the documentation of which function
| > > - postprocess the DOCSTRINGS files to transform all
| > > @seealso(anyfunction) sections into @seealso(@ref(anyfunction,,its-txifile))
| > >
| > > (I have found, that anchor for all the functions already get added to	
| > > the .texi files by munch-texi).
| > >
| > > Would you consider an according changeset?
| > > Is it ok to add the (as far as I can see) second perl dependency to the
| > > build process?

Why would it need to be a second script?  Couldn't this be added to
the munge-texi program?

| Yeah, I think I did that in python. I remember trying to do it directly
| in texinfo, but for some reason that never worked out.

The macro capabilities of Texinfo are unfortunately pretty limited.  I
don't think there is a good way to parse an argument to a macro, so
splitting the elements of the seealso list is probably impossible.

jwe



More information about the Octave-maintainers mailing list