Tagged Questions

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

-1
votes
1answer
235 views

What does “levelspec” mean in the documentation? [closed]

The following code returns the first three integer elements of Sqrt[Range[100]]: ...
1
vote
1answer
141 views

Ways to access lists inside lists

I have gone through some reference material but I am not getting really good links that will help me grow understanding of ...
29
votes
6answers
764 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 ...
0
votes
0answers
31 views

“Go back” and “Go forward” in help? [duplicate]

This is a duplicate question with Gestures for forward/backward in help browser (particularly on a Mac). Please close this question. In IE, we can "go back" by Alt+←, and "go forward" by Alt+→. This ...
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 ...
13
votes
1answer
200 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 ...
4
votes
1answer
445 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 ...
11
votes
2answers
270 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 ...
7
votes
1answer
548 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 ...
5
votes
1answer
125 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
15
votes
1answer
286 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 ...
33
votes
2answers
979 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 ...
4
votes
2answers
243 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 ...
2
votes
2answers
137 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 ...
13
votes
0answers
165 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: ...
6
votes
0answers
98 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 ...
18
votes
1answer
217 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 ...
4
votes
1answer
159 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 ...
7
votes
1answer
263 views

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

In the non-printing characters documentation, I see two named characters that are largely undocumented: \[InvisiblePrefixScriptBase] and ...
3
votes
2answers
207 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 ...
7
votes
2answers
176 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 ...
3
votes
2answers
141 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. ...
16
votes
3answers
466 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 ...
10
votes
1answer
149 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 ...
9
votes
1answer
112 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. ...
16
votes
1answer
381 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 ...
1
vote
1answer
101 views

Print documentation (or front end) with all Openers open?

From the online reference: http://reference.wolfram.com/mathematica/ref/Opener.html a JS function javascript:open_ES() is invoked to open all Openers within a section. Note (1) this feature is ...
4
votes
2answers
179 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 ...
8
votes
2answers
533 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 ...
1
vote
1answer
458 views

What does the slash-colon symbol do?

I came across a bit of code that uses the syntax /: and I don't know what it does. I can't find its documentation, or maybe I'm just not looking properly. The code ...
15
votes
4answers
944 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 ...
17
votes
3answers
843 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. ...
10
votes
1answer
217 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 ...
4
votes
2answers
188 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 ...