| 
									
										
										
										
											2004-06-13 20:20:40 +00:00
										 |  |  | " Vim syntax file | 
					
						
							|  |  |  | " Language:	Perl POD format | 
					
						
							| 
									
										
										
										
											2004-10-07 21:02:47 +00:00
										 |  |  | " Maintainer:	Scott Bigham <dsb@killerbunnies.org> | 
					
						
							|  |  |  | " Last Change:	2004 Oct 05 | 
					
						
							| 
									
										
										
										
											2004-06-13 20:20:40 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | " To add embedded POD documentation highlighting to your syntax file, add | 
					
						
							|  |  |  | " the commands: | 
					
						
							|  |  |  | " | 
					
						
							|  |  |  | "   syn include @Pod <sfile>:p:h/pod.vim | 
					
						
							|  |  |  | "   syn region myPOD start="^=pod" start="^=head" end="^=cut" keepend contained contains=@Pod | 
					
						
							|  |  |  | " | 
					
						
							|  |  |  | " and add myPod to the contains= list of some existing region, probably a | 
					
						
							|  |  |  | " comment.  The "keepend" flag is needed because "=cut" is matched as a | 
					
						
							|  |  |  | " pattern in its own right. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | " Remove any old syntax stuff hanging around (this is suppressed | 
					
						
							|  |  |  | " automatically by ":syn include" if necessary). | 
					
						
							|  |  |  | " For version 5.x: Clear all syntax items | 
					
						
							|  |  |  | " For version 6.x: Quit when a syntax file was already loaded | 
					
						
							|  |  |  | if version < 600 | 
					
						
							|  |  |  |   syntax clear | 
					
						
							|  |  |  | elseif exists("b:current_syntax") | 
					
						
							|  |  |  |   finish | 
					
						
							|  |  |  | endif | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | " POD commands | 
					
						
							| 
									
										
										
										
											2004-10-07 21:02:47 +00:00
										 |  |  | syn match podCommand	"^=head[1234]"	nextgroup=podCmdText | 
					
						
							| 
									
										
										
										
											2004-06-13 20:20:40 +00:00
										 |  |  | syn match podCommand	"^=item"	nextgroup=podCmdText | 
					
						
							|  |  |  | syn match podCommand	"^=over"	nextgroup=podOverIndent skipwhite | 
					
						
							|  |  |  | syn match podCommand	"^=back" | 
					
						
							|  |  |  | syn match podCommand	"^=cut" | 
					
						
							|  |  |  | syn match podCommand	"^=pod" | 
					
						
							|  |  |  | syn match podCommand	"^=for"		nextgroup=podForKeywd skipwhite | 
					
						
							|  |  |  | syn match podCommand	"^=begin"	nextgroup=podForKeywd skipwhite | 
					
						
							|  |  |  | syn match podCommand	"^=end"		nextgroup=podForKeywd skipwhite | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | " Text of a =head1, =head2 or =item command | 
					
						
							|  |  |  | syn match podCmdText	".*$" contained contains=podFormat | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | " Indent amount of =over command | 
					
						
							|  |  |  | syn match podOverIndent	"\d\+" contained | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | " Formatter identifier keyword for =for, =begin and =end commands | 
					
						
							|  |  |  | syn match podForKeywd	"\S\+" contained | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | " An indented line, to be displayed verbatim | 
					
						
							|  |  |  | syn match podVerbatimLine	"^\s.*$" | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | " Inline textual items handled specially by POD | 
					
						
							|  |  |  | syn match podSpecial	"\(\<\|&\)\I\i*\(::\I\i*\)*([^)]*)" | 
					
						
							|  |  |  | syn match podSpecial	"[$@%]\I\i*\(::\I\i*\)*\>" | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | " Special formatting sequences | 
					
						
							| 
									
										
										
										
											2004-10-07 21:02:47 +00:00
										 |  |  | syn region podFormat	start="[IBSCLFX]<[^<]"me=e-1 end=">" oneline contains=podFormat | 
					
						
							|  |  |  | syn match  podFormat	"Z<>" | 
					
						
							|  |  |  | syn match  podFormat	"E<\(\d\+\|\I\i*\)>" contains=podEscape,podEscape2 | 
					
						
							|  |  |  | syn match  podEscape	"\I\i*>"me=e-1 contained | 
					
						
							|  |  |  | syn match  podEscape2	"\d\+>"me=e-1 contained | 
					
						
							| 
									
										
										
										
											2004-06-13 20:20:40 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | " Define the default highlighting. | 
					
						
							|  |  |  | " For version 5.7 and earlier: only when not done already | 
					
						
							|  |  |  | " For version 5.8 and later: only when an item doesn't have highlighting yet | 
					
						
							|  |  |  | if version >= 508 || !exists("did_pod_syntax_inits") | 
					
						
							|  |  |  |   if version < 508 | 
					
						
							|  |  |  |     let did_pod_syntax_inits = 1 | 
					
						
							|  |  |  |     command -nargs=+ HiLink hi link <args> | 
					
						
							|  |  |  |   else | 
					
						
							|  |  |  |     command -nargs=+ HiLink hi def link <args> | 
					
						
							|  |  |  |   endif | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |   HiLink podCommand		Statement | 
					
						
							|  |  |  |   HiLink podCmdText		String | 
					
						
							|  |  |  |   HiLink podOverIndent		Number | 
					
						
							|  |  |  |   HiLink podForKeywd		Identifier | 
					
						
							|  |  |  |   HiLink podFormat		Identifier | 
					
						
							|  |  |  |   HiLink podVerbatimLine	PreProc | 
					
						
							|  |  |  |   HiLink podSpecial		Identifier | 
					
						
							| 
									
										
										
										
											2004-10-07 21:02:47 +00:00
										 |  |  |   HiLink podEscape		String | 
					
						
							|  |  |  |   HiLink podEscape2		Number | 
					
						
							| 
									
										
										
										
											2004-06-13 20:20:40 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  |   delcommand HiLink | 
					
						
							|  |  |  | endif | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | let b:current_syntax = "pod" | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | " vim: ts=8 |