<?xml version="1.0" encoding="iso-8859-1"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <!-- template designed by Marco Von Ballmoos --> <title></title> <link rel="stylesheet" href="media/stylesheet.css" /> <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> </head> <body> <a name="top"></a><h2>Full index</h2><h3>Package indexes</h3><ul> <li><a href="elementindex_geshi.html">geshi</a></li></ul><br /><div class="index-letter-menu"> <a class="index-letter" href="elementindex.html#a">a</a> <a class="index-letter" href="elementindex.html#d">d</a> <a class="index-letter" href="elementindex.html#e">e</a> <a class="index-letter" href="elementindex.html#g">g</a> <a class="index-letter" href="elementindex.html#h">h</a> <a class="index-letter" href="elementindex.html#l">l</a> <a class="index-letter" href="elementindex.html#o">o</a> <a class="index-letter" href="elementindex.html#p">p</a> <a class="index-letter" href="elementindex.html#r">r</a> <a class="index-letter" href="elementindex.html#s">s</a></div> <a name="a"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">a</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">add_keyword</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodadd_keyword">GeSHi::add_keyword()</a> in geshi.php</div> <div class="index-item-description">Adds a keyword to a keyword group for highlighting</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">add_keyword_group</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodadd_keyword_group">GeSHi::add_keyword_group()</a> in geshi.php</div> <div class="index-item-description">Creates a new keyword group</div> </dd> </dl> <a name="d"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">d</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">disable_highlighting</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methoddisable_highlighting">GeSHi::disable_highlighting()</a> in geshi.php</div> <div class="index-item-description">Disables all highlighting</div> </dd> </dl> <a name="e"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">e</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_classes</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_classes">GeSHi::enable_classes()</a> in geshi.php</div> <div class="index-item-description">Sets whether CSS classes should be used to highlight the source. Default is off, calling this method with no arguments will turn it on</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_highlighting</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_highlighting">GeSHi::enable_highlighting()</a> in geshi.php</div> <div class="index-item-description">Enables all highlighting</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_ids</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_ids">GeSHi::enable_ids()</a> in geshi.php</div> <div class="index-item-description">Whether CSS IDs should be added to each line</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_important_blocks</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_important_blocks">GeSHi::enable_important_blocks()</a> in geshi.php</div> <div class="index-item-description">Sets whether context-important blocks are highlighted</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_inner_code_block</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_inner_code_block">GeSHi::enable_inner_code_block()</a> in geshi.php</div> <div class="index-item-description">Sets whether to force a surrounding block around the highlighted code or not</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_keyword_links</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_keyword_links">GeSHi::enable_keyword_links()</a> in geshi.php</div> <div class="index-item-description">Turns linking of keywords on or off.</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_line_numbers</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_line_numbers">GeSHi::enable_line_numbers()</a> in geshi.php</div> <div class="index-item-description">Sets whether line numbers should be displayed.</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_multiline_span</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_multiline_span">GeSHi::enable_multiline_span()</a> in geshi.php</div> <div class="index-item-description">Sets wether spans and other HTML markup generated by GeSHi can span over multiple lines or not. Defaults to true to reduce overhead.</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_strict_mode</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_strict_mode">GeSHi::enable_strict_mode()</a> in geshi.php</div> <div class="index-item-description">Enables/disables strict highlighting. Default is off, calling this method without parameters will turn it on. See documentation for more details on strict mode and where to use it.</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">error</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methoderror">GeSHi::error()</a> in geshi.php</div> <div class="index-item-description">Returns an error message associated with the last GeSHi operation, or false if no error has occured</div> </dd> </dl> <a name="g"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">g</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Constructor.png" alt="Method" title="Method" /></title> <span class="method-title">GeSHi</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodGeSHi">GeSHi::GeSHi()</a> in geshi.php</div> <div class="index-item-description">Creates a new GeSHi object, with source and language</div> </dd> <dt class="field"> <img src="media/images/Class.png" alt="Class" title="Class" /></title> GeSHi </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html">GeSHi</a> in geshi.php</div> <div class="index-item-description">The GeSHi Class.</div> </dd> <dt class="field"> <img src="media/images/Page.png" alt="Page" title="Page" /></title> <span class="include-title">geshi.php</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html">geshi.php</a> in geshi.php</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_ACTIVE</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_ACTIVE">GESHI_ACTIVE</a> in geshi.php</div> <div class="index-item-description">Links in the source in the :active state</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_CAPS_LOWER</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_CAPS_LOWER">GESHI_CAPS_LOWER</a> in geshi.php</div> <div class="index-item-description">Leave keywords found as the case that they are</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_CAPS_NO_CHANGE</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_CAPS_NO_CHANGE">GESHI_CAPS_NO_CHANGE</a> in geshi.php</div> <div class="index-item-description">Lowercase keywords found</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_CAPS_UPPER</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_CAPS_UPPER">GESHI_CAPS_UPPER</a> in geshi.php</div> <div class="index-item-description">Uppercase keywords found</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_END_IMPORTANT</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_END_IMPORTANT">GESHI_END_IMPORTANT</a> in geshi.php</div> <div class="index-item-description">The ender for important parts of the source</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_FANCY_LINE_NUMBERS</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_FANCY_LINE_NUMBERS">GESHI_FANCY_LINE_NUMBERS</a> in geshi.php</div> <div class="index-item-description">Use fancy line numbers when building the result</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_HEADER_DIV</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HEADER_DIV">GESHI_HEADER_DIV</a> in geshi.php</div> <div class="index-item-description">Use a "div" to surround the source</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_HEADER_NONE</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HEADER_NONE">GESHI_HEADER_NONE</a> in geshi.php</div> <div class="index-item-description">Use nothing to surround the source</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_HEADER_PRE</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HEADER_PRE">GESHI_HEADER_PRE</a> in geshi.php</div> <div class="index-item-description">Use a "pre" to surround the source</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_HEADER_PRE_TABLE</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HEADER_PRE_TABLE">GESHI_HEADER_PRE_TABLE</a> in geshi.php</div> <div class="index-item-description">Use a "table" to surround the source:</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_HEADER_PRE_VALID</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HEADER_PRE_VALID">GESHI_HEADER_PRE_VALID</a> in geshi.php</div> <div class="index-item-description">Use a pre to wrap lines when line numbers are enabled or to wrap the whole code.</div> </dd> <dt class="field"> <img src="media/images/Function.png" alt="Function" title="Function" /></title> <span class="method-title">geshi_highlight</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#functiongeshi_highlight">geshi_highlight()</a> in geshi.php</div> <div class="index-item-description">Easy way to highlight stuff. Behaves just like highlight_string</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_HOVER</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HOVER">GESHI_HOVER</a> in geshi.php</div> <div class="index-item-description">Links in the source in the :hover state</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_LANG_ROOT</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_LANG_ROOT">GESHI_LANG_ROOT</a> in geshi.php</div> <div class="index-item-description">The language file directory for GeSHi</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_LINK</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_LINK">GESHI_LINK</a> in geshi.php</div> <div class="index-item-description">Links in the source in the :link state</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_NORMAL_LINE_NUMBERS</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_NORMAL_LINE_NUMBERS">GESHI_NORMAL_LINE_NUMBERS</a> in geshi.php</div> <div class="index-item-description">Use normal line numbers when building the result</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_NO_LINE_NUMBERS</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_NO_LINE_NUMBERS">GESHI_NO_LINE_NUMBERS</a> in geshi.php</div> <div class="index-item-description">Use no line numbers when building the result</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_ROOT</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_ROOT">GESHI_ROOT</a> in geshi.php</div> <div class="index-item-description">The root directory for GeSHi</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_SECURITY_PARANOID</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_SECURITY_PARANOID">GESHI_SECURITY_PARANOID</a> in geshi.php</div> <div class="index-item-description">Tells GeSHi to be paranoid about security settings</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_START_IMPORTANT</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_START_IMPORTANT">GESHI_START_IMPORTANT</a> in geshi.php</div> <div class="index-item-description">The starter for important parts of the source</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_VERSION</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_VERSION">GESHI_VERSION</a> in geshi.php</div> <div class="index-item-description">The version of this GeSHi file</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_VISITED</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_VISITED">GESHI_VISITED</a> in geshi.php</div> <div class="index-item-description">Links in the source in the :visited state</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">get_language_name</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_language_name">GeSHi::get_language_name()</a> in geshi.php</div> <div class="index-item-description">Gets a human-readable language name (thanks to Simon Patterson for the idea :))</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">get_language_name_from_extension</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_language_name_from_extension">GeSHi::get_language_name_from_extension()</a> in geshi.php</div> <div class="index-item-description">Given a file extension, this method returns either a valid geshi language name, or the empty string if it couldn't be found</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">get_multiline_span</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_multiline_span">GeSHi::get_multiline_span()</a> in geshi.php</div> <div class="index-item-description">Get current setting for multiline spans, see GeSHi->enable_multiline_span().</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">get_real_tab_width</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_real_tab_width">GeSHi::get_real_tab_width()</a> in geshi.php</div> <div class="index-item-description">Returns the tab width to use, based on the current language and user preference</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">get_stylesheet</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_stylesheet">GeSHi::get_stylesheet()</a> in geshi.php</div> <div class="index-item-description">Returns a stylesheet for the highlighted code. If $economy mode is true, we only return the stylesheet declarations that matter for this code block instead of the whole thing</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">get_time</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_time">GeSHi::get_time()</a> in geshi.php</div> <div class="index-item-description">Gets the time taken to parse the code</div> </dd> </dl> <a name="h"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">h</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">highlight_lines_extra</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodhighlight_lines_extra">GeSHi::highlight_lines_extra()</a> in geshi.php</div> <div class="index-item-description">Specifies which lines to highlight extra</div> </dd> </dl> <a name="l"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">l</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">load_from_file</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodload_from_file">GeSHi::load_from_file()</a> in geshi.php</div> <div class="index-item-description">Given a file name, this method loads its contents in, and attempts</div> </dd> </dl> <a name="o"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">o</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">optimize_keyword_group</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodoptimize_keyword_group">GeSHi::optimize_keyword_group()</a> in geshi.php</div> <div class="index-item-description">compile optimized regexp list for keyword group</div> </dd> </dl> <a name="p"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">p</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">parse_code</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodparse_code">GeSHi::parse_code()</a> in geshi.php</div> <div class="index-item-description">Returns the code in $this->source, highlighted and surrounded by the nessecary HTML.</div> </dd> </dl> <a name="r"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">r</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">remove_keyword</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodremove_keyword">GeSHi::remove_keyword()</a> in geshi.php</div> <div class="index-item-description">Removes a keyword from a keyword group</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">remove_keyword_group</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodremove_keyword_group">GeSHi::remove_keyword_group()</a> in geshi.php</div> <div class="index-item-description">Removes a keyword group</div> </dd>Lines 1–500 of 867. Load more
<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <!-- template designed by Marco Von Ballmoos --> <title></title> <link rel="stylesheet" href="media/stylesheet.css" /> <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> </head> <body> <a name="top"></a> <h2>Full index</h2> <h3>Package indexes</h3> <ul> <li><a href="elementindex_geshi.html">geshi</a></li> </ul> <br /> <div class="index-letter-menu"> <a class="index-letter" href="elementindex.html#a">a</a> <a class="index-letter" href="elementindex.html#d">d</a> <a class="index-letter" href="elementindex.html#e">e</a> <a class="index-letter" href="elementindex.html#g">g</a> <a class="index-letter" href="elementindex.html#h">h</a> <a class="index-letter" href="elementindex.html#l">l</a> <a class="index-letter" href="elementindex.html#o">o</a> <a class="index-letter" href="elementindex.html#p">p</a> <a class="index-letter" href="elementindex.html#r">r</a> <a class="index-letter" href="elementindex.html#s">s</a> </div> <a name="a"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">a</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">add_keyword</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodadd_keyword">GeSHi::add_keyword()</a> in geshi.php</div> <div class="index-item-description">Adds a keyword to a keyword group for highlighting</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">add_keyword_group</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodadd_keyword_group">GeSHi::add_keyword_group()</a> in geshi.php</div> <div class="index-item-description">Creates a new keyword group</div> </dd> </dl> <a name="d"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">d</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">disable_highlighting</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methoddisable_highlighting">GeSHi::disable_highlighting()</a> in geshi.php</div> <div class="index-item-description">Disables all highlighting</div> </dd> </dl> <a name="e"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">e</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_classes</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_classes">GeSHi::enable_classes()</a> in geshi.php</div> <div class="index-item-description">Sets whether CSS classes should be used to highlight the source. Default is off, calling this method with no arguments will turn it on</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_highlighting</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_highlighting">GeSHi::enable_highlighting()</a> in geshi.php</div> <div class="index-item-description">Enables all highlighting</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_ids</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_ids">GeSHi::enable_ids()</a> in geshi.php</div> <div class="index-item-description">Whether CSS IDs should be added to each line</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_important_blocks</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_important_blocks">GeSHi::enable_important_blocks()</a> in geshi.php</div> <div class="index-item-description">Sets whether context-important blocks are highlighted</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_inner_code_block</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_inner_code_block">GeSHi::enable_inner_code_block()</a> in geshi.php</div> <div class="index-item-description">Sets whether to force a surrounding block around the highlighted code or not</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_keyword_links</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_keyword_links">GeSHi::enable_keyword_links()</a> in geshi.php</div> <div class="index-item-description">Turns linking of keywords on or off.</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_line_numbers</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_line_numbers">GeSHi::enable_line_numbers()</a> in geshi.php</div> <div class="index-item-description">Sets whether line numbers should be displayed.</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_multiline_span</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_multiline_span">GeSHi::enable_multiline_span()</a> in geshi.php</div> <div class="index-item-description">Sets wether spans and other HTML markup generated by GeSHi can span over multiple lines or not. Defaults to true to reduce overhead.</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">enable_strict_mode</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodenable_strict_mode">GeSHi::enable_strict_mode()</a> in geshi.php</div> <div class="index-item-description">Enables/disables strict highlighting. Default is off, calling this method without parameters will turn it on. See documentation for more details on strict mode and where to use it.</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">error</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methoderror">GeSHi::error()</a> in geshi.php</div> <div class="index-item-description">Returns an error message associated with the last GeSHi operation, or false if no error has occured</div> </dd> </dl> <a name="g"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">g</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Constructor.png" alt="Method" title="Method" /></title> <span class="method-title">GeSHi</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodGeSHi">GeSHi::GeSHi()</a> in geshi.php</div> <div class="index-item-description">Creates a new GeSHi object, with source and language</div> </dd> <dt class="field"> <img src="media/images/Class.png" alt="Class" title="Class" /></title> GeSHi </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html">GeSHi</a> in geshi.php</div> <div class="index-item-description">The GeSHi Class.</div> </dd> <dt class="field"> <img src="media/images/Page.png" alt="Page" title="Page" /></title> <span class="include-title">geshi.php</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html">geshi.php</a> in geshi.php</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_ACTIVE</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_ACTIVE">GESHI_ACTIVE</a> in geshi.php</div> <div class="index-item-description">Links in the source in the :active state</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_CAPS_LOWER</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_CAPS_LOWER">GESHI_CAPS_LOWER</a> in geshi.php</div> <div class="index-item-description">Leave keywords found as the case that they are</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_CAPS_NO_CHANGE</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_CAPS_NO_CHANGE">GESHI_CAPS_NO_CHANGE</a> in geshi.php</div> <div class="index-item-description">Lowercase keywords found</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_CAPS_UPPER</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_CAPS_UPPER">GESHI_CAPS_UPPER</a> in geshi.php</div> <div class="index-item-description">Uppercase keywords found</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_END_IMPORTANT</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_END_IMPORTANT">GESHI_END_IMPORTANT</a> in geshi.php</div> <div class="index-item-description">The ender for important parts of the source</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_FANCY_LINE_NUMBERS</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_FANCY_LINE_NUMBERS">GESHI_FANCY_LINE_NUMBERS</a> in geshi.php</div> <div class="index-item-description">Use fancy line numbers when building the result</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_HEADER_DIV</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HEADER_DIV">GESHI_HEADER_DIV</a> in geshi.php</div> <div class="index-item-description">Use a "div" to surround the source</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_HEADER_NONE</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HEADER_NONE">GESHI_HEADER_NONE</a> in geshi.php</div> <div class="index-item-description">Use nothing to surround the source</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_HEADER_PRE</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HEADER_PRE">GESHI_HEADER_PRE</a> in geshi.php</div> <div class="index-item-description">Use a "pre" to surround the source</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_HEADER_PRE_TABLE</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HEADER_PRE_TABLE">GESHI_HEADER_PRE_TABLE</a> in geshi.php</div> <div class="index-item-description">Use a "table" to surround the source:</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_HEADER_PRE_VALID</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HEADER_PRE_VALID">GESHI_HEADER_PRE_VALID</a> in geshi.php</div> <div class="index-item-description">Use a pre to wrap lines when line numbers are enabled or to wrap the whole code.</div> </dd> <dt class="field"> <img src="media/images/Function.png" alt="Function" title="Function" /></title> <span class="method-title">geshi_highlight</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#functiongeshi_highlight">geshi_highlight()</a> in geshi.php</div> <div class="index-item-description">Easy way to highlight stuff. Behaves just like highlight_string</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_HOVER</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_HOVER">GESHI_HOVER</a> in geshi.php</div> <div class="index-item-description">Links in the source in the :hover state</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_LANG_ROOT</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_LANG_ROOT">GESHI_LANG_ROOT</a> in geshi.php</div> <div class="index-item-description">The language file directory for GeSHi</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_LINK</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_LINK">GESHI_LINK</a> in geshi.php</div> <div class="index-item-description">Links in the source in the :link state</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_NORMAL_LINE_NUMBERS</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_NORMAL_LINE_NUMBERS">GESHI_NORMAL_LINE_NUMBERS</a> in geshi.php</div> <div class="index-item-description">Use normal line numbers when building the result</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_NO_LINE_NUMBERS</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_NO_LINE_NUMBERS">GESHI_NO_LINE_NUMBERS</a> in geshi.php</div> <div class="index-item-description">Use no line numbers when building the result</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_ROOT</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_ROOT">GESHI_ROOT</a> in geshi.php</div> <div class="index-item-description">The root directory for GeSHi</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_SECURITY_PARANOID</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_SECURITY_PARANOID">GESHI_SECURITY_PARANOID</a> in geshi.php</div> <div class="index-item-description">Tells GeSHi to be paranoid about security settings</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_START_IMPORTANT</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_START_IMPORTANT">GESHI_START_IMPORTANT</a> in geshi.php</div> <div class="index-item-description">The starter for important parts of the source</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_VERSION</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_VERSION">GESHI_VERSION</a> in geshi.php</div> <div class="index-item-description">The version of this GeSHi file</div> </dd> <dt class="field"> <img src="media/images/Constant.png" alt="Constant" title="Constant" /></title> <span class="const-title">GESHI_VISITED</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/_geshi.php.html#defineGESHI_VISITED">GESHI_VISITED</a> in geshi.php</div> <div class="index-item-description">Links in the source in the :visited state</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">get_language_name</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_language_name">GeSHi::get_language_name()</a> in geshi.php</div> <div class="index-item-description">Gets a human-readable language name (thanks to Simon Patterson for the idea :))</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">get_language_name_from_extension</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_language_name_from_extension">GeSHi::get_language_name_from_extension()</a> in geshi.php</div> <div class="index-item-description">Given a file extension, this method returns either a valid geshi language name, or the empty string if it couldn't be found</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">get_multiline_span</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_multiline_span">GeSHi::get_multiline_span()</a> in geshi.php</div> <div class="index-item-description">Get current setting for multiline spans, see GeSHi->enable_multiline_span().</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">get_real_tab_width</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_real_tab_width">GeSHi::get_real_tab_width()</a> in geshi.php</div> <div class="index-item-description">Returns the tab width to use, based on the current language and user preference</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">get_stylesheet</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_stylesheet">GeSHi::get_stylesheet()</a> in geshi.php</div> <div class="index-item-description">Returns a stylesheet for the highlighted code. If $economy mode is true, we only return the stylesheet declarations that matter for this code block instead of the whole thing</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">get_time</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodget_time">GeSHi::get_time()</a> in geshi.php</div> <div class="index-item-description">Gets the time taken to parse the code</div> </dd> </dl> <a name="h"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">h</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">highlight_lines_extra</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodhighlight_lines_extra">GeSHi::highlight_lines_extra()</a> in geshi.php</div> <div class="index-item-description">Specifies which lines to highlight extra</div> </dd> </dl> <a name="l"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">l</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">load_from_file</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodload_from_file">GeSHi::load_from_file()</a> in geshi.php</div> <div class="index-item-description">Given a file name, this method loads its contents in, and attempts</div> </dd> </dl> <a name="o"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">o</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">optimize_keyword_group</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodoptimize_keyword_group">GeSHi::optimize_keyword_group()</a> in geshi.php</div> <div class="index-item-description">compile optimized regexp list for keyword group</div> </dd> </dl> <a name="p"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">p</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">parse_code</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodparse_code">GeSHi::parse_code()</a> in geshi.php</div> <div class="index-item-description">Returns the code in $this->source, highlighted and surrounded by the nessecary HTML.</div> </dd> </dl> <a name="r"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">r</div> <div style="float: right"><a href="#top">top</a></div> <div style="clear: both"></div> </div> <dl> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">remove_keyword</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodremove_keyword">GeSHi::remove_keyword()</a> in geshi.php</div> <div class="index-item-description">Removes a keyword from a keyword group</div> </dd> <dt class="field"> <img src="media/images/Method.png" alt="Method" title="Method" /></title> <span class="method-title">remove_keyword_group</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="geshi/core/GeSHi.html#methodremove_keyword_group">GeSHi::remove_keyword_group()</a> in geshi.php</div> <div class="index-item-description">Removes a keyword group</div> </dd>