Re: [cssed-devel] New plugin: developer doc plugin

[Iago R. <iag...@hi...>]

On Wed, 2004-09-15 at 03:44, Mich=C3=A8le Garoche wrote:
> I've just finished the plugin to view the doc for plugins in the user's=20
> favorite browser.
>=20
> The whole process consists of:
>=20
> 1 - Copying cssed/include/*.h into cssed-plugin-doc/include to be sure=20
> to have the latest headers
> 2 - Generate html with doxygen to be sure to have the latest docs
> 3 - Integrate cssed-plugin-doc/html into a new plugin, namely=20
> cssed-plugindoc-plugin
>=20
> That's to say the source files are not delivered, just the doc in html=20
> format, but the user can browse it from within cssed.

This should be carefully planned as the problems will be - surely - in
the packaging, not the plugin itself.

> As for browsing I use merely the open command, and the doc is placed in=20
> usr/share/cssed/plugindoc. A patch to src/plugindoc.c is necessary if=20
> the doc should not be placed at this location. A new item menu is added=20
> to the Plugins menu to browse the doc.

Much better to define it at compile time:
plugindocurl =3D PACKAGE_DATA_DIR "/" PACKAGE "/plugindoc/index.html"

> Tell me if it's OK. Then I'll upload both new doxygen files (updated to=20
> the latest headers) and the new plugin to my site, because they are too=20
> big to put them on the mailing list and post here the urls.

I'm making some sightly changes to it, as change system() with g_spawn_*
to have some error checking (right now it fails silently).

> I wonder if the right place in the menu should not be in Help menu=20
> (I've put it in Plugins menu). Then I could do the same for the user's=20
> doc, probably in the same plugin.

I will write the "default browser" part of the configuration file.

It's something that should be done a long time ago.

I must also interface in some way all help functions with the plugins
to  fix all documentation/help issues.

Then we could do the doc plugin much more usable.

What do you think ?

Should we go for this before this release, and "unfreeze" the code to
get docs into a plugin ??

This way we could make various doc packages depending on the browser
used.

I mean here, a web browser - as mozilla - or a help browser as yelp on
Gnome or *chm viewer on Win using the htmphelp API.

Is there any default help viewer on Mac ?
--=20
Iago Rubio  =20
- Home page    * http://www.iagorubio.com=20
- Last project * http://cssed.sourceforge.net        =20
- GPG Keyserv  * pgp.rediris.es id=3D0x909BD4DD