[ Index ]

PHP Cross Reference of Mambo 4.6.5

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

title

Body

[close]

/help/ -> config.main.html (source)

   1  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2  
   3  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4  
   5  <html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
   6  <head>
   7  <title>Global Configuration Manager</title>
   8  <link href="css/help.css" rel="stylesheet" type="text/css" />
   9  </head>
  10  <body>
  11  <strong class="title">Global Configuration Manager </strong>
  12  <table width="100%"  border="1" cellspacing="0" cellpadding="3">
  13       <tr>
  14            <td width="16%" align="right" valign="top" bgcolor="#EFEFEF" class="datalabel">Purpose:</td>
  15            <td width="84%" valign="top" class="data"><p>The Global Configuration
  16                      Manager allows you to control a number of variables that
  17                      affect your site as a whole. Changes made on this screen
  18                      will update the configuration.php file; accordingly, this
  19                      file must be writable. When your site is configured,
  20                      it is a good idea to make configuration.php unwritable for
  21                      security reasons. </p>
  22                 <p ><strong>Site Tab</strong></p>
  23                 
  24        <ul>
  25          <li><strong>Site Offline</strong> - Takes the front end of your website 
  26            on or offline. Use this option if you are updating the site and do not 
  27            wish to have your visitors view the site until you are finished.</li>
  28          <li><strong>Offline Message</strong> - When the Site Offline switch is 
  29            in the Yes position, this field sets the default message that displays 
  30            for your site visitors.</li>
  31          <li><strong>System Error Message</strong> - This message will display 
  32            if the initial database connection fails.&nbsp; You can type anything 
  33            you like in this box.</li>
  34          <li><strong>Site Name</strong> - Sets the name of the site. This will 
  35            display in the Title Bar of the visitors' browsers and will also show 
  36            in system-generated emails. </li>
  37          <li><strong>ShowUnauthorised Links</strong> -&nbsp;With this option turned 
  38            on, visitors&nbsp;will see all links, including those to Content Items 
  39            to which the visitor may not have access, (that is, content given an 
  40            Access Level of &#39;Registered&#39; or &#39;Special&#39;). With this 
  41            option off, they will only see links to content with an Access Level 
  42            of &#39;Public&#39;.</li>
  43          <li><strong>Allow User Registration</strong> - This option allows you 
  44            to set whether visitors can register for a user account. If the &quot;Yes&quot; 
  45            radio button is chosen, the Login Form will include the prompt &ldquo;No 
  46            account yet? Create one&quot;. If the &quot;No&quot; radio button is 
  47            chosen, they will not be presented with an option to register.</li>
  48          <li><strong>Use New Account Activation</strong> - If the &quot;Yes&quot; 
  49            radio button is chosen, an activation link will be sent to user&#39;s 
  50            e-mail address. A new user can not login until he has clicked on the 
  51            activation link.&nbsp; If the &quot;No&quot; radio button is chosen, 
  52            Users will be able to login right away without activation.</li>
  53          <li><strong>Email New User Password</strong> - With this option set to 
  54            &#39;Yes&#39;, the new user will receive an email with a password generated 
  55            by Mambo. If it is set to &#39;No&#39;, new Users will select their 
  56            own password.</li>
  57          <li><strong>Require Unique Email</strong> - Select whether you want to 
  58            prevent registration with duplicate e-mail addresses. In combination 
  59            with user activation this option prevents users from signing up more 
  60            than once using the same e-mail address.</li>
  61          <li><strong>Use Captcha Authentication</strong> - Select whether users 
  62            are required to enter verification details from a security image before 
  63            submitting forms. This stops automatic form submissions such as spam.</li>
  64          <li><strong>Debug Site</strong> - This option allows you to view the error 
  65            messages that are created by your site&#39;s php installation. It can 
  66            be a handy tool for debugging if you are having problems and for reporting 
  67            errors to your System Administrator or Web host.</li>
  68          <li><strong>WYSIWYG Editor</strong> - Choose which of the installed Text 
  69            Editors you want to use to edit Content Items.</li>
  70          <li><strong>List Length</strong> - Choose a default length for lists in 
  71            the Admin system.</li>
  72          <li><strong>Favourites Site Icon</strong> - This sets the icon that appears 
  73            in some browsers next to the name and/or address of your site.&nbsp; 
  74            By default this is the Mambo flower.&nbsp; If you want another icon 
  75            to show up, you must upload another icon to replace the Mambo flower.&nbsp;</li>
  76        </ul>               
  77                 <p><strong>Locale Tab</strong> </p>
  78                 <ul>
  79                      <li><strong>Language</strong>:&nbsp; Choose
  80                           the default language used on your site. Note that you
  81                           may have to install a language pack if you wish to use
  82                           a language other than that deployed with the system.</li>
  83                      <li><strong>Time
  84                           Offset</strong>: This option sets the time offset in
  85                           hours between your server location and GMT (Greenwich
  86                           Mean Time - UK).</li>
  87                      <li><strong>Debugging</strong>: </li>
  88                      <li><strong>Use gettext</strong>: </li>
  89                      <li><strong>Country
  90                           Locale</strong>: Type the location of your Web site.&nbsp; For
  91                           instance en_GB would be the setting for the UK.</li>
  92                 </ul>               
  93                 <p><strong>Content Tab</strong> </p>
  94                 <ul>
  95                      <li><strong>Linked Titles</strong>:
  96                           Select &#39;Yes&#39;, if you want the title of a Content
  97                           Item to function as a hyper-link leading to the Content
  98                           Item.</li>
  99                      <li><strong>Read
 100                           More Link</strong>: Hide / display the
 101                           text &quot;Read more&quot; at the end of your &quot;Intro
 102                           Text&quot; of your Content Items.</li>
 103                      <li><strong>Item Rating / Voting</strong>:&nbsp;This
 104                           option allows users to vote on / rate  Content Items.&nbsp; Choose &#39;Yes&#39;,
 105                           and a &#39;Star Bar&#39; will be shown on each Content
 106                           Item, as well as a form for submitting ratings. </li>
 107                      <li><strong>Author
 108                           Names</strong>: Show /Hide the Author&#39;s name when
 109                           a Content Item is displayed.</li>
 110                      <li> <strong>Created Date and Time</strong>:&nbsp;Show /Hide the
 111                           creation date and time when a Content Item
 112                           is displayed</li>
 113                      <li>.<strong>Modified
 114                           Date and Time</strong>: Show /Hide the last modified
 115                           date and time when
 116                           a Content Item is displayed.</li>
 117                      <li><strong>Hits</strong>: Show /Hide the number
 118                           of times an article/content has been viewed.</li>
 119                      <li> <strong>PDF Icon</strong>:
 120                           Show /Hide the PDF
 121                           maker icon on Content Items.</li>
 122                      <li><strong>Print Icon</strong>:&nbsp; Show /Hide the Printer
 123                           Friendly Version icon on Content Items.</li>
 124                      <li><strong>Email
 125                           Icon</strong>:&nbsp;Show /Hide the Email Page to Friend
 126                           icon on Content Items.</li>
 127                      <li><strong>Icons</strong>: Choose the
 128                           radio button &quot;Show&quot;, when you want the hidden links
 129                           to Email/Print/PDF to be icons rather than text.</li>
 130                      <li><strong>Table
 131                           of Contents on multi-page items</strong>: Choose the radio
 132                           button &quot;Show&quot;, to show the Table of Content navigation
 133                           index boxes&nbsp; for multi-page Content Items.</li>
 134                      <li><strong>Back Button</strong>:&nbsp;Show /Hide navigational
 135                           back buttons on each page to make it easier for users
 136                           to navigate your site.</li>
 137                      <li><strong>Content Item Navigation</strong>:
 138                           Choose the radio button &quot;Show&quot;, to publish&nbsp; &#39;Next&#39; and &#39;Previous&#39; links
 139                           when viewing Content Items in a category or&nbsp; to change
 140                           pages within the same article.</li>
 141                 </ul>               
 142                 <p><strong>Database Tab</strong> </p>
 143                 <p ><strong>Warning</strong>&nbsp;&nbsp;These
 144                      are very important settings. If your Mambo web site has been
 145                      installed on your behalf do not alter these settings.</p>
 146                 <ul>
 147                      <li><strong>Hostname</strong>:
 148                           Your Host name - typically &quot;localhost.&quot; </li>
 149                      <li><strong>MySQL
 150                           Username</strong>: The username to access
 151                           your Mambo database.</li>
 152                      <li><strong>MySQL Password</strong>:&nbsp; The password to
 153                           access your Mambo database.</li>
 154                      <li><strong>MySQL
 155                           Database</strong>: The name of the database
 156                           your Mambo installation uses.</li>
 157                      <li><strong>MySQL Database Prefix</strong>:
 158                           The prefix used for records in your Mambo
 159                           database. Typically &ldquo;mos_&quot; by default. <strong>Very
 160                           Important!</strong> DO NOT CHANGE UNLESS YOU HAVE A
 161                           DATABASE BUILT USING TABLES WITH THE PREFIX YOU ARE
 162                           SETTING!!</li>
 163                 </ul>               
 164                 <p><strong>Server Tab</strong> </p>
 165                 <p >The following two items are predefined
 166                      during the installation and are not configurable through
 167                      this tab. The only way to change them is by manually editing
 168                      the configuration.php file.</p>
 169                 <ul>
 170                      <li><strong>Absolute Path</strong>:&nbsp;This
 171                           is the directory information used by Mambo on the server
 172                           that orientates it to it&#39;s surrounding system.</li>
 173                      <li><strong>Live
 174                           Site</strong>:&nbsp;This is the absolute URL (web address)
 175                           for your installation of Mambo. Typical value is http://www.mysite.com.</li>
 176                 </ul>               
 177                 <p>The following items are editable on the screen. </p>
 178                 <ul>
 179                      <li><strong>GZIP Page Compression</strong>:
 180                                Choose the radio button &quot;Yes&quot;, to allow
 181                                your web server to send compressed data, if supported
 182                           by the server, to the client web browser.</li>
 183                      <li><strong>Login
 184                                Session Lifetime</strong>: Type the number of seconds
 185                                the Administration session should be allowed to stay
 186                                live before automatic logout occurs. After automatic
 187                                logout, the Administrator will be required to login
 188                           again using the correct username and password.&nbsp; </li>
 189                      <li><strong>Error
 190                                Reporting</strong>:&nbsp;If this option
 191                                is enabled under the Site tab, then using the drop down
 192                                box, select the level or reporting required. Options
 193                           are System Default, None, Simple and Maximum.</li>
 194                 </ul>               <div >
 195                      <ul>
 196                           <ul>
 197                                <li>System Default - &nbsp;This turns Error reporting
 198                                          to the system default according to php.ini on the
 199                                          server.</li>
 200                                <li>None -&nbsp;This turns off error reporting.</li>
 201                                <li>Simple - &nbsp;This turns error reporting to
 202                                     simple options.</li>
 203                                <li>&nbsp;Maximum - &nbsp;This turns error reporting
 204                                     to the Maximum level.</li>
 205                           </ul>
 206                           <li><strong>Register Globals Emulation</strong>: By
 207                                default set to &quot;ON.&quot; Setting this to &quot;OFF&quot; may
 208                                cause problems with some components. </li>
 209                           <li><strong>Help Server</strong>: Set the URL for the
 210                                system to use to access the live help site data.
 211                                Leave blank to disable this feature. </li>
 212                           <li> <strong>File Creation</strong>:
 213                                By default, files created by the installation of
 214                                components, modules and mambots inherit the server
 215                                default permissions. By choosing &quot;CHMOD new
 216                                files&quot;, you can override
 217                                the server permissions.</li>
 218                           <li><strong>Directory Creation</strong>:
 219                                As with files, new directories will by default
 220                                inherit the server default permissions. Choose &quot;CHMOD
 221                                new directories&quot; to
 222                                override the server permissions.</li>
 223                      </ul>
 224                      <p><strong>Metadata Tab</strong> </p>
 225                      <p >These settings, affect the way
 226                      search engines index your site.</p>
 227                      <ul>
 228                           <li><strong>Global Site Meta Description</strong>:&nbsp;Type
 229                                a description of your web site used to assist Search
 230                                Engines. Make sure that the most important
 231                                part of your description is in the first 20 words. </li>
 232                           <li><strong>Global
 233                                Site Meta Keywords</strong>: Appears in the keywords
 234                                field of your site's metadata. Can append metadata
 235                                to this list for individual Content Items, but
 236                                the appended text will always come after what is
 237                                input here. </li>
 238                           <li><strong>Show
 239                                     Title Meta Tag</strong>: Includes the item
 240                                     / component title name in the Title meta tag
 241                                     field in the source code.</li>
 242                           <li><strong>Show Author Meta
 243                                          Tag</strong>: Includes the Author meta
 244                                          tag field in the source code when viewing
 245                                          content.</li>
 246                      </ul>
 247                      <p><strong>Mail Tab</strong> </p>
 248                      <ul>
 249                           <li><strong>Mailer</strong>: Choose
 250                                which mailer you wish to use: PHP mail function, Sendmail
 251                                or SMTP Server.</li>
 252                           <li><strong>Mail From</strong>: Choose which email
 253                                address will show as the sender of system-generated
 254                                emails.</li>
 255                           <li><strong>From Name</strong>:
 256                                Choose what name will show as the sender of system-generated
 257                                emails.</li>
 258                           <li><strong>Sendmail
 259                                Path</strong>: This is the directory of the Mail server.
 260                                Under Linux installations is normally /usr/sbin/sendmail.
 261                                Not applicable on Windows installations.If you have chosen
 262                                the SMTP Server as the Mailer, then you have to set the following
 263                                settings. Ignore otherwise.&nbsp;</li>
 264                           <li><strong>SMTP</strong> <strong>Auth</strong>:
 265                                Choose &quot;Yes&quot; if SMTP Authentication is required
 266                                by your host.</li>
 267                           <li><strong>SMTP User</strong>: If authentication
 268                                is required and set above, type your username.</li>
 269                           <li><strong>SMTP
 270                                Pass</strong>:&nbsp;If authentication is required and set
 271                                above, type your password.</li>
 272                           <li><strong>SMTP Host</strong>: This
 273                                     is usually set as &quot;localhost,&quot; but you may
 274                                need to check this with your host.</li>
 275                      </ul>
 276                      <p><strong>Cache Tab</strong> </p>
 277                      <ul>
 278                           <li><strong>Caching</strong>: Choose &quot;Yes&quot; to
 279                                allow for caching of certain elements within Mambo. This
 280                                will generally improve the performance of your site.</li>
 281                           <li><strong>Cache
 282                                Folder</strong>:&nbsp;This is the folder or directory to
 283                                store the cache files. This must be writable for this caching
 284                                to be successfully implemented. Contact your Web Master if
 285                                you have any difficulties.</li>
 286                           <li><strong>Cache Time</strong>: Edit
 287                                     the maximum length of time, in seconds, for a cache file
 288                                     to be stored before it is refreshed.</li>
 289                      </ul>
 290                      <p><strong>Statistics Tab</strong> </p>
 291                      <ul>
 292                           <li><strong>Statistics</strong>: Choose &#39;Yes&#39;,
 293                                to allow the browser and visitor domain statistics to be
 294                                collected on the basis of settings in&nbsp; the Content Tab.
 295                                You can then access the statistics, from&nbsp;Site -&gt; Statistics.</li>
 296                           <li><strong>Log
 297                                Content Hits by Date</strong>: Choose &quot;Yes&quot; to
 298                                enable logging of the hits on Content Items, on
 299                                a daily basis. Warning: This will tend to collect
 300                                masses of data over time. Be sure that your server
 301                                space has the space to to store this information.&nbsp;</li>
 302                           <li> <strong>Log
 303                                Search Strings</strong>: Choose &quot;Yes&quot; to enable
 304                                logging of the search text, entered by a user. Such logging
 305                                facilitates the &#39;tuning&#39; of your web site, giving
 306                                you an insight into how your visitors are trying to find
 307                                the information they seek. Analysis reporting is provided
 308                                under Site-&gt;Statistics-&gt;Search Text.</li>
 309                      </ul>
 310                      <p><strong>SEO Tab</strong> </p>
 311                      <ul>
 312                           <li><span ><strong>Search Engine Friendly
 313                                          URLs</strong>:&nbsp; This changes the way site
 314                                          links are presented and optimises them so that
 315                                          search engines can access more of your site. This
 316                                          option is ONLY available to sites hosted on Apache
 317                                          servers.&nbsp; Choose &#39;Yes&#39; to enable Mambo
 318                                          to output friendly URLs rather than normal database
 319                                          generated URLs. If you use this option you must
 320                           rename your htaccess.txt file to .htaccess.</span></li>
 321                           <li><span ><strong>Dynamic
 322                                               Page Titles</strong>: Choose &quot;Yes&quot; to
 323                                               set the page titles (that appear at the top of
 324                                               a viewers browser) to be the same as the page title
 325                           they are viewing. Again this helps search engines.NOTE: &nbsp;</span></li>
 326                      </ul>
 327            </div></td>
 328       </tr>
 329       <tr>
 330            <td align="right" valign="top" bgcolor="#EFEFEF" class="datalabel">Usage:</td>
 331            <td valign="top" class="data">n/a</td>
 332       </tr>
 333       <tr>
 334            <td align="right" valign="top" bgcolor="#EFEFEF" class="datalabel">Default State: </td>
 335            <td valign="top" class="data">n/a</td>
 336       </tr>
 337       <tr>
 338            <td align="right" valign="top" bgcolor="#EFEFEF" class="datalabel">Parameters:</td>
 339            <td valign="top" class="data"><ul>
 340                 <li><strong>Make unwritable
 341                           after saving</strong> Checking
 342                      this box will change the file permissions of configuration.php
 343                 to unwritable once you have applied your changes. </li>
 344            </ul></td>
 345       </tr>
 346       <tr>
 347            <td align="right" valign="top" bgcolor="#EFEFEF" class="datalabel">Toolbar Icons: </td>
 348            <td valign="top" class="data"><ul>
 349                 <li><strong>Save</strong>: Save your changes. </li>
 350                 <li><strong>Apply</strong>: Apply your changes to the site without
 351                      saving. </li>
 352                 <li><strong>Cancel</strong>: Cancel the present operation without
 353                      saving. </li>
 354            </ul></td>
 355       </tr></table>
 356  
 357  
 358  
 359  </body></html>