[ Index ]

PHP Cross Reference of Mambo 4.6.5

[ Variables ]     [ Functions ]     [ Classes ]     [ Constants ]     [ Statistics ]

title

Body

[close]

/help/ -> modules.search.html (source)

   1  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2  <html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
   3  <head>
   4  <title>Site Module - Search</title>
   5  <link href="css/help.css" rel="stylesheet" type="text/css" />
   6  </head>
   7  <body><strong class="title">Module: Search </strong>
   8  <table width="100%"  border="1" cellspacing="0" cellpadding="3">
   9       <tr>
  10            <td width="16%" align="right" valign="top" bgcolor="#EFEFEF" class="datalabel">Purpose:</td>
  11            <td width="84%" valign="top" class="data"><p>The <strong>Search</strong> module shows
  12                      a box into which users can enter query and then search your
  13                      site for occurrences of that query.</p>
  14                 <strong>Details </strong>  <ul>
  15                      <li><strong>Title</strong>: Title of the module to display
  16                           on the page.</li>
  17                      <li><strong>Show Title</strong>: Show/Hide the Title (above) of
  18                           the Module on the page. </li>
  19                      <li><strong>Position</strong>: Assign the Module to a position
  20                           on the template.</li>
  21                      <li><strong>Module order</strong>: The order the module will
  22                           appear among modules assigned to the same page, in the
  23                           same position.</li>
  24                      <li><strong>Access Level</strong>: Determines who (which
  25                           class of user) can view the Module.</li>
  26                      <li><strong>Published</strong>: Show/Hide the Module.</li>
  27                      <li><strong>ID</strong>: This is the ID number for the module
  28                           item. This is auto-allocated by the Mambo system when
  29                           the module is saved.</li>
  30                      <li><strong>Description:</strong> A short description of
  31                           the functions provided by the Module Type</li>
  32                      <li><strong>Pages / Items</strong>: Sets on which pages the
  33                           Module will appear.</li>
  34                 </ul></td>
  35       </tr>
  36       <tr>
  37            <td align="right" valign="top" bgcolor="#EFEFEF" class="datalabel">Usage:</td>
  38            <td valign="top" class="data">n/a</td>
  39       </tr>
  40       <tr>
  41            <td align="right" valign="top" bgcolor="#EFEFEF" class="datalabel">Default State: </td>
  42            <td valign="top" class="data">Published</td>
  43       </tr>
  44       <tr>
  45            <td align="right" valign="top" bgcolor="#EFEFEF" class="datalabel">Parameters:</td>
  46            <td valign="top" class="data"><ul>
  47                 <li><strong>Module Class
  48                           Suffix</strong>: A suffix to be applied to the CSS class
  49                           of the module (table.moduletable) to allow individual
  50                      module styling.</li>
  51                 <li><strong>Enable Cache</strong>: Select to cache the
  52                      contents of this module.</li>
  53                 <li><strong>Box Width</strong>: Set the length of the box into which users can
  54                      enter their search query.</li>
  55                 <li><strong>Text</strong>: Enter text to appear in the blank search box; if you
  56                      leave this blank, the system default text will appear.</li>
  57                 <li><strong>Search Button</strong>: Show/Hide button for users to click to begin
  58                      search. If you do not show button, user has to hit the enter
  59                      key to begin the search.</li>
  60                 <li><strong>Button Position</strong>: Select where the button appears relative
  61                      to the search box.</li>
  62                 <li><strong>Button Text</strong>: Specify text to appear on the button; if you
  63                      leave this blank, the system default text will appear.</li>
  64            </ul></td>
  65       </tr>    <tr>
  66            <td align="right" valign="top" bgcolor="#EFEFEF" class="datalabel">Toolbar Icons: </td>
  67            <td valign="top" class="data"><ul>
  68                 <li><strong>Preview</strong>: Preview Module. NOTE: You can only
  69                      Preview typed modules. </li>
  70                 <li><strong>Save</strong>: Save changes and return to Module Manager. </li>
  71                 <li><strong>Apply</strong>: Apply changes without exiting the
  72                      page. </li>
  73                 <li><strong>Close</strong>: Cancel without saving your changes
  74                      and return to Module Manager. </li>
  75            </ul></td>
  76       </tr>
  77  </table>
  78  
  79  </body></html>