cn
/
joe-syntax
mirror of https://github.com/cmur2/joe-syntax.git
1
0
Fork 0
Code Releases Activity

Updated REAMDE

This commit is contained in:
Christian Nicolai 2011-08-22 19:30:01 +02:00
parent 419e028f5f
commit 047a0a054a
1 changed files with 34 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@ -1,39 +1,51 @@
JOE Syntax Highlighting JOE Syntax Highlighting
======================= =======================
*[self](https://github.com/cmur2/joe-syntax)* This directory mainly contains *improved and completely new* JOE syntax files
fixing bugs in the original files and adding support for new languages.
For JOE see [here](http://joe-editor.sourceforge.net/).
For JOE project see [here](http://sourceforge.net/projects/joe-editor/).
For original JOE syntax files see [here](http://joe-editor.hg.sourceforge.net/hgweb/joe-editor/joe-editor/file/tip/syntax).
For a description about how JOEs jsf parser works, see 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).
### How JOE syntax highlighting works
See [HowItWorks.md](https://github.com/cmur2/joe-syntax/blob/master/HowItWorks.md).
Using Using
----- -----
### ftyperc
To enable the enhanced *ftyperc* without overwriting '/etc/joe/ftyperc', you
may place the modified one in '~/.joe/' as '~/.joe/ftyperc'.
### *.jsf ### *.jsf
To enable the .jsf files in this repository they need to appear in JOEs To enable the .jsf files in this repository they need to appear in JOEs
*syntax* directory. This is likely to be '/usr/share/joe/syntax' when using *syntax* directory. This is likely to be '/usr/share/joe/syntax' when using
Debian and APT. A good way to achieve this is to clone this repository Debian and APT. You may download the
somewhere onto your hard disk and establish symlinks to all jsf files in the [latest jsf-bundle](https://github.com/downloads/cmur2/joe-syntax/jsf-bundle_1.tar)
*syntax* directory and place it's contents into the *syntax* directory (Note: this bundle might
be outdated compared to the repository's state).
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.
### 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/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 Other Syntax Files
------------------ ------------------
* [d.jsf](https://gist.github.com/1032393) * [d.jsf](https://gist.github.com/1032393)
Links
-----
For JOE see [here](http://joe-editor.sourceforge.net/).
For JOE project see [here](http://sourceforge.net/projects/joe-editor/).
For original JOE syntax files see [here](http://joe-editor.hg.sourceforge.net/hgweb/joe-editor/joe-editor/file/tip/syntax).
*You can find this repository [here](https://github.com/cmur2/joe-syntax).*