/www/tags/NOV_07_2009/htdocs/42docs/users-guide/mode-rule-eol-span.html
HTML | 25 lines | 25 code | 0 blank | 0 comment | 0 complexity | a1af195039e84c314b0fb9ff4739abf6 MD5 | raw file
1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>The EOL_SPAN Tag</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="jEdit 4.2 User's Guide"><link rel="up" href="writing-modes.html" title="Chapter 10. Mode Definition Syntax"><link rel="previous" href="mode-rule-span-regexp.html" title="The SPAN_REGEXP Tag"><link rel="next" href="mode-rule-eol-span-regexp.html" title="The EOL_SPAN_REGEXP Tag"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">The EOL_SPAN Tag</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="mode-rule-span-regexp.html">Prev</a> </td><th width="60%" align="center">Chapter 10. Mode Definition Syntax</th><td width="20%" align="right"> <a accesskey="n" href="mode-rule-eol-span-regexp.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="mode-rule-eol-span"></a>The EOL_SPAN Tag</h2></div></div><div></div></div><p> 2 An <tt class="literal">EOL_SPAN</tt> is similar to a <tt class="literal">SPAN</tt> 3 except that highlighting stops at the end of the line, and no end sequence 4 needs to be specified. The text to match is specified between the opening and 5 closing <tt class="literal">EOL_SPAN</tt> tags. 6 The following attributes are supported: 7 </p><div class="itemizedlist"><ul type="disc"><li><p><tt class="literal">TYPE</tt> - The token type to highlight the 8 span with. See <a href="mode-syntax-tokens.html" title="Token Types">the section called “Token Types”</a> for a list of token 9 types.</p></li><li><p><tt class="literal">AT_LINE_START</tt> - If set to 10 <tt class="literal">TRUE</tt>, the span will only be highlighted if the start 11 sequence occurs at the beginning of a line.</p></li><li><p><tt class="literal">AT_WHITESPACE_END</tt> - If set to 12 <tt class="literal">TRUE</tt>, the span will only be highlighted if the 13 sequence is the first non-whitespace text in the line.</p></li><li><p><tt class="literal">AT_WORD_START</tt> - If set to 14 <tt class="literal">TRUE</tt>, the span will only be highlighted if the start 15 sequence occurs at the beginning of a word.</p></li><li><p><tt class="literal">DELEGATE</tt> - text inside the span will be 16 highlighted with the specified ruleset. To delegate to a ruleset defined 17 in the current mode, just specify its name. To delegate to a ruleset 18 defined in another mode, specify a name of the form 19 <tt class="literal"><i class="replaceable"><tt>mode</tt></i>::<i class="replaceable"><tt>ruleset</tt></i></tt>. 20 Note that the first (unnamed) ruleset in a mode is called 21 “<span class="quote">MAIN</span>”.</p></li><li><p><tt class="literal">EXCLUDE_MATCH</tt> - If set to 22 <tt class="literal">TRUE</tt>, the start and end sequences will not be highlighted, 23 only the text between them will.</p></li></ul></div><p> 24 Here is an <tt class="literal">EOL_SPAN</tt> that highlights C++ comments: 25 </p><table border="0" bgcolor="#E0E0E0"><tr><td><pre class="programlisting"><EOL_SPAN TYPE="COMMENT1">//</EOL_SPAN></pre></td></tr></table></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="mode-rule-span-regexp.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="writing-modes.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="mode-rule-eol-span-regexp.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">The SPAN_REGEXP Tag </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> The EOL_SPAN_REGEXP Tag</td></tr></table></div></body></html>