[ Index ]

PHP Cross Reference of Mambo 4.6.5

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

title

Body

[close]

/help/ -> modules.login.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 - Login Form</title>
   5  <link href="css/help.css" rel="stylesheet" type="text/css" />
   6  </head>
   7  <body><strong class="title">Module: Login
   8  Form</strong>
   9  <table width="100%"  border="1" cellspacing="0" cellpadding="3">
  10       <tr>
  11            <td width="16%" align="right" valign="top" bgcolor="#EFEFEF" class="datalabel">Purpose:</td>
  12            <td width="84%" valign="top" class="data"><p>The <strong>Login Form</strong> module
  13                      displays a Username and Password login form. It also displays
  14                      a link to retrieve a forgotten password. If user registration
  15                      is enabled, (refer to the Global Configuration settings),
  16                      then another link will be shown to invite users to self-register.
  17                      If the user is logged in, the module displays a &quot;Logout&quot; link.</p>
  18                 <strong>Details </strong>&nbsp; <ul>
  19                      <li><strong>Title</strong>: Title of the module to display
  20                           on the page.</li>
  21                      <li><strong>Show Title</strong>: Show/Hide the Title (above)
  22                           of the Module on the page. </li>
  23                      <li><strong>Position</strong>: Assign the Module to a position
  24                           on the template.</li>
  25                      <li><strong>Module order</strong>: The order the module will
  26                           appear among modules assigned to the same page, in the
  27                           same position.</li>
  28                      <li><strong>Access Level</strong>: Determines who (which
  29                           class of user) can view the Module.</li>
  30                      <li><strong>Published</strong>: Show/Hide the Module.</li>
  31                      <li><strong>ID</strong>: This is the ID number for the module
  32                           item. This is auto-allocated by the Mambo system when
  33                           the module is saved.</li>
  34                      <li><strong>Description:</strong> A short description of
  35                           the functions provided by the Module Type</li>
  36                      <li><strong>Pages / Items</strong>: Sets on which pages the
  37                           Module will appear.</li>
  38                 </ul></td>
  39       </tr>
  40       <tr>
  41            <td align="right" valign="top" bgcolor="#EFEFEF" class="datalabel">Usage:</td>
  42            <td valign="top" class="data">n/a</td>
  43       </tr>
  44       <tr>
  45            <td align="right" valign="top" bgcolor="#EFEFEF" class="datalabel">Default State: </td>
  46            <td valign="top" class="data">Published</td>
  47       </tr>
  48       <tr>
  49            <td align="right" valign="top" bgcolor="#EFEFEF" class="datalabel">Parameters:</td>
  50            <td valign="top" class="data"><ul>
  51                 <li><strong>Module Class Suffix</strong>: A suffix to be applied
  52                      to the CSS class of the module (table.moduletable) to allow
  53                      individual module styling.</li>
  54                 <li><strong>Pre-text</strong>: This
  55                           allows to display text or HTML above the login form.</li>
  56                 <li><strong>Post-text</strong>:
  57                           This allows to display text or HTML below the login
  58                           form.</li>
  59                 <li><strong>Login
  60                           Redirection URL</strong>:You may enter here the URL
  61                           of a page you want the logout to redirect to. If left
  62                           blank, it will load the Home Page. </li>
  63                 <li><strong>Logout Redirection URL</strong>:
  64                           You may enter here the URL of a page you want the logout
  65                           to redirect to. If left blank, it will load the Home
  66                           Page. </li>
  67                 <li><strong>Login
  68                           Message</strong>: Show/Hide the javascript Alert indicating
  69                           Login success or failure.</li>
  70                 <li><strong>Logout Message</strong>:
  71                           Show/Hide the javascript Alert indicating Logout success.</li>
  72                 <li><strong>Greeting</strong>:
  73                           Show/Hide the simple greeting text.</li>
  74                 <li><strong>Name/Username</strong>:
  75                           Choose whether to display Name or Username in the greeting.
  76                           The Name is defined for each registered user in the
  77                           list accessed through Site -&gt; User Manager -&gt; Add/Edit
  78                           users under the heading Name, the Username in the same
  79                           list under the heading UserID</li>
  80            </ul></td>
  81       </tr>    <tr>
  82            <td align="right" valign="top" bgcolor="#EFEFEF" class="datalabel">Toolbar Icons: </td>
  83            <td valign="top" class="data"><ul>
  84                 <li><strong>Preview</strong>: Preview Module. NOTE: You can only
  85                      Preview typed modules. </li>
  86                 <li><strong>Save</strong>: Save changes and return to Module Manager. </li>
  87                 <li><strong>Apply</strong>: Apply changes without exiting the
  88                      page. </li>
  89                 <li><strong>Close</strong>: Cancel without saving your changes
  90                      and return to Module Manager. </li>
  91            </ul></td>
  92       </tr>
  93  </table>
  94  
  95  </body></html>