gharib85/wwbcommon

Packages and scripts common to my projects developed using Wolfram Workbench.

Wolfram Workbench Common

Set of packages and scripts common to my projects developed using Wolfram Workbench.

• Features
• Installation
  • Project import
  • Ant runtime configuration
  • Example project configuration
    • Simple docbuild
    • Docbuild and deploy script
    • Script running tests in multiple versions of Mathematica
• Bugs and requests
• Contributing
• License

Features

• Tools "fixing" documentation:
  • making it cross version compatible,
  • fixing links in HTML version.
• Tools making source notebooks version control friendly:
  • disabling notebook cache,
  • disabling notebook cells history tracking,
  • removing existing cell change times.
• Tools for running tests in multiple versions of mathematica.
• Tools enabling inclusion of running of tests into build/deploy scripts.
• Scripts simplifying customization of documentation building and package deployment.

Installation

Project import

1. Download repository archive.

2. In Eclipse choose: File > Import....

3. Select: General > Existing Projects into Workspace, click Next >.

4. Choose Select archive file and Browse... for downloaded archive file.

5. Make sure WWBCommon is selected in Projects window and click Finish.

Ant runtime configuration

To make files available to Ant scripts from all projects perform following steps.

1. In Eclipse choose: Window > Preferences.

2. Select Ant > Runtime

3. In Properties tab click on Add property...

4. Type in: Name: WWBCommonPath, Value: ${workspace_loc}/WWBCommon, click OK.

5. Click Apply, than OK.

Example project configuration

Simple docbuild

1. Copy examples/docbuild.xml file to root directory of your project (or any other location and point it in: Project > Properties > Mathematica > Paclet Settings > Documentation Build File).

2. In copied docbuild.xml file change MySuperDuperMmaApp to name of your application. If you placed docbuild.xml somewhere else than root of your project adapt basedir attribute of project element.

Docbuild and deploy script

1. Copy examples/buildScripts directory to root directory of your project.

2. In copied buildScripts/project.properties file change MySuperDuperMmaApp to name of your application.

3. Change: Project > Properties > Mathematica > Paclet Settings > Documentation Build File setting to buildScripts/docbuild.xml.

Script running tests in multiple versions of Mathematica

1. Copy examples/runTests.xml file to root directory of your project (or any other location in your project).

2. In copied runTests.xml file.

   • Change value of WorkbenchMUnitPath property to path to MUnits MathematicaSourceVersioned directory in your installation of Workbench (in some installations MUnit might be inside a jar file so you'll need to extract it first). Since this is a system-wide property it might be preferable to set it once, for all projects, in ant runtime configuration.
   • Value of mathExecutables property should be a comma separated list of paths to Mathematica executables in which you want to run tests.
   • Change value of app.name property to name of your application.
   • Value of testFiles property should be a comma separated list of paths to test files or test suite files that you want to run.
   • If you placed runTests.xml somewhere else than root of your project adapt basedir attribute of project element.

Bugs and requests

If you find any bugs or have feature request please create an issue on GitHub.

Contributing

Feel free to fork and send pull requests.

All contributions are welcome!

License

This project is released under GNU General Public License version 3.

Attribution

Parts of code of this project are modifications of files from xTras package by Teake Nutma used under GNU General Public License version 3.

Parts of code of this project are a derivative of code written by Teake Nutma, Simon Rochester and Sebastian Schenk in Creating cross-version compatible documentation with Workbench thread on Mathematica Stack Exchange used under Creative Commons Attribution-ShareAlike 3.0 Unported License.