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.
60
questions with no upvoted or accepted answers
16
votes
0answers
192 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 ...
9
votes
0answers
55 views
How to create multilingual documentation inside Wolfram Workbench?
I am relatively new to Mathematica package development. Currently I am trying to migrate a single .m file to a fully grown paclet for future maintainability and currently I am hitting a brick wall:
...
9
votes
0answers
171 views
Is there a documentation generator for Mathematica?
I'm looking for a way to document the functions of my packages inline, preferably inside comments. There should be a Doxygen type tool for this that takes comments and that generates html from markup ...
8
votes
0answers
51 views
Styles inheritance stack for elements of a Graphics/GraphicsBox
You can skip to the bottom if you only care about the question.
My original goal was to control FrameLabel color from a notebook level opposed to doing it ...
7
votes
0answers
102 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 ...
7
votes
0answers
83 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 ...
7
votes
0answers
222 views
Monitor function doesn't show continious change of values
Bug introduced in 10.0 and fixed in 11.0.0
Mathematica version: 10.2
Monitor[i = 0; While[i < 100, Pause[0.1]; i++]; i, i]
The above code is from the ...
7
votes
0answers
140 views
Associating symbol pages with symbols (Workbench)
Normally when you have symbol Abc, WorkBench creates a symbol page named Abc.
Then when you make a build, type Abc and then press the F1 key, you are sent to the Abc symbol page.
Suppose however ...
6
votes
0answers
63 views
Mathematica 12 crashes when I use F1 for documentation
I have been using Wolfram Mathematica for about 3 years and never experienced this before. Out of the blue, today it started behaving like this; anytime I try to look into the documentation of an ...
6
votes
0answers
90 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?
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
;;;
...
5
votes
0answers
147 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 -...
4
votes
0answers
51 views
How to obtain earlier look for Virtual book in the latest documentation center?
In V 12.1, on windows, typing tutorial/VirtualBookOverview in the help windows shows this
Is it possible to obtain the earlier virtual book look, which is much ...
4
votes
0answers
56 views
Problem with links when using Workbench (Eclipse version) HTML Documentation Build
I am building a package documentation with eclipse workbench. I have used the Mathematica code in the following link Workbench (Eclipse version) HTML Documentation Build HTML issues to fix some ...
4
votes
0answers
202 views
Creating Paclet with Workbench
I've followed Emerson Willard's guide to creating a paclet with Workbench but am stuck on the step "Build your project and documentation as usual and then create your Paclet file and deploy." I hit ...
4
votes
0answers
148 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 ...
4
votes
0answers
58 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 ...
4
votes
0answers
74 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 ...
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 ...
4
votes
0answers
169 views
errors in CUDA example
It seems that there are some errors in the documentation page Consider these functions in the documentation CUDA Programming.
However, I'm not a expert in CUDA nor C, could you check whether these are ...
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
1answer
102 views
how to create a menu as the Documentation Center?
I am developing a package in Workbench and for documentation I want to make a menu of options such as the Mathematica documentation center. I could only make templates for guides, tutorials, etc; but ...
3
votes
0answers
63 views
how to download Finite ELements tutorial as PDF
For long tutorials, I prefer hard copy.
Is it possible to download from somewhere this document
https://reference.wolfram.com/language/FEMDocumentation/tutorial/FiniteElementOverview.html
as PDF ...
3
votes
0answers
134 views
Import Notebook in Wolfram Workbench
Wolfram Workbench 3* Eclipse (2018-09), Windows 10, MMA 11.0.1.0 [New Eclipse & Workbench installations & this is the 1st test]
(* I can no longer find a version ref, all I know for certain ...
3
votes
0answers
56 views
How to prevent duplication in usage message for Information and Double Usage Line within DocumentationTools
In DocumentationTools palette within Wolfram Workbench there a
Double Usage Line which is used to write usage description in the
...
3
votes
0answers
79 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 ...
3
votes
0answers
118 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 ...
3
votes
0answers
101 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 ...
3
votes
0answers
130 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
0answers
96 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 ...
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 ...
3
votes
0answers
75 views
Why are CellPrint cells not overwritten?
Quoting https://reference.wolfram.com/language/ref/CellPrint.html
Cells generated by `CellPrint` by default have `GeneratedCell->True`, so that they are overwritten if they are regenerated.
An ...
2
votes
0answers
32 views
Workbench application project with documentation in eclipse
I am trying to make a simple workbench application project in Eclipse but I can't seem to figure out how to build the documentation. I have written a package, but when I click build (under ...
2
votes
0answers
87 views
What is the best way to compare two notebooks?
I have two quite large notebooks with minimal differences. To compare them, I currently put them side by side and compare with my eyes, which feels quite inefficient. What are better ways to do this?
...
2
votes
0answers
68 views
How to know if a built-in expression is a function or not
Following the comments on the answer here I would like to know if there is a way to deduce from the documentation if a built-in expression is a function or simply "a variable that stores ...
2
votes
0answers
52 views
White lines in Plot3D and exclusions in documentation
I am aware that this issue has come up before in a number of posts. However, my question is a little different and as far as I can see not answered previously.
If I run the following code taken ...
2
votes
0answers
54 views
Built-in help stopped working
At some point recently, the built-in help seems to have disappeared on my copy of Mathematica. When I try to use it, the help window has a message like "Your search - GraphLayout - in Documentation ...
2
votes
0answers
56 views
F1 unresponsive at start up
I have Mathematica 11.3 installed on two PCs. My home PC runs Linux and does not have a problem. On my office PC (Windows 7) I find that on start up, pressing F1 to get context sensitive help is ...
2
votes
0answers
195 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. ...
2
votes
0answers
62 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 ...
2
votes
0answers
71 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?
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 ...
1
vote
1answer
87 views
Spherical Harmonics Parity
In Mathematica's documentation, the Spherical Harmonics are said to be defined as follows, for $l \geq 0$:
Furthermore, we know that $\cos(x)=\cos(-x)$, hence one can be led to believe that $Y_l^m(-\...
1
vote
0answers
16 views
Open Details section in docs made with Workbench
I'm making some package docs with Workbench (10.1.822). The "Details" section is closed by default, which is a shame because I've got some useful info there that would be easy to overlook:
...
1
vote
0answers
29 views
Obscure explanation on Adaptive scheme of NIntegrate
I found the documentation of wolfram appears to be written hurriedly since it seems to contain a number of unclear statements, e.g., equation numbers were often missed, texts in codes and those in ...
1
vote
0answers
50 views
What is the difference between form and pattern in the documentation?
In the documentation, I see the term form and the term pattern. For example, see Cases and MatchQ for both usages. What is the ...
1
vote
0answers
55 views
Branch cut of generalized hypergeometric function (error in Mathematica documentation?)
I am trying to compute the discontinuity around $x=1$ (equivalently, the branch cut) of generalized Hypergeometric functions ${}_{q+1}F_q(a_1,\dots,a_{q+1};b_1,\dots,b_q;x)$. Two formulae are given in ...
1
vote
0answers
46 views
Error in QuantumUtils in Mathematica
I installed QuantumUtils, but when I am running
Needs["QuantumUtils`"]
RunAllTest[]
I have following error:
...
1
vote
0answers
85 views
How does PacletInstall work? And is it possible to find packages using PacletInstall?
It seems that many packages published could be installed using PacletInstall
. For example, from this Rubi install instruction webpage, we could see the comman:
...
1
vote
0answers
58 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.
...
