Actions

Difference between revisions of "Help screen layout"

From Joomla! Documentation

(Undo revision 7160 by Dextercowley (Talk))
m (moved Layout helpscreen to Help screen layout: continuity of names, Help screen style guide, Help screen layout, etc.)
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{RightTOC}}
 +
A brief introduction or summary of the screen.
 
==How to access==
 
==How to access==
Navigate to the [[screen.modules.15|Module Manager]] and select . To create a new Module, click on the "New" button on the toolbar. To edit an existing Module, click on the Module Name or click on the checkbox for the Module and click on the Edit button in the toolbar.
+
Back-end, Article -> Section Manager
 +
Or click on the button 'Section Manager' at the Back-end main screen.
  
 
==Description==
 
==Description==
This is where you add new Modules or edit existing Modules for the front end of your Joomla! web site. When you install Joomla!, 20 Modules are included for use in the front end of your web site. Each of these has it's own application and it's own Parameters. These are documented below.
+
General description of the help screen.
  
 
==Screenshot==
 
==Screenshot==
[[Image:Module_new.png|frame|center]]
+
[[Image:thescreenshot.jpg]]
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 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===
+
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.
+
 
+
'''Module Parameters'''
+
[[Image:Archive_module_parameters1.png|frame|center]]
+
*'''Count.''' The number of Articles to display.
+
{{colheader|Module Class Suffix}}
+
 
+
'''Advanced Parameters'''
+
[[Image:Archive_module_parameters2.png|frame|center]]
+
{{colheader|Caching}}
+
 
+
===Banner===
+
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".
+
 
+
'''Module Parameters'''
+
[[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_module_parameters_advanced.png|frame|center]]
+
{{colheader|Caching}}
+
{{colheader|Cache Time}}
+
 
+
===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".
+
 
+
====Module Parameters====
+
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. Also, doing a Menu in this manner has the advantage of making the Breadcrumbs Module display in a hierarchical manner.
+
*'''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.
+
 
+
====Advanced Parameters====
+
[[Image:Menu_module_advanced_parameters.png|frame|center]]
+
*'''Show Whitespace.''' Whether or not to show whitespace in the rendered XHTML. Whitespace includes spaces, tabs, newlines, and other formatting characters that don't affect the XHTML content. Note that this setting does not affect the appearance of the page. It only affects the appearance of the XHTML source code (for example, if you look at the source code from your browser).
+
{{colheader|Caching}}
+
{{colheader|Menu Tag ID}}
+
{{colheader|Menu Class Suffix}}
+
{{colheader|Module Class Suffix}}
+
*'''Maximum Menu Depth.'''
+
 
+
====Other Parameters====
+
[[Image:Menu_module_other_parameters.png|frame|center]]
+
*'''Show Menu Images.''' Whether or not to show Menu Images for the Menu Items.
+
*'''Menu Image Alignment.''' Whether to align the images to the left or the right.
+
*'''Menu Image Link.''' Whether or not to have the image be a link to the Menu Item.
+
*'''Expand Menu.''' Whether or not to expand the menu so that all sub-menu items are always visible.
+
*'''Activate Parent.''' Whether or not to set the ID's of the parent Menu Items as active when a sub-menu choice is activated.
+
*'''Full Active Highlighting.''' Whether or not to enable activation of the Link - Article and Link - URL. Note that setting this to "Yes" can cause the loss of XHTML compliance if more than one item is active.
+
*'''Indent Image.''' What image will be shown for each indented sub-level of menu item. Options are:
+
**''Template.'' The Template will control the indenting images.
+
**''Joomla! default images.'' Joomla! default images for indenting will be used.
+
**''Use Parameters Below.'' Image file for each level 1 - 6 will be as indicated in the values below.
+
**''None.'' Images will not be indented.
+
*'''Indent Image 1 - 6.''' Select an image file from the drop-down list box for each of the sub-levels 1 - 6. The images are selected from the "images/M_images" folder.
+
 
+
===Most Read Content===
+
 
+
===NewsFlash===
+
 
+
===Poll===
+
 
+
===Random Image===
+
 
+
===Related Articles===
+
 
+
===Search===
+
 
+
===Sections===
+
 
+
===Statistics===
+
 
+
===Syndicate===
+
 
+
===Who's Online===
+
 
+
===Wrapper===
+
 
+
  
 
==Column Headers==
 
==Column Headers==
Line 233: Line 24:
  
 
Using modular templates; [[Toolbar_helpscreens]]
 
Using modular templates; [[Toolbar_helpscreens]]
 +
 +
==List Filters==
 +
Enter Search and filter options here.
  
 
==Function==
 
==Function==
Line 246: Line 40:
 
*Link 1.
 
*Link 1.
 
*Link 2.
 
*Link 2.
 +
 +
 +
:'''''Make sure you add a category!'''''
 +
 +
For example, '''<nowiki>[[Category:Joomla! 2.5]]</nowiki>''' will add the page to the category [[:Category:Joomla! 2.5|Joomla! 2.5]].
 +
 +
[[Category:Style guides|{{PAGENAME}}]]

Revision as of 07:27, 29 July 2012

Contents

A brief introduction or summary of the screen.

How to access

Back-end, Article -> Section Manager Or click on the button 'Section Manager' at the Back-end main screen.

Description

General description of the help screen.

Screenshot

File:Thescreenshot.jpg

Column Headers

In the table with .... displayed, you will see different columns. Here you can read what they mean and what is displayed in that column.

Using modular templates; Column_headers_helpscreens

Toolbar

At the top right you will see the toolbar:

File:Screenshot.toolbar.jpg

The functions are:

Using modular templates; Toolbar_helpscreens

List Filters

Enter Search and filter options here.

Function

If the Column Headers and Toolbar icons don't give enough information about the use of the screen, add this header.

Subject 
Description.

; Subject : Description.

Quick Tips

  • Tip 1.
  • Tip 2.

Related information

  • Link 1.
  • Link 2.


Make sure you add a category!

For example, [[Category:Joomla! 2.5]] will add the page to the category Joomla! 2.5.