Help25

Difference between revisions of "Menus Menu Item Article Category List"

From Joomla! Documentation

m (inserted missing options)
(first draft)
Line 1: Line 1:
−
===Category List Layout===
+
{{inuse}}
−
Used to show articles belonging to one Category, in a list layout. A list layout lists each Article's Title and allows the User to link to the Article. An example is shown below:[[Image:category_list_layout_example.png|frame|center]]
+
==How To Access==
 +
To create a new Category List Menu Item:
 +
* Select Menus → [name of the menu] from the drop-down menu on the back-end of your Joomla! installation (for example, Menus → Main Menu).
 +
* Click New to create a new menu item or click on an existing item to edit.
 +
* Click the Menu Item Type Select button and then click the Category List link under Articles.
  
−
'''Parameters - Basic'''
+
To edit an existing Category List Menu Item, click its Title in Menu Manager: Menu Items.
−
The Category List Layout has the following Basic Parameters, as shown below.
 
−
[[Image:category_list_basic_parameters.png|frame|center]]
 
−
{{colheader|Category Parameter}}
 
−
{{colheader|Number of Links}}
 
−
{{colheader|Table Headings}}
 
−
{{colheader|Date Column}}
 
−
{{colheader|Date Format}}
 
−
{{colheader|Filter}}
 
−
{{colheader|Filter Field}}
 
  
−
'''Parameters - Advanced'''
+
==Description==
−
The Category List Layout has the following Advanced Parameters, as shown below.
+
Used to show articles belonging to a specific Category in a list layout.
−
[[Image:Category_list_advanced_parameters.png|frame|center]]
+
{{Chunk25:colheader|List Layout}}
−
{{colheader|Primary Order}}
+
 
−
*'''Pagination.''' Hide or Show Pagination support. Pagination provides page links at the bottom of the page that allow the User to navigate to additional pages. These are needed if the Articles will not fit on one page. An example is shown below.[[Image:blog_layout_pagination.png|frame|center]]The following options are available.
+
==Screenshot==
−
**''Use Global:'' Follows the setting in Article Manager Options >>> Shared Options.
+
[[File:Help25-article-category-list-screenshot.png|frame|none]]
−
**''Hide:'' Pagination links not shown. Note: In this case, Users will not be able to navigate to additional pages.
+
 
−
**''Show:'' Pagination links shown if needed.
+
==Column Headers==
−
**''Auto:'' Pagination links shown if needed.
+
 
−
*'''Display Select:''' Show or Hide the Display # drop-down list box. This allows you to limit the number of Articles listed on one page.
+
===Common Options===
−
{{colheader|Show a Feed Link}}
+
See [[Help25:Menus_Menu_Item_Manager_Edit|Menu Item Manager: New Menu Item]] for help on fields common to all Menu Item types, including Details, Link Type Options, Page Display Options, Metadata Options, and Module Assignments for this Menu Item.
 +
 
 +
===Required Settings===
 +
This layout requires that you select a category. This is done in the list box shown below.
 +
[[File:Help25-chunk-article-category-select-category.png|frame|none]]
 +
{{Chunk25:colheader|Choose a category}}
 +
 
 +
===Category Options===
 +
The Category Options control the way that category information is shown in the layout. The Category List Layout has the following Category Options, as shown below.
 +
[[Image:Help25-chunk-article-category-category-options.png|frame|none]]
 +
{{Chunk25:colheader|Category Title}}
 +
{{Chunk25:colheader|Category Description}}
 +
{{Chunk25:colheader|Category Image}}
 +
{{Chunk25:colheader|Subcategory Levels}}
 +
{{Chunk25:colheader|Empty Categories}}
 +
{{Chunk25:colheader|No Articles Message}}
 +
{{Chunk25:colheader|Subcategories Descriptions}}
 +
{{Chunk25:colheader|No Articles in Category}}
 +
{{Chunk25:colheader|Page Subheading}}
 +
 
 +
===List Layouts===
 +
List Layout Options control the appearance of the list layout.
 +
[[File:Help25-chunk-article-category-list-layout-options.png|frame|none]]
 +
{{Chunk25:colheader|Leading Articles}}
 +
{{Chunk25:colheader|Intro Articles}}
 +
{{Chunk25:colheader|No Columns}}
 +
{{Chunk25:colheader|No Links}}
 +
{{Chunk25:colheader|Multi Column Order}}
 +
{{Chunk25:colheader|Include Subcategories}}
 +
{{Chunk25:colheader|Category Order}}
 +
{{Chunk25:colheader|Article Order}}
 +
{{Chunk25:colheader|Date for Ordering}}
 +
{{Chunk25:colheader|Pagination}}
 +
{{Chunk25:colheader|Pagination Results}}
 +
 
 +
===Article Options===
 +
The Category List Layout has the following Article Options, as shown below. These options determine how the articles will show in the list layout.
 +
[[Image:Help25-article-featured-article-options.png|frame|none]]
 +
In addition to Yes/No or Hide/Show, these options allow the following settings.
 +
*''Use Global:'' Use the default value from [[Help25:Content_Article_Manager#Options|Article Manager Options]].
 +
 
 +
The Article Options are as follows.
 +
{{Chunk25:colheader|Show Title}}
 +
{{Chunk25:colheader|Linked Titles}}
 +
{{Chunk25:colheader|Show Intro Text}}
 +
{{Chunk25:colheader|Show Category}}
 +
{{Chunk25:colheader|Link Category}}
 +
{{Chunk25:colheader|Show Parent}}
 +
{{Chunk25:colheader|Link Parent}}
 +
{{Chunk25:colheader|Show Author}}
 +
{{Chunk25:colheader|Link Author}}
 +
{{Chunk25:colheader|Show Create Date}}
 +
{{Chunk25:colheader|Show Modify Date}}
 +
{{Chunk25:colheader|Show Publish Date}}
 +
{{Chunk25:colheader|Show Navigation}}
 +
{{Chunk25:colheader|Show Voting}}
 +
{{Chunk25:colheader|Show Read More}}
 +
{{Chunk25:colheader|Show Show Title with Read More}}
 +
{{Chunk25:colheader|Show Icons}}
 +
{{Chunk25:colheader|Show Print Icon}}
 +
{{Chunk25:colheader|Show Email Icon}}
 +
{{Chunk25:colheader|Show Hits}}
 +
{{Chunk25:colheader|Show Unauthorised Links}}
 +
 
 +
===Integration Options===
 +
The Featured Articles layout has the following Integration Options.
 +
[[File:Help25-chunk-integration-options.png‎|frame|none]]
 +
These determine whether a news feed will be available for the page and what information it will show.
 +
{{Chunk25:colheader|Show Feed Link}}
 +
{{Chunk25:colheader|For each feed item show}}
 +
 
 +
==Toolbar==
 +
At the top right you will see the toolbar:
 +
 
 +
[[File:Help25-chunk-menu-item-toolbar.png]]
 +
 
 +
The functions are:
 +
{{Chunk25:Help_screen_toolbar_icon_Save|menu item}}
 +
{{Chunk25:Help_screen_toolbar_icon_SaveAndClose|menu item}}
 +
{{Chunk25:Help_screen_toolbar_icon_SaveAndNew|menu item}}
 +
{{Chunk25:Help_screen_toolbar_icon_SaveAsCopy|menu item}}
 +
{{Chunk25:Help_screen_toolbar_icon_Cancel}}
 +
{{Chunk25:Help_screen_toolbar_icon_Help}}
 +
 
 +
==Quick Tips==
 +
* The Category List layout is a convenient way to list a compact directory of articles in a category that can include filtering and searching.
 +
 
 +
==Related Information==
 +
* To create a new Category see [[Help25:Components_Content_Categories_Edit|Category Manager: Add or Edit]].
 +
* To create a new menu see [[Help25:Menus_Menu_Manager|Menus Menu Manager]].
 +
 
 +
<noinclude>{{cathelp|2.5|Menu Item Manager|Menus}}</noinclude>

Revision as of 19:55, 16 April 2012

Quill icon.png
Page Actively Being Edited!

This help25 page is actively undergoing a major edit for a short while.
As a courtesy, please do not edit this page while this message is displayed. The user who added this notice will be listed in the page history. This message is intended to help reduce edit conflicts; please remove it between editing sessions to allow others to edit the page. If this page has not been edited for several hours, please remove this template, or replace it with {{underconstruction}} or {{incomplete}}.

How To Access[edit]

To create a new Category List Menu Item:

  • Select Menus → [name of the menu] from the drop-down menu on the back-end of your Joomla! installation (for example, Menus → Main Menu).
  • Click New to create a new menu item or click on an existing item to edit.
  • Click the Menu Item Type Select button and then click the Category List link under Articles.

To edit an existing Category List Menu Item, click its Title in Menu Manager: Menu Items.

Description[edit]

Used to show articles belonging to a specific Category in a list layout. Chunk25:Help screen column header List Layout

Screenshot[edit]

Help25-article-category-list-screenshot.png

Column Headers[edit]

Common Options[edit]

See Menu Item Manager: New Menu Item for help on fields common to all Menu Item types, including Details, Link Type Options, Page Display Options, Metadata Options, and Module Assignments for this Menu Item.

Required Settings[edit]

This layout requires that you select a category. This is done in the list box shown below.

Help25-chunk-article-category-select-category.png
  • Choose a category. Select one Category from the list box.

Category Options[edit]

The Category Options control the way that category information is shown in the layout. The Category List Layout has the following Category Options, as shown below.

Help25-chunk-article-category-category-options.png
  • Category Title. (Use Global/Hide/Show) Whether to hide or show the title of the category.
  • Category Description. (Use Global/Hide/Show) Description of this category, which can optionally be displayed in the front-end.
  • Category Image. (Use Global/Hide/Show) Whether to hide or show the category image.
  • Subcategory Levels. (Use Global/All/1-5) The number of levels of subcategories to show in the layout. Select All to show all levels in the subcategory hierarchy.
  • Empty Categories. (Use Global/Hide/Show) Whether to hide or show the categories that contain no content items or subcategories.
  • No Articles Message. (Use Global/Hide/Show) If set to Show, the message 'There are no articles in this category' will display when a category contains no articles.
  • Subcategories Descriptions. (Use Global/Hide/Show) Whether to hide or show the category description of subcategories.
  • # Articles in Category. (Use Global/Hide/Show) Whether to hide or show the count of articles in each category.
  • Page Subheading. Optional text to show as a page subheading.

List Layouts[edit]

List Layout Options control the appearance of the list layout.

Help25-chunk-article-category-list-layout-options.png
  • # Leading Articles. Number of Articles to show using the full width of the main display area. "0" means that no Articles will show when using the full width. If an Article has a "Read more..." break, only the part of the text before the break (the Intro text) will display. Leave blank to use the default value from the component options.
  • # Intro Articles. Determines the number of Articles to display after the leading Article. These Articles will display in the number of columns set in the Columns parameter below. If an Article has a "Read more..." break, only the text before the break (Intro text) will display, followed by a "Read more..." link. The order order in which to display the articles is determined by the Category Order and Article Order parameters below. Leave blank to use the default value from the component options.
  • # Columns. The number of columns to use in the Intro Text area. This is normally between 1 and 3 (depending on the template you are using). If 1 is used, the Into Text Articles will display using the full width of the display area, just like the Leading Articles. Leave blank to use the default value from the component options.
  • # Links. The number of Links to display in the 'Links' area of the page. These links allow a User to link to additional Articles, if there are more Articles than can fit on the first page of the Blog Layout. Leave blank to use the default value from the component options.
  • Multi Column Order. In multi-column blog layouts, whether to order articles Down the columns or Across the columns.
    • Use Global: Use the value from the component options screen.
    • Down: Order articles going down the first column and then over to the next column, for example:
article 1 1 (continued)
article 2 article 4
article 3 article 5
  • Across: Order articles going across the columns and then back to the first column, for example:
article 1 1 (continued)
article 2 article 3
article 4 article 5
  • Include Subcategories. (Use Global/None/All/1-5). If None, only articles from the current category will show. If 1-5, all articles from the current category and subcategories up to and including that level will show. If All, all articles from the current category and all subcategories will show.
  • Category Order. Order of Categories in this Layout. The following options are available.
    Help25-chunk-category-order.png
    • Use Global: Use the default value from the component options screen.
    • No Order: Articles are ordered only by the Article Order, without regard to Category.
    • Title Alphabetical: Categories are displayed in alphabetical order (A to Z)
    • Title Reverse Alphabetical: Categories are displayed in reverse alphabetical order (Z to A)
    • Category Manager Order: Categories are ordered according to the Order column entered in the Category Manager.
  • Article Order. Order of articles in this Layout. The following options are available.
    Help25-chunk-article-order.png
    • Use Global: Use the default value from the component options screen.
    • Featured Articles Order: Articles are ordered according to the Order column entered in Article Manager: Featured Article.
    • Most recent first: Articles are displayed starting with the most recent and ending with the oldest.
    • Oldest first: Articles are displayed starting with the oldest and ending with the most recent.
    • Title Alphabetical: Articles are displayed by Title in alphabetical order (A to Z)
    • Title Reverse Alphabetical: Articles are displayed by Title in reverse alphabetical order (Z to A)
    • Author Alphabetical: Articles are displayed by Author in alphabetical order (A to Z)
    • Author Reverse Alphabetical: Articles are displayed by Author in reverse alphabetical order (Z to A)
    • Most Hits: Articles are displayed by the number of hits, starting with the one with the most hits and ending with the one with the least hits
    • Least Hits: Articles are displayed by the number of hits, starting with the one with the least hits and ending with the one with the most hits
    • Article Manager Order: Articles are ordered according to the Order column entered in the Article Manager.
  • Date for Ordering. The date used when articles are sorted by date. The following options are available.
    • Use Global: Use the default value from the component options screen.
    • Created: Use the article created date.
    • Modified: Use the article modified date.
    • Published: Use the article start publishing date.
  • Pagination. Hide or Show Pagination support. Pagination provides page links at the bottom of the page that allow the User to navigate to additional pages. These are needed if the Articles will not fit on one page. An example is shown below.
    Help25-chunk-pagination.png
    The following options are available.
    • Use Global: Use the default value from the component options screen.
    • Auto: Pagination links shown if needed.
    • Show: Pagination links shown if needed.
    • Hide: Pagination links not shown. Note: In this case, Users will not be able to navigate to additional pages.
  • Pagination Results. Hide or Show the current page number and total pages (e.g., "Page 1 of 2") at the bottom of each page. Use Global will use the default value from the component options.

Article Options[edit]

The Category List Layout has the following Article Options, as shown below. These options determine how the articles will show in the list layout.

Help25-article-featured-article-options.png

In addition to Yes/No or Hide/Show, these options allow the following settings.

The Article Options are as follows.

  • Show Title. (Use Global/Hide/Show). Whether or not to show the Article's Title.
  • Linked Titles. (Use Global/No/Yes). If the Article's Title is shown, whether to show it as a link to the article.
  • Show Intro Text. (Hide/Show) Hide or Show an Article's Intro Text when the 'Read more...' link is selected. Intro Text is the part of the Article before a 'Read more...' break. If this parameter is 'Show', when the User selects the 'Read more...' link, the entire article will display, including the Intro Text. If this parameter is 'Hide', when the User selects the 'Read more...' link, only the part of the Article after the 'Read more...' link will display.
  • Show Category. (Use Global/Hide/Show). Whether or not to show the Article's Category.
  • Link Category. (Use Global/No/Yes). If the Article's Category is shown, whether to show it as a link to a Category layout (list or blog) for that Category.
  • Show Parent. (Use Global/Hide/Show). Whether or not to show the Article's Parent Category.
  • Link Parent. (Use Global/No/Yes). If the Article's Parent Category is shown, whether to show it as a link to a Category layout (list or blog) for that Category.
  • Show Author. (Use Global/Hide/Show) Whether to show the author of the Article.
  • Link Author. (Use Global/No/Yes). If the Article's author is shown, whether to show it as a link to a Contact layout for that author. Note that the author must be set up as a Contact in Contact Manager: Edit.
  • Show Create Date. (Use Global/Hide/Show). Whether or not to show the Article's create date.
  • Show Modify Date. (Use Global/Hide/Show). Whether or not to show the Article's modify date.
  • Show Publish Date. (Use Global/Hide/Show). Whether or not to show the Article's start publishing date.
  • Show Navigation. (Use Global/Hide/Show). Whether or not to show a navigation link (for example, Next or Previous article) when you drill down to the article.
  • Show Voting. (Use Global/Hide/Show). Whether or not to show the a voting icon for the article.
  • Show Read More. (Use Global/Hide/Show). Whether or not to show a "Read More" link to allow a drill down to the entire article.
  • Show Title with Read More. (Use Global/Hide/Show). If set to Show, the Article's title will show in the "Read More" button.
  • Show Icons. (Use Global/Hide/Show). If set to Show, Print and Email will use icons instead of text.
  • Show Print Icon. (Use Global/Hide/Show). Show or Hide the Print Article button.
  • Show Email Icon. (Use Global/Hide/Show). Show or Hide the Email Article button.
  • Show Hits. (Use Global/Hide/Show). Show or Hide the number of times the article has been hit (displayed by a user).
  • Show Unauthorised Links. (Use Global/No/Yes). If Yes, the Intro Text for restricted articles will show. Clicking on the "Read More" link will require users to log in to view the full article content.

Integration Options[edit]

The Featured Articles layout has the following Integration Options.

Help25-chunk-integration-options.png

These determine whether a news feed will be available for the page and what information it will show.

  • Show Feed Link. (Use Global/Hide/Show) Whether to Hide or Show a link to a news feed (RSS Feed). If set to Show, a Feed Link will show up as a feed icon in the address bar of most modern browsers).
  • For each feed item show. (Use Global/Intro Text/Full Text) If Intro Text, only the article's intro text will show in the feed. Otherwise, the entire text of the article will show.

Toolbar[edit]

At the top right you will see the toolbar:

Help25-chunk-menu-item-toolbar.png

The functions are:

  • Save. Saves the menu item and stays in the current screen.
  • Save & Close. Saves the menu item and closes the current screen.
  • Save & New. Saves the menu item and keeps the editing screen open and ready to create another menu item.
  • Save as Copy. Saves your changes to a copy of the current menu item. Does not affect the current menu item. This toolbar icon is not shown if you are creating a new menu item.
  • Cancel/Close. Closes the current screen and returns to the previous screen without saving any modifications you may have made.
  • Help. Opens this help screen.

Quick Tips[edit]

  • The Category List layout is a convenient way to list a compact directory of articles in a category that can include filtering and searching.

Related Information[edit]

Retrieved from "https://docs.joomla.org/index.php?title=Help25:Menus_Menu_Item_Article_Category_List&oldid=66629"