A message from our CEO about the future of Stack Overflow and Stack Exchange. Read now.

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
3
votes
0answers
110 views

Finding the Mathematica package for time series

I'm studying time series. Searching at internet I found this pdf file with a lot a useful information and examples about time series. I want to know if some one knows how to get the required package ...
3
votes
1answer
113 views

Complete list of values for \$SystemID, \$OperatingSystem

The documentation lists some "typical values", but it leaves out some; e.g. "Windows-x86-64". Also, if the main difference between the two variables is that ...
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 ...
4
votes
0answers
71 views

Customizing documentation from workbench?

The documentation generator is working now for me, but I'm hoping someone knows how to customize the html generation in any of the following ways: Is there a way to keep input cells as text (instead ...
1
vote
0answers
45 views

How do I activate the infobutton that links to the documentation page for package functions [duplicate]

When typing the name of a built-in function like Integrate, the button () appears next to that name in the autocomplete: But in my self-defined application,it doesn't works Also, the button is gray ...
16
votes
1answer
327 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 ...
4
votes
1answer
62 views

Disable “Load at Startup” checkbox in Add-Ons list

When a package comes with documentation, it will show up in the Installed Add-Ons list in the Documentation Center. This list can be accessed at ...
7
votes
0answers
93 views

More documentation on stylesheets?

I am finding the "help" for manipulating stylesheets in Mathematica is limited. I have a found a number of helpful tips in the documentation center and StackExchange, including help with ...
12
votes
2answers
594 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 ...
12
votes
1answer
221 views

Documentation Tools: Prevent rasterizing output cell

When building documentation using the Workbench, some of the output cells get fully rasterized. I assume this is done to save space. Can I turn this off, either globally, or on a per-cell basis? I ...
5
votes
2answers
222 views

How to create horizontal delimiter like in the Documentation?

Like this screenshoot How to draw such line with Mathematica code?
2
votes
0answers
187 views

Any Colocalization measuring methods or WL functions?

[Cross-posted on the Wolfram Community.] Is anyone aware of any Wofram image-processing tutorial or documentation/example that specifically address: 1) Intensity Correlation Coefficient-Based: (e.g. ...
7
votes
1answer
136 views

Documentation Tools: Where is the metadata from source doc pages used?

I am experimenting with the Documentation Tools for the first time, to integrate my package's doc pages into the Documentation Center. Doc pages are generated from a "source notebook" that the ...
12
votes
1answer
164 views

Documentation Tools: Don't put web URL in user package docs

I am exploring the Workbench documentation tools for the first time and one of the difficulties I encountered was that every generated (compiled) documentation page includes weblinks. These point to ...
8
votes
2answers
217 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 "...
7
votes
1answer
247 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, ...
2
votes
0answers
29 views

How to search effectively for information on MMA Syntax such as “_?” [duplicate]

In another question here, I saw this poincareMetric[u_?VectorQ, v_?VectorQ] := ... Whilst I am familiar with the syntax label_Type, e.g. x_Real, I had not seen ...
11
votes
2answers
383 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 ...
3
votes
0answers
89 views

Is it possible to export documentation to PDF with hyperlink relinking?

I am establishing local Mathematica documentation website. We're decided export documentation to PDF, then display the pdf files in the browser. But currently we found the hyperlink will become to ...
5
votes
1answer
104 views

What do the contents of Index and SpellIndex folders do in applications?

In the built documentation folder of an application with Wolfram Workbench, there are two folders /Documentation/English/Index and ...
4
votes
0answers
1k views

Mathematica documentation in PDF

How can I find the pdf versions of the topics in Mathematica Documentation Center? It is not practical to open the pages of functions one by one and read. I am not talking about the tutorial ...
7
votes
0answers
75 views

Enabling “Update” button for installed packages

I found that if you navigate to the "Installed Add-Ons" page in the *Wolfram Documentation Center" accessed by following Help ▸ Wolfram Documentation ▸ Add-ons and Packages you will find a listing ...
6
votes
1answer
239 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: ...
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 ...
7
votes
2answers
144 views

Display Documentation From Function

I would like a documentation function that works like that following. doc["search terms"] and it displays the list of search terms. And then ...
1
vote
2answers
123 views

Wierd behaviour of HoldPattern

I'm still thinking about how to implement Condition with anonymous patterns. And now I think I've found a way to implement it, but again, a suspected unclear ...
10
votes
2answers
213 views

How do I make a TOC at the top of a tutorial page in Wolfram Workbench?

At the top of the Complex Polynomial Systems page in the Wolfram Documentation Center, there is a table of contents with each item linking to the appropriate headers below (Mathematica 9 and above). ...
1
vote
0answers
62 views

Improved Documentation Search By Actual Content

Now by default Mathematica documentation searches keywords section in the Options version of the notebook and the actual text of the notebook. For example here is a snippet from ...
6
votes
3answers
124 views

Condition usage clarification

ref / Condition / Details says: lhs := Module[{vars}, rhs /; test ] allows local variables to be shared between test and <...
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 ...
3
votes
1answer
96 views

How can I view the source code of the last example of Classify?

The last example of Classify 's documentation is: draw in the box to test a logistic classifier trained on the dataset. In general, we can easily viwe the code in ...
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 (...
1
vote
0answers
86 views

Where can I find documentation on the methods/algorithm used in FindGraphPartition in Mathematica 10?

I am working on a graph theoretical project where it would be helpful to know the name of the algorithm used in FindGraphPartition. Question: Where can I find ...
4
votes
1answer
64 views

How do I add a “Background & Context” section to symbol doc pages in Workbench?

Some of the documentation pages for Mathematica 10's built-in symbols have an additional "Background & Context" section (just below the Details section) that's reserved for textbook-type ...
4
votes
0answers
574 views

“PostProcess” and “Tolerance” in DifferentialEvolution? [closed]

What is "postprocess" option in DifferentialEvolution method (for instance when using ...
3
votes
0answers
76 views

Latest changes in Documentation Center

I used to be able to copy code selectively in the Wolfram Documentation Center. Clicking on every piece of code used to generate a pop up in the format of InputForm (I think?). I really liked it ...
1
vote
1answer
40 views

How can I get Snippet in TextSearchReport in V10.4

In the help page, there is a column named snippet which is very useful, but I cann't see it when I evaluate the Function TextSeachReport on V10.3 or V10.4
22
votes
3answers
897 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. ...
3
votes
0answers
52 views

How to generate docs for your package? [duplicate]

I don't have Wolfram Workbench, is there any other simple way to build documentation notebooks (like the built in documentation) for your custom packages?
2
votes
0answers
57 views

How to get divider line in function/option table in Wolfram Workbench

In the tutorial pages in the documentation to my package, I have a table that contains functions and their definitions. In the sample tutorial page, I see a divider line separating the header from ...
5
votes
0answers
91 views

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

Bug introduced in 10.0 and fixed in 10.3.0 Create a file temp.txt with the following content: test1 ;;; test2 ;;; test3 ;;; ...
7
votes
1answer
201 views

Why does Table behave differently 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 ...
5
votes
2answers
124 views

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

Consider the following sample: ...
4
votes
1answer
110 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
126 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
159 views

What is the current structure of a simple package? [duplicate]

Currently, from a variety of examples, and (mostly) the template generated by my IDE, I get: ...
4
votes
1answer
74 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?
24
votes
3answers
886 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 <...
11
votes
1answer
134 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
115 views

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

Potentially simple, but I fail to implement it. Consider the following example: ...