data/syntax/rdoc.xml

0001 <?xml version="1.0" encoding="UTF-8"?>
0002 <!DOCTYPE language>
0003 <language name="R documentation" version="4" section="Markup" kateversion="5.0"
0004           extensions="*.Rd" author="Aaron Puchert" license="MIT" >
0005 <highlighting>
0006     <list name="PreprocessorOptions">
0007         <item>unix</item>
0008         <item>windows</item>
0009     </list>
0010     <list name="Formats">
0011         <item>example</item>
0012         <item>html</item>
0013         <item>latex</item>
0014         <item>text</item>
0015         <item>TRUE</item>
0016         <item>FALSE</item>
0017     </list>
0018
0019     <list name="TopLevel-ExpectName">
0020         <item>\docType</item>
0021         <item>\encoding</item>
0022         <item>\keyword</item>
0023         <item>\name</item>
0024     </list>
0025     <list name="TopLevel-ExpectLatex">
0026         <item>\author</item>
0027         <item>\concept</item>
0028         <item>\description</item>
0029         <item>\details</item>
0030         <item>\format</item>
0031         <item>\note</item>
0032         <item>\references</item>
0033         <item>\seealso</item>
0034         <item>\source</item>
0035         <item>\title</item>
0036     </list>
0037     <list name="TopLevel-ExpectNameLatex">
0038         <item>\section</item>
0039     </list>
0040     <list name="TopLevel-ExpectMacroLatex">
0041         <item>\newcommand</item>
0042         <item>\renewcommand</item>
0043     </list>
0044     <list name="TopLevel-ExpectR">
0045         <item>\examples</item>
0046         <item>\usage</item>
0047     </list>
0048     <list name="TopLevel-ExpectVerbatim">
0049         <item>\alias</item>
0050         <item>\Rdversion</item>
0051         <item>\synopsis</item>
0052         <item>\RdOpts</item>
0053     </list>
0054     <list name="TopLevel-ExpectItem2List">
0055         <item>\arguments</item>
0056         <item>\value</item>
0057     </list>
0058
0059     <!-- For now we highlight these as macros.
0060     <list name="Latex-Markup">
0061         <item>\cr</item>
0062         <item>\dots</item>
0063         <item>\ldots</item>
0064         <item>\R</item>
0065         <item>\tab</item>
0066     </list>
0067     -->
0068     <list name="Latex-ExpectLatex">
0069         <item>\acronym</item>
0070         <item>\bold</item>
0071         <item>\cite</item>
0072         <item>\command</item>
0073         <item>\dfn</item>
0074         <item>\dQuote</item>
0075         <item>\emph</item>
0076         <item>\file</item>
0077         <item>\linkS4class</item>
0078         <item>\pkg</item>
0079         <item>\sQuote</item>
0080         <item>\strong</item>
0081         <item>\var</item>
0082     </list>
0083     <list name="Latex-ExpectNameLatex">
0084         <item>\enc</item>
0085         <item>\method</item>
0086         <item>\S3method</item>
0087         <item>\S4method</item>
0088     </list>
0089     <list name="Latex-ExpectNameLatex-Section">
0090         <item>\subsection</item>
0091     </list>
0092     <list name="Latex-ExpectMacroLatex">
0093         <item>\newcommand</item>
0094         <item>\renewcommand</item>
0095     </list>
0096     <list name="Latex-ExpectItemList">
0097         <item>\enumerate</item>
0098         <item>\itemize</item>
0099     </list>
0100     <list name="ItemList-Item">
0101         <item>\item</item>
0102     </list>
0103     <list name="Latex-ExpectItem2List">
0104         <item>\describe</item>
0105     </list>
0106     <list name="Latex-ExpectIf">
0107         <item>\if</item>
0108         <item>\ifelse</item>
0109     </list>
0110     <list name="Latex-ExpectRLike">
0111         <item>\code</item>
0112     </list>
0113     <list name="Latex-ExpectVerbatim">
0114         <item>\email</item>
0115         <item>\env</item>
0116         <item>\kbd</item>
0117         <item>\option</item>
0118         <item>\out</item>
0119         <item>\preformatted</item>
0120         <item>\samp</item>
0121         <item>\url</item>
0122         <item>\verb</item>
0123         <item>\deqn</item>
0124         <item>\eqn</item>
0125     </list>
0126     <list name="Latex-ExpectVerbatimLatex">
0127         <item>\tabular</item>
0128         <item>\href</item>
0129         <item>\figure</item>
0130     </list>
0131     <list name="Latex-ExpectOptionName">
0132         <item>\link</item>
0133     </list>
0134     <list name="Latex-ExpectOptionR">
0135         <item>\Sexpr</item>
0136     </list>
0137
0138     <list name="R-ExpectRLike">
0139         <item>\dontrun</item>
0140         <item>\special</item>
0141         <item>\v</item>
0142         <item>\var</item>
0143     </list>
0144     <list name="R-ExpectNameLatex">
0145         <item>\method</item>
0146         <item>\S3method</item>
0147         <item>\S4method</item>
0148     </list>
0149     <list name="R-ExpectOptionName">
0150         <item>\l</item>
0151         <item>\link</item>
0152     </list>
0153     <list name="R-ExpectR">
0154         <item>\dontshow</item>
0155         <item>\donttest</item>
0156         <item>\testonly</item>
0157     </list>
0158
0159     <contexts>
0160         <context name="TopLevel" attribute="NormalText" lineEndContext="#stay">
0161             <IncludeRules context="Common"/>
0162
0163             <keyword String="TopLevel-ExpectName" attribute="Section" context="ExpectName"/>
0164             <keyword String="TopLevel-ExpectLatex" attribute="Section" context="ExpectLatex"/>
0165             <keyword String="TopLevel-ExpectNameLatex" attribute="Section" context="ExpectNameLatex"/>
0166             <keyword String="TopLevel-ExpectMacroLatex" attribute="Markup" context="ExpectMacroLatex"/>
0167             <keyword String="TopLevel-ExpectR" attribute="Section" context="ExpectR"/>
0168             <keyword String="TopLevel-ExpectVerbatim" attribute="Section" context="ExpectVerbatim"/>
0169             <keyword String="TopLevel-ExpectItem2List" attribute="Section" context="ExpectItem2List"/>
0170         </context>
0171
0172         <!-- Common rules: only included in other contexts -->
0173         <context name="Common" attribute="NormalText" lineEndContext="#stay">
0174             <DetectSpaces/>
0175             <DetectChar char="%" attribute="Comment" context="Comment"/>
0176
0177             <Detect2Chars char="\" char1="\" attribute="Escape"/>
0178             <Detect2Chars char="\" char1="%" attribute="Escape"/>
0179             <Detect2Chars char="\" char1="{" attribute="Escape"/>
0180             <Detect2Chars char="\" char1="}" attribute="Escape"/>
0181
0182             <StringDetect String="#ifdef" firstNonSpace="true" attribute="Preprocessor"
0183                             context="PreprocessorCondition" beginRegion="Preprocessor"/>
0184             <StringDetect String="#ifndef" firstNonSpace="true" attribute="Preprocessor"
0185                             context="PreprocessorCondition" beginRegion="Preprocessor"/>
0186             <StringDetect String="#endif" firstNonSpace="true" attribute="Preprocessor"
0187                             context="Comment" endRegion="Preprocessor"/>
0188         </context>
0189
0190         <!-- Contexts where we expect certain arguments -->
0191         <context name="ExpectName" attribute="NormalText" lineEndContext="#stay">
0192             <DetectChar char="{" attribute="Brace" context="#pop!Name" beginRegion="Brace"/>
0193             <RegExpr String="[^{]*" attribute="Error" context="#pop"/>
0194         </context>
0195         <context name="ExpectLatex" attribute="NormalText" lineEndContext="#stay">
0196             <DetectChar char="{" attribute="Brace" context="#pop!Latex" beginRegion="Brace"/>
0197             <RegExpr String="[^{]*" attribute="Error" context="#pop"/>
0198         </context>
0199         <context name="ExpectItemList" attribute="NormalText" lineEndContext="#stay">
0200             <DetectChar char="{" attribute="Brace" context="#pop!ItemList" beginRegion="Brace"/>
0201             <RegExpr String="[^{]*" attribute="Error" context="#pop"/>
0202         </context>
0203         <context name="ExpectItem2List" attribute="NormalText" lineEndContext="#stay">
0204             <DetectChar char="{" attribute="Brace" context="#pop!Item2List" beginRegion="Brace"/>
0205             <RegExpr String="[^{]*" attribute="Error" context="#pop"/>
0206         </context>
0207         <context name="ExpectNameLatex" attribute="NormalText" lineEndContext="#stay">
0208             <DetectChar char="{" attribute="Brace" context="#pop!NameLatex" beginRegion="Brace"/>
0209             <RegExpr String="[^{]*" attribute="Error" context="#pop"/>
0210         </context>
0211         <context name="ExpectMacroLatex" attribute="NormalText" lineEndContext="#stay">
0212             <DetectChar char="{" attribute="Brace" context="#pop!MacroLatex" beginRegion="Brace"/>
0213             <RegExpr String="[^{]*" attribute="Error" context="#pop"/>
0214         </context>
0215         <context name="ExpectLatexLatex" attribute="NormalText" lineEndContext="#stay">
0216             <DetectChar char="{" attribute="Brace" context="#pop!LatexLatex" beginRegion="Brace"/>
0217             <RegExpr String="[^{]*" attribute="Error" context="#pop"/>
0218         </context>
0219         <context name="ExpectR" attribute="NormalText" lineEndContext="#stay">
0220             <DetectChar char="{" attribute="Brace" context="#pop!R" beginRegion="Brace"/>
0221             <RegExpr String="[^{]*" attribute="Error" context="#pop"/>
0222         </context>
0223         <context name="ExpectRLike" attribute="NormalText" lineEndContext="#stay">
0224             <DetectChar char="{" attribute="Brace" context="#pop!RLike" beginRegion="Brace"/>
0225             <RegExpr String="[^{]*" attribute="Error" context="#pop"/>
0226         </context>
0227         <context name="ExpectVerbatim" attribute="NormalText" lineEndContext="#stay">
0228             <DetectChar char="{" attribute="Brace" context="#pop!Verbatim" beginRegion="Brace"/>
0229             <RegExpr String="[^{]*" attribute="Error" context="#pop"/>
0230         </context>
0231         <context name="ExpectVerbatimLatex" attribute="NormalText" lineEndContext="#stay">
0232             <DetectChar char="{" attribute="Brace" context="#pop!VerbatimLatex" beginRegion="Brace"/>
0233             <RegExpr String="[^{]*" attribute="Error" context="#pop"/>
0234         </context>
0235         <context name="ExpectOptionName" attribute="Verbatim" lineEndContext="#stay">
0236             <IncludeRules context="Common"/>
0237             <DetectChar char="{" attribute="Brace" context="#pop!Name" beginRegion="Brace"/>
0238             <DetectChar char="[" attribute="Brace" context="#pop!OptionName" beginRegion="Bracket"/>
0239             <RegExpr String="[^{[]*" attribute="Error" context="#pop"/>
0240         </context>
0241         <context name="ExpectOptionR" attribute="Verbatim" lineEndContext="#stay">
0242             <IncludeRules context="Common"/>
0243             <DetectChar char="{" attribute="Brace" context="#pop!R" beginRegion="Brace"/>
0244             <DetectChar char="[" attribute="Brace" context="#pop!OptionR" beginRegion="Bracket"/>
0245             <RegExpr String="[^{[]*" attribute="Error" context="#pop"/>
0246         </context>
0247         <context name="ExpectIf" attribute="NormalText" lineEndContext="#stay">
0248             <IncludeRules context="Common"/>
0249             <DetectChar char="{" attribute="Brace" context="#pop!If" beginRegion="Brace"/>
0250             <RegExpr String="[^{]*" attribute="Error" context="#pop"/>
0251         </context>
0252
0253         <!-- The actual arguments -->
0254         <context name="Latex" attribute="NormalText" lineEndContext="#stay">
0255             <IncludeRules context="Common"/>
0256             <DetectChar char="{" attribute="Brace" context="Latex" beginRegion="Brace"/>
0257             <DetectChar char="}" attribute="Brace" context="#pop" endRegion="Brace"/>
0258
0259             <keyword String="Latex-ExpectLatex" attribute="Markup" context="ExpectLatex"/>
0260             <keyword String="Latex-ExpectNameLatex" attribute="Markup" context="ExpectNameLatex"/>
0261             <keyword String="Latex-ExpectNameLatex-Section" attribute="Section" context="ExpectNameLatex"/>
0262             <keyword String="Latex-ExpectMacroLatex" attribute="Markup" context="ExpectMacroLatex"/>
0263             <keyword String="Latex-ExpectItemList" attribute="Markup" context="ExpectItemList"/>
0264             <keyword String="Latex-ExpectItem2List" attribute="Markup" context="ExpectItem2List"/>
0265             <keyword String="Latex-ExpectIf" attribute="Markup" context="ExpectIf"/>
0266             <keyword String="Latex-ExpectRLike" attribute="Markup" context="ExpectRLike"/>
0267             <keyword String="Latex-ExpectVerbatim" attribute="Markup" context="ExpectVerbatim"/>
0268             <keyword String="Latex-ExpectVerbatimLatex" attribute="Markup" context="ExpectVerbatimLatex"/>
0269             <keyword String="Latex-ExpectOptionName" attribute="Markup" context="ExpectOptionName"/>
0270             <keyword String="Latex-ExpectOptionR" attribute="Markup" context="ExpectOptionR"/>
0271
0272             <RegExpr String="\\[A-Za-z][A-Za-z0-9]*" attribute="UserDefinedMacro"/>
0273             <RegExpr String="#[1-9]" attribute="UserDefinedMacroArgument"/>
0274         </context>
0275         <context name="ItemList" attribute="NormalText" lineEndContext="#stay">
0276             <IncludeRules context="Common"/>
0277             <DetectChar char="{" attribute="Brace" context="Item2List" beginRegion="Brace"/>
0278             <DetectChar char="}" attribute="Brace" context="#pop" endRegion="Brace"/>
0279             <keyword String="ItemList-Item" attribute="Markup"/>
0280             <IncludeRules context="Latex"/>
0281         </context>
0282         <context name="Item2List" attribute="NormalText" lineEndContext="#stay">
0283             <IncludeRules context="Common"/>
0284             <keyword String="ItemList-Item" attribute="Markup" context="ExpectLatexLatex"/>
0285             <IncludeRules context="Latex"/>
0286         </context>
0287         <context name="Name" attribute="ItemName" lineEndContext="#stay">
0288             <IncludeRules context="Common"/>
0289             <RegExpr String="\\[A-Za-z][A-Za-z0-9]*" attribute="UserDefinedMacro"/>
0290             <RegExpr String="#[1-9]" attribute="UserDefinedMacroArgument"/>
0291             <DetectChar char="{" attribute="Brace" context="Name" beginRegion="Brace"/>
0292             <DetectChar char="}" attribute="Brace" context="#pop" endRegion="Brace"/>
0293         </context>
0294         <context name="NameLatex" attribute="ItemName" lineEndContext="#stay">
0295             <IncludeRules context="Common"/>
0296             <RegExpr String="\\[A-Za-z][A-Za-z0-9]*" attribute="UserDefinedMacro"/>
0297             <RegExpr String="#[1-9]" attribute="UserDefinedMacroArgument"/>
0298             <DetectChar char="{" attribute="Brace" context="Latex" beginRegion="Brace"/>
0299             <DetectChar char="}" attribute="Brace" context="#pop!ExpectLatex" endRegion="Brace"/>
0300         </context>
0301         <context name="MacroLatex" attribute="UserDefinedMacro" lineEndContext="#stay">
0302             <IncludeRules context="Common"/>
0303             <DetectChar char="}" attribute="Brace" context="#pop!ExpectLatex" endRegion="Brace"/>
0304         </context>
0305         <context name="LatexLatex" attribute="ItemName" lineEndContext="#stay">
0306             <IncludeRules context="Common"/>
0307             <DetectChar char="}" attribute="Brace" context="#pop!ExpectLatex" endRegion="Brace"/>
0308             <IncludeRules context="Latex"/>
0309         </context>
0310         <context name="R" attribute="RSource" lineEndContext="#stay">
0311             <IncludeRules context="Common"/>
0312             <DetectChar char="{" attribute="Brace" context="R" beginRegion="Brace"/>
0313             <DetectChar char="}" attribute="Brace" context="#pop" endRegion="Brace"/>
0314             <keyword String="R-ExpectR" attribute="Markup" context="ExpectR"/>
0315             <keyword String="R-ExpectRLike" attribute="Markup" context="ExpectRLike"/>
0316             <keyword String="R-ExpectNameLatex" attribute="Markup" context="ExpectNameLatex"/>
0317             <keyword String="R-ExpectOptionName" attribute="Markup" context="ExpectOptionName"/>
0318             <IncludeRules context="level0##R Script"/>
0319         </context>
0320         <context name="RLike" attribute="Verbatim" lineEndContext="#stay">
0321             <IncludeRules context="Common"/>
0322             <DetectChar char="{" attribute="Brace" context="RLike" beginRegion="Brace"/>
0323             <DetectChar char="}" attribute="Brace" context="#pop" endRegion="Brace"/>
0324             <keyword String="R-ExpectRLike" attribute="Markup" context="ExpectRLike"/>
0325             <keyword String="R-ExpectNameLatex" attribute="Markup" context="ExpectNameLatex"/>
0326             <keyword String="R-ExpectOptionName" attribute="Markup" context="ExpectOptionName"/>
0327         </context>
0328         <context name="Verbatim" attribute="Verbatim" lineEndContext="#stay">
0329             <IncludeRules context="Common"/>
0330             <DetectChar char="{" attribute="Brace" context="Verbatim" beginRegion="Brace"/>
0331             <DetectChar char="}" attribute="Brace" context="#pop" endRegion="Brace"/>
0332         </context>
0333         <context name="VerbatimLatex" attribute="Verbatim" lineEndContext="#stay">
0334             <IncludeRules context="Common"/>
0335             <DetectChar char="{" attribute="Brace" context="Verbatim" beginRegion="Brace"/>
0336             <DetectChar char="}" attribute="Brace" context="#pop!ExpectLatex" endRegion="Brace"/>
0337         </context>
0338         <context name="OptionName" attribute="Verbatim" lineEndContext="#stay">
0339             <IncludeRules context="Common"/>
0340             <DetectChar char="{" attribute="Brace" context="Verbatim" beginRegion="Brace"/>
0341             <DetectChar char="]" attribute="Brace" context="#pop!ExpectName" endRegion="Bracket"/>
0342             <DetectChar char="}" attribute="Error" context="#pop!ExpectName" endRegion="Bracket"/>
0343         </context>
0344         <context name="OptionR" attribute="Verbatim" lineEndContext="#stay">
0345             <IncludeRules context="Common"/>
0346             <DetectChar char="{" attribute="Brace" context="Verbatim" beginRegion="Brace"/>
0347             <DetectChar char="]" attribute="Brace" context="#pop!ExpectR" endRegion="Bracket"/>
0348             <DetectChar char="}" attribute="Error" context="#pop!ExpectR" endRegion="Bracket"/>
0349         </context>
0350         <context name="If" attribute="Verbatim" lineEndContext="#stay">
0351             <IncludeRules context="Common"/>
0352             <keyword String="Formats" attribute="Builtin"/>
0353             <DetectChar char="}" attribute="Brace" context="#pop" endRegion="Brace"/>
0354         </context>
0355
0356         <context name="Comment" attribute="Comment" lineEndContext="#pop">
0357             <DetectSpaces />
0358             <IncludeRules context="##Comments"/>
0359         </context>
0360
0361         <context name="PreprocessorCondition" attribute="Preprocessor" lineEndContext="#pop">
0362             <keyword String="PreprocessorOptions" attribute="Builtin"/>
0363         </context>
0364     </contexts>
0365
0366     <itemDatas>
0367         <itemData name="NormalText" defStyleNum="dsNormal"/>
0368         <itemData name="RSource" defStyleNum="dsNormal" spellChecking="false"/>
0369         <itemData name="Brace" defStyleNum="dsOperator" spellChecking="false"/>
0370         <itemData name="Section" defStyleNum="dsControlFlow" spellChecking="false"/>
0371         <itemData name="Markup" defStyleNum="dsKeyword" spellChecking="false"/>
0372         <itemData name="UserDefinedMacro" defStyleNum="dsFunction" spellChecking="false"/>
0373         <itemData name="UserDefinedMacroArgument" defStyleNum="dsVariable" spellChecking="false"/>
0374         <itemData name="ItemName" defStyleNum="dsSpecialString" spellChecking="false"/>
0375         <itemData name="Escape" defStyleNum="dsSpecialChar" spellChecking="false"/>
0376         <itemData name="Preprocessor" defStyleNum="dsPreprocessor" spellChecking="false"/>
0377         <itemData name="Builtin" defStyleNum="dsBuiltIn" spellChecking="false"/>
0378         <itemData name="Verbatim" defStyleNum="dsVerbatimString" spellChecking="false"/>
0379         <itemData name="Comment" defStyleNum="dsComment"/>
0380         <itemData name="Error" defStyleNum="dsError" spellChecking="false"/>
0381     </itemDatas>
0382 </highlighting>
0383 <general>
0384     <keywords weakDeliminator="\" wordWrapDeliminator=",{}[]"/>
0385     <comments>
0386         <comment name="singleLine" start="%"/>
0387     </comments>
0388 </general>
0389 </language>
0390 <!-- kate: replace-tabs on; tab-width 4; indent-width 4; -->