octave-maintainers
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: @ref into @seealso


From: David Bateman
Subject: Re: @ref into @seealso
Date: Tue, 21 Oct 2008 09:15:51 +0100
User-agent: Mozilla-Thunderbird 2.0.0.16 (X11/20080724)

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?

regards

Thorsten Meyer


Couldn't this be done in the @seealso macro itself? Also Soren did something similar in python for the Octave-forge webpages, where the @seealso macros create hyper-links to the other functions. See for example

http://octave.sourceforge.net/doc/f/cat.html

that cross references horzcat and vertcat.

Regards
David

--
David Bateman                                address@hidden
Motorola Labs - Paris +33 1 69 35 48 04 (Ph) Parc Les Algorithmes, Commune de St Aubin +33 6 72 01 06 33 (Mob) 91193 Gif-Sur-Yvette FRANCE +33 1 69 35 77 01 (Fax) The information contained in this communication has been classified as: [x] General Business Information [ ] Motorola Internal Use Only [ ] Motorola Confidential Proprietary



reply via email to

[Prev in Thread] Current Thread [Next in Thread]