From help-request at octave dot org Sat Jan  7 16:24:11 2006
Subject: Re: Re octave-forge DOCSTRINGS
From: Paul Kienzle <pkienzle at users dot sourceforge dot net>
To: David dot Bateman at motorola dot com
Cc: Jorge Barros de Abreu <ficmatin01 at solar dot com dot br>,         Help-Octave <help@octave.org>
Date: Sat, 7 Jan 2006 17:22:15 -0500

I believe the idea is to generate the base documentation files for the  
octave translation project.  Currently we are generating the octave  
files from the DOCSTRINGS.

Since make_index is unwieldy as a monolithic package, I think it makes  
sense to break it into separate programs for extracting the docstrings  
and converting to HTML.  A small detail is that make_index also wants  
the location of the original file so that we can point to it in the  
CVS, so the docstrings format will need to be extended a bit.

Hmmm... maybe it is time for me to learn about Python and XML.

	- Paul

On Jan 7, 2006, at 4:16 PM, David Bateman wrote:

> ./admin/make_index will create an index in html from of all of the  
> functions listed in one of the INDEX files if run in the head of  
> octave-forge and octave itself is placed in ../octave relative to this  
> point. This is what is used to create the category index on the  
> octave-forge home page. If its not in one of the INDEX files its  
> probably an internal function (or maybe a new function that wasn't  
> indexed when introduced), so this is probably what you want...
>
> If run from a sub-directory of octave-forge make_index outputs to the  
> standard output, the first sentence of every function description in  
> the INDEX file in the current directory. This is useful if you ever  
> want to create a contents.m file.
>
> Finally I created a function a long time back to get the help as a  
> string, as part of an early thread about Soren's package manager on  
> octave-forge. See the message
>
> http://sourceforge.net/mailarchive/forum.php? 
> thread_id=4850715&forum_id=4874
>
> this might also be of help to you...
>
> Cheers
> David
>
>
>
> -------------------------------------------------------------
> Octave is freely available under the terms of the GNU GPL.
>
> Octave's home on the web:  http://www.octave.org
> How to fund new projects:  http://www.octave.org/funding.html
> Subscription information:  http://www.octave.org/archive.html
> -------------------------------------------------------------
>



-------------------------------------------------------------
Octave is freely available under the terms of the GNU GPL.

Octave's home on the web:  http://www.octave.org
How to fund new projects:  http://www.octave.org/funding.html
Subscription information:  http://www.octave.org/archive.html
-------------------------------------------------------------