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

41
votes
1answer
928 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 ...
4
votes
1answer
58 views

? (Definition) versus ?? (Information)

What is the difference between ? Definition and ?? ...
3
votes
3answers
138 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. ...
8
votes
3answers
190 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 ...
14
votes
2answers
193 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 ...
4
votes
0answers
35 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. ...
8
votes
2answers
333 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 ...
14
votes
2answers
241 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, ...
13
votes
3answers
322 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 ...
2
votes
1answer
56 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/ ...
6
votes
1answer
123 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 ...
2
votes
1answer
62 views

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

Command WordData["Word", "Properties"] seems have an endless list of properties, such as : "Definitions", ...
5
votes
1answer
157 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 ...
1
vote
0answers
50 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 ...
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 ...
15
votes
1answer
382 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 ...
17
votes
0answers
200 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: ...
3
votes
1answer
45 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 ...
4
votes
1answer
121 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) ...
2
votes
0answers
65 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 ...
1
vote
0answers
41 views

Purpose of VertexWeight

I am trying to partition a graph into partitions of equal weight (on the vertex). I looked at the documentation, and found VertexWeight, which seems to attach a weight to a vertex. In the details, ...
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 ...
3
votes
0answers
49 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. ...
10
votes
1answer
291 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 ...
7
votes
1answer
173 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 ...
6
votes
1answer
176 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. ...
3
votes
1answer
150 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 ...
2
votes
1answer
59 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" ...
1
vote
0answers
36 views

How to remove box around “More Information” section in documentation Symbol Page generated by Workbench [duplicate]

I am using Workbench 2.0 with Mathematica 9.0.1. For some reason, the one section titled "MORE INFORMATION" is boxed (see screenshot). All other section headers look like built-in Mathematica symbol ...
1
vote
1answer
116 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 ...
11
votes
1answer
144 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 ...
22
votes
1answer
342 views

How to extract a list of available Method-s

The option Methodapplies for several functions, such as NDSolve, FindRoot, ...
11
votes
2answers
163 views

Listable functions thread over Associations; is this documented?

Thanks to a somewhat misapplied use of MapThread I learned of this behavior: ...
3
votes
2answers
111 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?
5
votes
2answers
143 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 ...
2
votes
1answer
111 views

Switch Shift+Enter and Enter

How can I switch the functionality of Enter and Shift+Enter in Windows? I find mat labs functionality more intuitive sometimes.
4
votes
1answer
105 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 ...
2
votes
0answers
39 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 ...
9
votes
1answer
171 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 ...
6
votes
2answers
223 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 ...
30
votes
6answers
931 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 ...
3
votes
0answers
92 views

Derivative of generating function (Example from documentation)

In the documentation for GeneratingFunction, the following example is given under Examples -> Properties & Relations -> Derivative: ...
3
votes
1answer
121 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 ...
1
vote
0answers
48 views

Is there any metadata-holding mechanisms in Mathematica programming similar to Java annotations?

I'm re-implementing some tools previously implemented in Java in Wolfram Language. Is there any metadata-holding mechanisms in Mathematica programming similar to Java annotations?
6
votes
2answers
337 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 ...
2
votes
1answer
77 views

Elements in `Reap` and `Sow`

Can someone help explain it to me: How does here e come out? Why b disappears? ...
1
vote
1answer
67 views

Conditions in SparseArray

I got confused by {i_, j_} /; in the following code. I didn't see an explanation in the SparseArray documentation. Can anyone ...
4
votes
1answer
127 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 ...
0
votes
0answers
43 views

Limits explanation in doc

Limit[expr,x->Subscript[x, 0],Direction->1] computes the limit as x approaches Subscript[x, 0] from smaller values. ...
4
votes
2answers
301 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 ...