1
0
mirror of https://github.com/cmur2/joe-syntax.git synced 2024-11-18 20:56:17 +01:00
joe-syntax/README.md

54 lines
5.1 KiB
Markdown
Raw Normal View History

2013-06-28 20:19:41 +02:00
# JOE Syntax Highlighting
2011-08-01 18:46:03 +02:00
2017-08-04 16:08:43 +02:00
This repository mainly contains *improved and completely new* JOE syntax files fixing bugs in the original files and adding support for new languages.
2011-08-07 10:39:35 +02:00
2013-06-28 20:19:41 +02:00
## Using
2011-08-01 10:25:17 +02:00
2017-08-04 16:08:43 +02:00
### \*.jsf
2011-08-06 22:19:09 +02:00
2015-03-03 13:33:49 +01:00
To enable the .jsf files in this repository they need to appear in JOEs *syntax* directory, either locally (*~/.joe/syntax*) or globally. The global syntax directory is is likely to be */usr/share/joe/syntax* when using Debian and APT or */usr/local/Cellar/joe/3.7/share/joe/syntax* when using brew on Mac OS X. You may download the [latest jsf-bundle](https://github.com/downloads/cmur2/joe-syntax/jsf-bundle_2.tar) and place it's contents into the *syntax* directory (Note: this bundle might be outdated compared to the repository's state).
2011-08-22 19:30:01 +02:00
2015-03-03 13:33:49 +01:00
A maybe better way to achieve this is to clone this repository somewhere onto your hard disk and establish symlinks to all jsf files in the *syntax* directory, or to install this repository to *~/.joe/syntax* and symlink *ftyperc* appropriately (see below).
2011-08-22 19:30:01 +02:00
### ftyperc (only needed to enable new languages)
2015-03-03 13:33:49 +01:00
To enable the enhanced *ftyperc* from this repository to gain syntax highlighting support for new languages without overwriting */etc/joe/ftyperc*, you may place the modified one in *~/.joe/* as *~/.joe/ftyperc*.
2011-08-22 19:30:01 +02:00
2013-06-28 20:19:41 +02:00
## How JOE syntax highlighting works
2011-08-22 19:30:01 +02:00
2015-03-03 13:33:49 +01:00
See [HowItWorks.md](https://github.com/cmur2/joe-syntax/blob/master/HowItWorks.md) which is a reworked version of the header of [c.jsf](http://joe-editor.hg.sourceforge.net/hgweb/joe-editor/joe-editor/file/tip/syntax/c.jsf.in). Another good resource might be [jsf.jsf](http://joe-editor.hg.sourceforge.net/hgweb/joe-editor/joe-editor/file/tip/syntax/jsf.jsf.in).
2011-08-01 10:25:17 +02:00
2013-06-28 20:19:41 +02:00
## Other Syntax Files
2011-07-31 17:00:58 +02:00
* [d.jsf](https://gist.github.com/1032393)
2011-08-01 18:46:03 +02:00
2013-06-28 20:19:41 +02:00
## Licensing
2015-03-10 15:11:10 +01:00
Every .jsf file from the original repository is under GPL as [JOE](http://sourceforge.net/projects/joe-editor/). There are efforts to move JOE to GPL v2 or any later version.
2013-06-28 20:21:06 +02:00
Every .jsf file created and modified exclusively by [me (Christian Nicolai)](https://github.com/cmur2) is under GPL v2 or any later version.
2013-06-28 20:19:41 +02:00
2015-02-18 19:51:17 +01:00
Files with contributions (or unclear license info):
2013-06-28 20:19:41 +02:00
* [elixir.jsf](https://github.com/cmur2/joe-syntax/blob/master/elixir.jsf) which is created by [Andrew Lisin](https://github.com/avli) under GPL v2 or any later version ([comment](https://github.com/cmur2/joe-syntax/pull/18#issuecomment-78036115))
2015-02-18 19:49:35 +01:00
* [erlang.jsf](https://github.com/cmur2/joe-syntax/blob/master/erlang.jsf) which is created by [Christian Nicolai](https://github.com/cmur2) and then modified by Jonas Rosling and enhanced with a small tweak from [raev](https://github.com/raev)
2013-06-28 20:19:41 +02:00
* [go.jsf](https://github.com/cmur2/joe-syntax/blob/master/go.jsf) which is entirely contributed by [Daniel Vargas](https://github.com/danielvargas)
* [ini.jsf](https://github.com/cmur2/joe-syntax/blob/master/ini.jsf) which is created by [Christian Nicolai](https://github.com/cmur2) with contributions from [Todd Lewis](https://github.com/utoddl)
2015-03-10 15:11:10 +01:00
* [js.jsf](https://github.com/cmur2/joe-syntax/blob/master/js.jsf) which is created by [Christian Nicolai](https://github.com/cmur2) and then modified by [Rebecca Turner](https://github.com/iarna) under GPL v2 or any later version and compatible ISC license ([comment](https://github.com/cmur2/joe-syntax/pull/13#issuecomment-78058267))
* [json.jsf](https://github.com/cmur2/joe-syntax/blob/master/json.jsf) which is entirely contributed by [Rebecca Turner](https://github.com/iarna) under GPL v2 or any later version and compatible ISC license ([comment](https://github.com/cmur2/joe-syntax/pull/14#issuecomment-78058037))
2014-12-18 22:56:00 +01:00
* [lsl.jsf](https://github.com/cmur2/joe-syntax/blob/master/lsl.jsf) which is from [Zai Lynch](https://wiki.secondlife.com/wiki/User:Zai_Lynch) under GPL v1 (delivered by [Rebecca Turner](https://github.com/iarna))
* [md.jsf](https://github.com/cmur2/joe-syntax/blob/master/md.jsf) which is created by [Christian Nicolai](https://github.com/cmur2) and then modified by Jonas Rosling
* [powershell.jsf](https://github.com/cmur2/joe-syntax/blob/master/powershell.jsf) which is entirely contributed by [Oskar Liljeblad](https://github.com/osklil) under GPL v2 or any later version ([comment](https://github.com/cmur2/joe-syntax/pull/5#issuecomment-76935968))
* [puppet.jsf](https://github.com/cmur2/joe-syntax/blob/master/puppet.jsf) which is created by [Christian Nicolai](https://github.com/cmur2) and then modified by [Eric Eisenhart](https://github.com/eeisenhart)
* [sql.jsf](https://github.com/cmur2/joe-syntax/blob/master/sql.jsf) which is from an "unknown source" (delivered by [Rebecca Turner](https://github.com/iarna))
2017-02-04 23:40:52 +01:00
* [yaml.jsf](https://github.com/cmur2/joe-syntax/blob/master/yaml.jsf) which is created by [Christian Nicolai](https://github.com/cmur2) with bug fixes from [Todd Lewis](https://github.com/utoddl)
2013-06-28 20:19:41 +02:00
## Links
2011-08-22 19:30:01 +02:00
For JOE see [here](http://joe-editor.sourceforge.net/).
2017-08-04 16:08:43 +02:00
For JOE project see [here](https://sourceforge.net/projects/joe-editor/).
For original JOE syntax files see [here](https://sourceforge.net/p/joe-editor/mercurial/ci/default/tree/syntax/).
2015-03-10 11:56:05 +01:00
For ne (the nice editor that uses JOE syntax files, too) see [here](http://ne.di.unimi.it/).
2011-08-22 19:30:01 +02:00
*You can find this repository [here](https://github.com/cmur2/joe-syntax).*