Annotate syntax elements at box level.
- Usage examples
- Installation
- Compatibility
- Bugs and requests
- Contributing
- Usage in other packages
- License
- Versioning
You can find usage examples in answer to "How to convert a notebook cell to a string retaining all formatting, colorization of identifiers etc?" question on Mathematica Stack Exchange.
To install newest version of SyntaxAnnotations package, in Mathematica version 10 or newer, evaluate following code:
PacletInstall@"http://github.com/jkuczm/MathematicaSyntaxAnnotations/releases/download/v0.2.2/SyntaxAnnotations-0.2.2.paclet"Note that above requires allowing Mathematica to use the Internet.
To load SyntaxAnnotations package evaluate:
Needs@"SyntaxAnnotations`"To uninstall SyntaxAnnotations package evaluate:
PacletUninstall@"SyntaxAnnotations"If in your setup Mathematica doesn't have Internet access,
or you're using version older than 10, download
SyntaxAnnotations.0.2.2.paclet
file and evaluate PacletInstall with path to downloaded file:
PacletInstall@"path/to/downloaded/SyntaxAnnotations.0.2.2.paclet"To load SyntaxAnnotations package evaluate:
Needs@"SyntaxAnnotations`"To uninstall SyntaxAnnotations package evaluate:
PacletUninstall@"SyntaxAnnotations"To use package directly from the Web, without installation, evaluate:
Import@"https://raw.githubusercontent.com/jkuczm/MathematicaSyntaxAnnotations/master/NoInstall.m"This package contains extensive automatic test suite. Package is tested with all Mathematica major and minor versions from 8.0 to 11.0 on Linux. Since it doesn't contain any OS specific code it should work with above versions on all operating systems.
There's also no obvious reason for package not to work on older (6.0+) and newer (11.1+) versions of Mathematica, but it was not tested with these versions.
If you find any bugs or have feature request please create an issue on GitHub.
Feel free to fork and send pull requests.
All contributions are welcome!
There are two ways to use SyntaxAnnotations with your own package.
First is to require users, of your package, to install SyntaxAnnotations
separately. Your package can then load it, as any other external package, using
Get@"SyntaxAnnotations`". Be aware that if your package requires specific
version of SyntaxAnnotations and user wants to use other package requiring
different version of SyntaxAnnotations it may lead to a version conflict.
Second way is to include specific version of SyntaxAnnotations as sub-package
of your package. To do it, simply put SyntaxAnnotations.m file inside main
directory of your package. And load it using Get@"`SyntaxAnnotations`"
(note the grave accent character at the beginning of string) somewhere inside
main context of your package.
Directory structure of YourPackage` can, for example, look like this:
YourPackage
├── Kernel
│ └── init.m
├── SyntaxAnnotations.m
└── YourPackage.m
and YourPackage.m file:
BeginPackage@"YourPackage`"
(* Public symbols usage *)
Get@"`SyntaxAnnotations`"
Begin@"`Private`"
(* Implementation *)
End[]
EndPackage[]This way specific version of SyntaxAnnotations package, distributed with your
package, will be loaded as YourPackage`SyntaxAnnotations` , and will be
completely independent of other versions of SyntaxAnnotations possibly used by
user of your package.
This package is released under The MIT License.
Releases of this package will be numbered using Semantic Versioning guidelines.