[Clam-devel] [Fwd: about CLAM audio]

[Hernán Ordiales]

On 8/10/07, Pau Arumi <parumi at iua.upf.edu> wrote:
> En/na globot ha escrit:
> > about documentation, to be honest the doxygen doc is like a cheese with
> > a lot of hole. You should think about people that don't know much about
> > sound (like me). So a small a synthetique explanation about each element
> > would be great. For example, i want to use a 3 band filter, there is an
> > input for controller named "Amount", i do not know what is it and can't
> > find a small explanation (so i have to experiment and loose time).
> > this kind of example can be found a little evrywhere this is the
> > difficulty,
>
> agree. documentation of each processing algorithm, port and control
> is another open trench. actually we are going to make this doc
> available from runtime. so for instance, networkeditor processing
> tree will show the doc. this feature (related to plugins and
> metadata) will appear very soon, and it will (hopefully) motivate
> adding brief doc of most of the processings.

i was going to propose to add help for each processing in context menu
(for many sms transformations i think can be taken from smstools score
dialog) but i don't know if that is already a consequence of your
words...

question: it's clam's wiki a place for a little theoretical things?
because if does, maybe is a good idea add one wiki page for each
processing or at least for any worth (not obvious)
transformation/effect. At least a short description, examples and
maybe some audio demos.

i noticed that many people (at least new one) gets disoriented with so
many features of clam, and doesn't know well what kind of things can
do or be useful or not. I thought in some dynamic user friendly doc to
solve this, here a (very short) demo to get the idea:

http://h.ordia.com.ar/mindmaps/clam-framework.html
(note that nodes can be expanded and shrunk)

was made with freemind (java based ->crossplatform) and can be easily
embedded in a browser.

[snip]

roman: yep, your mails are (very) long... but very funny :-)

my two cents,
-- 
Hernán
http://h.ordia.com.ar
GnuPG: 0xEE8A3FE9