Questions related to writing and handling usage messages of symbols.

learn more… | top users | synonyms

4
votes
0answers
59 views

What is the status of `::Usage` and Templates in Mathematica v10?

In Mathematica 9, a number of issues concerning the ::Usage and templates were raised. In 9.0, there was a bug first reported here and better diagnosed here, where ...
3
votes
0answers
56 views

ParametricRegion question - a bug report

It is just to report that the request: ?ParametricRegion does not return the expected definition. Instead I see this: ...
1
vote
1answer
86 views

Unevaluated symbols [duplicate]

I often find it useful to define a symbol from strings (often in a loop in which I define other symbols). This I accomplish with Symbol (and often ...
4
votes
2answers
129 views

Listing all usage messages from a loaded package

I am writing several packages in collaboration with others. In order to help the group use my packages, I want to provide them with a simple reference of function names and usage messages. How can I ...
7
votes
1answer
152 views

User-defined template; removing repeated text (v 9.0.1)

In Mathematica 9.0.1, I want to write a user-defined template for a function that I wrote: myfunc ...
2
votes
2answers
72 views

Unsetting messages

The following code suggests that Mathematica stores the messages in cache: ...
3
votes
2answers
133 views

Dynamically show usage

As the title states I would like to dynamically show ::usage on several functions. Let's consider two functions here: ...
15
votes
0answers
156 views

How to format usage messages such that function templates are parsed correctly?

Is it possible to format usage messages (with italic arguments etc) such that Mathematica 9 still parses function templates correctly? For example, plain usage messages work when pressing ...
11
votes
2answers
267 views

Transform fancy usage messages in 1D string

When we look at the usage messages of built-in functions nowadays (not in the good old times, when they were a simple descriptions) we see that although they look pretty in the front end, it is really ...
15
votes
1answer
167 views

Standard message definition construct

Why are the messages almost always defined like this (at least in packages): If[Not@ValueQ[function::usage], function::usage = "Usage message"] and not just like ...
25
votes
2answers
753 views

Strange ::usage behavior in v9

Note: This is fixed in 9.0.1. Something has gone wrong with usage in Mathematica 9. Would someone tell me how to fix it? I define a function ...
4
votes
2answers
237 views

How to create 'help' `?` for a function (as documentation)

I have defined a function PassVeltB in some complicated way. But now I would like to add a little documentation that gives the user information on how it is to be ...
14
votes
3answers
707 views

Best Practice to write ::usage for own package functions

I'm writing an own package with Mathematica, that I would like to make available for others. In order to do that (and for my own usage of the package), I would like to write ...
14
votes
1answer
261 views

Usage displays properly only after second call

If I have a usage message containig two-dimensional stuff (subscripts or formulas) and I call the usage, then sometimes I get an improperly formatted output enclosed in "...". Linebreaks are gone, but ...
14
votes
4answers
907 views

Managing formatted usage messages in Wolfram Workbench

We have numerous packages (defined in .m files) that we maintain and develop in WolframWorkbench (2.0), and in those packages, we use the traditional method of ...