|
714
|
1 " Vim syntax file
|
|
|
2 " Language: R Help File
|
|
|
3 " Maintainer: Johannes Ranke <jranke@uni-bremen.de>
|
|
2662
|
4 " Last Change: 2010 Nov 22
|
|
|
5 " Version: 0.7.4
|
|
|
6 " SVN: $Id: rhelp.vim 90 2010-11-22 10:58:11Z ranke $
|
|
|
7 " Remarks: - Includes R syntax highlighting in the appropriate
|
|
714
|
8 " sections if an r.vim file is in the same directory or in the
|
|
|
9 " default debian location.
|
|
|
10 " - There is no Latex markup in equations
|
|
2034
|
11 " - Thanks to Will Gray for finding and fixing a bug
|
|
2152
|
12 " - No support for \if, \ifelse and \out as I don't understand
|
|
|
13 " them and have no examples at hand (help welcome).
|
|
|
14 " - No support for \var tag within quoted string (dito)
|
|
714
|
15
|
|
|
16 " Version Clears: {{{1
|
|
|
17 " For version 5.x: Clear all syntax items
|
|
819
|
18 " For version 6.x and 7.x: Quit when a syntax file was already loaded
|
|
714
|
19 if version < 600
|
|
|
20 syntax clear
|
|
|
21 elseif exists("b:current_syntax")
|
|
|
22 finish
|
|
|
23 endif
|
|
|
24
|
|
|
25 syn case match
|
|
|
26
|
|
842
|
27 " R help identifiers {{{
|
|
714
|
28 syn region rhelpIdentifier matchgroup=rhelpSection start="\\name{" end="}"
|
|
|
29 syn region rhelpIdentifier matchgroup=rhelpSection start="\\alias{" end="}"
|
|
|
30 syn region rhelpIdentifier matchgroup=rhelpSection start="\\pkg{" end="}"
|
|
2662
|
31 syn region rhelpIdentifier matchgroup=rhelpSection start="\\method{" end="}" contained
|
|
|
32 syn region rhelpIdentifier matchgroup=rhelpSection start="\\Rdversion{" end="}"
|
|
714
|
33
|
|
|
34 " Highlighting of R code using an existing r.vim syntax file if available {{{1
|
|
827
|
35 syn include @R syntax/r.vim
|
|
842
|
36 syn match rhelpDots "\\dots" containedin=@R
|
|
2662
|
37 syn region rhelpRcode matchgroup=Delimiter start="\\examples{" matchgroup=Delimiter transparent end="}" contains=@R,rhelpSection
|
|
|
38 syn region rhelpRcode matchgroup=Delimiter start="\\usage{" matchgroup=Delimiter transparent end="}" contains=@R,rhelpIdentifier,rhelpS4method
|
|
|
39 syn region rhelpRcode matchgroup=Delimiter start="\\synopsis{" matchgroup=Delimiter transparent end="}" contains=@R
|
|
|
40 syn region rhelpRcode matchgroup=Delimiter start="\\special{" matchgroup=Delimiter transparent end="}" contains=@R contained
|
|
|
41 syn region rhelpRcode matchgroup=Delimiter start="\\code{" matchgroup=Delimiter transparent end="}" contains=@R,rhelpLink contained
|
|
|
42 syn region rhelpS4method matchgroup=Delimiter start="\\S4method{.*}(" matchgroup=Delimiter transparent end=")" contains=@R,rhelpDots contained
|
|
|
43 syn region rhelpSexpr matchgroup=Delimiter start="\\Sexpr{" matchgroup=Delimiter transparent end="}" contains=@R
|
|
714
|
44
|
|
|
45 " Strings {{{1
|
|
|
46 syn region rhelpString start=/"/ end=/"/
|
|
|
47
|
|
819
|
48 " Special characters ( \$ \& \% \# \{ \} \_) {{{1
|
|
714
|
49 syn match rhelpSpecialChar "\\[$&%#{}_]"
|
|
|
50
|
|
|
51 " Special Delimiters {{{1
|
|
|
52 syn match rhelpDelimiter "\\cr"
|
|
|
53 syn match rhelpDelimiter "\\tab "
|
|
|
54
|
|
|
55 " Keywords {{{1
|
|
2662
|
56 syn match rhelpKeyword "\\R" contained
|
|
714
|
57 syn match rhelpKeyword "\\ldots"
|
|
842
|
58 syn match rhelpKeyword "--"
|
|
|
59 syn match rhelpKeyword "---"
|
|
|
60 syn match rhelpKeyword "<"
|
|
|
61 syn match rhelpKeyword ">"
|
|
2152
|
62 syn match rhelpKeyword "\\ge"
|
|
|
63 syn match rhelpKeyword "\\le"
|
|
|
64 syn match rhelpKeyword "\\alpha"
|
|
|
65 syn match rhelpKeyword "\\beta"
|
|
|
66 syn match rhelpKeyword "\\gamma"
|
|
|
67 syn match rhelpKeyword "\\delta"
|
|
|
68 syn match rhelpKeyword "\\epsilon"
|
|
|
69 syn match rhelpKeyword "\\zeta"
|
|
|
70 syn match rhelpKeyword "\\eta"
|
|
|
71 syn match rhelpKeyword "\\theta"
|
|
|
72 syn match rhelpKeyword "\\iota"
|
|
|
73 syn match rhelpKeyword "\\kappa"
|
|
|
74 syn match rhelpKeyword "\\lambda"
|
|
|
75 syn match rhelpKeyword "\\mu"
|
|
|
76 syn match rhelpKeyword "\\nu"
|
|
|
77 syn match rhelpKeyword "\\xi"
|
|
|
78 syn match rhelpKeyword "\\omicron"
|
|
|
79 syn match rhelpKeyword "\\pi"
|
|
|
80 syn match rhelpKeyword "\\rho"
|
|
|
81 syn match rhelpKeyword "\\sigma"
|
|
|
82 syn match rhelpKeyword "\\tau"
|
|
|
83 syn match rhelpKeyword "\\upsilon"
|
|
|
84 syn match rhelpKeyword "\\phi"
|
|
|
85 syn match rhelpKeyword "\\chi"
|
|
|
86 syn match rhelpKeyword "\\psi"
|
|
|
87 syn match rhelpKeyword "\\omega"
|
|
|
88 syn match rhelpKeyword "\\Alpha"
|
|
|
89 syn match rhelpKeyword "\\Beta"
|
|
|
90 syn match rhelpKeyword "\\Gamma"
|
|
|
91 syn match rhelpKeyword "\\Delta"
|
|
|
92 syn match rhelpKeyword "\\Epsilon"
|
|
|
93 syn match rhelpKeyword "\\Zeta"
|
|
|
94 syn match rhelpKeyword "\\Eta"
|
|
|
95 syn match rhelpKeyword "\\Theta"
|
|
|
96 syn match rhelpKeyword "\\Iota"
|
|
|
97 syn match rhelpKeyword "\\Kappa"
|
|
|
98 syn match rhelpKeyword "\\Lambda"
|
|
|
99 syn match rhelpKeyword "\\Mu"
|
|
|
100 syn match rhelpKeyword "\\Nu"
|
|
|
101 syn match rhelpKeyword "\\Xi"
|
|
|
102 syn match rhelpKeyword "\\Omicron"
|
|
|
103 syn match rhelpKeyword "\\Pi"
|
|
|
104 syn match rhelpKeyword "\\Rho"
|
|
|
105 syn match rhelpKeyword "\\Sigma"
|
|
|
106 syn match rhelpKeyword "\\Tau"
|
|
|
107 syn match rhelpKeyword "\\Upsilon"
|
|
|
108 syn match rhelpKeyword "\\Phi"
|
|
|
109 syn match rhelpKeyword "\\Chi"
|
|
|
110 syn match rhelpKeyword "\\Psi"
|
|
|
111 syn match rhelpKeyword "\\Omega"
|
|
714
|
112
|
|
|
113 " Links {{{1
|
|
|
114 syn region rhelpLink matchgroup=rhelpSection start="\\link{" end="}" contained keepend
|
|
2034
|
115 syn region rhelpLink matchgroup=rhelpSection start="\\link\[.\{-}\]{" end="}" contained keepend
|
|
842
|
116 syn region rhelpLink matchgroup=rhelpSection start="\\linkS4class{" end="}" contained keepend
|
|
714
|
117
|
|
|
118 " Type Styles {{{1
|
|
|
119 syn match rhelpType "\\emph\>"
|
|
|
120 syn match rhelpType "\\strong\>"
|
|
|
121 syn match rhelpType "\\bold\>"
|
|
|
122 syn match rhelpType "\\sQuote\>"
|
|
|
123 syn match rhelpType "\\dQuote\>"
|
|
|
124 syn match rhelpType "\\preformatted\>"
|
|
|
125 syn match rhelpType "\\kbd\>"
|
|
|
126 syn match rhelpType "\\samp\>"
|
|
|
127 syn match rhelpType "\\eqn\>"
|
|
|
128 syn match rhelpType "\\deqn\>"
|
|
|
129 syn match rhelpType "\\file\>"
|
|
|
130 syn match rhelpType "\\email\>"
|
|
|
131 syn match rhelpType "\\url\>"
|
|
2662
|
132 syn match rhelpType "\\href\>"
|
|
714
|
133 syn match rhelpType "\\var\>"
|
|
|
134 syn match rhelpType "\\env\>"
|
|
|
135 syn match rhelpType "\\option\>"
|
|
|
136 syn match rhelpType "\\command\>"
|
|
2662
|
137 syn match rhelpType "\\newcommand\>"
|
|
|
138 syn match rhelpType "\\renewcommand\>"
|
|
714
|
139 syn match rhelpType "\\dfn\>"
|
|
|
140 syn match rhelpType "\\cite\>"
|
|
|
141 syn match rhelpType "\\acronym\>"
|
|
|
142
|
|
|
143 " rhelp sections {{{1
|
|
|
144 syn match rhelpSection "\\encoding\>"
|
|
|
145 syn match rhelpSection "\\title\>"
|
|
2662
|
146 syn match rhelpSection "\\item\>"
|
|
714
|
147 syn match rhelpSection "\\description\>"
|
|
|
148 syn match rhelpSection "\\concept\>"
|
|
|
149 syn match rhelpSection "\\arguments\>"
|
|
|
150 syn match rhelpSection "\\details\>"
|
|
|
151 syn match rhelpSection "\\value\>"
|
|
|
152 syn match rhelpSection "\\references\>"
|
|
|
153 syn match rhelpSection "\\note\>"
|
|
|
154 syn match rhelpSection "\\author\>"
|
|
|
155 syn match rhelpSection "\\seealso\>"
|
|
|
156 syn match rhelpSection "\\keyword\>"
|
|
|
157 syn match rhelpSection "\\docType\>"
|
|
|
158 syn match rhelpSection "\\format\>"
|
|
|
159 syn match rhelpSection "\\source\>"
|
|
2662
|
160 syn match rhelpSection "\\itemize\>"
|
|
|
161 syn match rhelpSection "\\describe\>"
|
|
|
162 syn match rhelpSection "\\enumerate\>"
|
|
|
163 syn match rhelpSection "\\item "
|
|
|
164 syn match rhelpSection "\\item$"
|
|
714
|
165 syn match rhelpSection "\\tabular{[lcr]*}"
|
|
|
166 syn match rhelpSection "\\dontrun\>"
|
|
|
167 syn match rhelpSection "\\dontshow\>"
|
|
|
168 syn match rhelpSection "\\testonly\>"
|
|
1621
|
169 syn match rhelpSection "\\donttest\>"
|
|
714
|
170
|
|
|
171 " Freely named Sections {{{1
|
|
2662
|
172 syn region rhelpFreesec matchgroup=Delimiter start="\\section{" matchgroup=Delimiter transparent end="}"
|
|
|
173 syn region rhelpFreesubsec matchgroup=Delimiter start="\\subsection{" matchgroup=Delimiter transparent end="}"
|
|
714
|
174
|
|
842
|
175 " R help file comments {{{1
|
|
2662
|
176 syn match rhelpComment /%.*$/
|
|
714
|
177
|
|
|
178 " Error {{{1
|
|
|
179 syn region rhelpRegion matchgroup=Delimiter start=/(/ matchgroup=Delimiter end=/)/ transparent contains=ALLBUT,rhelpError,rhelpBraceError,rhelpCurlyError
|
|
|
180 syn region rhelpRegion matchgroup=Delimiter start=/{/ matchgroup=Delimiter end=/}/ transparent contains=ALLBUT,rhelpError,rhelpBraceError,rhelpParenError
|
|
|
181 syn region rhelpRegion matchgroup=Delimiter start=/\[/ matchgroup=Delimiter end=/]/ transparent contains=ALLBUT,rhelpError,rhelpCurlyError,rhelpParenError
|
|
|
182 syn match rhelpError /[)\]}]/
|
|
|
183 syn match rhelpBraceError /[)}]/ contained
|
|
|
184 syn match rhelpCurlyError /[)\]]/ contained
|
|
|
185 syn match rhelpParenError /[\]}]/ contained
|
|
|
186
|
|
|
187 " Define the default highlighting {{{1
|
|
|
188 " For version 5.7 and earlier: only when not done already
|
|
|
189 " For version 5.8 and later: only when an item doesn't have highlighting yet
|
|
|
190 if version >= 508 || !exists("did_rhelp_syntax_inits")
|
|
|
191 if version < 508
|
|
|
192 let did_rhelp_syntax_inits = 1
|
|
|
193 command -nargs=+ HiLink hi link <args>
|
|
|
194 else
|
|
|
195 command -nargs=+ HiLink hi def link <args>
|
|
|
196 endif
|
|
|
197 HiLink rhelpIdentifier Identifier
|
|
|
198 HiLink rhelpString String
|
|
|
199 HiLink rhelpKeyword Keyword
|
|
842
|
200 HiLink rhelpDots Keyword
|
|
714
|
201 HiLink rhelpLink Underlined
|
|
842
|
202 HiLink rhelpType Type
|
|
714
|
203 HiLink rhelpSection PreCondit
|
|
|
204 HiLink rhelpError Error
|
|
|
205 HiLink rhelpBraceError Error
|
|
|
206 HiLink rhelpCurlyError Error
|
|
|
207 HiLink rhelpParenError Error
|
|
|
208 HiLink rhelpDelimiter Delimiter
|
|
|
209 HiLink rhelpComment Comment
|
|
|
210 HiLink rhelpRComment Comment
|
|
|
211 HiLink rhelpSpecialChar SpecialChar
|
|
|
212 delcommand HiLink
|
|
|
213 endif
|
|
|
214
|
|
|
215 let b:current_syntax = "rhelp"
|
|
|
216 " vim: foldmethod=marker:
|
