Actions

Template

Relatedhelp

From Joomla! Documentation

Revision as of 16:45, 20 December 2012 by Tom Hutchison (Talk | contribs)

Info non-talk.png
General Information

No related Help Screens were found, please check the documentation for Related Help Template page for proper usage. Examples of use can be found in the template documentation.

[view] [edit] [history]

Template-info.pngTemplate documentation

Contents


Functions/Features

This template will allow related help screens, with a table of links and page descriptions to be called easily while suppressing the current page's name. This template uses the DPL extension and is a requirement for it to function properly.

Automatic Namespace detection, intended for use on Help Screen namespaces. Could be used on other Namespaces, but the results may not be expected as the template is looking for the 'Description' section of pages for inclusion.

Usage

{{relatedhelp|newsfeed}}
Related Help Screens Description
Components Newsfeeds Categories

News Feed Categories allow you to categorize different website feeds entering your site for better organization.

Components Newsfeeds Categories Edit

The New/Edit page for the News Feeds Category Manager is a create/edit screen that allows website administrators to create or edit News Feed Categories. Categories allow a broken down structure of News Feeds. You must have at least one category before you can create any News Feeds!

Components Newsfeeds Feeds

The News Feed Manager screen allows you to add News Feeds from other sites to your Joomla! site. You can add links to these feeds for users by creating News Feed layouts in Menu Item Manager - New/Edit.

Components Newsfeeds Feeds Edit

This is where you add a new News Feed or edit an existing one. Note that you need to create at least one News Feed Category before you can create your first News Feed.

Menus Menu Item Newsfeed Categories

Used to show a list of all RSS News Feed Categories. Categories are shown in a hierarchical list, as shown below. Depending on the selected options for this layout, you can click on a category Title to show the News Feeds in that category.

Menus Menu Item Newsfeed Category

Used to show a list of all RSS News Feeds in a Category. Depending on the selected options for this layout, you can include subcategories of a News Feed category.

Menus Menu Item Newsfeed Single Newsfeed

Used to show a single RSS News Feed. The News Feed is selected from the list of News Feeds created in New/Edit News Feeds.

{{relatedhelp|article}}
Related Help Screens Description
Components Article Manager Options

Used to set global defaults for menu items that display articles. These default values will be used when "Use Global" is selected for an option in an Articles menu item. For example, to show the 'Create Date' for an article in your Articles menu items, then set that option to "Show" here and it will be the default value. You do not need to set any of these options. Your Joomla site will work with the default settings.

Content Article Manager

The Article Manager is used to find, mark featured, add and edit articles. See Toolbar below for a detailed list of all functions.

Content Article Manager Edit

This is the back-end screen where you can add and edit Articles. The same screen is used for adding a new Article and editing an existing Article. You can also select the Section and Category for an Article and indicate whether or not it is Published and if it is selected to appear on the Front Page.

The Article's content is edited using the default editor selected in the User Manager - New/Edit. The Joomla! default editor is called TinyMCE.

A number of Parameters can be set for the Article. Metadata can also be entered.

Content Featured Articles

Used to control which 'Featured Articles are displayed on the Front Page and in what order they are displayed. The Front Page is often the Home page of a web site, but it can be any page in the site. The Front Page is created using a Menu Item with the Front Page layout.

Extensions Module Manager Articles Archive

This module shows a list of the calendar months containing archived articles. After you have changed the status of an article to archived, this list will be automatically generated.

Extensions Module Manager Articles Categories

This module displays a list of articles from one or more categories.

Extensions Module Manager Articles Category

This module displays a list of published articles from one or more categories.

Extensions Module Manager Articles Newsflash

The Article Newsflash Module will display a fixed number of Articles from a specific Category or a set of Categories.

Extensions Module Manager Articles Related

This Module shows a list of Articles that are related to the current Article being viewed by the user (for example, a Article Layout or a Blog or List layout where the user has clicked on an Article link). Articles are considered to be related to each other if they share at least one Keyword in the Article's Metadata Information. Article Keywords are entered in the Metadata Information section of the Article Manager - New/Edit screen.

Menus Menu Item Article Archived

Used to show a list of Archived Articles. The Archived Article list can be displayed by date, filtered, and intro text added as shown below.

Menus Menu Item Article Categories

Used to show a list of Categories. Categories are shown in a hierarchical list, as shown below. Depending on the selected options for this layout, you can click on a category Title to show the articles in that category.

Menus Menu Item Article Category Blog

Used to show articles belonging to a specific Category in a blog layout. Controls the Introduction or Leading Article, additional Articles with intro text, and additional links to more Articles in the same category. Some examples of settings for the Blog Layout format include: number of articles, article columns, across or down layouts, and number of additional links. See the Advanced Details Tab for all this menu item.

Menus Menu Item Article Category List

Used to show articles belonging to a specific Category in a list layout.

Menus Menu Item Article Create

Allows users to submit an article. Normally this is available only to users who have logged in to the front end of the site. Users must have permission to create articles. When the Create Article page is shown in the front end, the screen shows as examples in the following Front End Screenshots section.

Menus Menu Item Article Featured

Used to show all Articles that have been tagged as Featured. Articles are shown in a Blog Layout.

Menus Menu Item Article Single Article

Used to show one article in the front end of the site.

Use of not= to not include Help screens with a word or phrase.
{{relatedhelp|article|not=menu}}
Related Help Screens Description
Components Article Manager Options

Used to set global defaults for menu items that display articles. These default values will be used when "Use Global" is selected for an option in an Articles menu item. For example, to show the 'Create Date' for an article in your Articles menu items, then set that option to "Show" here and it will be the default value. You do not need to set any of these options. Your Joomla site will work with the default settings.

Content Article Manager

The Article Manager is used to find, mark featured, add and edit articles. See Toolbar below for a detailed list of all functions.

Content Article Manager Edit

This is the back-end screen where you can add and edit Articles. The same screen is used for adding a new Article and editing an existing Article. You can also select the Section and Category for an Article and indicate whether or not it is Published and if it is selected to appear on the Front Page.

The Article's content is edited using the default editor selected in the User Manager - New/Edit. The Joomla! default editor is called TinyMCE.

A number of Parameters can be set for the Article. Metadata can also be entered.

Content Featured Articles

Used to control which 'Featured Articles are displayed on the Front Page and in what order they are displayed. The Front Page is often the Home page of a web site, but it can be any page in the site. The Front Page is created using a Menu Item with the Front Page layout.

Extensions Module Manager Articles Archive

This module shows a list of the calendar months containing archived articles. After you have changed the status of an article to archived, this list will be automatically generated.

Extensions Module Manager Articles Categories

This module displays a list of articles from one or more categories.

Extensions Module Manager Articles Category

This module displays a list of published articles from one or more categories.

Extensions Module Manager Articles Newsflash

The Article Newsflash Module will display a fixed number of Articles from a specific Category or a set of Categories.

Extensions Module Manager Articles Related

This Module shows a list of Articles that are related to the current Article being viewed by the user (for example, a Article Layout or a Blog or List layout where the user has clicked on an Article link). Articles are considered to be related to each other if they share at least one Keyword in the Article's Metadata Information. Article Keywords are entered in the Metadata Information section of the Article Manager - New/Edit screen.

Parameters

Parameter Parameter description req./opt.
{{{1}}} common title name fragment required
{{{not}}} common title name fragment optional

Known Issues

  • Should be used in Help Screen namespaces.
  • Title fragment, pay attention to plurals. 'Article' may yield more than 'articles' when used. To single out a word, and only a full word use underscore to force a space before and after, example: _word_.