Actions

Help15

Difference between revisions of "Screen.system.info.15"

From Joomla! Documentation

(Points to Watch)
(Dependencies)
Line 8: Line 8:
  
  
==Dependencies==
 
{{Help screen dependencies placeholder}}
 
  
[[Category:DocCamp]]
 
  
 
==Version Changes==
 
==Version Changes==

Revision as of 06:24, 19 January 2008

Contents

Description

Description Placeholder

Enter a general overview of the functions of the screen under consideration. Use paragraph format type and do not add extra white space. Ensure that you use the correct styles for inline emphasis and notices.

Please remove this placeholder as soon as you start entering text here.





Version Changes

The primary difference between version 1.0 from version 1.5 is the number of tabs and how it's more broken up for a better understanding. In Joomla! 1.0, the Relevant PHP Settings was under the System Info tab but now they have there own tab for Joomla! 1.5 labeled as PHP Settings. Also moved to it's own tab is the Configuration File, which was originally under the System Info tab in Joomla! 1.0 but now under it's own tab titled Configuration File for Joomla 1.5.

Column Headers

System Info

PHP Built on: Provides details of the principle operating system which the web server that Joomla is running on.
Database Version: Provides the current version of the MySQL database being used by the installation of Joomla!.
Database Collation: How the MySQL databased is structured for the information used by Joomla!.
PHP Version: Provides the current version of PHP server side script that is being used for this installation of Joomla!.
Web Server: Provides the current type and version of web server which the installation of Joomla! is running on.
Web Server to PHP interface: The script that permits interaction between the web server (in most cases, Apache) and the PHP scripting language.
Joomla! Version: Provides the current version of Joomla!. It is recommended that it is always to to day and using the current stable release.
User Agent: The summary of the current user's local machine's operating system and browser information which is used to create an unique session ID for access and functionality within the Joomla! web site.

PHP Settings

These is the Relevant PHP Settings information (originally under the System Info tab of Joomla! 1.0) which are the general access and configuration requirements of specific PHP settings. If any of these is highlighted as incorrect should be taken care of to rectify the situation.

Configuration File

Originally under the System Info tab of Joomla! 1.0, this is the content of the current Joomla! configuration.php file which is stored under the main joomla_root/ directory. This file is created for you automatically when you first installed Joomla! and where most changes of the Global Configuration section of Joomla! are recorded. Please note that none of the settings can be changed from this page.

Directory Permissions

Originally labeled a Permissions in Joomla! 1.0, this shows you a list of directories that should have write access to. Please note that all directories listed on this page should say Writable, action would be needed if they're not writable.

PHP Information

The PHP Info Tab is the output of an integrated php.info script built into Joomla!. It displays the full configuration of the PHP server side scripting language that Joomla! runs on, together with all the associated system information that goes towards the creation of the web server.

PHP is installed, and runs on the server (hence the server side above), and therefore all the settings are made on the server. The visitor to the web site does not need to have anything special running on their local machine in order to view/use any of the extra functionality that PHP gives to the web site.

All the settings that are ever likely to be needed are displayed here. Any changes that are required would be made within the php.ini and other files on the web server.

How much control a web site owner has over this information depends on whether they own the server or if the server host is flexible in their customer approach.

It is a good practice to know the limitations of a particular server installation and this screens output is key to that information gathering operation.

For full details on the information contained within the PHP Info screen visit: http://php.net/phpinfo.

Typical Usage

Typical Usage Placeholder

This is the most important new section in these Help Screens. This is the meat on the bones of the Help Screen. This should represent the typical basic usage of the screens' functionality in normal use. Write it as a guide not just as a sequence of instructions - except when this is required. Include links to other screens that are needed to complete the function effectively. Use paragraph format type and do not add extra white space. Ensure that you use the correct styles for inline emphasis and notices.

Please remove this placeholder as soon as you start entering text here.

Quick Tips

Quick Tips Placeholder

Using the analogy of the previous section this is the sauce and condiments that go with the meat! Provide any one liners that may not normally be obvious. These may already be known to you or you may spot something within the forums or other publications. Just ensure they work and that the wording is consistent with the rest of the document and not a straight copy of the content from other sources. Use paragraph format type and do not add extra white space. Ensure that you use the correct styles for inline emphasis and notices.

Please remove this placeholder as soon as you start entering text here.

Points to Watch

Points to Watch Placeholder

Highlight known issues or easy traps that can be fallen into when using this function. Include references to known solutions rather than repeating the solutions here, unless considered essential. Even if there are none immediately apparent leave this section in the Help Screen - this message for future reference. Just replace this message with None Known at this Time. Use paragraph format type and do not add extra white space. Ensure that you use the correct styles for inline emphasis and notices.

Please remove this placeholder as soon as you start entering text here.

Dependencies

Dependencies Placeholder

Describe other screens that rely on the presence of this function or that this function relies upon, in order to work correctly for example: a Category depends upon the presence of a Section (up) and it must be in place before a Categorised Article (down) can be created. If there are no Dependencies either up or down for the particular screen just state None but do include the section. Use paragraph format type and do not add extra white space. Ensure that you use the correct styles for inline emphasis and notices. It will probably be sufficient to just list these and provide links to the Help Screens relating to the dependency.

Please remove this placeholder as soon as you start entering text here.