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

2
votes
0answers
25 views

why does ReadString[“fname”,term] open a persistent stream, and how to close it?

Create a file temp.txt with the following content: test1 ;;; test2 ;;; test3 ;;; Treating the semicolon sequence as ...
2
votes
0answers
60 views

What is the recommended writing style for WDC pages? [closed]

I am in the process of writing some documentation for functions in my package, and I was browsing through some of the documentation for built-in functions for guidance. I noticed that occasionally, a ...
4
votes
1answer
79 views

Why does table behave differntly in mathematica compared to wolframcloud?

In Stephen Wolfram's elementary introduction to the wolfram language it says you can use the table function like this: Table[5,10], to create a table of the element 5 repeated 10 times. This works in ...
5
votes
2answers
78 views

Parameter of “CopySpecial” can't be “MathML” or “CopyAsTeX”?

Consider the following sample: ...
4
votes
1answer
60 views

Search/query the documentation programmatically

I wonder if it is feasible to query the documentation center for e.g build-in functions that contain a "Neat Examples"-section in their respective documentation page. Another functionality that ...
7
votes
1answer
84 views

Recommendations about modifying usage of built-in symbols

In my package, I use some of the built-in Mathematica symbols in non-canonical ways. Right now, I use them as Options or ...
4
votes
0answers
91 views

What is the current structure of a simple package?

Currently, from a variety of examples, and (mostly) the template generated by my IDE, I get: ...
4
votes
1answer
56 views

Why does documentation search fail on substrings?

For example many times I have to type the full string exactly which defeats the point of a search, so perhaps this is a bug?
17
votes
1answer
400 views

List of symbols marked [[EXPERIMENTAL]] in the documentation

Some of the built-in Wolfram Language symbols are marked as [[EXPERIMENTAL]] in the documentation. For example How can I get a list of all the symbols marked as ...
8
votes
1answer
104 views

Abnormal behavior of RealDigits[x]

In the Details of the document of RealDigits writes the following line: RealDigits[x] normally returns a list of digits of ...
0
votes
0answers
44 views

Fail to implement region specification in NDSolve - Misreading the doc?

Potentially simple, but I fail to implement it. Consider the following example: ...
7
votes
1answer
158 views

Methods Available for Derivative Pricing in Mathematica?

I am using Mathematica to price options (built in functions, no need to reinvent the wheel, right?). In the documentation, the Binomial method is used as an example of specifying a non-standard ...
15
votes
2answers
348 views

Pop-up documentation for “The new function of the day”

The Wolfram Language has more than 5000 built-in functions and constants. ...
2
votes
0answers
25 views

Why are CellPrint cells not overwritten?

Quoting https://reference.wolfram.com/language/ref/CellPrint.html Cells generated by `CellPrint` by default have `GeneratedCell->True`, so that they are overwritten if they are regenerated. An ...
0
votes
0answers
48 views

Generate CHM from Documentation

Is it possible to generate a Microsoft CHM from Mathematica's documentation? This is a narrow question and might not help future users so it might be closed.
1
vote
0answers
45 views

Two issues about Underline(d)

From the Help Browser Style["abcd xyz", FontVariations -> {"Underline" -> True}] abcd xyz The text is NOT Underlined, contrary to the online version Also ...
7
votes
0answers
110 views

Monitor function doesn't show continious change of values

Bug introduced in 10.0 and persisting through 10.3 Mathematica version: 10.2 Monitor[i = 0; While[i < 100, Pause[0.1]; i++]; i, i] The above code is from ...
9
votes
1answer
207 views

DSolve documention on web differs greatly from distributed MMA 10.2.0 version

In the course of improving my answer to 95361, I noticed that the DSolve documentation on the web is much better written than that distributed with Mathematica ...
7
votes
3answers
132 views

How to create a documentation page for a given message issued by a (user-defined) function?

I want to create properly linked documentation pages dedicated to specific messages issued by my own functions inside a package, similar to those for messages of built-in functions like ...
4
votes
0answers
90 views

errors in CUDA example

It seems that there are some errors in the documentation page Consider these functions in the documentation CUDA Programming. However, I'm not a expert in CUDA nor C, could you check whether these are ...
8
votes
1answer
80 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 ...
12
votes
1answer
162 views

“ParametricSensitivity” in ParametricNDSolve

"ParametricSensitivity" is listed as a Method in the documentation for ParametricNDSolve, ...
20
votes
1answer
254 views

New AssociationThread forms in 10.2?

Bug introduced in 10.2.0 and fixed in 10.3.0 (The extension of AssociationThread is not (yet) implemented and the corresponding documentation has been removed) ...
18
votes
1answer
239 views

A With expression local variable specification without head List

I just noticed a new form of With in its documentation: With[$x=x_0$, $expr$] specifies that all occurrences of the symbol $x$ in $expr$ should be replaced ...
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 ...
3
votes
1answer
124 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 ...
13
votes
2answers
432 views

Is FrameTicks broken in 10.1.0?

On my system, Mathematica 10.1.0 under Windows, none of these FrameTicks documentation examples work correctly: ...
2
votes
1answer
96 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 ...
15
votes
2answers
199 views

How do I add my own help pages to the in-built Wolfram documentation?

How do I add my own help pages to the in-built Wolfram documentation ?
1
vote
1answer
66 views

What am I missing on this part of the documentation?

In the documentation for FullSimplify, under Options > Assumptions it is stated that: When assumptions are given as an argument, $Assumptions is used as well: ...
4
votes
1answer
65 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"] ...
7
votes
2answers
179 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 ...
24
votes
0answers
338 views

Documentation of the frequently-used functions in the context of Internal` and Compile` [duplicate]

In this site, I have gradually found out that there is a collection of functions in all kinds of answers. For instance, Compile`GetElement, ...
7
votes
1answer
116 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 ...
4
votes
1answer
70 views

? (Definition) versus ?? (Information)

What is the difference between ? Definition and ?? ...
8
votes
1answer
83 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. ...
16
votes
2answers
297 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, ...
2
votes
1answer
67 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/ ...
4
votes
1answer
87 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 ...
8
votes
1answer
158 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 ...
6
votes
1answer
228 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 ...
4
votes
1answer
81 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
0answers
84 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 ...
4
votes
1answer
160 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) ...
1
vote
0answers
56 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
146 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 ...
21
votes
1answer
288 views

Default behaviour of Hash[expr] and hashing in different versions of Mathematica

In different versions of Mathematica, Wolfram silently changed the behaviour of Hash when the algorithm is not specified explicitly ...
6
votes
1answer
200 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
0answers
57 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. ...
2
votes
1answer
76 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" ...