manual page for addons

4 messages Options
Embed this post
Permalink
Facundo Muñoz

manual page for addons

Reply Threaded More More options
Print post
Permalink

Hi,
I'm using a grass script of my own (say script.sh) which is located in a
separate directory pointed by GRASS_ADDON_PATH.
However, the graphical interface provided by g.parser does not show the
corresponding manual page.
I have a script.sh.html in the same directory. ¿Should I put a copy in
/usr/share/doc/grass-doc/html/?
¿Is there any other environment variable pointing to the add-on
documentation?

Thanks!
ƒacu.-
_______________________________________________
grass-user mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/grass-user
Markus Neteler

Re: manual page for addons

Reply Threaded More More options
Print post
Permalink
2009/9/16 Facundo Muñoz <[hidden email]>:
>
> Hi,
> I'm using a grass script of my own (say script.sh) which is located in a
> separate directory pointed by GRASS_ADDON_PATH.
> However, the graphical interface provided by g.parser does not show the
> corresponding manual page.
> I have a script.sh.html in the same directory. ¿Should I put a copy in
> /usr/share/doc/grass-doc/html/?

Yes.

> ¿Is there any other environment variable pointing to the add-on
> documentation?

AFAIK that's not (yet?) available.

Markus

> Thanks!
> ƒacu.-
> _______________________________________________
> grass-user mailing list
> [hidden email]
> http://lists.osgeo.org/mailman/listinfo/grass-user
>
_______________________________________________
grass-user mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/grass-user
hamish-2

Re: manual page for addons

Reply Threaded More More options
Print post
Permalink
there may be something in William's extra ETC for frameworks magic.


Hamish




_______________________________________________
grass-user mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/grass-user
William Kyngesburye

Re: manual page for addons

Reply Threaded More More options
Print post
Permalink
There was some discussion this summer in relation to g.extension about  
user-addon paths.

For user manual pages, see how I do it for OSX in macosx/app/
build_html_user_index.sh.  It's basically a copy of  
build_html_index.sh (used in compilation only) changed to build a user  
html index on startup, from a known path (not GRASS_ADDON_PATH).  It's  
a bit clunky because the installed help index is static, so the user  
help index must be a separate index, and it's not possible to link to  
a user's home folder from the main index in html (because it's  
variable).

I think GRASS needs a more structured external addon path setup than  
the loose GRASS_ADDON_PATH (which only extends the env PATH).  My  
GRASS_ADDON_ETC, and companion g.findetc is one step to this, but it  
doesn't say anything about help files.

On Nov 1, 2009, at 8:30 PM, Hamish wrote:

> there may be something in William's extra ETC for frameworks magic.
>
>
> Hamish
>

-----
William Kyngesburye <kyngchaos*at*kyngchaos*dot*com>
http://www.kyngchaos.com/

"Oh, look, I seem to have fallen down a deep, dark hole.  Now what  
does that remind me of?  Ah, yes - life."

- Marvin


_______________________________________________
grass-user mailing list
[hidden email]
http://lists.osgeo.org/mailman/listinfo/grass-user