Plug-ins, Hosts, Apps,
Hardware, Soundware
Developers
(Brands)
Videos Groups
Whats's in?
Banks & Patches
Download & Upload
Music Search
KVR
   
KVR Forum » MUTOOLS
Thread Read
link to help file description for every module?
Goto page 1, 2, 3, 4  Next
> DiGiT <
is BANNED
- profile
- pm
PostPosted: Thu Nov 22, 2012 11:30 am reply with quote
wouldnt it be useful if there was a link to the manual or help file page corresponding to the description of the module you clicked it in? would possibly reduce confusion for a no0b being able to reference an explanation of a module's function easily.
^ Joined: 08 Jan 2005  Member: #54204  Location: Detroit
sl23
KVRian
- profile
- pm
- e-mail
PostPosted: Thu Nov 22, 2012 1:54 pm reply with quote
Do you mean in MuLab? Like a Tooltip? That could be useful. Could be a traditional Tooltip that can be switched off or something like Ableton Live's tips.
----
Live for an ideal and leave no place in the mind for anything else.

Portugal property for sale
^ Joined: 28 Mar 2008  Member: #177216  Location: U.K.
Reincke
KVRist
- profile
- pm
- e-mail
- www
PostPosted: Fri Nov 23, 2012 12:40 am reply with quote
> DiGiT < wrote:
wouldnt it be useful if there was a link to the manual or help file page corresponding to the description of the module you clicked it in? would possibly reduce confusion for a no0b being able to reference an explanation of a module's function easily.

+++++1
Let's bang the drum for one of the most powerful features of MuLab/Mux, which is just a bit under-documented.

I suggest enhance the reference doc for each module that it describes at least
    all in-/outputs,
    the gui elements,
    ranges of modulation,
    clipping behaviour of modulation signals,
    mono/stereo-behahiour,
    hints for good examples in the factory,
    and of course the internal functionality.

That would really help understanding the modules much faster. I would prefer the help pages, which can entirely be read outside MuLab.
JR
^ Joined: 25 Jul 2010  Member: #236324  Location: Germany
mutools
KVRAF
- profile
- pm
- e-mail
- www
PostPosted: Fri Nov 23, 2012 3:01 am reply with quote
> DiGiT < wrote:
wouldnt it be useful if there was a link to the manual or help file page corresponding to the description of the module you clicked it in? would possibly reduce confusion for a no0b being able to reference an explanation of a module's function easily.


Yes i had a similar idea some time ago. Maybe something like a "Help" context function (shortcuttable). Taken note on the wishlist.
^ Joined: 24 Jun 2008  Member: #183484  Location: Europe
mutools
KVRAF
- profile
- pm
- e-mail
- www
PostPosted: Fri Nov 23, 2012 3:06 am reply with quote
Reincke wrote:
Let's bang the drum for one of the most powerful features of MuLab/Mux, which is just a bit under-documented.That would really help understanding the modules much faster. I would prefer the help pages, which can entirely be read outside MuLab.


MuDrum: http://www.mutools.com/info/docs/mux/mudrum.html

What's missing in there?

Modules: http://www.mutools.com/info/docs/mux/mutools-modules.html

What's missing in there?

Please let me know!
^ Joined: 24 Jun 2008  Member: #183484  Location: Europe
Reincke
KVRist
- profile
- pm
- e-mail
- www
PostPosted: Fri Nov 23, 2012 3:38 am reply with quote
mutools wrote:
Reincke wrote:
Let's bang the drum for one of the most powerful features of MuLab/Mux, which is just a bit under-documented.That would really help understanding the modules much faster. I would prefer the help pages, which can entirely be read outside MuLab.
...
Modules: http://www.mutools.com/info/docs/mux/mutools-modules.html
What's missing in there?
Please let me know!
Hi Jo, in the citation you have cut out my (admittedly a bit generic) hints. No problem, but please give some time to collect examples of facts I am missing in the docs relating the modules.
Nonetheless the module features are really great. 30 years ago I was dreaming of hardware equipment like that, which was much too expensive and didn't fit in my little room. And now we have all of this in a magic little case ... Love
JR
^ Joined: 25 Jul 2010  Member: #236324  Location: Germany
mutools
KVRAF
- profile
- pm
- e-mail
- www
PostPosted: Fri Nov 23, 2012 3:57 am reply with quote
Reincke wrote:
Hi Jo, in the citation you have cut out my (admittedly a bit generic) hints.


I should have put 3 dots i guess? like [...]
^ Joined: 24 Jun 2008  Member: #183484  Location: Europe
Reincke
KVRist
- profile
- pm
- e-mail
- www
PostPosted: Fri Nov 23, 2012 5:17 am reply with quote
mutools wrote:
Reincke wrote:
Hi Jo, in the citation you have cut out my (admittedly a bit generic) hints.


I should have put 3 dots i guess? like [...]
Oh, it was not my intention to indicate an incomplete citation. I just thought my origin post probably would show what I'm looking for and I wonder if the items were too abstract.
JR
^ Joined: 25 Jul 2010  Member: #236324  Location: Germany
sl23
KVRian
- profile
- pm
- e-mail
PostPosted: Fri Nov 23, 2012 9:18 am reply with quote
Jo, would this tooltip/help system be useful for MuLab in general? Might even replace necessity for docs? Which, over time, could save you time in editing and updating them.
----
Live for an ideal and leave no place in the mind for anything else.

Portugal property for sale
^ Joined: 28 Mar 2008  Member: #177216  Location: U.K.
mutools
KVRAF
- profile
- pm
- e-mail
- www
PostPosted: Fri Nov 23, 2012 9:27 am reply with quote
sl23 wrote:
Jo, would this tooltip/help system be useful for MuLab in general? Might even replace necessity for docs?


It are the docs, but in a more integrated way. That's how i see it.
^ Joined: 24 Jun 2008  Member: #183484  Location: Europe
sl23
KVRian
- profile
- pm
- e-mail
PostPosted: Fri Nov 23, 2012 9:42 am reply with quote
Oh ok Smile
----
Live for an ideal and leave no place in the mind for anything else.

Portugal property for sale
^ Joined: 28 Mar 2008  Member: #177216  Location: U.K.
pljones
KVRAF
- profile
- pm
- www
PostPosted: Fri Nov 23, 2012 9:57 am reply with quote
The one thing I'd say is don't only put it on the context menu. Newcomers don't always look there. A [?] link in the each window's title bar, next to the close [X] could be good additional hint.
^ Joined: 08 Feb 2003  Member: #5825  Location: London, UK
> DiGiT <
is BANNED
- profile
- pm
PostPosted: Fri Nov 23, 2012 10:43 am reply with quote
yeah the [?] was how i envisioned it. can you hyperlink to a certain line in the help file or does it have to be on a topic?

jo would you accept offers of help with writing passages for the help file? not quite a wiki but maybe it would take some pressure off of you, as well as allow people to expand on what you would have said, perhaps making it clearer to more people, end result: an easier to use tool and less excuse to ask simple questions.
^ Joined: 08 Jan 2005  Member: #54204  Location: Detroit
sl23
KVRian
- profile
- pm
- e-mail
PostPosted: Fri Nov 23, 2012 11:02 am reply with quote
> DiGiT < wrote:
jo would you accept offers of help with writing passages for the help file? not quite a wiki but maybe it would take some pressure off of you, as well as allow people to expand on what you would have said, perhaps making it clearer to more people, end result: an easier to use tool and less excuse to ask simple questions.

That's a good idea.

What's meant by [?] on each window? It would only appear on the MuLab main window and the Mux Windows? Not really context sensitive then though. Or is this as well as a tooltip?
----
Live for an ideal and leave no place in the mind for anything else.

Portugal property for sale
^ Joined: 28 Mar 2008  Member: #177216  Location: U.K.
pljones
KVRAF
- profile
- pm
- www
PostPosted: Sat Nov 24, 2012 12:02 am reply with quote
Pretty much every window anywhere has a top right-hand corner [X] next to which a [?] could go:

Unless you want every knob on the UI to have help text (e.g. "knob -> allows attached parameter to be adjusted"), then linking to the appropriate page for the module concerned would probably be best as well as fairly stable (i.e. not needing too much time ensuring the links remain up to date). This would mean, for example, the "Poly Synth" module's [?] linked to a section describing its use.
^ Joined: 08 Feb 2003  Member: #5825  Location: London, UK
All times are GMT - 8 Hours

Printable version
Page 1 of 4
Goto page 1, 2, 3, 4  Next
Display posts from previous:   
ReplyNew TopicPrevious TopicNext Topic
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum
Username: Password:  
KVR Developer Challenge 2012