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 17 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 1.0.12 :: Modules arrow Site Modules: New

Site Modules: New PDF Print E-mail

other.screensPlease note that at the present time a number of Help icons in Joomla! direct you to this Help Screen. In fact there are now separate Help Screens for these functions as follows: Admin Module: New

1012_doc_icon

Type:

com_modules

Access:

menu=>Modules=>Site Modules=>Module Manager->New

User Level:

Administrator; Super Administrator.

Screenshot:

module_manager_new
Module Manager: New

Description:

Module Type: custom

The Site Module: New function provides the opportunity to create a new (custom) Module, for the Front-end of the web site, directly within Joomla and without the need for programming skills or knowledge of the Joomla! code.

When clicked the resulting screen presents a series of options, primarily directed at creating an output display for RSS News Feeds from external web sites, but it is also suitable for creating a Module that will display Content that is not related to any existing Module or Menu Item for example. This does not include any Content that relates to Sections, Categories, or Static Content Items.

The Custom Module is not suited to complex functions and it is better for these to be created externally within an editor and packaged as necessary for uploading via the Module Installer.

Toolbar:

 preview_save_apply_cancel_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. If the current action was creating a new Module it will now have been saved, and will appear on the Module Manager list. In addition, the current session now becomes an Edit action rather than the Add action it was previously. Once the editing session is complete click Save as above.

Cancel: Clicking Cancel at any point ends the current creation session and returns the display to the Module Manager screen. Any changes made since the session commenced will be lost and the new Module will not have been created.

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.

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.

Parameters:

Module Class Suffix: This field can contain a suffix that will be applied to the CSS classes of this page. This allows individual Module styling with relative ease. For example, if the suffix .foo is entered here, all CSS code elements in the CSS file within the Template for Modules will have .foo added to them. table.moduletable becomes table.moduletable.foo. Separate entries would then need to be added in the CSS file of the Template, for each corresponding difference.

Enable Cache: Select No or Yes to set whether the Cache will be enabled for the content of this Module. If set to Yes this will speed up delivery of the content to a User as the information is held within the web server in a static web space rather than the database having to be queried for an update each time a request is made to view the content. For the web site, caching the information means there will be fewer requests being submitted to the database, and therefore the overall service of the web site is less affected by a high volume of requests having to be processed by the database.

Mambots: Select No or Yes to set whether Mambots - particularly Search Mambots - will be allowed access to the content of this Module.

RSS URL: Enter the URL of the RSS News Feed, of the external web site, that this Module is intended to display.

Title: Select No or Yes to set whether the Title of the News Feed (created by the originating site) will be shown in the Module.

Feed Description: Select No or Yes to set whether the Feed Description (created by the originating site) will be shown in the Module.

Feed Image: Select No or Yes to set whether the image, from the originating sites feed, will be displayed in the Module.

Items: Enter the number of the RSS News Feed Items available from the originating site that will be displayed within the Module. If the originating site transmits fewer Items than this setting, then this will be the number displayed.

Description: Select No or Yes to set whether the Module will display the Description text for each News Feed Item, if these are available, from the feed received from the originating web site.

Word Count: Choose the the maximum number of visible words available from the description of the New Item. 0 means all text will be displayed.

RSS Cache: Set the amount of time (in seconds) that a News Feed is stored in the web site cache before a further request is sent to the external site for an update, to get the latest News Feed entries.

The time value entered here depends on the type of site providing the feed. If a linked site only updates once a day, for example, then a higher setting can be made, whereas a feed from a dynamic web site for example, http://forum.joomla.org, whose content is rapidly changing would benefit from a more frequent refresh rate.

The following may be of use, although any figure can be entered:

  • 3,600 = 1 hour;
  • 86,400 = 1 day; (the default)
  • 604,800 = 1 week;
  • 2,419,200= 4 weeks;
  • 31,536,000 = 1 year!

Custom Output: The text editor field is provided to allow any text or code to be entered. The resulting output of any code will then be displayed together with any text that was entered, within the Module.

Related Information:

Syndicate Module

Module Manager [ Site ]

For further details on the types of RSS feed please see: http://en.wikipedia.org/wiki/RSS.

For further details on Mozilla Firefox Live Bookmarks visit: http://kb.mozillazine.org/index.php?title=Live_Bookmarks_-_Firefox&printable=yes


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 >