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.
22
votes
2answers
418 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 ...
16
votes
3answers
331 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
278 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
3answers
384 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. ...
14
votes
1answer
142 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 ...
13
votes
3answers
530 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 ...
12
votes
1answer
115 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 ...
10
votes
1answer
113 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 ...
10
votes
1answer
126 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
174 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
82 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
0answers
131 views
func::usage needs to be run twice?
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:
...
9
votes
2answers
200 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 ...
9
votes
1answer
100 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. ...
6
votes
2answers
148 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
...
6
votes
2answers
307 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 ...
6
votes
0answers
75 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
74 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
5
votes
1answer
98 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
0answers
70 views
What are \[InvisiblePrefixScriptBase] and \[InvisiblePostfixScriptBase]?
In the non-printing characters documentation, I see two named characters that are largely undocumented: \[InvisiblePrefixScriptBase] and ...
4
votes
1answer
96 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
121 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
1answer
123 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
143 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
116 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. ...
2
votes
2answers
131 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 ...
2
votes
2answers
84 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 ...
1
vote
1answer
90 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 ...
1
vote
0answers
90 views
How to activate the collapsed template list on V9
Is there way to activate the collapsed template list?
By "collapsed template list", I mean the little arrow which appears when ones types the name of an built-in function, as shown on this video.
...
0
votes
1answer
230 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 ...
0
votes
0answers
26 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 ...
0
votes
0answers
44 views
The “Source” format of Import[], where's that from? [closed]
In my attempt to import an article from The NY Times, I found it's not working. So I did some searching, and in this thread the OP was in some similar situation.
It seems that the NYT's website is ...
-1
votes
0answers
62 views
Where can I find description of errors and warnings? [closed]
I am trying to solve numerically quite simple equation using NSolve[]. NSolve writes a warning:
...
