[PD-dev] IRC notes about Documentation (Help Menu)
B. Bogart
ben at ekran.org
Fri Mar 18 20:26:20 CET 2005
Here are my notes from the documentation discussion this afternoon. Some
things are still in argument!
Could someone wiki this?
* All pd objects (from libs, externals and abstractions) have a standard
help patch format. This contains special "comments" that contain a
string that is used for indexing "meta ___" maybe?
* All these files are parsed for the "meta" string and generate the help
menu as well as the index for searching.
* This indexing should happen on startup before a patch it loaded.
* The index can be rebuilt manually from the help menu.
* possible organization of doc/
Manual (html, pdf, etc..) doc/manual
Examples doc/examples
Reference doc/reference
B>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 256 bytes
Desc: OpenPGP digital signature
URL: <http://lists.puredata.info/pipermail/pd-dev/attachments/20050318/517a7649/attachment.pgp>
More information about the Pd-dev
mailing list