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
11
votes
1answer
195 views

Package documentation separately from code

Mathematica documentation is heavy duty stuff. Of the 7.75GB my Mac says Mathematica 11.3 takes up, 5.46 of that is documentation. So when I write my own packages I don't want to do what WRI did and ...
5
votes
3answers
152 views

help example blank in 11.3 under ref/ExclusionsStyle

I only found this one case so far, by chance. In version 11.2, under the help page ref/ExclusionsStyle or ?ExclusionsStyle, the ...
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 ...
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 ...
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 ...
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 ...
1
vote
0answers
108 views

MaTeX documentation not available in documentation center [closed]

Typing "MaTeX" in the documentation center doesn't give any hits. Do I have to do anything before this works? I tried uninstalling and re-installing MaTeX (via ...
6
votes
1answer
87 views

Is Depth[x, Heads->True] historical?

I randomly found that Depth has a boolean option called Heads: ...
4
votes
0answers
138 views

Good Textbook on Boundary Integral Equation or Boundary Element Methods Using Mathematica

Is there a good textbook out there that treats Boundary Integral Equations or Boundary Element Methods Using Mathematica? I have scouted around a bit and could not find a good textbook that treats ...
0
votes
1answer
41 views

How to disable opening new Documentation Window when selecting an item from the Documentation Home page?

When I open the Wolfram Documentation Center, a new window opens to the Home page. If I select an item from the top category drop down (eg, Core Language & Structure -> Lists), a 2nd Documentation ...
11
votes
1answer
234 views

Can I implement something like the old documentation help browser?

Old versions of Mathematica had a help browser that was more click through and structured. How can I reimplement something like that for the new (since v6) docs?
10
votes
1answer
320 views

How can I implement my own documentation search function?

The current documentation search doesn't allow for very sophisticate searching, can I write my own function to search through the docs?
14
votes
1answer
363 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 ...
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 ...
5
votes
1answer
92 views

? vs Information - Making UpValues less destructive

I'll first state the main question of this, what follows afterwards are some of my thoughts/attempts at fixing it and additional questions about possible improvements (getting an answer to those would ...
8
votes
1answer
336 views

Is Wolfram's example of solving PDEs in 3D inconsistent?

I am slightly puzzled over the example "Solve PDEs over 3D Regions" provided by Wolfram. The example shows how to solve Laplace's equation over a space shuttle mesh. However, if I run the code in 11.0....
11
votes
2answers
649 views

How to calculate CellularAutomaton rule numbers in higher dimensions?

Where can I find documentation of the rule number convention for CellularAutomaton for higher than 1 dimension? I understand the convention for elementary 1D ...
4
votes
0answers
215 views

How does `Simplify` resolve `LeafCount` ties? [closed]

The documentation for ComplexityFunction says With the default setting ComplexityFunction->Automatic, forms are ranked primarily according to their LeafCount, ...
4
votes
1answer
129 views

Download DocumentationBuild and Transmogrify without Eclipse

I've been playing with the HTML docs system recently, but want to download the core packages from the source (for downstream users / fun). My digging has gotten me this far: the DocumentationBuild (...
2
votes
1answer
99 views

Cell @ CellGroupData[… in Cells family

Bug introduced in V10.4 or earlier and persisting through V11.3 Background This question originates from two already posted questions updated with further doubts I've faced. I deleted one and merged ...
5
votes
0answers
53 views

calling up workbench-generated help pages for custom functions [duplicate]

Using Wolfram Workbench 2, I have succeeded in creating custom documentation for custom functions. After doing "Application Tools -> Deploy Application", I can Get ...
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 ...
1
vote
1answer
58 views

Cells[] ignoring multiple style cells

Bug introduced in V9 and fixed in V11 Same story as in NotebookImport ignoring multiple style cells, ...
11
votes
1answer
231 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: ...
1
vote
1answer
89 views

What is happening behind the scenes in this SphericalPlot3D function call that maps a scalar field to the surface of a sphere?

I am trying to understand what is happening in the following code (taken from here): ...
0
votes
0answers
58 views

Mathematica IntervalGraph

I wanted to visualize an Interval Graph.Documentation says there exists a function IntervalGraph in Global which used to be in package Combinatorica before ...
27
votes
1answer
828 views

Automating documentation generation

Outside of kernel symbols Mathematica provides access to lots of usage info, e.g. DownValues, Options, ...
4
votes
0answers
53 views

Convert Doc Notebook to HTML

Is there any built-in utility to convert a documentation notebook to the type of page that's on the Wolfram website, e.g. the web version of FormFunction from the ...
6
votes
2answers
327 views

Cropping from the top and bottom of an image using ImageCrop

Under details and options the documentation article ref/ImageCrop says: The cropping specification spec in ImageCrop[image, size, spec] can have the following forms: {side1, side2} ... crops ...
1
vote
0answers
52 views

Same functions in plot but in different ways get different graph

According the documentation in Wolfram, Plot uses in below way, Plot[f,{x,xmin,xmax}] So, there is my original code. ...
3
votes
0answers
62 views

Understanding the difference between EvaluationNotebook and ButtonNotebook (and their FrontEnd` versions)

The Documentation for ButtonNotebook says: ButtonNotebook[] gives the notebook, if any, that contains the button which ...
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 ...
4
votes
0answers
64 views

Is the package documentation buggy? [duplicate]

At https://reference.wolfram.com/language/tutorial/SettingUpWolframLanguagePackages.html we read: BeginPackage["Package`"] set Package` to be the current ...
11
votes
1answer
271 views

Question about changes in Documentation Center from version 10 to 11

The package Exploring Abstract Algebra with Mathematica works fine in Mathematica 10.4. After installing it in the $UserBaseDirectory it neatly shows up under Add-Ons and Packages in the ...
10
votes
1answer
143 views

Cell State and Openers in 11.1 documentation

So I've been playing with the new 11.1 documentation style and I noticed that there's something seemingly odd with the openers. If we open any doc page: ...
3
votes
1answer
109 views

ParametricRegion example from documentation not running

I tried running a piece of code in the examples listed in Scope in https://reference.wolfram.com/language/ref/ParametricRegion.html and it gives an error. I tried running the below code to get a ...
2
votes
0answers
58 views

Where is documentation for Control`PoleZeroPlot? [duplicate]

An earlier question here mentioned Control`PoleZeroPlot, which I've found useful. Typing Names["*`PoleZeroPlot] returns ...
11
votes
1answer
572 views

Dimensions — counter-intuitive?

Perhaps I'm misunderstanding the meaning of Dimensions in Mathematica, but the following two examples seem very counter-intuitive to me. If we define ...
3
votes
0answers
107 views

Mathematica freezes often when using third party library

I am one of the maintainers of the quantum-utils library for Mathematica. We have been unable to sort out a problem that started with Mathematica 11 (on macOS, windows, and linux). The symptom is that ...
1
vote
0answers
47 views

About the accuracy of NormBound in LSODA [closed]

As most of us only known, LSODA obtains a bound on the dominant eigenvalue by determining the norm of the Jacobian $||J||_p$. For a comprehensive understand of this powerful stiffness-switch method, ...
6
votes
0answers
88 views

How to generate docs with the new style?

Is there a way to make the Wolfram Workbench generate HTML with the new documentation styles of version 11.1?
12
votes
1answer
181 views

How to add example links to documentation pages?

Link to Wolfram Community version. The Details section of documentation pages often contains ">>" links to the examples below. Is there a quick and easy way to add these links using the Workbench ...
2
votes
1answer
225 views

Loading documentation of Package installed in any directory

Installing Package into $UserBaseDirectory or $BaseDirectory means automatic loading of the documentation (after calling the ...
2
votes
1answer
86 views

Create notebook with a section extracted from Documentation

I would like to copy a part of a help section into a notebook. The objective is to add comment and save them. My issue is that, when I copy a part of a help section into a notebook, all the links ...
5
votes
1answer
65 views

Weird documentation search behavior

I was typing a search in the docs and when I hit return I saw this: Is this a bug?
3
votes
1answer
49 views

why ?ListLinePlot do not show link to help pages like other commands?

Bug introduced in 11.0 Any idea why ?ListLinePlot do not bring the standard help with that link at the end which sends one to the actual help page like other ...
3
votes
0answers
83 views

Building integrators and how they compare across platforms

I'm interested in building some numerical integrators. Specifically symplectic integrators. Now, my Mathematica has been coming along, day by day, slowly but surely. Still not at a stage where I can ...
4
votes
2answers
287 views

Inserting link to help page

How do I insert a link to a particular help page in Mathematica? Insert > Hyperlink... does not seem to offer this option. In particular, I am trying to link to guide/MatrixDecompositions.
1
vote
0answers
45 views

“Typical supported forms include…”

The following is an excerpt from the official documentation for Placed (emphasis added): Typical supported forms include ...
1
vote
0answers
92 views

Length[Range[5]] vs Length@Range[5] [duplicate]

I've looked all over the Wolfram Documentation and done various searches on the web and this site and I can't find an explanation of the single "@" symbol as a means of applying functions. It seems ...