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

32
votes
2answers
880 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 ...
26
votes
6answers
600 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 ...
20
votes
0answers
204 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 ...
17
votes
1answer
200 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 ...
16
votes
3answers
430 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
3answers
733 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. ...
16
votes
1answer
362 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
239 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
184 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 ...
14
votes
4answers
852 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 ...
13
votes
1answer
183 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
2answers
404 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 amendend some of its bugs. In the process, though, some older functionality has ...
13
votes
0answers
160 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: ...
11
votes
2answers
266 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 ...
11
votes
1answer
214 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 ...
11
votes
1answer
264 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
1answer
102 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
146 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
211 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 ...
9
votes
1answer
193 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 ...
9
votes
1answer
111 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. ...
8
votes
2answers
479 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
176 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 ...
8
votes
1answer
157 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 ...
7
votes
2answers
169 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
137 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
434 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
1answer
235 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
289 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
1answer
134 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
146 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
94 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 ...
5
votes
1answer
121 views

Where to find a summary for Q functions? [duplicate]

Is there a summary for all Function like NumberQ, LetterQ and so forth? data=123; IntegerQ[data] True
4
votes
2answers
146 views

Capturing an F1

I teach an Intro to Mathematica course, and one of the things I try to reinforce early on is just how helpful Mathematica's help is. In the very first lab for the course, I even give the students a ...
4
votes
1answer
119 views

Example from Mathematica documentation (ExtremeValueDistribution) seems to be evualting “forever”

I am referring to this example at the reference page for the extreme value distribution: http://reference.wolfram.com/mathematica/ref/ExtremeValueDistribution.html#6764486 The first three commands ...
4
votes
1answer
336 views

What's the simplest way to plot an ErrorListPlot with only y error bars?

Sometimes I get really tired of Preparing data for making an ErrorListPlot using Thread and friends. Is there a simpler way to plot an ErrorListPlot with only y ...
4
votes
2answers
165 views

How to display cell groups in documentation pages

I recently introduced my WildCats package in the Meta Thread What third-party packages do you use? and @Szabolcs promptly observed that: "I noticed that there are many cell groups in the documentation ...
4
votes
2answers
87 views

Scalar product operator of complex vectors

What is the scalar product operator for complex vectors (or matrices) in Mathematica? The usual $Dot[]$ doesn't work. E.g. here is what the Mathematica gives $$\{1,0\}.\{I,0\}=I$$ but the answer ...
4
votes
1answer
156 views

Write-protect documentation for self-written Add-on package

My package works fine so far, and now I want to add some documentation. I have put a file in ...
4
votes
2answers
184 views

Problem with EllipticE documentation

The complete elliptic integral of the second kind, EllipticE, is defined as, Integrate[Sqrt[1-m Sin[t]^2],{t,0,z}] According ...
3
votes
2answers
197 views

Key to get help about current function

I know you can hit F1 to pop up the documentation center, and then type the name of a function and search for it. I'd like to know if there's a key that just pops up the help page of the function ...
3
votes
2answers
135 views

Is there a quick way to find a built-in function by name search?

Is there a quick way to search all built-in Mathematica functions by name? Say I want to find all functions whose name contains "Graph", such as GraphPlot, NeighborhoodGraph, Subgraph, and so forth. ...
3
votes
2answers
121 views

How to open directly the help/reference window from a notebook

I'm used to do ??symbol when I want the reference for a given symbol, then I click on the >> arrows to open the help window. Would it be possible to ...
3
votes
2answers
219 views

How to get a list of available appearance/styles?

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

LibraryLink Documentation

The documentation for LibraryLink has the following example ...
3
votes
1answer
244 views

Methods for NSolve

I've been using NSolve a moderate (50-100 equations) size system of linear equations and it has been working splendidly (Solve ...
2
votes
1answer
76 views

Is it possible to auto-load documentation for current function? [duplicate]

As much as Mathematica amazes me with endless variety of integrated functions and packages, inconsistency with functions parameters or finding details about a function takes some time and isn't as ...
2
votes
2answers
122 views

How to use the Find and Replace Dialog Window?

The Find edit box in the Find and Replace Dialog Window shows a default word while opening. How do I tell it to show the word in which the mouse cursor is located in the Notebook, rather than the last ...
2
votes
1answer
57 views

Documentation build failed with Workbench

I'm starting to use Wolfram Workbench 2 to develop a Mathematica package. For the first time I tried "Documentation - Build" under the "Application Tools" but got fatal errors: BUILD FAILED ...
2
votes
0answers
51 views

Autoupdate Section Numbers? - Technical Document Authoring with Mathematica

Technical document authoring systems are structured ways to create, manage, and update documentation for various mediums such as print, pdf, web, etc. Take a look at this technical document ported to ...