Difference between revisions of "Embedded Help"
Jump to navigation
Jump to search
m (→From Colin) |
(+Open Questions) |
||
| Line 1: | Line 1: | ||
= From Colin = | == From Colin == | ||
* [http://developer.gnome.org/projects/gdp/handbook/gdp-handbook/ar01s08.html "Writing Context Sensitive Help (coming in GNOME-3.0)"] | * [http://developer.gnome.org/projects/gdp/handbook/gdp-handbook/ar01s08.html "Writing Context Sensitive Help (coming in GNOME-3.0)"] | ||
* I guess we should convince pygmee and Kevin to change [http://svn.sourceforge.net/viewcvs.cgi/inkscape/user_manual/trunk/ their manual] so that it fits for that purpose, whatever change is necessary. | * I guess we should convince pygmee and Kevin to change [http://svn.sourceforge.net/viewcvs.cgi/inkscape/user_manual/trunk/ their manual] so that it fits for that purpose, whatever change is necessary. | ||
| Line 5: | Line 5: | ||
* see [http://wiki.inkscape.org/wiki/index.php/Report_on_c%27t_article_12/2006 this review from German c't magazine] pointing out the need of some embedded documentation/help | * see [http://wiki.inkscape.org/wiki/index.php/Report_on_c%27t_article_12/2006 this review from German c't magazine] pointing out the need of some embedded documentation/help | ||
= Mail from Bob Jamison = | == Mail from Bob Jamison == | ||
* Context-sensitive help is one thing where I think they are spot-on. How hard would it be for us to provide "F1 Help"? If only to pop up a browser on a given html page and #anchor. (http://permalink.gmane.org/gmane.comp.graphics.inkscape.devel/16826) | * Context-sensitive help is one thing where I think they are spot-on. How hard would it be for us to provide "F1 Help"? If only to pop up a browser on a given html page and #anchor. (http://permalink.gmane.org/gmane.comp.graphics.inkscape.devel/16826) | ||
= From matiphas = | == From matiphas == | ||
* kind of 3 levels of needs : instant help (already existing, but not for effects/extensions :( ); than a kind of embedded glossary, and finally a big user manual | * kind of 3 levels of needs : instant help (already existing, but not for effects/extensions :( ); than a kind of embedded glossary, and finally a big user manual | ||
* yup, a short explanation text should be integrated in the inx file or the extension code and then displayed (in a tab for a dialog ?) with the effect... I don't know what would be the best display place for it | * yup, a short explanation text should be integrated in the inx file or the extension code and then displayed (in a tab for a dialog ?) with the effect... I don't know what would be the best display place for it | ||
* ok, got another idea, let's start from the Inkscape terminology page. Filling it might help creating some content for an embedded help | * ok, got another idea, let's start from the Inkscape terminology page. Filling it might help creating some content for an embedded help | ||
== Open Questions == | |||
* do we want to use something like Yelp in *nix? | |||
* can we produce CHM files for Windows? | |||
* what help system does Mac OS X use? | |||
[[Category:Developer Documentation]] | |||
Revision as of 23:53, 20 June 2006
From Colin
- "Writing Context Sensitive Help (coming in GNOME-3.0)"
- I guess we should convince pygmee and Kevin to change their manual so that it fits for that purpose, whatever change is necessary.
- That glossary could be section and subsections of the big manual I'd say.
- see this review from German c't magazine pointing out the need of some embedded documentation/help
Mail from Bob Jamison
- Context-sensitive help is one thing where I think they are spot-on. How hard would it be for us to provide "F1 Help"? If only to pop up a browser on a given html page and #anchor. (http://permalink.gmane.org/gmane.comp.graphics.inkscape.devel/16826)
From matiphas
- kind of 3 levels of needs : instant help (already existing, but not for effects/extensions :( ); than a kind of embedded glossary, and finally a big user manual
- yup, a short explanation text should be integrated in the inx file or the extension code and then displayed (in a tab for a dialog ?) with the effect... I don't know what would be the best display place for it
- ok, got another idea, let's start from the Inkscape terminology page. Filling it might help creating some content for an embedded help
Open Questions
- do we want to use something like Yelp in *nix?
- can we produce CHM files for Windows?
- what help system does Mac OS X use?