summaryrefslogtreecommitdiffstats
path: root/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_syntax_highlighting.sst
blob: 12a70fb8acd79b6a63933180d8e79a8b9a725381 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
% 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/v4/conf/editor-syntax-etc/

_1 ./data/sisu/v3/conf/editor-syntax-etc/

_1 /usr/share/sisu/v4/conf/editor-syntax-etc

_1 /usr/share/sisu/v3/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/v4/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)