aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst
diff options
context:
space:
mode:
Diffstat (limited to 'data/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst')
-rw-r--r--data/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst151
1 files changed, 151 insertions, 0 deletions
diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst
new file mode 100644
index 00000000..ef881aae
--- /dev/null
+++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst
@@ -0,0 +1,151 @@
+% SiSU insert 4.0
+
+@title: SiSU
+ :subtitle: Syntax Highlighting
+
+@creator:
+ :author: Amissah, Ralph
+
+@date:
+ :published: 2007-09-16
+ :created: 2002-11-12
+ :issued: 2002-11-12
+ :available: 2002-11-12
+ :modified: 2012-10-03
+
+@rights:
+ :copyright: Copyright (C) Ralph Amissah 2007
+ :license: GPL 3 (part of SiSU documentation)
+
+@classify:
+ :topic_register: electronic documents:SiSU:document:syntax highlighting;SiSU:manual:syntax highlighting;electronic documents:SiSU:manual:syntax highlighting;SiSU:document:syntax highlighting;SiSU:document:syntax highlighting
+ :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
+
+:A~? @title @creator
+
+:B~? SiSU Syntax Highlighting
+
+1~ Editor Files, Syntax Highlighting
+
+The directory:
+
+_1 ./data/sisu/conf/editor-syntax-etc/
+
+_1 /usr/share/sisu/conf/editor-syntax-etc
+
+contains rudimentary sisu syntax highlighting files for:
+
+_* (g)vim http://www.vim.org
+
+_1 package: sisu-vim
+
+status: largely done
+
+_1 there is a vim syntax highlighting and folds component
+
+_* gedit http://www.gnome.org/projects/gedit
+
+_* gobby http://gobby.0x539.de/
+
+_1 file: sisu.lang
+
+place in:
+
+_1 /usr/share/gtksourceview-1.0/language-specs
+
+or
+
+_1 ~/.gnome2/gtksourceview-1.0/language-specs
+
+_1 status: very basic syntax highlighting
+
+_1 comments: this editor features display line wrap and is used by Goby!
+
+_* nano http://www.nano-editor.org
+
+_1 file: nanorc
+
+save as:
+
+_1 ~/.nanorc
+
+_1 status: basic syntax highlighting
+
+_1 comments: assumes dark background; no display line-wrap; does line breaks
+
+_* diakonos (an editor written in ruby) http://purepistos.net/diakonos
+
+file: diakonos.conf
+
+save as:
+
+_1 ~/.diakonos/diakonos.conf
+
+includes:
+
+_1 status: basic syntax highlighting
+
+comments: assumes dark background; no display line-wrap
+
+_* kate & kwrite http://kate.kde.org
+
+_1 file: sisu.xml
+
+_1 place in:
+
+_2 /usr/share/apps/katepart/syntax
+
+_1 or
+
+_2 ~/.kde/share/apps/katepart/syntax
+
+_1 [settings::configure kate::{highlighting,filetypes}]
+
+_1 [tools::highlighting::{markup,scripts}::SiSU]
+
+% kde-config --prefix
+% KDEDIR/share/apps/katepart/syntax/
+% KDEHOME/share/apps/katepart/syntax
+% [In the configure dialog in kate, go to the "Editor->highlighting" page and
+% >select a highlight to change the mimetype/pattern associations for it.]
+% /etc/mime.types
+% /usr/share/mime/text
+
+_* nedit http://www.nedit.org
+
+_1 file: sisu_nedit.pats
+
+_1 nedit -import sisu_nedit.pats
+
+_1 status: a very clumsy first attempt [not really done]
+
+_1 comments: this editor features display line wrap
+
+_* emacs http://www.gnu.org/software/emacs/emacs.html
+
+_1 files: sisu-mode.el
+
+_1 to file ~/.emacs add the following 2 lines:
+
+_2 (add-to-list 'load-path "/usr/share/sisu/conf/editor-syntax-etc/emacs")
+
+_2 (require 'sisu-mode.el)
+
+_1 [not done / not yet included]
+
+_* vim & gvim http://www.vim.org
+
+_1 files:
+
+_1 package is the most comprehensive sisu syntax highlighting and editor environment provided to date (is for vim/ gvim, and is separate from the contents of this directory)
+
+_1 status: this includes: syntax highlighting; vim folds; some error checking
+
+_1 comments: this editor features display line wrap
+
+NOTE:
+
+[SiSU parses files with long lines or line breaks, but, display linewrap (without line-breaks) is a convenient editor feature to have for sisu markup]
+
+% aeditor (an editor written in ruby)
+