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
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 ...
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 ...
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 ...
37
votes
3answers
960 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 ...
36
votes
4answers
1k views

Are you interested in a Wolfram Workbench Update? [closed]

I also posted this on the Wolfram Community site (link below) Last week I attended the Wolfram Tour (which was great). I asked whenever we could expect a new version of Workbench, as the current (...
36
votes
1answer
1k views

How to extract a list of available Method-s

The option Methodapplies for several functions, such as NDSolve, FindRoot, ...
36
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 ...
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 <...
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 ...
28
votes
2answers
870 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 ...
27
votes
1answer
828 views

Automating documentation generation

Outside of kernel symbols Mathematica provides access to lots of usage info, e.g. DownValues, Options, ...
26
votes
2answers
462 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 ...
25
votes
4answers
703 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 ...
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 ...
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 ...
25
votes
1answer
295 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 ...
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. ...
24
votes
3answers
887 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 <...
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 ...
22
votes
3answers
898 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. ...
22
votes
1answer
510 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
0answers
394 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, ...
21
votes
1answer
433 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 ...
20
votes
1answer
535 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 ...
20
votes
1answer
292 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) ...
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 ...
19
votes
1answer
464 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 ...
18
votes
2answers
668 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 ...
18
votes
1answer
411 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 ...
17
votes
3answers
787 views

Why use \[FormalN]?

Through a copy of some code from an answer on this site I discovered the existence of: \[FormalN] The documentation describes it as follows: ...
17
votes
1answer
1k views

Understanding Sow and Reap documentation

Both in Sow and in Reap documentation there is the example: ...
17
votes
2answers
1k views

How has Hash changed in 11.3?

There are already few topic related to Hash[_String]: How does Hash calculate hash for strings? Incorrect calculating Hash SHA256 But it looks like changes are ...
17
votes
2answers
464 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, ...
17
votes
1answer
782 views

Mathematica's deeper documentation

Is there Mathematica documentation on the methods that it uses? Documentation that goes into explanations of the methods that it employs.
17
votes
2answers
226 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 ...
17
votes
2answers
259 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 ?
16
votes
3answers
527 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 ...
16
votes
1answer
396 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....
16
votes
1answer
546 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 ...
16
votes
2answers
310 views

Listable functions thread over Associations; is this documented?

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

How to make notebooks suitable for the Documentation Center?

Normally, documentation meant to be integrated into the Documentation Center is built from special source notebooks. According to the Workbench documentation, it should also be possible to use ...
16
votes
1answer
361 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 ...
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 ...
15
votes
1answer
443 views

Directory of Wolfram Language reference tutorials

The online reference for the Wolfram Language includes tutorials on various topics. Is there a table of contents or directory containing links to all of these tutorials?
15
votes
2answers
388 views

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

The Wolfram Language has more than 5000 built-in functions and constants. ...
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: ...
14
votes
1answer
434 views

“ParametricSensitivity” in ParametricNDSolve

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

What to expect from Interpreter[“Expression”]?

Sometimes it works ok Interpreter["Expression"]["1"] 1 sometimes not: Interpreter["Expression"]["Graphics[{}]"] Why ...
14
votes
1answer
392 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 ...
14
votes
1answer
214 views

How can I remove the large thumbnails in the version-11.1 Documentation

Perhaps because I am used to the old style of Mathematica Documentation, the large thumbnails in the "Details and Options" section in version-11.1 Documentation look cumbersome and redundant to me. So ...