Questions tagged [documentation]

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.

Filter by
Sorted by
Tagged with
39
votes
7answers
1k views

How symbol lookup actually works

Bug introduced in V6 and fixed in V11.3 The behavior indeed changed but now the documentation is clear about it. This code is inconsistent with the description from Power Programming with ...
82
votes
1answer
2k 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
691 views

What do brackets around a levelspec option do?

The following code returns the first three integer elements of Sqrt[Range[100]]: ...
44
votes
6answers
2k 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 ...
16
votes
3answers
540 views

Language`* documentation project

Language` context is around for a long time. It is also heavily used (APIFunctions / FormFunctions dependencies deployment rely on it). It is undocumented and ...
30
votes
3answers
1k views

Is there a “precedence table” for the canonical Sort ordering?

This answer in which I wrote about the Operator Precedence Table was unexpectedly popular. That got me thinking about similar things, and I am wondering: Does an "ordering table" exist for the ...
31
votes
1answer
1k 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 <...
26
votes
1answer
298 views

How do I add the infobutton in autocomplete that links to the documentation page for package functions?

When typing the name of a built-in function like Integrate, the button (ℹ︎) appears next to that name in the autocomplete: But I don't get that (ℹ︎) button for my ...
16
votes
1answer
397 views

Structure of Graphics (esp. those produced by Plot, ListPlot, etc.)

I'm looking for a description of the structure of Graphics objects, aimed at the advanced Mathematica programmer. The motivation for this question is the following....
26
votes
2answers
464 views

Is there a way to make the “Details” section of the Documentation expanded by default?

By default, the Mathematica documentation opens with the "Details" section collapsed. This is never what I'm looking for — in fact, I've lost count of the times I've sought help on a feature and not ...
22
votes
3answers
905 views

What is a printer's point?

Bug introduced in 10.4 or earlier and persisting through v11.3 (misleading documentation inconsistency) According to the documentation it is a basic unit for size spec. ...
8
votes
2answers
543 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 ...
16
votes
1answer
547 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 ...
22
votes
1answer
511 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 ...
25
votes
5answers
2k 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 ...
18
votes
2answers
674 views

User-defined usage message template; removing repeated text

In Mathematica 9.0.1, I want to write a user-defined template for a function that I wrote: myfunc ...
19
votes
2answers
1k views

Where is the “Function Navigator” and “Virtual Book” gone?

Under V9 "Help" was a Item each for "Function Navigator" and "Virtual Book" to find and one could work with it. Under V10 these Helpers are gone. Although under Documentation/English/System the ...
24
votes
3answers
3k 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. ...
21
votes
1answer
435 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
1k 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 ...
14
votes
1answer
397 views

Workbench (Eclipse version) HTML Documentation Build HTML issues

Description The HTML generated for local viewing by Workbench (Eclipse plugin version 10.1.757) has some issues before they can be published. This post is in continuation of the original question ...
11
votes
2answers
387 views

Workbench 2 and 3 Documentation HTML Build Fails (Output file test failed)

In Wolfram Workbench it used to be possible to generate HTML Documentation pages. Now when I build, using Mathematica 10.4+ and Workbench 2 or 3 on Windows 8.1, the HTML build fails (the notebook ...
11
votes
1answer
615 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 <...
9
votes
1answer
4k 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
3answers
220 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. ...
36
votes
1answer
1k views

How to extract a list of available Method-s

The option Methodapplies for several functions, such as NDSolve, FindRoot, ...
37
votes
3answers
963 views

Most influential and/or disrupting features introduced with new versions of Mathematica

This is something that has been bugging me for ages. With every upgrade, Mathematica has added new functionalities and amended some of its bugs. In the process, though, some older functionality has ...
25
votes
4answers
704 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 ...
19
votes
1answer
476 views

Using DocumentationBuild and Transmogrify to generate web docs

I build my docs in Mathematica, rather than using Workbench and the DocumentationTools. But now I want to be able to build HTML versions of my docs. I knew Workbench (partially) supported this and ...
13
votes
4answers
502 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 ...
24
votes
1answer
567 views

A documented syntax of FileNames doesn't work?

Documentation discrepancy present in 10.3 and fixed in 10.4.1 According to the documentation for FileNames under Details: However when I attempt to use this ...
16
votes
2answers
312 views

Listable functions thread over Associations; is this documented?

Thanks to a somewhat misapplied use of MapThread I learned of this behavior: ...
13
votes
1answer
456 views

How to use Get on a folder

Documentation flaw introduced before 9.0 and persisting through V11.0.0 In the documentation for Get it says: If the file found by ...
38
votes
2answers
1k 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 ...
17
votes
2answers
470 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, ...
12
votes
2answers
598 views

How can I build documentation using docbuild.xml outside of the Workbench?

Building package documentation from source notebooks using the Workbench is as simple as a click of a button. How can I automate the documentation build from the command line? I believe that this ...
14
votes
1answer
367 views

How to create search indices for custom documentation pages?

I have a package that uses custom documentation pages that are not generated with Wolfram Workbench. How can I create search indices for these pages? Requirements: Searching should work in ...
17
votes
1answer
1k views

Understanding Sow and Reap documentation

Both in Sow and in Reap documentation there is the example: ...
28
votes
2answers
876 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 ...
25
votes
1answer
635 views

Pop-up appeared and then disappeared during first documentation search in 11.2

After installing Mathematica 11.2, the first time I searched for something in the help center a pop-up appeared and then disappeared. It didn't appear on a subsequent search, even if I restarted ...
16
votes
0answers
186 views

Why are delayed definitions in scoping functions NOT documented?

As outlined here, := may be used in scoping constructs like With to give delayed definitions, but this is undocumented. This ...
6
votes
1answer
241 views

linking usage message to package documentation

I am trying to write documentation for a package I made, using Workbench. Let's say I have a function test, first I write a usage message as: ...
20
votes
1answer
537 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 ...
8
votes
1answer
160 views

Dynamic triggered but renders the same content

Documentation bug introduced in V10 or eralier and persisting through V11.3 It is a documentation bug because the undocumented optimization method by FE makes major assumptions. The example is not ...
7
votes
1answer
256 views

What is the purpose of the Kernel and Application extensions in PacletInfo.m?

Wolfram Workbench has a graphical editor for PacletInfo.m files. It is possible to add a "Kernel" extension with Symbols, ...
15
votes
2answers
261 views

Silent change (bug?) of Join after v9

Consider the following sample: Join[{A[x]}, {A[x]}, 2] It causes Join::headsd warning in and before v9 and returns the input: ...
11
votes
1answer
233 views

Self contained APIFunction. Collecting definitions

Bug fixed in V11.2 Previously dependencies collector failed to collect check if check was only mentioned in lhs: ...
10
votes
1answer
259 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 ...
9
votes
1answer
226 views

What really makes a Dialog window behave as a modal dialog?

CreateDialog[DefaultButton[], Modal -> True] creates a modal Dialog, one which needs to be closed before the front-end ...
8
votes
2answers
221 views

Documentation Tools: How to prevent breaking up CamelCase package name?

I am exploring the Workbench documentation tools for the first time and one of the difficulties I encountered was that when documentation pages are generated, a CamelCase package name is changed into "...