<html> <head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Version" rel="Chapter" href="Version.html"> <link title="Utils" rel="Chapter" href="Utils.html"> <link title="Tables" rel="Chapter" href="Tables.html"> <link title="Search_js" rel="Chapter" href="Search_js.html"> <link title="Search" rel="Chapter" href="Search.html"> <link title="Main" rel="Chapter" href="Main.html"> <link title="Licenses" rel="Chapter" href="Licenses.html"> <link title="Icons" rel="Chapter" href="Icons.html"> <link title="Definitions" rel="Chapter" href="Definitions.html"> <link title="DefinitionParser" rel="Chapter" href="DefinitionParser.html"> <link title="DefinitionLexer" rel="Chapter" href="DefinitionLexer.html"> <link title="Base64" rel="Chapter" href="Base64.html"> <link title="Args" rel="Chapter" href="Args.html"><title>Index of values</title> </head> <body> <div class="navbar"> <a class="up" href="index.html" title="Index">Up</a> </div> <h1>Index of values</h1> <table> <tr><td align="left"><br></td></tr> <tr><td><a href="DefinitionLexer.html#VAL__ocaml_lex_comment_rec">__ocaml_lex_comment_rec</a> [<a href="DefinitionLexer.html">DefinitionLexer</a>]</td> <td></td></tr> <tr><td><a href="DefinitionLexer.html#VAL__ocaml_lex_string_rec">__ocaml_lex_string_rec</a> [<a href="DefinitionLexer.html">DefinitionLexer</a>]</td> <td></td></tr> <tr><td><a href="DefinitionLexer.html#VAL__ocaml_lex_tables">__ocaml_lex_tables</a> [<a href="DefinitionLexer.html">DefinitionLexer</a>]</td> <td></td></tr> <tr><td><a href="DefinitionLexer.html#VAL__ocaml_lex_token_rec">__ocaml_lex_token_rec</a> [<a href="DefinitionLexer.html">DefinitionLexer</a>]</td> <td></td></tr> <tr><td align="left"><br>A</td></tr> <tr><td><a href="Definitions.html#VALadd">add</a> [<a href="Definitions.html">Definitions</a>]</td> <td><div class="info"> <code class="code">add defs name value</code> adds a binding from <code class="code">name</code> to <code class="code">value</code> to the set of definitions <code class="code">defs</code>. </div> </td></tr> <tr><td><a href="Tables.html#VALadd_cell">add_cell</a> [<a href="Tables.html">Tables</a>]</td> <td><div class="info"> To be called to notify the presence of a cell on the current row. </div> </td></tr> <tr><td><a href="Tables.html#VALadd_cells">add_cells</a> [<a href="Tables.html">Tables</a>]</td> <td><div class="info"> To be called to notify the presence of several cells on the current row. </div> </td></tr> <tr><td><a href="Definitions.html#VALadd_from_file">add_from_file</a> [<a href="Definitions.html">Definitions</a>]</td> <td><div class="info"> <code class="code">add_from_file defs filename</code> adds the bindings read from the file named <code class="code">filename</code> to the set of definitions <code class="code">defs</code>. </div> </td></tr> <tr><td><a href="Icons.html#VALall">all</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> Association list from icon names to their related image data (encoded in base64). </div> </td></tr> <tr><td><a href="Icons.html#VALattention_base64">attention_base64</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> Data for the 'attention' icon, in base64 encoding. </div> </td></tr> <tr><td align="left"><br>B</td></tr> <tr><td><a href="Tables.html#VALbegin_row">begin_row</a> [<a href="Tables.html">Tables</a>]</td> <td><div class="info"> To be called when a new row begins. </div> </td></tr> <tr><td><a href="Tables.html#VALbegin_table">begin_table</a> [<a href="Tables.html">Tables</a>]</td> <td><div class="info"> To be called when a new table begins. </div> </td></tr> <tr><td><a href="Icons.html#VALbug_base64">bug_base64</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> Data for the 'bug' icon, in base64 encoding. </div> </td></tr> <tr><td align="left"><br>C</td></tr> <tr><td><a href="DefinitionLexer.html#VALcomment">comment</a> [<a href="DefinitionLexer.html">DefinitionLexer</a>]</td> <td></td></tr> <tr><td><a href="Icons.html#VALcss">css</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> The piece of CSS used for icons. </div> </td></tr> <tr><td><a href="Search.html#VALcss">css</a> [<a href="Search.html">Search</a>]</td> <td><div class="info"> The piece of CSS used for search results. </div> </td></tr> <tr><td><a href="Tables.html#VALcss">css</a> [<a href="Tables.html">Tables</a>]</td> <td><div class="info"> The piece of CSS used for tables. </div> </td></tr> <tr><td align="left"><br>D</td></tr> <tr><td><a href="DefinitionParser.html#VALdefinition">definition</a> [<a href="DefinitionParser.html">DefinitionParser</a>]</td> <td></td></tr> <tr><td><a href="Args.html#VALdefinitions">definitions</a> [<a href="Args.html">Args</a>]</td> <td><div class="info"> Definitions, that is bindings from names to values. </div> </td></tr> <tr><td align="left"><br>E</td></tr> <tr><td><a href="Base64.html#VALencode">encode</a> [<a href="Base64.html">Base64</a>]</td> <td><div class="info"> <code class="code">encode ~sz st</code> returns the contents of the stream <code class="code">st</code> encoded in base64. </div> </td></tr> <tr><td><a href="Base64.html#VALencode_channel">encode_channel</a> [<a href="Base64.html">Base64</a>]</td> <td><div class="info"> <code class="code">encode_channel ch</code> returns the contents of the channel <code class="code">ch</code> (from the current position to the end of the channel) encoded in base64. </div> </td></tr> <tr><td><a href="Base64.html#VALencode_file">encode_file</a> [<a href="Base64.html">Base64</a>]</td> <td><div class="info"> <code class="code">encode_file f</code> returns the contents of the file <code class="code">f</code> encoded in base64. </div> </td></tr> <tr><td><a href="Base64.html#VALencode_string">encode_string</a> [<a href="Base64.html">Base64</a>]</td> <td><div class="info"> <code class="code">encode_string s</code> returns the contents of the string <code class="code">s</code> encoded in base64. </div> </td></tr> <tr><td><a href="Tables.html#VALend_row">end_row</a> [<a href="Tables.html">Tables</a>]</td> <td><div class="info"> To be called when the current row ends. </div> </td></tr> <tr><td><a href="Tables.html#VALend_table">end_table</a> [<a href="Tables.html">Tables</a>]</td> <td><div class="info"> To be called when the current table ends. </div> </td></tr> <tr><td><a href="Icons.html#VALerror_base64">error_base64</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> Data for the 'error' icon, in base64 encoding. </div> </td></tr> <tr><td align="left"><br>F</td></tr> <tr><td><a href="Args.html#VALfull_text">full_text</a> [<a href="Args.html">Args</a>]</td> <td><div class="info"> Whether full-text search is enabled. </div> </td></tr> <tr><td align="left"><br>G</td></tr> <tr><td><a href="Search.html#VALgenerate_data">generate_data</a> [<a href="Search.html">Search</a>]</td> <td><div class="info"> Generates the JavaScript data file in the passed directory. </div> </td></tr> <tr><td><a href="Search_js.html#VALgenerate_files">generate_files</a> [<a href="Search_js.html">Search_js</a>]</td> <td><div class="info"> Generates JavaScript files in the passed directory. </div> </td></tr> <tr><td><a href="Search.html#VALgenerate_html">generate_html</a> [<a href="Search.html">Search</a>]</td> <td><div class="info"> Generates the HTML file for search page in the passed directory. </div> </td></tr> <tr><td><a href="Definitions.html#VALget">get</a> [<a href="Definitions.html">Definitions</a>]</td> <td><div class="info"> <code class="code">get defs name</code> returns the value associated to <code class="code">name</code> in <code class="code">defs</code>. </div> </td></tr> <tr><td align="left"><br>I</td></tr> <tr><td><a href="Icons.html#VALinfo_base64">info_base64</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> Data for the 'info' icon, in base64 encoding. </div> </td></tr> <tr><td align="left"><br>L</td></tr> <tr><td><a href="Search.html#VALlink">link</a> [<a href="Search.html">Search</a>]</td> <td><div class="info"> HTML link to search page. </div> </td></tr> <tr><td align="left"><br>M</td></tr> <tr><td><a href="Definitions.html#VALmake">make</a> [<a href="Definitions.html">Definitions</a>]</td> <td><div class="info"> Create an empty set of definitions. </div> </td></tr> <tr><td><a href="Tables.html#VALmake_state">make_state</a> [<a href="Tables.html">Tables</a>]</td> <td><div class="info"> Creates an empty state containing no table. </div> </td></tr> <tr><td align="left"><br>N</td></tr> <tr><td><a href="Icons.html#VALnew_base64">new_base64</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> Data for the 'new' icon, in base64 encoding. </div> </td></tr> <tr><td><a href="Icons.html#VALnote_base64">note_base64</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> Data for the 'note' icon, in base64 encoding. </div> </td></tr> <tr><td align="left"><br>P</td></tr> <tr><td><a href="Search_js.html#VALparser">parser</a> [<a href="Search_js.html">Search_js</a>]</td> <td><div class="info"> Contents of <code class="code">"argot_parser.js"</code> file. </div> </td></tr> <tr><td><a href="Licenses.html#VALpredefined">predefined</a> [<a href="Licenses.html">Licenses</a>]</td> <td><div class="info"> Predefined licenses as an association list from names (with possible synonyms) to URLs. </div> </td></tr> <tr><td align="left"><br>R</td></tr> <tr><td><a href="Utils.html#VALread_lines">read_lines</a> [<a href="Utils.html">Utils</a>]</td> <td><div class="info"> <code class="code">read_lines filename</code> returns the lines from the file named <code class="code">filename</code>. </div> </td></tr> <tr><td><a href="Args.html#VALregister">register</a> [<a href="Args.html">Args</a>]</td> <td><div class="info"> Registers the various command-line switches. </div> </td></tr> <tr><td><a href="Icons.html#VALremark_base64">remark_base64</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> Data for the 'remark' icon, in base64 encoding. </div> </td></tr> <tr><td align="left"><br>S</td></tr> <tr><td><a href="Args.html#VALsearch">search</a> [<a href="Args.html">Args</a>]</td> <td><div class="info"> Whether search information should be generated. </div> </td></tr> <tr><td><a href="Search_js.html#VALsearch">search</a> [<a href="Search_js.html">Search_js</a>]</td> <td><div class="info"> Contents of <code class="code">"argot_search.js"</code> file. </div> </td></tr> <tr><td><a href="Icons.html#VALsearch_base64">search_base64</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> Data for the 'search' icon, in base64 encoding. </div> </td></tr> <tr><td><a href="Args.html#VALsearch_frame">search_frame</a> [<a href="Args.html">Args</a>]</td> <td><div class="info"> Whether search should appear in a frame. </div> </td></tr> <tr><td><a href="Icons.html#VALstateful_base64">stateful_base64</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> Data for the 'stateful' icon, in base64 encoding. </div> </td></tr> <tr><td><a href="DefinitionLexer.html#VALstring">string</a> [<a href="DefinitionLexer.html">DefinitionLexer</a>]</td> <td></td></tr> <tr><td align="left"><br>T</td></tr> <tr><td><a href="Icons.html#VALthreadsafe_base64">threadsafe_base64</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> Data for the 'threadsafe' icon, in base64 encoding. </div> </td></tr> <tr><td><a href="Icons.html#VALthreadunsafe_base64">threadunsafe_base64</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> Data for the 'threadunsafe' icon, in base64 encoding. </div> </td></tr> <tr><td><a href="Licenses.html#VALto_html">to_html</a> [<a href="Licenses.html">Licenses</a>]</td> <td><div class="info"> <code class="code">to_html name</code> return the HTML portion related to the license whose name is passed. </div> </td></tr> <tr><td><a href="Icons.html#VALtodo_base64">todo_base64</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> Data for the 'todo' icon, in base64 encoding. </div> </td></tr> <tr><td><a href="Icons.html#VALtodoc_base64">todoc_base64</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> Data for the 'todoc' icon, in base64 encoding. </div> </td></tr> <tr><td><a href="Icons.html#VALtofix_base64">tofix_base64</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> Data for the 'tofix' icon, in base64 encoding. </div> </td></tr> <tr><td><a href="DefinitionLexer.html#VALtoken">token</a> [<a href="DefinitionLexer.html">DefinitionLexer</a>]</td> <td></td></tr> <tr><td><a href="Icons.html#VALtransparent_base64">transparent_base64</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> Data for the 'transparent' icon, in base64 encoding. </div> </td></tr> <tr><td><a href="Utils.html#VALtrim">trim</a> [<a href="Utils.html">Utils</a>]</td> <td><div class="info"> Returns a copy of the string without leading and trailing whitespace. </div> </td></tr> <tr><td><a href="Utils.html#VALtrim_left">trim_left</a> [<a href="Utils.html">Utils</a>]</td> <td><div class="info"> Returns a copy of the string without leading whitespace. </div> </td></tr> <tr><td><a href="Utils.html#VALtrim_right">trim_right</a> [<a href="Utils.html">Utils</a>]</td> <td><div class="info"> Returns a copy of the string without trailing whitespace. </div> </td></tr> <tr><td><a href="Search_js.html#VALtypes">types</a> [<a href="Search_js.html">Search_js</a>]</td> <td><div class="info"> Contents of <code class="code">"argot_types.js"</code> file. </div> </td></tr> <tr><td align="left"><br>V</td></tr> <tr><td><a href="Version.html#VALvalue">value</a> [<a href="Version.html">Version</a>]</td> <td><div class="info"> The current version of Argot as a string. </div> </td></tr> <tr><td align="left"><br>W</td></tr> <tr><td><a href="Icons.html#VALwarning_base64">warning_base64</a> [<a href="Icons.html">Icons</a>]</td> <td><div class="info"> Data for the 'warning' icon, in base64 encoding. </div> </td></tr> <tr><td><a href="Utils.html#VALwrite_lines">write_lines</a> [<a href="Utils.html">Utils</a>]</td> <td><div class="info"> <code class="code">write_lines filename lines</code> writes the strings from <code class="code">lines</code> to the file named <code class="code">filename</code>. </div> </td></tr> </table> </body> </html>