Definition description

Definition description - Messages

#1 Posted: 2/26/2012 12:16:14 PM
Andrey Ivashov

Andrey Ivashov

2269 likes in 3729 posts.

Group: Super Administrator

I've investigated the way how Mathcad users documenting their documents. And I see that many SMath Studio users also use the same approach as shown below:



The only possible reason is that Mathcad developers didn't implement some standard way how to create descriptions for the definitions. So, I'm thinking now to do something like this:



This will also make it possible to use that descriptions in Dynamic Assistance tool:



I'm just started to implement it, so any suggestions or idea corrections will be very welcome!

Best regards, Andrey Ivashov.
#2 Posted: 2/26/2012 2:00:39 PM
Radovan Omorjan

Radovan Omorjan

325 likes in 2052 posts.

Group: Moderator

Hello Andrey,

These function descriptions are in the spirit of SMath. I suppose that there must be some limitation in the description length/hight. If it would be to big, the large amount of worksheet might be covered with the description text.

Regards,
Radovan
When Sisyphus climbed to the top of a hill, they said: "Wrong boulder!"
#3 Posted: 2/26/2012 3:42:20 PM
Davide Carpi

Davide Carpi

1415 likes in 2872 posts.

Group: Moderator

great idea

I think the description could be organized to accommodate different fields (i.e. a general description, an input arguments description and an output argument description, or other data, like the revision number...)

Best Regards

w3b5urf3r
If you like my plugins please consider to support the program buying a license; for personal contributions to me: paypal.me/dcprojects
  • New Posts New Posts
  • No New Posts No New Posts