gEDA-dev: [PATCH*5] gschemdoc & gschem help menu changes

[Ales Hvezda]

Hi PeterB,

> By the way, can you check that the troff call actually does the right thing?  

What troff call?  In the patch (I haven't looked yet at the patches)?

> 01-gschemdoc-wiki.patch
> 
>     Allow gschemdoc to access wiki pages with -w.
>     
>     Adds the gschemdoc -w switch to make gschemdoc load a wiki page.
>     It initially tries to find a local export of the wiki; on failure,
>     it falls back to the online wiki at the gEDA website.

I'm sorta on the fence with this.  I don't know if I want many people
not installing the docs and going to the online wiki.  The whole point
of creating an offline version of the docs is to minimize bandwidth
requirements (yes, the wiki is _not_ bandwidth friendly).  Also, what
web address are you planning on putting into the code?  I can pretty much
guarantee it won't be correct in the next few months.  Also, there will
be version skew between what version of gEDA/gaf they are using and the
wiki (there might be things mentioned in the online version that haven't
yet been implemented in the current version they are using).

> 
> 02-gschem-browse-wiki.patch
> 
>     Add the gschem-browse-wiki Scheme function.
>     
>     This function allows Scheme code to open a browser to a wiki page by
>     calling gschemdoc with its -w option.  This will facilitate adding more
>     useful things to gschem's "Help" menu without needing a large number of
>     callbacks to be added to gschem.

Okay.

> 
> 03-gschem-help-menu.patch
> 
>     Rearrange gschem help menu & make it link to wiki pages.
>     
>     Rearrange the gschem help menu:
>      - "Manual" now links directly to the gschem User Guide

Hmm.. Not sure on this one.  I would prefer if the Manual link pointed
to the toplevel, until the UG gets some loving attention (and gsch2pcb
tutorial gets put into the wiki).

>      - "FAQ" now links directly to the gschem FAQ
>      - Add menu item which links directly to the wiki root page
>      - Rearrange "About" and "Hotkeys" to bottom of menu

Okay.

> 
> 04-gschem-del-help-manual.patch
> 
>     Remove "help-manual" Guile callback.
>     
>     The role of the "help-manual" Guile function exported by
>     gschem has been superceded by the new "gschem-browse-wiki"
>     function.  This patch removes "help-manual" from the C
>     source code entirely; "help-manual" is now a Scheme function
>     defined in "system-gschemrc".

Okay.

> 
> 05-move-gschemdoc.patch
> 
>     Move gschemdoc into the gschem package.
>     
>     Gschem relies heavily on gschemdoc, most importantly for its
>     "Help" menu functions, so it makes more sense for gschemdoc to
>     be in the gschem package than the utils package.

Okay.

-Ales