~chhei/GPlates.tmbundle

144485aa7ad011939c62149e008dfc94c08fe830 — christian 2 years ago 71c5dbf master
Updated README and added colouring example screenshot

FossilOrigin-Name: e544f6f14bdda22b21d70a6f80bb58ab2a0a951a1bd1bebd59ba39969d00af94
2 files changed, 18 insertions(+), 7 deletions(-)

A GPlatesBundle_MPRSexample.png
M README.md
A GPlatesBundle_MPRSexample.png => GPlatesBundle_MPRSexample.png +0 -0
M README.md => README.md +18 -7
@@ 1,25 1,30 @@
# GPlates.tmbundle

I have created this TextMate bundle to make the editing of the next generation [GPlates](http://www.gplates.org)
rotation files (*grot) easier. Currently, the implementation is **fully backwards-compatible** so 
I have created this bundle to make the editing of the next generation [GPlates](http://www.gplates.org)
rotation files (`*.grot`) easier in TextMate. The bundle primarily does syntax highlighting using 
[TextMate grammars](https://macromates.com/manual/en/language_grammars) and allows for code completion
with snippets such as `mprs` expanding to a full Moving Plate rotation sequence header. Currently, the implementation 
is **fully backwards-compatible** so 
that all applications relying on the old PLATES rotation file format can still read the files with the new format.

![Example of syntax colouring of `*.rot` files](GPlatesBundle_MPRSexample.png "Example of GROT Syntax colouring").  

It should be possible to import the TextMate Grammar/bundle into the popular VS Code editor [which uses 
the TextMate Grammar](https://code.visualstudio.com/api/language-extensions/syntax-highlight-guide).

**Contributions** to this bundle are happily acccepted - also, you can add issues using the 
[issue tracker](https://code.paleoearthlabs.org/gplates.tmbundle).

For background on the new rotation file standard please see 
[https://wiki.paleoearthlabs.org/software/gplates/grot/start](https://wiki.paleoearthlabs.org/software/gplates/grot/start) and the supplementary material to *Qin et al. (2012)* [here](http://www.geosci-instrum-method-data-syst.net/1/111/2012/) where the initial version of the new `*.GROT` file syntax is described.

X. Qin, R. D. Müller, J. Cannon, T. C. W. Landgrebe, C. Heine, R. J. Watson, and M. Turner. 
The GPlates Geological Information Model and Markup Language. *Geoscientific Instrumentation, Methods and Data Systems*, 
1(2):111–134, 2012. doi:[10.5194/gi-1-111-2012](http://www.geosci-instrum-method-data-syst.net/1/111/2012/).

The original Fossil repository is mirrored on [SourceHut](https://git.sr.ht/~chhei/GPlates.tmbundle).

## Installation  

Download a zip file from [the repository](https://code.paleoearthlabs.org/GPlates.tmbundle) on my website or on [SourceHut](https://git.sr.ht/~chhei/GPlates.tmbundle/archive/1.1.tar.gz). Double-clicking will install it in 
`~/Library/Application\ Support/TextMate/Pristine Copy/Bundles`
`~/Library/Application\ Support/TextMate/Pristine Copy/Bundles`. Once you open a `.grot` File you should see 
the syntax coloring, clicking the little cog at the bottom of the TextMate window will show the available functions/snippets.

Any edits you make to the files in the bundle will cause TextMate to create a new local copy of the bundle which 
is stored in `~/Library/Application\ Support/TextMate/Bundles`


@@ 33,6 38,12 @@ Using the Terminal:
Make sure your current theme as an `entity.character` and  `entity.heading` defined. 
Test different themes in case of doubt.

## Citation  

X. Qin, R. D. Müller, J. Cannon, T. C. W. Landgrebe, C. Heine, R. J. Watson, and M. Turner. 
The GPlates Geological Information Model and Markup Language. *Geoscientific Instrumentation, Methods and Data Systems*, 
1(2):111–134, 2012. doi:[10.5194/gi-1-111-2012](http://www.geosci-instrum-method-data-syst.net/1/111/2012/).

## License  

License (MIT)