[Bf-python] Adding help info to scripts

[Willian Padovani Germano]

Hi,

Jean-Michel:

Yes, bundled scripts will be updated.  I've been busy these weeks and 
wasn't able to try to kick start discussions on bf-scripts-dev someway, 
as the script group should be taking care of bundled scripts, discussing 
guidelines and improvements, etc.  This Sunday I added a bit of basic 
info to the wiki while I tried to learn how to use it.

For the 2.35 release that can happen someday next week, we'll have to 
test scripts and provide docs for them, I agreed with that last Sunday.  
Today I'll test scripts, write docs for mine and the simple open-browser 
ones, etc.  I'll also update your hotkeys and disp_paint scripts.

So all of you with scripts in the cvs can send me documentation blocks 
if you want to.  Otherwise I'll just use basic info from the script 
itself, like emails and links and later the authors can update with what 
they want.

Those with not mentioned updated scripts can send them too, of course.  
And about the bf-scripts cvs, feel free to email me with any doubt.

Tony:

It could be done with the usual """...""" block.  But as you say, this 
help info is really not related to the script code, it should be 
restricted to usage info for Blender users, a simple manual for users 
with buttons to open default browser and email client for extra help or 
support.

We could use some trick to only show the relevant part of the block, but 
the python documentation tools out there would show the whole thing, 
which can grow quite large.  Scripts with lots of options and shortcut 
keys or that require basic steps to be performed first in Blender (like: 
create a mesh and an empty, add ipo curves to the mesh, parent mesh and 
empty, position the empty at ...) can have extensive help information.  
And after this all would come the description part for coders, which 
could be large, too, with algos explained, etc.

My original idea was to use a second """ block for this, like the one 
used for menu registration, but after Michael mentioned the conflict 
caused by the registration block with python doc tools, using a 
commented block seemed better.  Tags makes it easier both to add the 
info and to parse it, less room for confusion: <link>Description for the 
tooltip, http:somewhere.com</link>.

-- 
Willian