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
4
votes
0answers
68 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 ...
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. ...
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 ...
3
votes
1answer
121 views

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

Command WordData["Word", "Properties"] seems to return an endless list of properties, such as: "Definitions", ...
10
votes
1answer
429 views

Mathieu function periodicity problem

Bug introduced in 9.0 or earlier and fixed in 10.3.0 This is a documentation mistake in MathieuCharacteristicA, ...
7
votes
2answers
317 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 ...
4
votes
1answer
269 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
70 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?
9
votes
2answers
730 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 ...
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 ...
1
vote
1answer
128 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 ...
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 ...
2
votes
1answer
85 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. ...
5
votes
2answers
2k 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 ...
4
votes
1answer
302 views

Documentation build failed with Workbench

I'm starting to use Wolfram Workbench 2 to develop a Mathematica package. For the first time I tried "Documentation - Build" under the "Application Tools" but got fatal errors: BUILD FAILED /Users/[....
8
votes
3answers
633 views

Extract a list of all built-in functions used in a notebook

I am writing my code documentation and need to list all the Mathematica built in functions I have used - explicitly written functions only. Is there a way to extract a list of all built in functions ...
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 <...
1
vote
1answer
360 views

how to make cells independent with each other in notebook

If we open DocumentationCenter and then run code, we will find that the Cells are independent from each other. For example: <...
4
votes
1answer
174 views

Example from Mathematica documentation (ExtremeValueDistribution) seems to be evaluating “forever”

Bug introduced in 9.0.1 or earlier and persisting through 11.0.1 or later I am referring to this example at the reference page for the extreme value distribution: http://reference.wolfram.com/...
2
votes
1answer
112 views

Is it possible to auto-load documentation for current function? [duplicate]

As much as Mathematica amazes me with endless variety of integrated functions and packages, inconsistency with functions parameters or finding details about a function takes some time and isn't as ...
11
votes
1answer
608 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 <...
5
votes
0answers
143 views

Derivative of generating function (Example from documentation)

Bug introduced in 9.0 or earlier and persisting through 11.0.1 or later In the documentation for GeneratingFunction, the following example is given under Examples -...
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 ...
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 ...
5
votes
2answers
212 views

Capturing an F1

I teach an Intro to Mathematica course, and one of the things I try to reinforce early on is just how helpful Mathematica's help is. In the very first lab for the course, I even give the students a ...
1
vote
1answer
145 views

Editing the Virtual Book?

It's my understanding that the Virtual Book (of mathematica 9) is in notebook (.nb) format. It appears to be a very polished style of documentation which I want to reuse (parts) of it to create my own ...
2
votes
0answers
105 views

Autoupdate Section Numbers? - Technical Document Authoring with Mathematica

Technical document authoring systems are structured ways to create, manage, and update documentation for various mediums such as print, pdf, web, etc. Take a look at this technical document ported to ...
3
votes
2answers
205 views

How to open directly the help/reference window from a notebook

I'm used to do ??symbol when I want the reference for a given symbol, then I click on the >> arrows to open the help window. Would it be possible to ...
3
votes
1answer
1k views

3D Printing in Mathematica Tutorials

Are there thorough tutorials on 3D printing for Mathematica? It seems that being able to export Mathematica files for 3D printing is unfortunately still a novelty, but it's vital for my business plans....
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 ...
6
votes
0answers
267 views

Documentation for user-defined functions; undocumented documentation feature? [closed]

I stumbled on some strange behaviour when trying out the new function template and documentation features, now purportedly working in v 9.0.1. I defined a function ...
3
votes
3answers
573 views

Generate a list of all user defined functions including their argument patterns

I have defined a bunch of functions over several different files, and I would like a list of prototypes of all the functions I have defined in my current session (I want the mathematica equivalent of ...
26
votes
2answers
461 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 ...
8
votes
1answer
219 views

FindSelectedFunction for packages - how to make it work?

Fixed in 10.0. Works correctly since Mathematica 10.0. The Mathematica help menu contains an entry Find Selected Function (Cmd+Shift+F on OSX). If you are working with say ...
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....
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 ...
12
votes
1answer
334 views

LibraryLink Documentation

Bug fixed in version 10.0.0 The documentation for LibraryLink has the following example ...
7
votes
1answer
290 views

Trouble with links to symbol pages generated by Wolfram Workbench

I am having some troubles with documentation generated by wolfram workbench. When i try to open symbol page created with workbench by pressing F1 I get a search page instead of my symbol page. When I ...
4
votes
1answer
677 views

What do brackets around a levelspec option do?

The following code returns the first three integer elements of Sqrt[Range[100]]: ...
1
vote
1answer
172 views

Ways to access lists inside lists

I have gone through some reference material but I am not getting really good links that will help me grow understanding of ...
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 ...
1
vote
0answers
39 views

“Go back” and “Go forward” in help? [duplicate]

This is a duplicate question with Gestures for forward/backward in help browser (particularly on a Mac). Please close this question. In IE, we can "go back" by Alt+←, and "go forward" by Alt+→. This ...
11
votes
1answer
123 views

When is the output of examples in function documentation rasterized?

Upon building documentation in Workbench, Workbench sometimes converts the output of examples on function pages into rasterized images, and sometimes not. Does anybody know what controls this behavior?...
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 ...
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 ...
13
votes
4answers
499 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 ...
9
votes
1answer
2k views

How can I get Mathematica to recognize the documentation for a newly installed package?

To install a new package on one's machine, one first downloads and unpacks the package into the $BaseDirectory/Applications directory. The tutorial Installing ...
5
votes
1answer
217 views

Where to find a summary for Q functions? [duplicate]

Is there a summary for all Function like NumberQ, LetterQ and so forth? data=123; IntegerQ[data] True
16
votes
1answer
545 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 ...
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 ...