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

[Peter TB Brett <peter-at-NOSPAMpeter-b_dot_co_dot_uk>]

On Wednesday 18 April 2007 13:39:00 Ales Hvezda wrote:
> [snip]
>
> >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.
>
> 	Ah, when exactly would the gschemdoc not find the local wiki copy?
> I don't see how that is possible if the user has installed all the geda-*
> files (which btw is highly recommended; nowhere (it better not) does it
> say you can just install one piece and have it all work correctly).

Yes, but it's always nice for features to gracefully degrade.  OTOH, I quite 
like the idea of having a button which will take me directly to the live 
version of the gEDA wiki, so if these changes go in I probably **won't** 
install the gEDA documentation package in the future.

By the way, can you check that the troff call actually does the right thing?  
It appears to work for everything I've tried, but if it doesn't match the 
substitution done when the wiki is exported someone will eventually trip up 
on it.

> 	In the bug report you mentioned some sort of future enhancements
> to make the manual more useful.  I thought it was pretty useful already,
> what sort of things are you planning on adding?  Thanks,

I'll be a good little hacker, and let the code speak for itself.  Patches 
attached:

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.

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.

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
     - "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

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".

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.


Cheers,

Peter


-- 
Fisher Society committee                    http://tinyurl.com/o39w2
CUSBC novices, match and league secretary   http://tinyurl.com/mwrc9
CU Spaceflight                              http://tinyurl.com/ognu2

v3sw6YChw7$ln3pr6$ck3ma8u7+Lw3+2m0l7Ci6e4+8t4Gb8en6g6Pa2Xs5Mr4p4
  hackerkey.com                                  peter-b.co.uk

gschemdoc-patches.tar.bz2

PGP signature

_______________________________________________
geda-dev mailing list
geda-dev@moria.seul.org
http://www.seul.org/cgi-bin/mailman/listinfo/geda-dev