-
Notifications
You must be signed in to change notification settings - Fork 16
/
dokuwiki.vim
270 lines (219 loc) · 13.3 KB
/
dokuwiki.vim
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
" Vim syntax file
" Language: dokuwiki
" Last Change: 2022-02-08
" Maintainer: Florian Preinstorfer <[email protected]>
" URL: https://github.com/nblock/vim-dokuwiki
" License: same as vim itself
" Reference: http://www.dokuwiki.org/syntax
" Credits:
" Bill Powell <[email protected]> -- original dokuwiki syntax file
" Hou Qingping <[email protected]> -- new features (combinations, footnote, quotes), bug fixes
" Sören König <[email protected]> -- zim syntax file
" Vladimir Zhbanov <[email protected]> -- a lot of patches
" Jonathan Beverley <[email protected]> -- syntax, folding, etc
" Joseph Harriott <[email protected]> -- syntax fixes
" initial checks. See `:help 44.12`
if !exists('main_syntax')
if version < 600
syntax clear
elseif exists("b:current_syntax")
finish
endif
let main_syntax = 'dokuwiki'
endif
""" Settings {{{
" Use syntax-based folding
setlocal foldmethod=syntax
setlocal foldtext=DokuFoldText()
" Set shift width for indent
setlocal shiftwidth=2
" Set the tab key size to two spaces
setlocal softtabstop=2
" Let tab keys always be expanded to spaces
setlocal expandtab
" Hide conceal text except when editing a line
setlocal conceallevel=2
setlocal concealcursor=nc
unlet! b:current_syntax
if !exists('g:dokuwiki_fenced_languages')
let g:dokuwiki_fenced_languages = []
endif
for s:type in map(copy(g:dokuwiki_fenced_languages),'matchstr(v:val,"[^=]*$")')
if s:type =~ '\.'
let b:{matchstr(s:type,'[^.]*')}_subtype = matchstr(s:type,'\.\zs.*')
endif
exec 'syn include @dokuwikiCode'.substitute(s:type,'\.','','g').' syntax/'.matchstr(s:type,'[^.]*').'.vim'
unlet! b:current_syntax
endfor
unlet! s:type
" when real width = 78, and winwidth(0)=82 because of line numbers
function! DokuFoldText()
" use user specified fillchar
"let l:foldchar = matchstr(&fillchars, 'fold:\zs.')
let l:foldchar = "=" " there isn't a local fillchars, and I don't want to change the global
let l:text = getline(v:foldstart)
" we assume 3 digits is enough width, wider looks a little odd, but that's it
let l:tail = printf("| %3d lines |%s", (v:foldend - v:foldstart + 1), repeat(l:foldchar, 3))
" winwidth() includes space for relativenumber, but I can't write there
let l:textSpace = winwidth(0) - strwidth(l:tail) - (&rnu ? &numberwidth : 0)
" if header is too long, truncate
if strwidth(l:text) > (l:textSpace)
let l:extender = "... ".repeat(l:foldchar, foldlevel(v:foldstart))
let l:text = strpart(l:text, 0, l:textSpace - strwidth(l:extender)) . l:extender
endif
" all the above is dealing with special cases, this is the payload
let l:padding = repeat(l:foldchar, l:textSpace - strwidth(l:text))
return l:text . l:padding . l:tail
endfunction
""" }}}
""" Patterns {{{
" Forced Linebreaks:
syn match dokuwikiLinebreak /\(\\\\$\|\\\\ \)/
" No Wiki Regions: %%
syn region dokuwikiNowiki start=+%%+ end=+%%+
syn region dokuwikiNowiki start=+<nowiki>+ end=+</nowiki>+
" Heading: ==== title ====
syn region dokuwikiHeading1 matchgroup=dokuwikiHeading1mg start="^=\{6}[^=]\+=\{6}$" end="^\ze\(=\{6,6}\).*\1$" fold contains=@Spell,@dokuwikiBlockItems,dokuwikiList,dokuwikiHeading5,dokuwikiHeading4,dokuwikiHeading3,dokuwikiHeading2
syn region dokuwikiHeading2 matchgroup=dokuwikiHeading2mg start="^=\{5}[^=]\+=\{5}$" end="^\ze\(=\{5,6}\).*\1$" fold contains=@Spell,@dokuwikiBlockItems,dokuwikiList,dokuwikiHeading5,dokuwikiHeading4,dokuwikiHeading3
syn region dokuwikiHeading3 matchgroup=dokuwikiHeading3mg start="^=\{4}[^=]\+=\{4}$" end="^\ze\(=\{4,6}\).*\1$" fold contains=@Spell,@dokuwikiBlockItems,dokuwikiList,dokuwikiHeading5,dokuwikiHeading4
syn region dokuwikiHeading4 matchgroup=dokuwikiHeading4mg start="^=\{3}[^=]\+=\{3}$" end="^\ze\(=\{3,6}\).*\1$" fold contains=@Spell,@dokuwikiBlockItems,dokuwikiList,dokuwikiHeading5
syn region dokuwikiHeading5 matchgroup=dokuwikiHeading5mg start="^=\{2}[^=]\+=\{2}$" end="^\ze\(=\{2,6}\).*\1$" fold contains=@Spell,@dokuwikiBlockItems,dokuwikiList
" Basic Formatting: **bold**, //italic//, __underline__, ''monospace'', etc
" A matchgroup is necessary to make concealends work with regions.
syn region dokuwikiBold matchgroup=FoldColumn start="\*\*" end="\*\*" contains=ALLBUT,dokuwikiBold,@dokuwikiNoneTextItem extend concealends
syn region dokuwikiItalic matchgroup=FoldColumn start="\/\/" end="\/\/" contains=ALLBUT,dokuwikiItalic,@dokuwikiNoneTextItem extend concealends
syn region dokuwikiUnderlined matchgroup=FoldColumn start="__" end="__" contains=ALLBUT,dokuwikiUnderlined,@dokuwikiNoneTextItem extend concealends
syn region dokuwikiMonospaced matchgroup=FoldColumn start="''" end="''" contains=ALLBUT,dokuwikiMonospaced,@dokuwikiNoneTextItem extend concealends
syn region dokuwikiStrikethrough matchgroup=FoldColumn start="<del>" end="</del>" contains=ALLBUT,@dokuwikiNoneTextItem,dokuwikiStrikethrough extend concealends
syn region dokuwikiSubscript matchgroup=FoldColumn start="<sub>" end="</sub>" contains=ALLBUT,@dokuwikiNoneTextItem,dokuwikiSubscript extend concealends
syn region dokuwikiSuperscript matchgroup=FoldColumn start="<sup>" end="</sup>" contains=ALLBUT,@dokuwikiNoneTextItem,dokuwikiSuperscript extend concealends
" Smileys: http://github.com/splitbrain/dokuwiki/blob/master/conf/smileys.conf
syn match dokuwikiSmiley "\(8-)\|8-O\|8-o\|:-(\|:-)\|=)\|:-\/\|:-\\\)" contains=@NoSpell
syn match dokuwikiSmiley "\(:-\\\|:-?\|:-D\|:-P\|:-o\|:-O\|:-x\)" contains=@NoSpell
syn match dokuwikiSmiley "\(:-X\|:-|\|;-)\|m(\|\^_\^\|:?:\|:!:\)\|LOL\|FIXME\|DELETEME" contains=@NoSpell
" Entities: http://github.com/splitbrain/dokuwiki/blob/master/conf/entities.conf
syn match dokuwikiEntities "<->" conceal cchar=↔
syn match dokuwikiEntities "->" conceal cchar=→
syn match dokuwikiEntities "<-\ze\([^>]\|$\)" conceal cchar=←
syn match dokuwikiEntities "<=>" conceal cchar=⇔
syn match dokuwikiEntities "=>" conceal cchar=⇒
syn match dokuwikiEntities "<=\ze\([^>]\|$\)" conceal cchar=⇐
syn match dokuwikiEntities "\( \|^\|\d\)\zsx\ze\d" conceal cchar=×
syn match dokuwikiEntities "\C\d\zsx\ze\($\|\s\|[0-9A-Z]\)" conceal cchar=×
syn match dokuwikiEntities "<<" conceal cchar=«
syn match dokuwikiEntities ">>" conceal cchar=»
syn match dokuwikiEntities "--\ze\([^-]\|$\)" conceal cchar=–
syn match dokuwikiEntities "---\ze\([^-]\|$\)" conceal cchar=—
syn match dokuwikiEntities "(c)" conceal cchar=©
syn match dokuwikiEntities "(tm)" conceal cchar=™
syn match dokuwikiEntities "(r)" conceal cchar=®
syn match dokuwikiEntities "\.\.\." conceal cchar=…
" Links: implicit, or [[target|optional link text]] or [[target|{{image file|optional caption}}]]
" http://github.com/splitbrain/dokuwiki/blob/master/conf/scheme.conf
syn region dokuwikiExternalLink start=+\(http\|https\|telnet\|gopher\|wais\|ftp\|ed2k\|irc\|ldap\):\/\/\|www\.+ end=+\(\ze[.,?:;-]*\_[^a-zA-Z0-9~!@#%&_+=/.,?:;-]\)+ contains=@NoSpell
syn region dokuwikiInternalLink matchgroup=dokuwikiLink start="\[\[" end="\]\]" contains=@NoSpell,dokuwikiLinkMedia,dokuwikiLinkNoMedia keepend extend
syn region dokuwikiLinkMedia matchgroup=dokuwikiLink start="|{{"ms=s-1,rs=s+1 end="}}\]\]"me=e-2,re=e-2 contained contains=dokuwikiInternalMediaLink,dokuwikiLinkCaption keepend
syn region dokuwikiLinkNoMedia matchgroup=dokuwikiLink start="|\({{\)\@!"ms=s-1,rs=s+1 end="\]\]" contained contains=dokuwikiLinkCaption keepend
syn region dokuwikiLinkCaption start="." end="\]\]"me=e-2 contained
" Embedded Images: {{filename|optional caption}}
syn match dokuwikiMediaSeparator "|" contained nextgroup=dokuwikiMediaCaption
syn region dokuwikiMediaCaption start="." end="}}"me=e-2 contained
syn region dokuwikiMediaLink matchgroup=dokuwikiLink start="{{" end="}}" contains=@NoSpell,dokuwikiMediaSeparator extend
syn match dokuwikiInternalMediaLink "{{\(\(}\|]]\)\@!\_.\)*}}\(]]\)\@=" contained contains=@NoSpell,dokuwikiMediaLink
" Control Macros: used for things like ~~NOTOC~~
syn region dokuwikiControlMacros start="\~\~" end="\~\~" contains=@NoSpell
" Code Blocks: <code> or <file> tags. Optionally <(code|file) language filename>
syn region dokuwikiCodeBlockPlain start="^\( \|\t\)\s*[^*-]" end="$"
syn region dokuwikiCodeBlock matchgroup=dokuwikiCodeMark start="<\z(code\|file\)\(\( [[:alpha:]-]\+\( [^>]\+\)\?\)\?>\)\@=" end="</\z1>" contains=@dokuwikiCodeBody,dokuwikiCodeBlock2 keepend extend
syn region dokuwikiCodeBlock2 matchgroup=dokuwikiCodeLang start="\(<\z(code\|file\)\)\@<= [[:alpha:]-]\+\(\( [^>]\+\)\?>\)\@=" end="\(</\z1>\)\@=" contains=@dokuwikiCodeBody,dokuwikiCodeBlock3 keepend extend
syn region dokuwikiCodeBlock3 matchgroup=dokuwikiCodeFile start="\(<\z(code\|file\) [[:alpha:]-]\+\)\@<= [^>]\+>\@=" end="\(</\z1>\)\@=" contains=@dokuwikiCodeBody keepend extend
syn region dokuwikiCodeBlockEnd matchgroup=dokuwikiCodeMark start="\(<\z(code\|file\)\( [[:alpha:]-]\+\( [^>]\+\)\?\)\?\)\@<=>" end="\(</\z1>\)\@=" keepend extend
syn cluster dokuwikiCodeBody contains=dokuwikiCodeBlockEnd
" Imported Syntax: Imported and heavily modified from markdown.vim fenced languages code
if main_syntax ==# 'dokuwiki'
for s:type in g:dokuwiki_fenced_languages
exec 'syn region dokuwikiCodeBlock'.substitute(matchstr(s:type,'[^=]*$'),'\..*','','').' matchgroup=dokuwikiCodeMark start="\(<\z(code\|file\) '.matchstr(s:type,'[^=]*').'\( [^>]\+\)\?\)\@<=>" end="</\z1>" keepend contains=dokuwikiCodeLang,@dokuwikiCode'.substitute(matchstr(s:type,'[^=]*$'),'\.','','g')
exec 'syn cluster dokuwikiCodeBody add=dokuwikiCodeBlock'.substitute(matchstr(s:type,'[^=]*$'),'\..*','','')
endfor
unlet! s:type
endif
" Lists: lines starting with * or -
syn match dokuwikiList "^\( \|\t\)\s*[*-]" contains=@dokuwikiTextItems
" Quotes: leading >, like email
syn match dokuwikiQuotes /^>\+ /
" Footnotes: like ((footnote))
syn region dokuwikiFootnotes start=/((/ end=/))/ contains=ALLBUT,dokuwikiFootnotes,@dokuwikiNoneTextItem extend
" Tables: ^header^header^header^, then |cell|cell|cell|, use ::: to span rows
syn region dokuwikiTable start="^[|\^]" end="$" contains=dokuwikiTableRow transparent keepend
syn region dokuwikiTableRow start="[|\^]" end="\ze[|\^]" transparent contained contains=dokuwikiTableSeparator,dokuwikiTableRowspan,@dokuwikiTextItems keepend
syn match dokuwikiTableSeparator "[|\^]" contained
syn match dokuwikiTableRowspan "[|\^]\s*:::\ze\s*[|\^]" contained transparent contains=dokuwikiRowspan,dokuwikiTableSeparator
syn match dokuwikiRowspan ":::" contained
" Embedded html/php
syn region dokuwikiEmbedded start="<html>" end="</html>"
syn region dokuwikiEmbedded start="<HTML>" end="</HTML>"
syn region dokuwikiEmbedded start="<php>" end="</php>"
syn region dokuwikiEmbedded start="<PHP>" end="</PHP>"
" Comment: requires http://www.dokuwiki.org/plugin:comment
if exists("dokuwiki_comment")
syn region dokuwikiComment start="/\*" end="\*/"
endif
" Horizontal Line: ----
syn match dokuwikiHorizontalLine "^\s\?----\+\s*$"
""" }}}
""" Clusters {{{
" @dokuwikiTextItems are those that work well in-line
syn cluster dokuwikiTextItems contains=dokuwikiBold,dokuwikiItalic,dokuwikiUnderlined,dokuwikiMonospaced,dokuwikiStrikethrough
syn cluster dokuwikiTextItems add=dokuwikiSubscript,dokuwikiSuperscript,dokuwikiSmiley,dokuwikiEntities
syn cluster dokuwikiTextItems add=dokuwikiExternalLink,dokuwikiInternalLink,dokuwikiMediaLink
syn cluster dokuwikiTextItems add=dokuwikiFootnotes,dokuwikiLinebreak,dokuwikiNowiki,dokuwikiCodeBlock
" @dokuwikiBlockItems only work all by themselves
syn cluster dokuwikiBlockItems add=@dokuwikiTextItems,dokuwikiCodeBlockPlain,dokuwikiHorizontalLine,dokuwikiQuotes,dokuwikiTable,dokuwikiEmbedded,dokuwikiControlMacros
" @dokuwikiNoneTextItem exists only for brevity
syn cluster dokuwikiNoneTextItem contains=ALLBUT,@dokuwikiTextItems
""" }}}
""" Highlighting {{{
hi link dokuwikiLinebreak Keyword
hi link dokuwikiNowiki Exception
hi def dokuwikiHeading1mg term=bold cterm=bold ctermfg=2 gui=bold guifg=#ff00ff
hi def dokuwikiHeading2mg term=bold cterm=bold ctermfg=5 gui=bold guifg=#cc33ff
hi def dokuwikiHeading3mg term=bold cterm=bold ctermfg=4 gui=bold guifg=#9966ff
hi def dokuwikiHeading4mg term=bold cterm=bold ctermfg=1 gui=bold guifg=#6699ff
hi def dokuwikiHeading5mg term=bold cterm=bold ctermfg=6 gui=bold guifg=#33ccff
hi def dokuwikiBold term=bold cterm=bold gui=bold
hi def dokuwikiItalic term=italic cterm=italic gui=italic
hi def dokuwikiUnderlined term=underline cterm=underline gui=underline
hi link dokuwikiMonospaced Type
hi link dokuwikiStrikethrough DiffDelete
hi link dokuwikiSubscript Special
hi link dokuwikiSuperscript Special
hi link dokuwikiExternalLink Underlined
hi link dokuwikiInternalLink Underlined
hi link dokuwikiLinkCaption Label
hi link dokuwikiLink Comment
hi link dokuwikiMediaSeparator Comment
hi link dokuwikiMediaCaption Label
hi link dokuwikiMediaLink Include
hi link dokuwikiSmiley Todo
hi link dokuwikiEntities Keyword
hi link dokuwikiList Identifier
hi link dokuwikiControlMacros Constant
hi link dokuwikiCodeBlockPlain String
hi link dokuwikiCodeBlock String
hi link dokuwikiCodeBlockEnd String
hi link dokuwikiCodeMark Comment
hi link dokuwikiCodeLang Tag
hi link dokuwikiCodeFile Include
hi link dokuwikiQuotes Visual
hi link dokuwikiFootnotes Comment
hi link dokuwikiTableSeparator Label
hi link dokuwikiRowspan NonText
hi link dokuwikiEmbedded String
hi link dokuwikiComment Comment
hi link dokuwikiHorizontalLine NonText
""" }}}
" other half of initial checks
let b:current_syntax = "dokuwiki"
if main_syntax ==# 'dokuwiki'
unlet main_syntax
endif