1.5 Template Project

The Joomla! Documentation Working Group is running a project to develop detailed reference and tutorial material on Joomla! 1.5 templates.  There is a project page on the documentation wiki where you can see the work in progress and help us by contributing your knowledge.

Who's Online

We have 3 guests online

Help Site License

The Joomla! Help Site content is copyright © 2005 - 2008 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution NonCommercial ShareAlike 2.5. Some parts of this website may be subject to other licenses.
Home arrow Help Screens arrow Help Screens :: Installers arrow Site Module: Edit [ Login Form ]

Site Module: Edit [ Login Form ] PDF Print E-mail

1012_doc_icon

Type:

com_modules /edit A

Access:

menu=>Modules=>Site Modules=>Module Manager=>Main Menu->edit

User Level:

Administrator; Super Administrator.

Screenshot:

module__login_ss login_display_ss
Site Module: Edit [ Login Form ] Login Form Display

Description:

Module Type: mod_login

The Login Module is the Registered Users way of gaining access to the additional Content of the web site not available to unregistered Guest.

The Module also provides links for a Guest to register with the web site (if set to be displayed, and allowed within the menu=>Site=>Global Configuration=>Site tab) and a separate link for existing Registered Users to recover their password if this has been forgotten.

Toolbar:

preview_save_apply_close_help

Preview: To check the appearance of the current Module in a browser-style window, click the Preview icon. A pop-up display page will appear. Close the pop-up by clicking anywhere upon it.

Save: Click Save to save any changes made during the current editing session, and return to the Module Manager screen.

Apply: Click Apply to save any changes made so far in the current session, but remain in the Module screen to continue editing. Once the editing session is complete click Save as above.

Close: Click Close at any point to end the current editing session and return to the Module Manager screen. Any changes made since the session commenced, or since the last time Apply was clicked, will be lost.

Help: Click the Help icon at any time to view this Help Screen.

Details:

Title: Enter a name for the Module being created. This will be displayed at the top of the Module display page - if the option to Show is selected below. The Page Title is also used by the Module Manager to identify it in its display list.

Show title: Select the No or Yes radio button to set whether the Title, entered above, will be displayed or not in the Front-end of the web site.

Position: Select the position in which this Module will be displayed, from the drop down list of all available Positions. These positions are determined by the Template in use and the menu=>Site=>Templates=>Module Positions screen.

Module Order: This option allows the place for this Module in the order of all Modules that are assigned to this Position in the Template to be set, and therefore its place in the Front-end display of the Template.

Access Level: Identify which User Group level can view this Module. Select from Public, Registered, or Special. See User Access Levels for further details on these.

ID: The unique Module Identification Number that Joomla! (MySQL) has assigned to the Module.

Published: Check this check box to Publish the Module. If there is no check mark in the check box, then the Category is Unpublished.

Description: Enter a description of the Module that explains its function in the open text field. The text will be displayed within the Administrator Back-end only and is for future reference purposes.

Parameters:

Max Name Length: Enter the maximum number of letters that are permitted to be used for the Template display name. The default is 20. Be aware that allowing an excessive number of letters may disrupt the display within the Module or of the Module itself.

Show Preview: Select Hide or Show to set whether the display preview image of the Template is shown or not. This function depends on there being an image thumbnail preview included with the Template files - check for an image titled template_thumbnail.png. This Module is unaffected by the setting in the Template Manager which Permits Template Previews.

Width: Enter the maximum width permitted for the preview image. The default size is 140 pixels (px). If the original image within the Template file is different to this it may create undesired effects and distort the image available to Users. If this happens either adjust the setting until it fits the Module, create a new image or scale resize and replace the current version in the Template folder.

Height: Enter the maximum height permitted for the preview image. The default size is 90 pixels (px). If the original image within the Template file is different to this it may create undesired effects and distort the image available to Users. If this happens either adjust the setting until it fits the Module, create a new image or scale resize and replace the current version in the Template folder.

Module Class Suffix: Enter the suffix for the CSS class of this module, for example: .moduletable-template. In this example, the -template is the suffix. This suffix class must currently be in the template CSS Style file. This allows individual CSS classes to be applied to certain modules independent of the site's default Template CSS classes.

Pre-text: This field allows a short message or instruction to be placed prior to the Username field in the Login Module. This might be used, for example, to welcome a guest and invite them to Login to the web site. By default this field is empty.

Post-text: This field allows a short message or instructions to be place after the New Registration link. This might be used, for example, to advise potential new registration submitters that they will receive an e-mail to complete the process. By default this field is empty.

Login Redirection URL: Enter the URL of a page that a Registered User will be redirected to after they login. By default this is the Front Page of the web site. The redirection might be used to display an information page, navigation page, or site map, for example.

Logout Redirection URL: Enter the URL of a page that a Registered User will be redirected to after they log out the web site. By default this is the Front Page of the web site but without any Registered or Special Content that they may previously have been able to view. The redirection might be used to display an information page , upcoming events page , or just a simple Good Bye message, for example.

Login Message: Select the No or Yes radio button to activate a pop up dialogue to confirm a successful log in. The Registered User is required to click a confirmation button before proceeding to the Login Redirection URL page.

Logout Message: Select the No or Yes radio button to activate a pop up dialogue to confirm a successful log out. The Registered User is required to click a confirmation button before proceeding to the Logout Redirection URL page.

Greeting: Select the No or Yes radio button to set whether the simple Greeting Message is displayed with the Username/Name in the Login Module following a successful login. By default this is set to Hi, username. The text that is displayed can be modified in the joomla_root/language/language_name.php file under the /** classes/html/usermenu.php */ field.

Name/Username: Select either Name or Username from the drop down list to set which of these will be displayed in the Login Module display, and used by other functions in the web site to identify the Registered User. By default this is set to Username.

Pages / Items:

Menu Item Links: Choose the Menu/Menu Item locations that this Module should be displayed on in the Front-end display of the web site if has been Published. In addition to individual pages it is possible to assign the Module as follows:

  • All - The Module will appear on every Menu/Menu Item location.
  • None - The Module will be active but not present on any Menu. It can however, be selected directly by a non-standard link.
  • Unassigned - Where a Content Item is not targeted by a specific Menu/Menu Item link select Unassigned for the Module to appear on that and all other unlinked pages.
note icon NOTE: Further clarity is being sought on the Menu / Menu Item options None & Unassigned.

Related Information:

Module Positions User Access Levels
Global Configuration - Site tab  

note icon NOTE: If you have any comments or suggestions regarding this Help screen then please post them in the Suggestions, Modifications, and Corrections forum in the User Documentation Work Group.

Thank you!

 

The User Documentation Team








Last Updated ( Monday, 09 April 2007 )
 
< Prev   Next >