Difference between revisions of "Embedded Help"

From Inkscape Wiki
Jump to navigation Jump to search
(Added Mac OS X section)
Line 12: Line 12:
 
* 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
 +
 +
== MacOS X ==
 +
The [http://www.devworld.apple.com/documentation/Carbon/Conceptual/ProvidingUserAssitAppleHelp/user_help_intro/chapter_1_section_1.html  "User Assistance"] technology or environment has [http://www.stepwise.com/SpecialCoverage/WWDC2001/501.html evolved] through several major stages, but has always been based upon a restricted HTML 3.2 [http://cocoadevcentral.com/articles/000072.php markup] and a lightweight "Help Viewer". See [http://www.andymatuschak.org/articles/2005/12/18/help-with-apple-help Help on Apple Help] for a near illegible page that describes the making of the excellent help system for the pixel editor [http://www.andymatuschak.org/pages/pixen/ Pixen] (not that many Inkscapers use pixel editors). Apple provides a [http://developer.apple.com/documentation/UserExperience/Conceptual/OSXHIGuidelines/XHIGUsingTechnologies/chapter_8_section_13.html comprehensive account] of the Human Interface factors relating to its technology, but this may be just outside what we need to be thinking about for Inkscape right now,
 +
 +
== See also ==
 +
[http://www.g2meyer.com/usablehelp/items.html Usable Help] A list of just under 250 links to articles on documentation and help systems for software and consumer products.
  
 
== Open Questions ==
 
== Open Questions ==
 
* do we want to use something like [http://live.gnome.org/Yelp Yelp] in *nix?
 
* do we want to use something like [http://live.gnome.org/Yelp Yelp] in *nix?
 
* can we produce [http://en.wikipedia.org/wiki/Microsoft_Compressed_HTML_Help CHM files] for Windows?
 
* can we produce [http://en.wikipedia.org/wiki/Microsoft_Compressed_HTML_Help CHM files] for Windows?
* what help system does Mac OS X use?
 
  
 
[[Category:Developer Documentation]]
 
[[Category:Developer Documentation]]

Revision as of 07:39, 21 June 2006

From Colin

Mail from Bob Jamison

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

MacOS X

The "User Assistance" technology or environment has evolved through several major stages, but has always been based upon a restricted HTML 3.2 markup and a lightweight "Help Viewer". See Help on Apple Help for a near illegible page that describes the making of the excellent help system for the pixel editor Pixen (not that many Inkscapers use pixel editors). Apple provides a comprehensive account of the Human Interface factors relating to its technology, but this may be just outside what we need to be thinking about for Inkscape right now,

See also

Usable Help A list of just under 250 links to articles on documentation and help systems for software and consumer products.

Open Questions

  • do we want to use something like Yelp in *nix?
  • can we produce CHM files for Windows?