joe-syntax/README.md

# JOE Syntax Highlighting

This repository mainly contains *improved and completely new* JOE syntax files fixing bugs in the original files and adding support for new languages.

## Using

### \*.jsf

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 either download the contents of this repository as a [zip file](https://github.com/cmur2/joe-syntax/archive/master.zip) or 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).

### ftyperc (only needed to enable new languages)

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*.

## How JOE syntax highlighting works

See [HowItWorks.md](https://github.com/cmur2/joe-syntax/blob/master/misc/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).

## Other Syntax Files

* [d.jsf](https://gist.github.com/1032393)

## Licensing

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.

Every .jsf file created and modified exclusively by [me (Christian Nicolai)](https://github.com/cmur2) is under GPL v2 or any later version.

Files with contributions (or unclear license info):

* [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)
* [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))
* [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))
* [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))
* [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)

## Links

For JOE see [here](http://joe-editor.sourceforge.net/).  
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/).  
For ne (the nice editor that uses JOE syntax files, too) see [here](http://ne.di.unimi.it/).  

*You can find this repository [here](https://github.com/cmur2/joe-syntax).*