/extras/txt2tags.vim

http://txt2tags.googlecode.com/ · Vim Script · 262 lines · 135 code · 23 blank · 104 comment · 2 complexity · 323df74833c82faf71b0193d09eefe52 MD5 · raw file 

    

  1. " Vim syntax file
    2. 

  2. " Filename: txt2tags.vim
    3. 

  3. " Language: marked text for conversion by txt2tags
    4. 

  4. " Maintainer: Aurelio Jargas
    5. 

  5. " Last change: 2010-10-22 - Added new targets for v2.6
    6. 

  6. "
    7. 

  7. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    8. 

  8. " INFO:
    9. 

  9. "
    10. 

  10. " - This is the txt2tags VIM syntax file.
    11. 

  11. " - It's a syntax file just like those for programming languages as C
    12. 

  12. "   or Python, so you know it's handy.
    13. 

  13. " - Here are registered all the structures for txt2tags marks.
    14. 

  14. " - When composing your text file, the marks will be highlighted,
    15. 

  15. "   helping you to quickly make error-free txt2tags files.
    16. 

  16. "
    17. 

  17. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    18. 

  18. " FOLD:
    19. 

  19. "
    20. 

  20. " - There are some folding rules on the syntax also
    21. 

  21. " - To use fold just uncomment the line of foldmethod below
    22. 

  22. " - Or set the fold use directly on the t2t file, adding this last line:
    23. 

  23. "
    24. 

  24. "     % vim: foldmethod=syntax
    25. 

  25. "
    26. 

  26. " - There are two kinds of fold:
    27. 

  27. "
    28. 

  28. "   Automatic fold:
    29. 

  29. "     - The fold starts at any top level title
    30. 

  30. "     - The fold ends with 3 consecutive blank lines
    31. 

  31. "
    32. 

  32. "   User defined fold:
    33. 

  33. "     - The fold starts by the "% label {{{" comment
    34. 

  34. "     - The fold ends with the "% }}}" comment
    35. 

  35. "
    36. 

  36. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    37. 

  37. " INSTALL: (as user)
    38. 

  38. "
    39. 

  39. " - Copy this file to the ~/.vim/syntax/ dir (create it if necessary)
    40. 

  40. "
    41. 

  41. " - Put in your .vimrc the following line:
    42. 

  42. "   au BufNewFile,BufRead *.t2t set ft=txt2tags
    43. 

  43. "
    44. 

  44. " If you use other extension for txt2tags files, change the '*.t2t'
    45. 

  45. "
    46. 

  46. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    47. 

  47. " INSTALL: (as superuser)
    48. 

  48. "
    49. 

  49. " If you have access to the system configuration, edit the
    50. 

  50. " /usr/share/vim/vim*/filetype.vim file, adding the following
    51. 

  51. " lines after the 'Z-Shell script' entry (near the end):
    52. 

  52. "
    53. 

  53. "   " txt2tags file
    54. 

  54. "   au BufNewFile,BufRead *.t2t                 setf txt2tags
    55. 

  55. "
    56. 

  56. " And copy this file (txt2tags.vim) to the Vim syntax dir:
    57. 

  57. "
    58. 

  58. "   /usr/share/vim/vim*/syntax/
    59. 

  59. "
    60. 

  60. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    61. 

  61. 

  62. 

  63. "FOLD: just uncomment the following line if you like to use Vim fold
    64. 

  64. "set foldmethod=syntax
    65. 

    66. 

  66. 

  67. " init
    68. 

  68. syn clear
    69. 

  69. syn sync minlines=500
    70. 

  70. syn case ignore
    71. 

  71. 

  72. "TODO see if user already has foldmethod defined, if so, set foldmethod=syntax
    73. 

  73. "TODO2 learn vim language :/
    74. 

    75. 

  75. syn cluster t2tComponents  contains=t2tNumber,t2tPercent,t2tMacro,t2tImg,t2tEmail,t2tUrl,t2tUrlMark,t2tUrlMarkImg,t2tUrlLocal
    76. 

  76. syn cluster t2tBeautifiers contains=t2tStrike,t2tUnderline,t2tItalic,t2tBold,t2tMonospace,t2tRaw
    77. 

  77. 

  78. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    79. 

  79. "LIST:
    80. 

  80. syn match t2tList    '^ *[-+:]\s*$'
    81. 

  81. syn match t2tList    '^ *: '
    82. 

  82. syn match t2tList    '^ *[+-] [^ ]'me=e-1
    83. 

  83. 

  84. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    85. 

  85. "TITLE:
    86. 

  86. syn match t2tTitleRef  contained '\[[a-z0-9_-]*\]\s*$'
    87. 

  87. syn match t2tTitleMark contained '^ *=\+'
    88. 

  88. syn match t2tTitleMark contained '=\+\s*$'
    89. 

  89. syn match t2tTitleMark contained '=\+\['me=e-1,he=e-1
    90. 

  90. syn match t2tTitle '^ *\(=\{1,5}\)[^=]\(\|.*[^=]\)\1\(\[[a-z0-9_-]*\]\)\=\s*$' contains=t2tTitleMark,t2tTitleRef
    91. 

  91. 

  92. syn match t2tNumTitleMark contained '^ *+\+'
    93. 

  93. syn match t2tNumTitleMark contained '+\+\s*$'
    94. 

  94. syn match t2tNumTitleMark contained '+\+\['me=e-1,he=e-1
    95. 

  95. syn match t2tNumTitle '^ *\(+\{1,5}\)[^+]\(\|.*[^+]\)\1\(\[[a-z0-9_-]*\]\)\=\s*$' contains=t2tNumTitleMark,t2tTitleRef
    96. 

  96. 

  97. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    98. 

  98. "URL EMAIL:
    99. 

  99. "syn case match
    100. 

  100. syn match t2tEmail '\<[A-Za-z0-9_.-]\+@\([A-Za-z0-9_-]\+\.\)\+[A-Za-z]\{2,4}\>\(?[A-Za-z0-9%&=+.,@*_-]\+\)\='
    101. 

  101. syn match t2tUrl   '\<\(\(https\=\|ftp\|news\|telnet\|gopher\|wais\)://\([A-Za-z0-9._-]\+\(:[^ @]*\)\=@\)\=\|\(www[23]\=\.\|ftp\.\)\)[A-Za-z0-9%._/~:,=$@&-]\+\>/*\(?[A-Za-z0-9/%&=+;.,@*_-]\+\)\=\(#[A-Za-z0-9%._-]\+\)\='
    102. 

  102. syn match t2tUrlLocal contained ' \([A-Za-z0-9%._/~,-]\+\|[A-Za-z0-9%._/~,-]*#[A-Za-z0-9%._-]\+\)\]'ms=s+1,me=e-1
    103. 

  103. syn match t2tUrlMark '\[[^]]\+ [^] ]\+\]' contains=t2tUrlLabel,t2tUrl,t2tEmail,t2tUrlLocal
    104. 

  104. syn match t2tUrlMarkImg '\[\[[[:alnum:]_,.+%$#@!?+~/-]\+\.\(png\|jpe\=g\|gif\|eps\|bmp\)\( \+"[^"]*"\)\{0,1\}\] [^] ]\+\]' contains=t2tUrl,t2tEmail,t2tUrlLocal,t2tImg
    105. 

  105. syn match t2tUrlLabel contained '\[[^]]\+ 'ms=s+1,me=e-1
    106. 

  106. 

  107. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    108. 

  108. "FONT BEAUTIFIERS:
    109. 

  109. syn match   t2tBold       '\*\*\S\(\|.\{-}\S\)\*\*\+'hs=s+2,he=e-2
    110. 

  110. syn match   t2tItalic       '//\S\(\|.\{-}\S\)//\+'hs=s+2,he=e-2
    111. 

  111. syn match   t2tUnderline    '__\S\(\|.\{-}\S\)__\+'hs=s+2,he=e-2
    112. 

  112. syn match   t2tStrike       '--\S\(\|.\{-}\S\)--\+'hs=s+2,he=e-2
    113. 

  113. syn match   t2tMonospace    '``\S\(\|.\{-}\S\)``\+'hs=s+2,he=e-2
    114. 

  114. syn match   t2tRaw          '""\S\(\|.\{-}\S\)""\+'hs=s+2,he=e-2
    115. 

  115. syn match   t2tTagged       "''\S\(\|.\{-}\S\)''\+"hs=s+2,he=e-2
    116. 

  116. syn match   t2tVerb1Line     '^``` .*$'hs=s+3
    117. 

  117. syn match   t2tRaw1Line      '^""" .*$'hs=s+3
    118. 

  118. syn match   t2tTagged1Line   "^''' .*$"hs=s+3
    119. 

  119. syn region  t2tVerbArea     start='^```\s*$'hs=s+3 end='^```\s*$'he=e-3
    120. 

  120. syn region  t2tRawArea      start='^"""\s*$'hs=s+3 end='^"""\s*$'he=e-3
    121. 

  121. syn region  t2tTaggedArea   start="^'''\s*$"hs=s+3 end="^'''\s*$"he=e-3
    122. 

  122. syn match   t2tComment '^%.*$' contains=t2tTodo,t2tFoldMark,t2tIncluded
    123. 

  123. syn region  t2tCommentArea  start="^%%%\s*$" end="^%%%\s*$"
    124. 

  124. 

  125. "Experimental
    126. 

  126. syn region  t2tTableArea  start="^|||\s*$" end="^|||\s*$" contains=t2tTableTab,t2tComment
    127. 

  127. syn match   t2tTableTab '\t' contained
    128. 

  128. "hi t2tTableTab    term=reverse     cterm=reverse     gui=reverse
    129. 

  129. "hi link t2tTableArea  Statement
    130. 

  130. set list listchars=tab:??
    131. 

  131. 

  132. 

  133. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    134. 

  134. "TABLE:
    135. 

  135. syn match   t2tTableAlign contained ' \+$'
    136. 

  136. syn match   t2tTableMark  contained '^ *[^ ]\+'
    137. 

  137. syn match   t2tTableBar   contained ' |\+ '     contains=t2tBlank
    138. 

  138. syn match   t2tTableBar   contained '|\+\s*$'   contains=t2tBlank
    139. 

  139. syn match   t2tTableTit   contained '^ *||.*' contains=t2tTableMark,t2tTableBar,t2tTableAlign
    140. 

  140. syn match   t2tTable             '^ *||\= .*' contains=t2tTableMark,t2tTableBar,t2tTableTit,@t2tBeautifiers,@t2tComponents,t2tTableAlign
    141. 

  141. 

  142. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    143. 

  143. "MISC:
    144. 

  144. syn keyword t2tTodo    TODO FIXME XXX contained
    145. 

  145. syn match   t2tNumber  '\<\d\+\([,.]\d\+\)\{,1}\>'
    146. 

  146. syn match   t2tPercent '\<\d\+\([,.]\d\+\)\{,1}%'
    147. 

  147. syn match   t2tBlank   '\s\+$'
    148. 

  148. syn match   t2tQuote   '^\t\+'
    149. 

  149. syn match   t2tBar     '^\s*[_=-]\{20,}\s*$' contains=t2tQuote
    150. 

  150. syn match   t2tImg     '\[[[:alnum:]_,.+%$#@!?+~/-]\+\.\(png\|jpe\=g\|gif\|eps\|bmp\)\( \+"[^"]*"\)\{0,1\}\]'
    151. 

  151. 

  152. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    153. 

  153. "MACROS AND COMMANDS:
    154. 

  154. "syn match   t2tMacro    '%%[a-z]\+'
    155. 

  155. syn match   t2tMacro    '%%\(date\|mtime\|infile\|outfile\)\>\(([^)]*)\)\='
    156. 

  156. syn match   t2tMacro    '^ *%%toc\s*$'
    157. 

  157. syn match   t2tIncluded '^%INCLUDED([a-z2]\+)'ms=s+1 contained 
    158. 

  158. syn match   t2tIncluded '^%--\{10,} Area Delimiter:'ms=s+1 contained 
    159. 

  159. syn match   t2tCommand  "^%!\s*include\s*\((\(\|txt\|html\|xhtml\|sgml\|lout\|tex\|mgp\|man\|moin\|pm6\|wiki\|gwiki\|doku\))\)\=\s*:\s*\S"me=e-1 contains=t2tTargets
    160. 

  160. 

  161. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    162. 

  162. "FOLD:
    163. 

  163. syn match  t2tFoldMark '\({{{\|}}}\)$'
    164. 

  164. syn region t2tUserFold keepend transparent fold start='^%.\+{{{$' end='^%.*}}}$'
    165. 

  165. syn region t2tTitleFold    transparent fold start='^ *=[^=].*[^=]=\(\[[a-z0-9_-]*\]\)\=\s*$' end='\n\n\n\n'
    166. 

  166. syn region t2tNumtitleFold transparent fold start='^ *+[^+].*[^+]+\(\[[a-z0-9_-]*\]\)\=\s*$' end='\n\n\n\n'
    167. 

  167. "heavy-folding-users: uncomment the following to fold *every* subtitle area
    168. 

  168. "syn region t2tTitleFoldDeep transparent fold start='^ *\(=\{2,5}\)[^=].*[^=]\1$' end='\n\n\n\n'
    169. 

  169. "syn region t2tNumtitleFoldDeep transparent fold start='^ *\(+\{2,5}\)[^+].*[^+]\1$' end='\n\n\n\n'
    170. 

    171. 

  171. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    172. 

  172. "HEADERS AND CONFIG:
    173. 

  173. "Headers are the first 3 lines
    174. 

  174. "Config are special comments right after the headers
    175. 

  175. "Config Area ends on a no-comment and no-blank line
    176. 

  176. syn keyword t2tTargets    contained txt xhtml html sgml tex lout mgp man
    177. 

  177. syn keyword t2tTargets    contained moin pm6 wiki gwiki doku dbk creole
    178. 

  178. syn keyword t2tTargets    contained pmw adoc art
    179. 

  179. syn match t2tConfigString contained +"[^"]*"\|'[^']*'+
    180. 

  180. syn match t2tConfigValue  contained ':.*'ms=s+1 contains=t2tConfigString
    181. 

  181. syn match t2tConfigKey    contained '^%![^:]\+:' contains=t2tTargets
    182. 

  182. syn match t2tConfigLine   contained "^%!\s*\(encoding\|style\|preproc\|postproc\|includeconf\|options\)\s*\((\s*\(\|txt\|html\|xhtml\|sgml\|tex\|lout\|mgp\|man\|moin\|pm6\|wiki\|gwiki\|doku\|dbk\|creole\|pmw\|adoc\|art\)\s*)\)\=\s*:\s*\S.*" contains=t2tConfigKey,t2tConfigValue,t2tConfigString
    183. 

  183. syn match t2tConfigLine   contained "^%!\s*target\s*:\s*\S.*" contains=t2tConfigKey,t2tTargets
    184. 

  184. syn match t2tConfigLine   contained "^%!\s*guicolors\s*:\s*\(\S\+\s\+\)\{3}\S\+\s*$" contains=t2tConfigKey,t2tTargets
    185. 

  185. 

  186. syn match  t2tHeaderArea  contained '\%^.*\n.*\n.*$' contains=t2tMacro
    187. 

  187. syn region t2tConfigArea         contained start='\%4l' end='^\%>3l[^%]'me=e-1 end='^\%>3l%!include[^c]'me=e-10 end='%%\(date\|mtim\|infi\|outf\)'me=e-6 contains=t2tComment,t2tConfigLine,t2tConfig1
    188. 

  188. syn region t2tConfigAreaNoHeader contained start='\%2l' end='^\%>1l[^%]'me=e-1 end='^\%>1l%!include[^c]'me=e-10 end='%%\(date\|mtim\|infi\|outf\)'me=e-6 contains=t2tComment,t2tConfigLine,t2tConfig1
    189. 

  189. 

  190. 

  191. syn region t2tTopArea       start='\%^\s*\S' end='^[^%]'me=e-1 end='^%!include[^c]'me=e-10 end='%%\(date\|mtim\|infi\|outf\)'me=e-6 contains=t2tHeaderArea,t2tConfigArea
    192. 

  192. syn region t2tTopAreaNoHead start='\%^\s*$'  end='^[^%]'me=e-1 end='^%!include[^c]'me=e-10 end='%%\(date\|mtim\|infi\|outf\)'me=e-6 contains=t2tConfigAreaNoHeader
    193. 

  193. 

  194. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    195. 

  195. "
    196. 

  196. " color groups
    197. 

  197. hi default link t2t_Link       PreProc
    198. 

  198. hi default link t2t_Component  Statement
    199. 

  199. hi default link t2t_Delim      Identifier
    200. 

  200. hi default link t2t_Verb       Type
    201. 

  201. hi default link t2t_Raw        String
    202. 

  202. hi default link t2t_Tagged     Special
    203. 

  203. "
    204. 

  204. " color definitions (specific)
    205. 

  205. hi default t2tBar         term=bold        cterm=bold        gui=bold
    206. 

  206. hi default t2tBold        term=bold        cterm=bold        gui=bold
    207. 

  207. hi default t2tItalic      term=italic      cterm=italic      gui=italic
    208. 

  208. hi default t2tStrike      term=italic      cterm=italic      gui=italic
    209. 

  209. hi default t2tUnderline   term=underline   cterm=underline   gui=underline
    210. 

  210. hi default t2tQuote       term=reverse     cterm=reverse     gui=reverse
    211. 

  211. hi default t2tTableAlign  term=reverse     cterm=reverse     gui=reverse
    212. 

  212. if &background == "light"
    213. 

  213.     hi default t2tComment     ctermfg=brown    guifg=brown
    214. 

  214. else
    215. 

  215.     hi default t2tComment     ctermfg=brown    guifg=bisque
    216. 

  216. endif
    217. 

  217. hi default link t2tCommentArea t2tComment 
    218. 

  218. "
    219. 

  219. " color definitions (using Vim defaults)
    220. 

  220. hi default link t2tTitle         Error
    221. 

  221. hi default link t2tNumTitle      Error
    222. 

  222. " comment the following line to avoid having trailing whitespaces in red
    223. 

  223. hi default link t2tBlank         Error
    224. 

  224. hi default link t2tNumber        Number
    225. 

  225. hi default link t2tPercent       Number
    226. 

  226. hi default link t2tFoldMark      Special
    227. 

  227. hi default link t2tTodo          Todo
    228. 

  228. hi default link t2tCommand       Special
    229. 

  229. hi default      t2tIncluded      cterm=bold
    230. 

  230. hi default link t2tTargets       Type
    231. 

  231. hi default link t2tConfigKey     Special
    232. 

  232. hi default link t2tConfigValue   NONE
    233. 

  233. hi default link t2tConfigString  String
    234. 

  234. hi default link t2tHeaderArea    t2t_Raw
    235. 

  235. hi default link t2tUrlMark       t2t_Delim
    236. 

  236. hi default link t2tUrlMarkImg    t2t_Delim
    237. 

  237. hi default link t2tUrlLabel      t2t_Delim
    238. 

  238. hi default link t2tTableTit      t2t_Delim
    239. 

  239. hi default link t2tTableMark     t2t_Delim
    240. 

  240. hi default link t2tTableBar      t2t_Delim
    241. 

  241. hi default link t2tEmail         t2t_Link
    242. 

  242. hi default link t2tUrl           t2t_Link
    243. 

  243. hi default link t2tUrlLocal      t2t_Link
    244. 

  244. hi default link t2tTitleRef      t2t_Link
    245. 

  245. hi default link t2tMacro         t2t_Component
    246. 

  246. hi default link t2tImg           t2t_Component
    247. 

  247. hi default link t2tList          t2t_Component
    248. 

  248. hi default link t2tMacro         t2t_Component
    249. 

  249. hi default link t2tTitleMark     NONE
    250. 

  250. hi default link t2tVerbArea      t2t_Verb
    251. 

  251. hi default link t2tVerb1Line     t2t_Verb
    252. 

  252. hi default link t2tMonospace     t2t_Verb
    253. 

  253. hi default link t2tRaw           t2t_Raw
    254. 

  254. hi default link t2tRaw1Line      t2t_Raw
    255. 

  255. hi default link t2tRawArea       t2t_Raw
    256. 

  256. hi default link t2tTagged        t2t_Tagged
    257. 

  257. hi default link t2tTagged1Line   t2t_Tagged
    258. 

  258. hi default link t2tTaggedArea    t2t_Tagged
    259. 

  259. 

  260. "
    261. 

  261. let b:current_syntax = 'txt2tags'
    262. 

  262. " vim:tw=0:et
    263.