Actions

Help15

Difference between revisions of "Screen.modules.edit.15"

From Joomla! Documentation

(Menu: in process)
m (Reverted edits by Xhyuyu (talk) to last revision by JoomlaWikiBot)
 
(29 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{underconstruction}}
 
 
==How to Access==
 
==How to Access==
Navigate to the [[screen.modules.15|Module Manager]] and either press the "New" button on the toolbar or click on a Module Name.
+
Navigate to the [[screen.modules.15|Module Manager]]. To create a new Module, press the "New" button on the toolbar. To edit an existing Module, click on the Module Name or click on the Module's checkbox and press the Edit button on the toolbar.
  
 
==Description==
 
==Description==
This is where you create new Modules or edit existing Modules. When you create a new Module, you will select the Module Type. This will determine what type of content this Module can display. If you edit and existing Module, the Module Type will already be determined. Note that you cannot change the Module Type of an existing Module.
+
This is where you create new Modules or edit existing Modules. This screen has two links in the upper left: Site and Administrator. The Site link is selected by default. The Site link allows you to work with Modules that will be visible on your web site's Front-end. This is where you will place most of your Modules.
  
==Screenshot==
+
The Administrator link allows you to work with Modules that show on your web site's Back-end. In many cases, it is not necessary to modify the back-end Modules for Joomla!. All of the standard Joomla! administrator functions are available with no modifications here. You only need to make changes here if you want to change the standard administrator functions.
[[Image:Module_new.png|frame|center]]
+
Note that if you install one or more Joomla! Extensions, these Extensions may add new Module Types. In this case, your screen will show additional Types.
+
  
==Module Types==
+
When you create a new Module, you will select the Module Type. This will determine what type of content this Module can display. If you edit an existing Module, the Module Type will already be determined. Note that you cannot change the Module Type of an existing Module.
When a new Module is created, the Module:[New] screen displays all of the Module Types available for new new Module. A standard Joomla! installation includes 20 Module Types. These are described below.
+
  
===Archived Content===
+
For detailed information about each Module type for your web site, see the [[screen.modulessite.edit.15|Modules Site]] screen. For detailed information about modifying the Modules for the back end of your site, see [[screen.modulesadministrator.edit.15|Modules Administrator]].
This Module shows Articles that have been set to Archived. The Articles are available behind a Month/Year directory list, as shown in the example below.[[Image:Archive_module1.png|frame|center]] Selecting a month link shows a screen like the one below.[[Image:Archive_module2.png|frame|center]]
+
Articles are stored by creation date not archival date. Only those months and years with archived Articles will be displayed. This list is generated automatically.
+
  
The Module Type name for this is "mod_archive". This module does not relate to any other component. This Module provides functionality that is similar to the Archived Article List Layout available on the [[screen.menus.edit.15#Archived Article List|Menu Item Manager New / Edit]] screen.
+
All Modules have two sections that are the same: Details and Menu Assignment. The Parameters are different for each Module Type.
  
'''Module Parameters'''
+
==Screenshot==
[[Image:Archive_module_parameters1.png|frame|center]]
+
[[Image:Module new details.png]]
*'''Count.''' The number of Articles to display.
+
{{colheader|Module Class Suffix}}
+
  
'''Advanced Parameters'''
+
==Details==
[[Image:Archive_module_parameters2.png|frame|center]]
+
*'''Module Type.''' This displays the system name of the module. No entry is allowed.
{{colheader|Caching}}
+
*'''Title.''' The Title of the Module.
 +
*'''Show Title.''' Whether or not to show the Title of the Module.
 +
*'''Enabled.''' Whether or not the Module is enabled. If "No", the Module will not be shown on the page.
 +
*'''Position'''. The Position on the page to show the Module. There are two types of Positions you can use.
 +
*#You can select a Position from the drop-down list box. The Positions in the list box are those provided by your Template. You can see the available Positions on the page by adding the letters "?tp=1" to the end of any front-end Joomla! URL. For example, if your home page is "www.mysite.com", you can type the URL "www.mysite.com?tp=1". The page will display with labeled rectangles indicating each pre-defined Position for the current Template.
 +
*#You can type in a Position that is different from the pre-defined positions (for example, "myposition1"). This type of Position can be used to insert a Module into an Article. If you enter the code "{loadposition xxx}" inside the text of an Article, where "xxx" matches the Position of a Module, and if the Module is assigned to the the Menu Selection where the Article is displayed (see [[#Menu Assignment|Menu Assignment]] below), then the Module will be displayed at that point in the Article.
 +
*'''Order.''' The Order that this Module will be displayed within the Position. If more than one Module is displayed at the same position, this will determine the order of display. The drop-down list box shows all Modules displaying at the current Position. Select the Module that you want the current Module to ''follow''.
 +
**You can also change the order of display in the [[screen.modules.15|Module Manager]].
 +
**The Module Order is only important when two or more Modules are displaying at the ''same Position'' and on the s''ame Menu Selections''.
 +
{{colheader|Enter Access Level}}
 +
{{colheader|Id}}
 +
*'''Description.''' A description of what the Module does. No entry is allowed.
  
===Banner===
+
==Menu Assignment==
This Module allows you to show active Banners from the Banner Component created in the [[screen.banners.15|Banner Manager]] screen. The Module Type name for this is "mod_banners".
+
This is where you tell Joomla! which pages to show this Module on. This Module will show on the page when this Menu Item is selected. If the Menu Item allows the user to navigate to sub-pages, then this Module will also show on these sub-pages. For example, if the Menu item is a Blog Layout, the Module will also show when the user clicks on a "Read more..." link, an Article Link, or a Page Navigation link from that Blog Layout.
 +
*'''Menus.''' "All" means show the current Module on all Menu Items. "None" means don't show the Module on any Menu Items. "Select Menu Item(s) from the List" allows you to select which Menu Items to show the Module on.
 +
*'''Menu Selection.''' If "Select Menu Items(s) from the List" above is selected, select individual Menu Items that will display the Module.
 +
**Use Ctrl+Click to select multiple Menu Items.
 +
**Use Shift+Click to select a range of Menu Items.
 +
**If you want to select most of the Menu Items, first click "All" above under Menus and then click "Select Menu Items(s) from the List". All of the Menu Items will be selected. Then use Ctrl+Click to deselect the Menu Items you don't want to include.
  
'''Module Parameters'''
+
==Toolbar==
[[Image:Banner_module_parameters.png|frame|center]]
+
{{colheader|Target}}
+
*'''Count.''' The number of Banners to display.
+
*'''Banner Client.''' The Client for this Banner Module. Select from the drop-down list box of Banner Clients. Banner Clients are created in the [[screen.banners.client.15|Banner Client Manager]] screen.
+
*'''Category.''' The Category for this Banner Module. Select from the drop-down list box of Banner Categories. Banner Categories are created in the [[screen.bannercategories.15|Banner Category Manager]] screen.
+
*'''Search By Tags.''' Whether or not to select the Banner by matching the Banner Tags to the current Article keywords.
+
*'''Randomise.''' Sticky, Ordering / Sticky, Randomise. "Sticky, Ordering" means that the Banners will display in order. "Sticky, Randomise" means that the Banners will display in random order.
+
*'''Header Text.''' Text to display before the Banner group.
+
*'''Footer Text.''' Text to display after the Banner group.
+
{{colheader|Module Class Suffix}}
+
  
'''Advanced Parameters'''
+
[[Image:banner_edit_toolbar.png]]
[[Image:Banner_module_parameters_advanced.png|frame|center]]
+
{{toolbaricon|Save}}
{{colheader|Caching}}
+
{{toolbaricon|Apply}}
{{colheader|Cache Time}}
+
{{toolbaricon|Close}}
 
+
{{toolbaricon|Help}}
===Breadcrumbs===
+
This Module shows a set of navigation links that illustrates where you are inside the web site and allows you to navigate back. An example is shown below:[[Image:Breadcrumbs_example.png|frame|center]] The Module Type name for this is "mod_breadcrumbs". This Module does not relate to any other component.
+
 
+
'''Module Parameters'''
+
[[Image:Breadcrumbs_parameters.png|frame|center]]
+
*'''Show Home.''' Whether or not to show the Home page in the Breadcrumbs path.
+
*'''Text for Home entry.''' The text to display for the Home page in the Breadcrumbs.
+
*'''Text Serarator.''' The text to use to separate navigation elements. If blank, ">>" is used.
+
{{colheader|Module Class Suffix}}
+
 
+
'''Advanced Parameters'''
+
[[Image:Breadcrumbs_parameters_advanced.png|frame|center]]
+
*'''Caching.''' The only valid value is "Never".
+
{{colheader|Cache Time}}
+
 
+
===Custom HTML===
+
This allows you to create a Module that contains any valid HTML code. There are many cases where you might want to put free-form HTML inside a web page. For example, you might want to create an HTML Image Map or you might want to copy HTML code from PayPal, Amazon, or some other site.
+
 
+
The Custom HTML Module allows you to create a self-contained HTML unit and then put it in any valid location on a page.
+
 
+
'''Custom Output'''
+
 
+
When you create or edit a Custom HTML Module, an editor session is opened using your default editor.
+
 
+
:''Important Note:'' The TinyMCE editor does not allow you to enter certain HTML tags. To work around this, you can temporarily change your User's editor to "No Editor", create the Custom HTML Module, and then change the editor back to TinyMCE. Another option is to use an editor from an Extension that allows HTML code to be entered.
+
 
+
An example of a Custom HTML editor session is shown below. Note that the "No Editor" option is being used.[[Image:Custom_html_example.png|frame|center]]
+
 
+
'''Module Parameters'''
+
[[Image:Custom_html_parameters.png|frame|center]]
+
{{colheader|Module Class Suffix}}
+
 
+
===Feed Display===
+
This Module shows an RSS News Feed from a website. An example is shown below:[[Image:Newsfeed_module_example.png|frame|center]] The Module Type name for this Module is "mod_feed". This Module is not related to the News Feeds Component or the News Feeds Layouts in the [[Screen.menus.edit.15#Single Feed Layout|Menu Items - New/Edit]] screen but is an alternative that allows a feed to display in a Module position.
+
 
+
'''Module Parameters'''
+
[[Image:Newsfeed_parameters.png|frame|center]]
+
{{colheader|Module Class Suffix}}
+
*'''Feed URL.''' The URL address of the RSS news feed.
+
*'''RTL Feed''' Whether or not the feed is in a language that reads from right to left.
+
*'''Feed Title.''' Whether or not to display the Feed Title.
+
*'''Feed Description.''' Whether or not to display the Feed Description.
+
*'''Feed Image.''' Whether or not to display the Feed Image.
+
*'''Items.''' The number of news feed items to display.
+
*'''Item Description.''' Whether or not to show the Description or Into Text of individual items.
+
*'''Word Count.''' The maximum number of words to display in the Item Description. A value of 0 will display the entire Item Description.
+
 
+
'''Advanced Parameters'''
+
[[Image:Newsfeed_module_advanced.png|frame|center]]
+
{{colheader|Caching}}
+
{{colheader|Cache Time}}
+
 
+
===Footer===
+
This Module displays the web site copyright and Joomla! license information, as shown in the example below:
+
[[Image:Footer_module_example.png|frame|center]] The Module Type name for this Module is "mod_footer". It is not related to any other component.
+
 
+
'''Module Parameters'''
+
[[Image:Footer_parameters.png|frame|center]]
+
{{colheader|Caching}}
+
 
+
===Latest News===
+
This Module shows a list of the most recently published Articles. An example is shown below:[[Image:Latest_module_example.png|frame|center]]
+
 
+
The Module Type name for this is "mod_latest". It is not related to any other component.
+
 
+
'''Module Parameters'''
+
[[Image:Latest_parameters.png|frame|center]]
+
*'''Count.''' The number of Articles to show.
+
*'''Order.''' Recently Added First or Recently Modified First. Whether to show the Articles based on the date added or the date modified.
+
*'''Authors.''' Anyone, Added or modified by Me, or Not added or modified by me. Optional filter to limit the display to Articles based on whether they were authored or modified by the current user. Only applies if a user is logged in to the site.
+
*'''Front Page Articles.''' Show or Hide Articles published to the Front Page.
+
*'''Section ID.''' Optional filter to select Articles only from specific Sections. Include one or more Section ID numbers, separated by a comma (for example, "12,15").
+
*'''Category ID.''' Optional filter to select Articles only from specific Categories. Include one or more Category ID numbers, separated by a comma (for example, "12,15").
+
{{colheader|Module Class Suffix}}
+
[[Image:Latest_parameters_advanced.png|frame|center]]
+
 
+
===Login===
+
This Module displays a username and password Login form. It also displays a link to retrieve a forgotten password. An example is shown below:[[Image:Login_module_example.png|frame|center]]
+
The Module Type name for this is "mod_login". If User registration is enabled in the User Settings of the [[screen.config.15#User Settings|Global Configuration]] screen, then the link "Create an Account" will be shown to invite Users to self-register.
+
 
+
This module is not related to any other component. Similar functionality can also be provided with a Menu Item of type Default Login Layout. See the [[screen.menus.edit.15#Default Login Layout|Menu Item New/Edit]] screen for more information.
+
 
+
'''Module Parameters'''
+
[[Image:Login_module_parameters.png|frame|center]]
+
*'''Caching.''' Caching is not allowed, so "Never" is always selected.
+
{{colheader|Module Class Suffix}}
+
*'''Pre-text.''' Optional text or HTML to display above the login form.
+
*'''Post-text.''' Optional text or HTML to display below the login form.
+
*'''Login Redirection Page.''' The page to load after a successful login. Select from the drop-down list box. If no page is selected, the home page will be used.
+
*'''Logout Redirection Page.''' The page to load after a successful logout. Select from the drop-down list box. If no page is selected, the home page will be used.
+
*'''Greeting.''' Whether or not to show the simple greeting text, for example, "Hi Administrator".
+
*'''Name/Username.''' Whether to use the user's Name or Username in the simple greeting.
+
*'''Encrypt Login Form.''' Whether or not to encrypt the login form using SSL. Do not enable this option if Joomla! is not accessible using the "https://" prefix.
+
 
+
===Menu===
+
This Module allows you to place your Menus on the page. Every Joomla! website has at least one Menu that is created in the [[screen.menumanager.15|Menu Manager]] screen. The Menu Module allows you place all or part of the selected Menu at the desired position and on the desired web pages. The name for this Module is "mod_mainmenu".
+
 
+
The Menu Module has the following Module Paramters:
+
[[Image:Menu_module_parameters.png|frame|center]]
+
*'''Menu Name.''' The name of the Menu created in the [[screen.menumanager.15|Menu Manager]] screen. The default is "mainmenu". Note that you can have more than one Menu Module with the same Menu Name specified here (for example, if you are using Start and End Levels).
+
*'''Menu Style.''' The style of the menu. The options are as follows:
+
** ''List.'' Joomla! 1.5 List style. This is the style used by the menus in the Sample website.
+
** ''Legacy Vertical.'' Compatible with Joomla! 1.0 vertical style.
+
** ''Legacy Horizontal.'' Compatible with Joomla! 1.0 horizontal style.
+
** ''Legacy Flat List.'' Compatible with Joomla! 1.0 flat list style.
+
'''Start and End Levels'''
+
 
+
Start and End Levels can be used to display different parts of one menu at different locations. For example, say you have one Menu with three levels as follows:
+
:Menu Item 1
+
:Menu Item 2
+
::Menu Item 2.1
+
:::Menu Item 2.1.1
+
:::Menu Item 2.1.2
+
::Menu Item 2.2
+
:Menu Item 3
+
Using Start Level and End Level, you could show this one Menu as three different small menus on your pages. To do this, you would:
+
#Create a "Main" menu with a Start Level of 0 and End Level of 1. This Module would display on all Menu Selections.
+
#Your "Middle" Menu Module would have Start Level of 1 and End Level of 2. It would only display Menu Items 2.1 and 2.2. It could be placed at a different Position than the "Main" menu and might only display on Menu Selection pages for Menu Items 2, 2.1, 2.1.1, 2.1.2, and 2.2.
+
#The "Third" Menu Module would have Start Level of 2 and End Level of 3, so it would only display Menu Items 2.1.1 and 2.1.2. It could be placed at a different Position from the other Menu Modules. It might only have a Menu Assignment for the Menu Items 2.1, 2.1.1, and 2.1.2.
+
In this way, you can have one large, multi-level Menu but break it up into separate Modules.
+
*'''Start Level.''' Optional level to start the display of the Menu. Default is 0 for the Top Level.
+
*'''End Level.''' Optional level to end the display of the Menu. Default is 0, which will display all levels of the menu.
+
*'''Always show sub-menu Items.''' Whether or not to show sub-menu items when the parent is not active. If "No", a sub-menu Item will only display when the parent Item is clicked. If "Yes", sub-menu Items will always display in the menu.
+
*'''Target Position.''' Optional Javascript values, in pixels, to position a Popup window (for example, "top=50,left=50,width=200,height=300"). This is used in some templates to specify the location of drop-down or pop-up menus.
+
[[Image:Menu_module_other_parameters.png|frame|center]]
+
 
+
[[Image:Menu_module_advanced_parameters.png|frame|center]]
+
 
+
===Most Read Content===
+
 
+
===NewsFlash===
+
 
+
===Poll===
+
 
+
===Random Image===
+
 
+
===Related Articles===
+
 
+
===Search===
+
 
+
===Sections===
+
 
+
===Statistics===
+
 
+
===Syndicate===
+
 
+
===Who's Online===
+
 
+
===Wrapper===
+
 
+
==Column Headers==
+
 
+
==Toolbar==
+
  
 
==Quick Tips==
 
==Quick Tips==
 
* You can insert a Joomla! Module inside an Article by typing "{loadposition xxx}", where "xxx" is the position entered for the desired Module. Note that the position name must not conflict with a position used by your Joomla! template. It can be any name (e.g., "mymoduleposition1") as long as it matches the position name typed in for the Module. The Menu Assignment for the Module must include the Menu Item where the Article is displayed, and the Plugin called "Content - Load Module" must be enabled (which it is by default). This feature allows you, for example, to insert a Custom HTML Module anywhere in an Article. See [[screen.content.edit.15|Article Manager - New/Edit]] for information about adding and editing Articles.
 
* You can insert a Joomla! Module inside an Article by typing "{loadposition xxx}", where "xxx" is the position entered for the desired Module. Note that the position name must not conflict with a position used by your Joomla! template. It can be any name (e.g., "mymoduleposition1") as long as it matches the position name typed in for the Module. The Menu Assignment for the Module must include the Menu Item where the Article is displayed, and the Plugin called "Content - Load Module" must be enabled (which it is by default). This feature allows you, for example, to insert a Custom HTML Module anywhere in an Article. See [[screen.content.edit.15|Article Manager - New/Edit]] for information about adding and editing Articles.
 +
* You can easily change the order of display of Modules using the [[screen.modules.15|Module Manager]].
  
 
==Related Information==
 
==Related Information==
 +
*To see a description and Parameters for the different front-end Module types: [[screen.modulessite.edit.15|Modules Site]]
 +
*To see a description and Parameters for the different back-end Module types: [[screen.modulesadministrator.edit.15|Modules Administrator]]
 +
*To work with existing Modules: [[screen.modules.15|Module Manager]]
  
<noinclude>{{cathelp|1.5|Module Manager|Extensions}}</noinclude>
+
<noinclude>{{cathelp|1.5|Module Manager Help Screens|Extensions Help Screens}}</noinclude>

Latest revision as of 05:41, 11 October 2012

Contents

How to Access

Navigate to the Module Manager. To create a new Module, press the "New" button on the toolbar. To edit an existing Module, click on the Module Name or click on the Module's checkbox and press the Edit button on the toolbar.

Description

This is where you create new Modules or edit existing Modules. This screen has two links in the upper left: Site and Administrator. The Site link is selected by default. The Site link allows you to work with Modules that will be visible on your web site's Front-end. This is where you will place most of your Modules.

The Administrator link allows you to work with Modules that show on your web site's Back-end. In many cases, it is not necessary to modify the back-end Modules for Joomla!. All of the standard Joomla! administrator functions are available with no modifications here. You only need to make changes here if you want to change the standard administrator functions.

When you create a new Module, you will select the Module Type. This will determine what type of content this Module can display. If you edit an existing Module, the Module Type will already be determined. Note that you cannot change the Module Type of an existing Module.

For detailed information about each Module type for your web site, see the Modules Site screen. For detailed information about modifying the Modules for the back end of your site, see Modules Administrator.

All Modules have two sections that are the same: Details and Menu Assignment. The Parameters are different for each Module Type.

Screenshot

Module new details.png

Details

  • Module Type. This displays the system name of the module. No entry is allowed.
  • Title. The Title of the Module.
  • Show Title. Whether or not to show the Title of the Module.
  • Enabled. Whether or not the Module is enabled. If "No", the Module will not be shown on the page.
  • Position. The Position on the page to show the Module. There are two types of Positions you can use.
    1. You can select a Position from the drop-down list box. The Positions in the list box are those provided by your Template. You can see the available Positions on the page by adding the letters "?tp=1" to the end of any front-end Joomla! URL. For example, if your home page is "www.mysite.com", you can type the URL "www.mysite.com?tp=1". The page will display with labeled rectangles indicating each pre-defined Position for the current Template.
    2. You can type in a Position that is different from the pre-defined positions (for example, "myposition1"). This type of Position can be used to insert a Module into an Article. If you enter the code "{loadposition xxx}" inside the text of an Article, where "xxx" matches the Position of a Module, and if the Module is assigned to the the Menu Selection where the Article is displayed (see Menu Assignment below), then the Module will be displayed at that point in the Article.
  • Order. The Order that this Module will be displayed within the Position. If more than one Module is displayed at the same position, this will determine the order of display. The drop-down list box shows all Modules displaying at the current Position. Select the Module that you want the current Module to follow.
    • You can also change the order of display in the Module Manager.
    • The Module Order is only important when two or more Modules are displaying at the same Position and on the same Menu Selections.
  • Access Level. Who has access to this item. Current options are:
    • Public: Everyone has access
    • Registered: Only registered users have access
    • Special: Only users with author status or higher have access
Enter the desired level using the drop-down list box.
  • ID. The ID number. This is a unique identification number for this item assigned automatically by Joomla!. It is used to identify the item internally, for example in internal links. You can not change this number.
  • Description. A description of what the Module does. No entry is allowed.

Menu Assignment

This is where you tell Joomla! which pages to show this Module on. This Module will show on the page when this Menu Item is selected. If the Menu Item allows the user to navigate to sub-pages, then this Module will also show on these sub-pages. For example, if the Menu item is a Blog Layout, the Module will also show when the user clicks on a "Read more..." link, an Article Link, or a Page Navigation link from that Blog Layout.

  • Menus. "All" means show the current Module on all Menu Items. "None" means don't show the Module on any Menu Items. "Select Menu Item(s) from the List" allows you to select which Menu Items to show the Module on.
  • Menu Selection. If "Select Menu Items(s) from the List" above is selected, select individual Menu Items that will display the Module.
    • Use Ctrl+Click to select multiple Menu Items.
    • Use Shift+Click to select a range of Menu Items.
    • If you want to select most of the Menu Items, first click "All" above under Menus and then click "Select Menu Items(s) from the List". All of the Menu Items will be selected. Then use Ctrl+Click to deselect the Menu Items you don't want to include.

Toolbar

Banner edit toolbar.png

  • Save. Save it and return to editing the menu details.
  • Apply. Save it, but stay in the same screen. If you have been working on a screen for a long time and don't want to risk losing your work, pressing Apply saves your work and lets you continue working. If, for example, you lost your Internet connection, your work will be saved up this point.
  • Close. Return to the previous screen without saving your work. If you press Close while adding a new item, this new item will not be created. If you were modifying an existing item, the modifications will not be saved.
  • Help. Opens this Help Screen.

Quick Tips

  • You can insert a Joomla! Module inside an Article by typing "{loadposition xxx}", where "xxx" is the position entered for the desired Module. Note that the position name must not conflict with a position used by your Joomla! template. It can be any name (e.g., "mymoduleposition1") as long as it matches the position name typed in for the Module. The Menu Assignment for the Module must include the Menu Item where the Article is displayed, and the Plugin called "Content - Load Module" must be enabled (which it is by default). This feature allows you, for example, to insert a Custom HTML Module anywhere in an Article. See Article Manager - New/Edit for information about adding and editing Articles.
  • You can easily change the order of display of Modules using the Module Manager.

Related Information

  • To see a description and Parameters for the different front-end Module types: Modules Site
  • To see a description and Parameters for the different back-end Module types: Modules Administrator
  • To work with existing Modules: Module Manager