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

6
votes
2answers
151 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
239 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
129 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
100 views

Is It Safe to Remove the Documentation Notebooks?

I am running Mathematica 10 on linux and noted that the directories containing Mathematica's documentation come to over 3GB. Am I safe to delete these directories without affecting how Mathematica ...
6
votes
1answer
53 views

ImageAdjust Documentation issues

A recent thread raised several concerns regarding the Documentation page for ImageAdjust. The first issue is related to the first statement under the ...
6
votes
1answer
190 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
185 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
193 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
107 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
2answers
152 views

Non sequitur in documentation of MemberQ

Mr.Wizard's question about MemberQ and FreeQ got me to re-read the documentation for those functions. I find I don't understand ...
5
votes
1answer
132 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
179 views

How to use Get on a folder

In the documentation for Get it says: If the file found by <<name is a directory, the Wolfram Language will try to ...
5
votes
1answer
871 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 ...
5
votes
1answer
171 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
170 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
65 views

? (Definition) versus ?? (Information)

What is the difference between ? Definition and ?? ...
4
votes
1answer
129 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
2answers
201 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
55 views

Why does TreePlot ignore the vertex labels in a TreeGraph argument?

Example (watch the vertex labels): aTree = TreeGraph[{"a" -> "b", "a" -> "c"}, VertexLabels -> "Name"] ...
4
votes
1answer
143 views

Mathematica as Answer Set Programming (ASP) engine?

Maybe I need to rephrase this question, so that it might receive some attention: Are there any packages or examples of how to put Mathematica to good use in the field of ASP (Answer Set Programming) ...
4
votes
2answers
374 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
84 views

Evaluating documentation example crashes the kernel

Save your work before attempting: Could someone confirm what looks like a bug (definitely occurs in v10 and OSX 10.8.5): In the documentation for Background and ...
4
votes
1answer
111 views

Get Documentation Search Results Programmatically

Currently I don't have access to Wolfram Workbench but would like to add my own pages to the documentation search results in Mathematica. How might I most easily manually add pages to the ...
4
votes
2answers
227 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 ...
4
votes
1answer
138 views

Missing functions in the Raspberry Pi V10 release

There are a few Mathematica users beside myself that are running it on a Raspberry Pi, and we found out it does not always perform the same as the Desktop version [1][2]. During the testing of the ...
4
votes
0answers
44 views

FindDivisions behavior changed?

I seem to recall using FindDivisions as a quick way to get all numbers in an interval that are divisible by a member of some set of integers, e.g. ...
3
votes
2answers
228 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
168 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
3answers
145 views

Pick bug? level 0 matching

A previous discussion of this issue (Is there a bug in Pick?) accepted that matching at level 0 is not a bug in Pick. Was that correct? I am not yet persuaded. ...
3
votes
2answers
149 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
123 views

How can I change the default font size of the Virtual Book?

How can I change the default font size of the Virtual Book?
3
votes
1answer
93 views

Where can I access documentation for old versions of Mathematica?

Some documentation of functions available in old versions of Mathematica (and old packages) is available online, e.g. http://reference.wolfram.com/language/Combinatorica/ref/Vertices.html Is there ...
3
votes
1answer
136 views

Merging documentation from Workbench with handed-coded package

On the one hand, I have been writing my package (directly into the .m file) separately using the standard Mathematica front-end. My source .m files and the init.m files have the appropriate folder ...
3
votes
1answer
65 views

Is the use of StringTemplate with a styled string documented behavior?

I was pleasantly surprised to find out that StringTemplate appears to work with styled (formatted) strings, with the style of the slots applied to the inserted ...
3
votes
1answer
171 views

Documentation with Workbench: Paclet vs Package

I am writing documentation for my package in Workbench v2.0 with Mathematica v9.0.1. But for some reason, all of the help pages (and the index) of the package say that the various functions and ...
3
votes
0answers
81 views

Is there a documentation generator for Mathematica?

I'm looking for a way to document the functions of my packages inline, preferably inside comments. There should be a Doxygen type tool for this that takes comments and that generates html from markup ...
3
votes
0answers
51 views

Missing links in usage statements

The integration of the documentation center does not seem to be complete on my machine. I often access the documentation center via the usage statement links. ...
3
votes
0answers
98 views

Derivative of generating function (Example from documentation)

In the documentation for GeneratingFunction, the following example is given under Examples -> Properties & Relations -> Derivative: ...
2
votes
1answer
87 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
165 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
81 views

How to obtain a complete list of WordData's “Properties”?

Command WordData["Word", "Properties"] seems to return an endless list of properties, such as: "Definitions", ...
2
votes
1answer
63 views

Should local Documentation match reference.wolfram.com?

I've searched here for similar questions but was unable to find any. I have a specific example where my local documentation does not match the documentation on http://reference.wolfram.com/language/ ...
2
votes
1answer
71 views

What can I do with “Syntax Templates” section at start of Symbol Pages (in Workbench)?

At the top of each Symbol Page, there are a bunch of little sections in grey (see screen shot). But I do not understand how to use them. I am particularly interested in the "Syntax templates" ...
2
votes
1answer
90 views

Using PlotRange to cut off outlying points

In the documentation for PlotRange, there is the following line: If a particular minimum or maximum is specified as {Automatic, α}, this means that the range ...
2
votes
1answer
103 views

Elements in `Reap` and `Sow`

Can someone help explain it to me: How does here e come out? Why b disappears? ...
2
votes
0answers
54 views

Documentation on the attribute OneIdentity [duplicate]

The documentation on the attribute OneIdentity says OneIdentity is an attribute that can be assigned to a symbol f to ...
2
votes
0answers
40 views

Example in Help File does not evaluate as claimed

In the help file, under BellB, I read at 'Properties and Relations': "Sum can give results involving ...
2
votes
1answer
112 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
65 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 ...
1
vote
1answer
610 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 ...