Questions about making your own documentation similar to the built-in documentation style. Also about finding things in the documentation, working with the documentation, errors in the documentation, missing documentation, Context used in the documentation etc.

learn more… | top users | synonyms

45
votes
1answer
1k views

Incompatible Changes since Mathematica Version 7?

There is documentation of the incompatible changes made to Mathematica with each major release: Incompatible Changes since Mathematica Version 1 Unfortunately that documentation simply stopped ...
33
votes
2answers
1k views

Documentation searches hang frequently: Anyone else dealing with this?

I've been struggling with a number of hangs, dynamic timeouts, and outright crashes when using the search/documentation center in version 9. I've tried uninstalling/reinstalling and clearing ...
30
votes
6answers
955 views

Creating cross-version compatible documentation with Workbench

Wolfram Workbench allows you to create documentation for your own packages that is similar to the build-in documentation center. Integrating this type of documentation with the documentation center is ...
28
votes
0answers
288 views

Managing Stack Exchange favorites via Documentation Center

My Stack Exchange favorites are getting bigger and bigger. It is becoming unmanageable and is getting hard to find what I look for. A related question is Sort favorite questions. Is it possible to ...
24
votes
0answers
330 views

Documentation of the frequently-used functions in the context of Internal` and Compile` [duplicate]

In this site, I have gradually found out that there is a collection of functions in all kinds of answers. For instance, Compile`GetElement, ...
23
votes
1answer
359 views

How to extract a list of available Method-s

The option Methodapplies for several functions, such as NDSolve, FindRoot, ...
18
votes
5answers
1k 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 ...
18
votes
1answer
256 views

Open and search Documentation-Center

In notebooks you can press F1 (or Shift+F1 for a new window) to: open the help page of the marked Symbol or the Symbol under ...
18
votes
2answers
525 views

Most influential and/or disrupting features introduced with new versions of Mathematica

This is something that has been bugging me for ages. With every upgrade, Mathematica has added new functionalities and amended some of its bugs. In the process, though, some older functionality has ...
18
votes
1answer
247 views

Is there a way to make the “Details” section of the documentation expand by default?

By default, the Mathematica documentation opens with the "Details" section collapsed. This is never what I'm looking for — in fact, I've lost count of the times I've sought help on a feature and ...
17
votes
3answers
1k views

Listing the functions defined in a package

Assume that I know a package's (Context?) name that is loaded. Now I want to list the functions defined in this package. How can I do it? I remember that I found a way once, but I cannot re-find it. ...
17
votes
0answers
216 views

A documented syntax of FileNames doesn't work?

bug present as of 10.0.2 According to the documentation for FileNames: However when I attempt to use this syntax I get an error: ...
16
votes
3answers
495 views

How to get complete Documentation Center graph of guide pages?

On the very last image below you can see a typical path of walking through Documentation Center guide pages. What is the best way to get the graph data and visualize the whole structure of these ...
16
votes
1answer
410 views

What does “suitable for symbolic manipulation” in the documentation mean?

This question is related to this other one I posted on Stack Overflow some time ago. There, in a beautiful answer, acl (with some unhumble editing done by me) showed that the derivative of ...
15
votes
1answer
334 views

Multiple templates for a single user-defined function

How do I use the ::usage tag to allow the Mathematica v9 front end to know that there are multiple ways to call an overloaded function (a function that can have ...
15
votes
1answer
392 views

How to write documentation in Wolfram Style?

Rather than craft my own stylesheets for documentation, I'd like to emulate (copy? ape? borrow?) the Wolfram style. Here is a very small example (type this in the help-box, which you get by pressing ...
14
votes
2answers
246 views

Inline documentation of “Properties”

Context I find the documentation has become a bit of a maze, in particular given the more recent convention of having keywords has strings rather than Mathematica Keywords. For instance, ...
14
votes
2answers
195 views

Bug in Operator Form of StringCases

fixed in 10.1 (windows) According to the documentation there's an operator form for StringCases ?StringCases Here is the ...
13
votes
3answers
325 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 ...
13
votes
1answer
216 views

Creating documentation for sub-packages in Workbench

I'd like to create proper documentation for a package of mine, and Workbench in principle provides the tools to do this. However, I've split my package into multiple sub-packages (because I found it ...
13
votes
0answers
171 views

func::usage needs to be run twice? [duplicate]

There is an annoying problem that I can't figure out why it's happening. I have defined a usage for a my function tensorA: ...
12
votes
1answer
167 views

$Path hijacked by PacletManager?

Summary: Since Mathematica version 6, the PacletManager seems to have engineered an escalating hijack of the $Path variable. Add-on packages need to have a ...
12
votes
1answer
407 views

Is there a “precedence table” for the canonical Sort ordering?

This answer in which I wrote about the Operator Precedence Table was unexpectedly popular. That got me thinking about similar things, and I am wondering: Does an "ordering table" exist for the ...
11
votes
2answers
168 views

Listable functions thread over Associations; is this documented?

Thanks to a somewhat misapplied use of MapThread I learned of this behavior: ...
11
votes
1answer
103 views

When is the output of examples in function documentation rasterized?

Upon building documentation in Workbench, Workbench sometimes converts the output of examples on function pages into rasterized images, and sometimes not. Does anybody know what controls this ...
10
votes
1answer
297 views

Full documentation for AppearanceElements

As explained in this solution, ListAnimate[Table[Plot[Sin[n x], {x, 0, 2}], {n, 3}]]//InputForm will allow me to view the types of appearance element for the ...
10
votes
1answer
153 views

How can I access documentation from the Workbench?

In Mathematica there is a hot key for searching words (that your cursor is within or adjacent to) in the documentation center, is there a way to do this from the Workbench instead of having to first ...
10
votes
1answer
222 views

Mouse gestures or keyboard shortcuts for navigating forward/backward in the documentation center

Is there any way to get gestures (e.g. trackpad- or Magic-Mouse-swiping left/right) to work for navigating forward and backward in the Mathematica help browser, particularly on a Mac? If not, what are ...
10
votes
1answer
115 views

DateList not using current year when a year is not specified

According to the documentation when using DateList but not giving it a year it should use the current year. It is not doing that for me. Instead it uses 1900. ...
9
votes
1answer
202 views

Structure of Graphics (esp. those produced by Plot, ListPlot, etc.)

I'm looking for a description of the structure of Graphics objects, aimed at the advanced Mathematica programmer. The motivation for this question is the ...
9
votes
1answer
179 views

Mathieu function periodicity problem

According to the documentation, the Mathieu characteristic function generates parameter a: The characteristic value Subscript[a, r] gives the value of the parameter a in y′′+(a-2q cos(2z))y=0 ...
8
votes
2answers
335 views

How to get a list of available appearance/styles/Methods?

This is a basic question but I haven't found any answer yet :/ Available appearances for Button[] are mentioned in Help, those ...
8
votes
3answers
191 views

Problem with Classify Documentation Center page

Every time I try to open the "Neat Examples" tab on the documentation center page for the function Classify Mma gets stuck showing "Progress Dialog". The problem ...
8
votes
2answers
595 views

Building documentation with interactive examples in Wolfram Mathematica

There are interactive examples in the documentation in Wolfram Mathematica. Thus to compile them we just need Shift+Enter. I want to develop such examples for functions from my own package, how can I ...
8
votes
1answer
170 views

FindSelectedFunction for packages - how to make it work?

The Mathematica help menu contains an entry Find Selected Function (Cmd+Shift+F on OSX). If you are working with say Transpose and want to look up its reference ...
8
votes
1answer
728 views

How can I get Mathematica to recognize the documentation for a newly installed package?

To install a new package on one's machine, one first downloads and unpacks the package into the $BaseDirectory/Applications directory. The tutorial Installing ...
7
votes
2answers
191 views

Keywords to find documentation for this syntax

Mathematica allows this syntax, but I cannot find any documentation (or books) that discuss the various uses/advantages of it ...
7
votes
1answer
195 views

How to know the internal algorithms of functions like Predict or Classify?

The document centre seems only explain how to use these functions, but just in an very brief way. I know Mathmatica is not open source, so we can not expect to see the code of the function, but are ...
7
votes
2answers
353 views

What is a “Region” in Mathematica 10?

"Region" seems to be a very important concept in Mathematica's latest version. Where can one find the more thorough introductory details about the concept of Region ...
7
votes
1answer
201 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 ...
7
votes
1answer
315 views

What are \[InvisiblePrefixScriptBase] and \[InvisiblePostfixScriptBase]?

In the non-printing characters documentation, I see two named characters that are largely undocumented: \[InvisiblePrefixScriptBase] and ...
6
votes
3answers
345 views

Extract a list of all built-in functions used in a notebook

I am writing my code documentation and need to list all the Mathematica built in functions I have used - explicitly written functions only. Is there a way to extract a list of all built in functions ...
6
votes
2answers
143 views

What does the AspectRatio option actually do?

The Documentation for AspectRatio on its first line under the "Details" section states: "AspectRatio determines the scaling for ...
6
votes
2answers
226 views

Is there a bug in the Part function of Mathematica 10?

I am using Mathematica 10 now. I typed code below {{1, 2}, {2, 4}, {3, 6}, {4, 8}}[[;; , 1]][[1]] and this gives result 1 ...
6
votes
1answer
115 views

How do I efficiently navigate the Documentation Center?

Back in the day, I read the Mathematica Book cover-to-cover, and I found it to be an enlightening experience. I realize that the Documentation Center is now an order of magnitude larger than the ...
6
votes
1answer
128 views

What really makes a Dialog expresion behave as a modal dialog?

CreateDialog[DefaultButton[], Modal -> True] creates a modal Dialog, one which needs to be closed before the front-end ...
6
votes
1answer
178 views

Fixing links to symbol pages with special characters made with Workbench

I am writing documentation for a package using Workbench v2.0 and Mathematica v9.0.1, and certain Symbols defined by my package have special (Greek) characters characters e.g. ...
6
votes
1answer
173 views

Trouble with links to symbol pages generated by Wolfram Workbench

I am having some troubles with documentation generated by wolfram workbench. When i try to open symbol page created with workbench by pressing F1 I get a search page instead of my symbol page. When I ...
6
votes
0answers
178 views

Documentation for user-defined functions; undocumented documentation feature?

I stumbled on some strange behaviour when trying out the new function template and documentation features, now purportedly working in v 9.0.1. I defined a function ...
6
votes
0answers
104 views

Associating symbol pages with symbols (Workbench)

Normally when you have symbol Abc, WorkBench creates a symbol page named Abc. Then when you make a build, type Abc and then press the F1 key, you are sent to the Abc symbol page. Suppose however ...