StackOverflow2013

Note that there are some explanatory texts on larger screens.

plurals

PO
text
Body
copied!<p>It took me while but I have finally finished writing a documented Mathematica application to help Mathematica users write their documented packages.</p> <p>This application is called <code>ApplicationMaker</code>. It contains three packages with various functions to help you create the application. By using these functions you can skip going through all the mess I had described in my previous answer. </p> <p>If you download <code>ApplicationMaker</code> from my website you will find a detailed tutorial showing you how to create a complete application with its documentation.</p> <h2>Overview</h2> <p>To create a new application you start by calling <code>NewApplication</code>. This creates the directory tree I mentioned in the previous answer. To find more about Mathematica's file organization click <a href="http://reference.wolfram.com/mathematica/tutorial/MathematicaFileOrganization.html" rel="noreferrer">here</a>.</p> <p>The next step is to create the packages. For that you call <code>NewPackage</code>. This function creates a template where you write your code.</p> <p>When you finish writing your code you need to call <code>UpdateInit</code>. This updates the init file that Mathematica needs so that you can use the function <code>Get (<<)</code>.</p> <p>At this point you are ready to create the documentation. Simply call <code>CreateReferencePages</code> and this will create a basic document that you can edit to document the reference pages for each symbol in your application.</p> <p>If you want to create a guide or a tutorial for your application then you can call <code>NewGuide</code> and <code>NewTutorial</code>.</p> <p>When you are done doing your edits you need to build your application so that Mathematica can adapt it to its documentation center. You do this by calling <code>BuildApplication</code>.</p> <p>At this point you are done. If you use <code>Information</code> on any of the symbols of your package you should see an arrow appended that leads you to the reference page for that symbol.</p> <p>If you wish to share this application you should first deploy it. The current application contains the reference pages which work with the documentation center and those that you edit. By deploying it you obtain a directory with only the necessary files for your application to work.</p> <h2>Installation</h2> <p>All you have to do is drop the folder <code>ApplicationMaker</code> in <code>$UserBaseDirectory/Applications/</code> or <code>$BaseDirectory/Applications/</code>. </p> <p>To get started open up the documentation center and look for "ApplicationMaker". This should show you the guide showing all the functions that the package contains. At the very bottom you should see a link to the tutorial.</p> <h2>Final Words</h2> <p>This is the first application I have ever build for Mathematica. I will try to keep updating the package I as discover new things to make the package better. For now, I hope that this first version of ApplicationMaker is useful to anybody trying to document their Mathematica applications.</p> <p>You may download ApplicationMaker <a href="https://github.com/jmlopez-rod/ApplicationMaker" rel="noreferrer">here</a>.</p>

Querying!

Guidance

An individual column

Larger individual text columns get their own page to allow for proper reading.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload