<?php include_once '../doc-typo3-funcs.php'; $doxygen_vars = array( "title" => "TYPO3 4.0.1: SC_view_help Class Reference", "datetime" => "Sat Dec 2 19:25:37 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?> <!-- Generated by Doxygen 1.4.6 --> <div class="tabs"> <ul> <li><a href="main.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li id="current"><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> <li> <form action="search.php" method="get"> <table cellspacing="0" cellpadding="0" border="0"> <tr> <td><label> <u>S</u>earch for </label></td> <td><input type="text" name="query" value="" size="20" accesskey="s"/></td> </tr> </table> </form> </li> </ul></div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul></div> <h1>SC_view_help Class Reference</h1><!-- doxytag: class="SC_view_help" --><a href="classSC__view__help-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#6ee14dd2c09faa37ac6a8b46da1c9053">init</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#4db0a2a741dcb7f522fd70c0843b1e88">main</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#5105c05071772ea6e51dbf259aa820e5">printContent</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#1011ab38ff538240124a07e174461e72">render_TOC</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#8f7363115333fe2e095b9a29c6009392">render_TOC_el</a> ($table, $tocCat, &$outputSections, &$tocArray, &$CSHkeys)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#76d7daf709ddc736cdc5116717747911">render_TOC_makeTocList</a> ($tocArray)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#6ad49d13b0ecb1e3378a75f070dce3f4">render_Table</a> ($table)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#002a73968ae30d22b539899832d0acec">render_Single</a> ($table, $field)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#5160603ee5699122957036bf127e1cde">make_seeAlso</a> ($value, $anchorTable='')</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#4a06d6c7e88e42cec88ee55b029f7383">printImage</a> ($images, $descr)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#c281a285862b358a36c87122f170e783">headerLine</a> ($str, $type=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#2b26166f478fb13377c5173633d6cfd8">prepareContent</a> ($str)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#dd1503a8d927a355b5c48c7909823eff">printItem</a> ($table, $field, $anchors=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#e582a891a3e9e0929855aa893d08dbef">getTableFieldNames</a> ($table, $field)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#d833c6634703c057978148136f5d1b92">getTableFieldLabel</a> ($table, $field='', $mergeToken=': ')</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#4a75895ecf7e8f24718a667f155d0c93">createGlossaryIndex</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#4c3c98d6e78e6ffa982c94bb68889913">substituteGlossaryWords</a> ($code)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#8ddac2b71cd8d2cd75580340e9a9c39a">substituteGlossaryWords_htmlcleaner_callback</a> ($code)</td></tr> <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="54b27d9b5a2c03936d2395be89238ec0"></a><!-- doxytag: member="SC_view_help::$allowedHTML" ref="54b27d9b5a2c03936d2395be89238ec0" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#54b27d9b5a2c03936d2395be89238ec0">$allowedHTML</a> = '<strong><em><b><i>'</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9f07c7b8925f5cc180fd61ba21925434"></a><!-- doxytag: member="SC_view_help::$limitAccess" ref="9f07c7b8925f5cc180fd61ba21925434" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#9f07c7b8925f5cc180fd61ba21925434">$limitAccess</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68923f77de86e4860917324d78cdb8d8"></a><!-- doxytag: member="SC_view_help::$table" ref="68923f77de86e4860917324d78cdb8d8" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#68923f77de86e4860917324d78cdb8d8">$table</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f7054d1b062d886c379460138f44a8b7"></a><!-- doxytag: member="SC_view_help::$field" ref="f7054d1b062d886c379460138f44a8b7" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#f7054d1b062d886c379460138f44a8b7">$field</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1a78e69bba6f91fde7d264b3917785dd"></a><!-- doxytag: member="SC_view_help::$tfID" ref="1a78e69bba6f91fde7d264b3917785dd" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#1a78e69bba6f91fde7d264b3917785dd">$tfID</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8021ff37879a4eb22f4bc038945e8933"></a><!-- doxytag: member="SC_view_help::$back" ref="8021ff37879a4eb22f4bc038945e8933" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#8021ff37879a4eb22f4bc038945e8933">$back</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="59b46616c6b136c7adf2c2eadfa5fd48"></a><!-- doxytag: member="SC_view_help::$renderALL" ref="59b46616c6b136c7adf2c2eadfa5fd48" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#59b46616c6b136c7adf2c2eadfa5fd48">$renderALL</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de39ab1a471bca440c83b9891ccee6c4"></a><!-- doxytag: member="SC_view_help::$content" ref="de39ab1a471bca440c83b9891ccee6c4" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#de39ab1a471bca440c83b9891ccee6c4">$content</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0028f32398995e7c035745928243e959"></a><!-- doxytag: member="SC_view_help::$glossaryWords" ref="0028f32398995e7c035745928243e959" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSC__view__help.html#0028f32398995e7c035745928243e959">$glossaryWords</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <p> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00122">122</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>.<hr><h2>Member Function Documentation</h2> <a class="anchor" name="4a75895ecf7e8f24718a667f155d0c93"></a><!-- doxytag: member="SC_view_help::createGlossaryIndex" ref="4a75895ecf7e8f24718a667f155d0c93" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::createGlossaryIndex </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Creates glossary index in $this->glossaryWords Glossary is cached in cache_hash table and so will be updated only when cache is cleared.<p> <dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00726">726</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. <p> References <a class="el" href="view__help_8php-source.html#l00128">$field</a>, <a class="el" href="class_8t3lib__befunc_8php-source.html#l01116">t3lib_BEfunc::getHash()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l01132">t3lib_div::isFirstPartOfStr()</a>, and <a class="el" href="class_8t3lib__befunc_8php-source.html#l01096">t3lib_BEfunc::storeHash()</a>. <p> Referenced by <a class="el" href="view__help_8php-source.html#l00167">main()</a>. </td> </tr> </table> <a class="anchor" name="d833c6634703c057978148136f5d1b92"></a><!-- doxytag: member="SC_view_help::getTableFieldLabel" ref="d833c6634703c057978148136f5d1b92" args="($table, $field='', $mergeToken=': ')" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::getTableFieldLabel </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>table</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>$ </td> <td class="mdname" nowrap> <em>field</em> = <code>''</code>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>$ </td> <td class="mdname" nowrap> <em>mergeToken</em> = <code>': '</code></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Returns composite label for table/field<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Table name </td></tr> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Field name </td></tr> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Token to merge the two strings with. </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>array Table and field labels in a numeric array </dd></dl> <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classSC__view__help.html#e582a891a3e9e0929855aa893d08dbef">getTableFieldNames()</a> </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00691">691</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. <p> References <a class="el" href="view__help_8php-source.html#l00128">$field</a>, <a class="el" href="view__help_8php-source.html#l00127">$table</a>, and <a class="el" href="view__help_8php-source.html#l00668">getTableFieldNames()</a>. <p> Referenced by <a class="el" href="view__help_8php-source.html#l00515">make_seeAlso()</a>, and <a class="el" href="view__help_8php-source.html#l00635">printItem()</a>. </td> </tr> </table> <a class="anchor" name="e582a891a3e9e0929855aa893d08dbef"></a><!-- doxytag: member="SC_view_help::getTableFieldNames" ref="e582a891a3e9e0929855aa893d08dbef" args="($table, $field)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::getTableFieldNames </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>table</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>$ </td> <td class="mdname" nowrap> <em>field</em></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Returns labels for $table and $field. If $table is "_MOD_" prefixed, the part after "_MOD_" is returned (non-tables, fx. modules)<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Table name </td></tr> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Field name </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>array Table and field labels in a numeric array </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00668">668</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. <p> References <a class="el" href="view__help_8php-source.html#l00128">$field</a>, and <a class="el" href="view__help_8php-source.html#l00127">$table</a>. <p> Referenced by <a class="el" href="view__help_8php-source.html#l00691">getTableFieldLabel()</a>. </td> </tr> </table> <a class="anchor" name="c281a285862b358a36c87122f170e783"></a><!-- doxytag: member="SC_view_help::headerLine" ref="c281a285862b358a36c87122f170e783" args="($str, $type=0)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::headerLine </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>str</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>$ </td> <td class="mdname" nowrap> <em>type</em> = <code>0</code></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Returns header HTML content<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Header text </td></tr> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Header type (1, 0) </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>string The HTML for the header. </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00599">599</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. <p> Referenced by <a class="el" href="view__help_8php-source.html#l00635">printItem()</a>. </td> </tr> </table> <a class="anchor" name="6ee14dd2c09faa37ac6a8b46da1c9053"></a><!-- doxytag: member="SC_view_help::init" ref="6ee14dd2c09faa37ac6a8b46da1c9053" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::init </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Initialize the class for various input etc.<p> <dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00146">146</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. <p> References <a class="el" href="class_8t3lib__div_8php-source.html#l00262">t3lib_div::_GP()</a>, and <a class="el" href="class_8t3lib__befunc_8php-source.html#l03030">t3lib_BEfunc::isModuleSetInTBE_MODULES()</a>. </td> </tr> </table> <a class="anchor" name="4db0a2a741dcb7f522fd70c0843b1e88"></a><!-- doxytag: member="SC_view_help::main" ref="4db0a2a741dcb7f522fd70c0843b1e88" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::main </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Main function, rendering the display<p> <dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00167">167</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. <p> References <a class="el" href="view__help_8php-source.html#l00726">createGlossaryIndex()</a>, <a class="el" href="view__help_8php-source.html#l00469">render_Single()</a>, <a class="el" href="view__help_8php-source.html#l00409">render_Table()</a>, and <a class="el" href="view__help_8php-source.html#l00221">render_TOC()</a>. </td> </tr> </table> <a class="anchor" name="5160603ee5699122957036bf127e1cde"></a><!-- doxytag: member="SC_view_help::make_seeAlso" ref="5160603ee5699122957036bf127e1cde" args="($value, $anchorTable='')" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::make_seeAlso </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>value</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>$ </td> <td class="mdname" nowrap> <em>anchorTable</em> = <code>''</code></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Make seeAlso links from $value<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>See-also input codes </td></tr> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>If $anchorTable is set to a tablename, then references to this table will be made as anchors, not URLs. </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>string See-also links HTML </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00515">515</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. <p> References <a class="el" href="class_8t3lib__div_8php-source.html#l03310">t3lib_div::getFileAbsFileName()</a>, <a class="el" href="view__help_8php-source.html#l00691">getTableFieldLabel()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l03746">t3lib_div::loadTCA()</a>, and <a class="el" href="incfile_8php-source.html#l00011">t3lib_div::trimExplode()</a>. <p> Referenced by <a class="el" href="view__help_8php-source.html#l00635">printItem()</a>. </td> </tr> </table> <a class="anchor" name="2b26166f478fb13377c5173633d6cfd8"></a><!-- doxytag: member="SC_view_help::prepareContent" ref="2b26166f478fb13377c5173633d6cfd8" args="($str)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::prepareContent </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname1" valign="top" nowrap> <em>str</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Returns prepared content<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Content to format. </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>string Formatted content. </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00620">620</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. <p> Referenced by <a class="el" href="view__help_8php-source.html#l00635">printItem()</a>. </td> </tr> </table> <a class="anchor" name="5105c05071772ea6e51dbf259aa820e5"></a><!-- doxytag: member="SC_view_help::printContent" ref="5105c05071772ea6e51dbf259aa820e5" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::printContent </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Outputting the accumulated content to screen<p> <dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00198">198</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. </td> </tr> </table> <a class="anchor" name="4a06d6c7e88e42cec88ee55b029f7383"></a><!-- doxytag: member="SC_view_help::printImage" ref="4a06d6c7e88e42cec88ee55b029f7383" args="($images, $descr)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::printImage </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>images</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>$ </td> <td class="mdname" nowrap> <em>descr</em></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Will return an image tag with description in italics.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Image file reference (list of) </td></tr> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Description string (divided for each image by line break) </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>string Image HTML codes </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00564">564</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. <p> References <a class="el" href="class_8t3lib__div_8php-source.html#l03310">t3lib_div::getFileAbsFileName()</a>, and <a class="el" href="incfile_8php-source.html#l00011">t3lib_div::trimExplode()</a>. <p> Referenced by <a class="el" href="view__help_8php-source.html#l00635">printItem()</a>. </td> </tr> </table> <a class="anchor" name="dd1503a8d927a355b5c48c7909823eff"></a><!-- doxytag: member="SC_view_help::printItem" ref="dd1503a8d927a355b5c48c7909823eff" args="($table, $field, $anchors=0)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::printItem </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>table</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>$ </td> <td class="mdname" nowrap> <em>field</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>$ </td> <td class="mdname" nowrap> <em>anchors</em> = <code>0</code></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Prints a single $table/$field information piece If $anchors is set, then seeAlso references to the same table will be page-anchors, not links.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Table name </td></tr> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Field name </td></tr> <tr><td valign="top"></td><td valign="top"><em>boolean</em> </td><td>If anchors is to be shown. </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>string HTML content </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00635">635</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. <p> References <a class="el" href="view__help_8php-source.html#l00128">$field</a>, <a class="el" href="view__help_8php-source.html#l00127">$table</a>, <a class="el" href="view__help_8php-source.html#l00691">getTableFieldLabel()</a>, <a class="el" href="view__help_8php-source.html#l00599">headerLine()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l03746">t3lib_div::loadTCA()</a>, <a class="el" href="view__help_8php-source.html#l00515">make_seeAlso()</a>, <a class="el" href="view__help_8php-source.html#l00620">prepareContent()</a>, and <a class="el" href="view__help_8php-source.html#l00564">printImage()</a>. <p> Referenced by <a class="el" href="view__help_8php-source.html#l00469">render_Single()</a>, and <a class="el" href="view__help_8php-source.html#l00409">render_Table()</a>. </td> </tr> </table> <a class="anchor" name="002a73968ae30d22b539899832d0acec"></a><!-- doxytag: member="SC_view_help::render_Single" ref="002a73968ae30d22b539899832d0acec" args="($table, $field)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::render_Single </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>table</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>$ </td> <td class="mdname" nowrap> <em>field</em></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Renders CSH for a single field.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>CSH key / table name </td></tr> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Sub key / field name </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>string HTML output </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00469">469</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. <p> References <a class="el" href="view__help_8php-source.html#l00128">$field</a>, <a class="el" href="view__help_8php-source.html#l00127">$table</a>, <a class="el" href="view__help_8php-source.html#l00635">printItem()</a>, and <a class="el" href="view__help_8php-source.html#l00785">substituteGlossaryWords()</a>. <p> Referenced by <a class="el" href="view__help_8php-source.html#l00167">main()</a>. </td> </tr> </table> <a class="anchor" name="6ad49d13b0ecb1e3378a75f070dce3f4"></a><!-- doxytag: member="SC_view_help::render_Table" ref="6ad49d13b0ecb1e3378a75f070dce3f4" args="($table)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::render_Table </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname1" valign="top" nowrap> <em>table</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Render CSH for a full cshKey/table<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>CSH key / table name </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>string HTML output </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00409">409</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. <p> References <a class="el" href="view__help_8php-source.html#l00128">$field</a>, <a class="el" href="view__help_8php-source.html#l00127">$table</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l03746">t3lib_div::loadTCA()</a>, <a class="el" href="view__help_8php-source.html#l00635">printItem()</a>, and <a class="el" href="view__help_8php-source.html#l00785">substituteGlossaryWords()</a>. <p> Referenced by <a class="el" href="view__help_8php-source.html#l00167">main()</a>, and <a class="el" href="view__help_8php-source.html#l00338">render_TOC_el()</a>. </td> </tr> </table> <a class="anchor" name="1011ab38ff538240124a07e174461e72"></a><!-- doxytag: member="SC_view_help::render_TOC" ref="1011ab38ff538240124a07e174461e72" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::render_TOC </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Creates Table Of Contents and possibly "Full Manual" mode if selected.<p> <dl compact><dt><b>Returns:</b></dt><dd>string HTML content </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00221">221</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. <p> References <a class="el" href="view__help_8php-source.html#l00127">$table</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l01132">t3lib_div::isFirstPartOfStr()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l03984">t3lib_div::makeInstance()</a>, <a class="el" href="view__help_8php-source.html#l00338">render_TOC_el()</a>, and <a class="el" href="view__help_8php-source.html#l00370">render_TOC_makeTocList()</a>. <p> Referenced by <a class="el" href="view__help_8php-source.html#l00167">main()</a>. </td> </tr> </table> <a class="anchor" name="8f7363115333fe2e095b9a29c6009392"></a><!-- doxytag: member="SC_view_help::render_TOC_el" ref="8f7363115333fe2e095b9a29c6009392" args="($table, $tocCat, &$outputSections, &$tocArray, &$CSHkeys)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::render_TOC_el </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>table</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>$ </td> <td class="mdname" nowrap> <em>tocCat</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>&$ </td> <td class="mdname" nowrap> <em>outputSections</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>&$ </td> <td class="mdname" nowrap> <em>tocArray</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>&$ </td> <td class="mdname" nowrap> <em>CSHkeys</em></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Creates a TOC list element and renders corresponding HELP content if "renderALL" mode is set.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>CSH key / Table name </td></tr> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>TOC category keyword: "core", "modules", "tables", "other" </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Array for accumulation of rendered HELP Content (in "renderALL" mode). Passed by reference! </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>TOC array; Here TOC index elements are created. Passed by reference! </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>CSH keys array. Every item rendered will be unset in this array so finally we can see what CSH keys are not processed yet. Passed by reference! </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00338">338</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. <p> References <a class="el" href="view__help_8php-source.html#l00127">$table</a>, and <a class="el" href="view__help_8php-source.html#l00409">render_Table()</a>. <p> Referenced by <a class="el" href="view__help_8php-source.html#l00221">render_TOC()</a>. </td> </tr> </table> <a class="anchor" name="76d7daf709ddc736cdc5116717747911"></a><!-- doxytag: member="SC_view_help::render_TOC_makeTocList" ref="76d7daf709ddc736cdc5116717747911" args="($tocArray)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::render_TOC_makeTocList </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname1" valign="top" nowrap> <em>tocArray</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Renders the TOC index as a HTML bullet list from TOC array<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>ToC Array. </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>string HTML bullet list for index. </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00370">370</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. <p> Referenced by <a class="el" href="view__help_8php-source.html#l00221">render_TOC()</a>. </td> </tr> </table> <a class="anchor" name="4c3c98d6e78e6ffa982c94bb68889913"></a><!-- doxytag: member="SC_view_help::substituteGlossaryWords" ref="4c3c98d6e78e6ffa982c94bb68889913" args="($code)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::substituteGlossaryWords </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname1" valign="top" nowrap> <em>code</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Processing of all non-HTML content in the output Will be done by a call-back to -><a class="el" href="classSC__view__help.html#8ddac2b71cd8d2cd75580340e9a9c39a">substituteGlossaryWords_htmlcleaner_callback()</a><p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Input HTML code </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>string Output HTML code </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00785">785</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. <p> References <a class="el" href="class_8t3lib__div_8php-source.html#l03984">t3lib_div::makeInstance()</a>. <p> Referenced by <a class="el" href="view__help_8php-source.html#l00469">render_Single()</a>, and <a class="el" href="view__help_8php-source.html#l00409">render_Table()</a>. </td> </tr> </table> <a class="anchor" name="8ddac2b71cd8d2cd75580340e9a9c39a"></a><!-- doxytag: member="SC_view_help::substituteGlossaryWords_htmlcleaner_callback" ref="8ddac2b71cd8d2cd75580340e9a9c39a" args="($code)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">SC_view_help::substituteGlossaryWords_htmlcleaner_callback </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname1" valign="top" nowrap> <em>code</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Substituting glossary words in the CSH (This is a call-back function from "class local_t3lib_parsehtml extends t3lib_parsehtml", see top of this script)<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Input HTML string </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>string HTML with substituted words in. alex widschwendter, media.res kommunikationsloesungen </dd></dl> <p> Definition at line <a class="el" href="view__help_8php-source.html#l00801">801</a> of file <a class="el" href="view__help_8php-source.html">view_help.php</a>. </td> </tr> </table> <hr>The documentation for this class was generated from the following file:<ul> <li>typo3_src-4.0.1/typo3/<a class="el" href="view__help_8php-source.html">view_help.php</a></ul> <?php include_once '../doc-typo3-funcs.php'; get_footer(); ?>