Help310

Difference between revisions of "Extensions Module Manager Articles Categories"

From Joomla! Documentation

m
 
(83 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{RightTOC}}
+
<noinclude><languages /></noinclude>
==How to Access==
 
To ''''add'''' a new Articles Categories module or ''''edit'''' an existing Articles Categories module, navigate to the [[Help25:Extensions_Module_Manager|Module Manager]]:
 
* Select {{rarr|Extensions,Module Manager}}
 
  
Click the ''''New'''' button and click on Articles Categories in the modal popup window.
+
{{Chunk30:Help_screen_Description_Header/<translate><!--T:33--> en</translate>}}
 +
{{Chunk30:Extensions_Module_Manager_Articles_Categories_Description/<translate><!--T:30--> en</translate>}}
  
To ''''Edit'''' an existing Articles Categories module, in the Module Manager click on an '''Articles Categories Modules Title''' or click the '''Articles Categories modules check box''' and then click the '''Edit''' button in the Toolbar.
+
{{Chunk30:Help_screen_How_To_Access_Header/<translate><!--T:34--> en</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_Module_Add/<translate><!--T:36--> en</translate>|<translate><!--T:37--> Articles - Categories</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_By_Menu/<translate><!--T:38--> en</translate>|<translate><!--T:39--> Extensions,Modules</translate>}}.
 +
{{Chunk30:Help_screen_How_To_Access_By_Button/<translate><!--T:40--> en</translate>|<translate><!--T:41--> New</translate>|<translate><!--T:42--> toolbar</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_Module_Select/<translate><!--T:43--> en</translate>|<translate><!--T:44--> Articles - Categories</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_Module_Edit/<translate><!--T:45--> en</translate>|<translate><!--T:46--> Articles - Categories</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_Module_By_Title/<translate><!--T:47--> en</translate>}}
  
==Description==
+
{{Chunk30:Help_screen_Screenshot_Header/<translate><!--T:35--> en</translate>}}
This module displays a list of articles from one or more categories.
+
[[File:help-3x-modules-site-module-manager-module-articles-categories-<translate><!--T:19--> en</translate>.png|800px|border]]
  
==Screenshot==
+
{{Chunk30:Help_screen_Form_Header/<translate><!--T:48--> en</translate>}}
[[Image:Help30-Extensions-Module-Manager-Articles-Categories-screen.png]]
+
{{Chunk30:Help_screen_Module_Title/<translate><!--T:128--> en</translate>}}
 +
{{Chunk30:Help_screen_Form_Module_Header/<translate><!--T:78--> en</translate>}}
 +
<translate><!--T:23--> This module displays a list of categories from one parent category.</translate>
 +
<translate><!--T:24--> *'''Parent Category'''. Select a parent category.</translate>
  
==Details==
+
<translate><!--T:25--> *'''Category Descriptions'''. (''Yes''/''No'') Show or hide category descriptions.</translate>
  
===Basic Options===
+
<translate><!--T:26--> *'''Show Number of Articles'''. (''Yes''/''No'') Show or hide Number of articles.</translate>
[[Image:Extensions-Module-Manager-Articles-Categories-basic-options-parameters.png]]
 
*'''Count.''' The number of Sections to display. The default value is 5.
 
{{colheader|Module Class Suffix}}
 
  
===Advanced Options===
+
<translate><!--T:27--> *'''Show Subcategories'''. (''Yes''/''No'') Show or hide Subcategories.</translate>
[[Image:Extensions-Module-Manager-Articles-Categories-advanced-options-parameters.png]]
 
{{colheader|Caching}}
 
{{colheader|Cache Time}}
 
  
===Menu Assignment===
+
<translate><!--T:28--> *'''# First Subcategories'''. (''All''/''1''/''2''/''3''/''4''/''5''/''6''/...). Select here the number of first level subcategories to display. Default is All.</translate>
{{Chunk30:Menu Assignment}}
 
  
==Toolbar==
+
<translate><!--T:29--> *'''Maximum Level Depth'''. (''All''/''1''/''2''/''3''/''4''/''5''/''6''/...). Select here the maximum level depth for each subcategory. Default is All.</translate>
{{Chunk30:Help_screen_module_manager_edit_toolbar}}
+
----
 +
:[[File:Help30-module-manager-details-screenshot-<translate><!--T:141--> en</translate>.png|265px|border|right|<translate><!--T:142--> Module sidebar</translate>]]
 +
{{Chunk30:Help_screen_Module_Show_Title/<translate><!--T:143--> en</translate>}}
 +
{{Chunk30:Help_screen_Module_Position/<translate><!--T:144--> en</translate>}}
 +
{{Chunk30:Help_screen_Status/<translate><!--T:145--> en</translate>|2=}}
 +
{{Chunk30:Help_screen_Start_Publishing/<translate><!--T:135--> en</translate>}}
 +
{{Chunk30:Help_screen_Finish_Publishing/<translate><!--T:136--> en</translate>}}
 +
{{Chunk30:Help_screen_Access/<translate><!--T:137--> en</translate>}}
 +
{{Chunk30:Help_screen_Module_Ordering/<translate><!--T:138--> en</translate>}}
 +
{{Chunk30:Help_screen_Language/<translate><!--T:139--> en</translate>}}
 +
{{Chunk30:Help_screen_Note/<translate><!--T:140--> en</translate>}}
 +
{{Chunk30:Help_screen_Form_Module_Menu_Assignment/<translate><!--T:93--> en</translate>}}
 +
:[[File:Help30-module-manager-menu-assignment-screenshot-<translate><!--T:94--> en</translate>.png|800px|none]]
 +
{{Chunk30:Help_screen_Module_Menu_Assignment/<translate><!--T:95--> en</translate>}}
 +
{{Chunk30:Help_screen_Form_Advanced_Header/<translate><!--T:121--> en</translate>}}
 +
:[[File:Help30-module-manager-advanced-options-categories-screenshot-<translate><!--T:97--> en</translate>.png|300px|none]]
 +
{{Chunk30:Help_screen_Module_Layout/<translate><!--T:98--> en</translate>}}
  
==Front End Screenshot==
+
<translate><!--T:125--> *'''Heading Style'''. (''h1''/''h2''/''h3''/''h4''/''h5'') Set the heading style to use.</translate>
{{Chunk30:Help screen screenshot disclaimer}}
+
{{Chunk30:Help_screen_Module_Class_Suffix/<translate><!--T:100--> en</translate>}}
Articles Categories module shown:
+
{{Chunk30:Help_screen_Caching/<translate><!--T:101--> en</translate>}}
 +
{{Chunk30:Help_screen_Cache_Time/<translate><!--T:102--> en</translate>}}
 +
{{Chunk30:Help_screen_Module_Tag/<translate><!--T:103--> en</translate>}}
 +
{{Chunk30:Help_screen_Bootstrap_Size/<translate><!--T:104--> en</translate>}}
 +
{{Chunk30:Help_screen_Header_Tag/<translate><!--T:105--> en</translate>}}
 +
{{Chunk30:Help_screen_Header_Class/<translate><!--T:106--> en</translate>}}
 +
{{Chunk30:Help_screen_Module_Style/<translate><!--T:107--> en</translate>}}
 +
{{Chunk30:Help_screen_Form_Permissions_Header/<translate><!--T:57--> en</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Manage/<translate><!--T:58--> en</translate>}}
 +
:[[File:Help30-module-manager-menu-permissions-screenshot-<translate><!--T:59--> en</translate>.png|800px|none]]
 +
{{Chunk30:Help_screen_Permissions_Change/<translate><!--T:60--> en</translate>|<translate><!--T:61--> this module</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Select_Group/<translate><!--T:62--> en</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Find_Action/<translate><!--T:63--> en</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Delete/<translate><!--T:64--> en</translate>|<translate><!--T:65--> this module</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Edit/<translate><!--T:66--> en</translate>|<translate><!--T:67--> this module</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Edit_State/<translate><!--T:68--> en</translate>|<translate><!--T:69--> this module</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Frontend_Editing/<translate><!--T:70--> en</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Select/<translate><!--T:71--> en</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Inherited/<translate><!--T:72--> en</translate>|<translate><!--T:73--> this site</translate>|<translate><!--T:74--> module options</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Allowed/<translate><!--T:122--> en</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Denied/<translate><!--T:123--> en</translate>}}
 +
{{Chunk30:Help_screen_Permissions_Save/<translate><!--T:124--> en</translate>}}
  
[[Image:Help30-module-manager-articles-categories-frontend-screenshot.png]]
+
{{Chunk30:Help_screen_Toolbar_Header/<translate><!--T:49--> en</translate>}}
 +
{{Chunk30:Help_screen_Toolbar_Position/<translate><!--T:108--> en</translate>}}
 +
:[[File:Help32-Save-SaveClose-SaveNew-SaveAsCopy-Close-toolbar-<translate><!--T:109--> en</translate>.png|800px|none]]
 +
{{Chunk30:Help_screen_Toolbar_Function/<translate><!--T:110--> en</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Save/<translate><!--T:111--> en</translate>|<translate><!--T:112--> module</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_SaveAndClose/<translate><!--T:113--> en</translate>|<translate><!--T:114--> module</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_SaveAndNew/<translate><!--T:115--> en</translate>|<translate><!--T:116--> module</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_SaveAsCopy/<translate><!--T:117--> en</translate>|<translate><!--T:118--> module</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Close/<translate><!--T:119--> en</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Help/<translate><!--T:120--> en</translate>}}
  
The Module Type name for this Module is "mod_articles_categories". It is related to the content component.
+
{{Chunk30:Help_screen_Related_Information_Header/<translate><!--T:50--> en</translate>}}
 +
{{Chunk30:Extensions_Module_Manager_Related_Information/<translate><!--T:52--> en</translate>}}
  
<noinclude>{{cathelp|3.0,3.1|Module Manager Help Screens|Extensions Help Screens}}</noinclude>
+
<noinclude>{{cathelp|3.0,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9,3.10|Module Manager Help Screens|Extensions Help Screens}}</noinclude>

Latest revision as of 04:50, 28 March 2022

Other languages:
Deutsch • ‎English • ‎français


Description[edit]

This module displays a list of categories from one parent category.


How to Access[edit]

Add a new module 'Articles - Categories'

  • Select Extensions  Modules from the dropdown menu of the Administrator Panel.
  • Click the New button in the toolbar
  • Select the Module Type Articles - Categories.

Edit an existing module 'Articles - Categories'

  • Click on the module's Title in Module.


Screenshot[edit]

Help-3x-modules-site-module-manager-module-articles-categories-en.png


Form Fields[edit]

  • Title. The title of the module. This is also the title displayed in the Frontend for the module.

Module[edit]

This module displays a list of categories from one parent category.

  • Parent Category. Select a parent category.
  • Category Descriptions. (Yes/No) Show or hide category descriptions.
  • Show Number of Articles. (Yes/No) Show or hide Number of articles.
  • Show Subcategories. (Yes/No) Show or hide Subcategories.
  • # First Subcategories. (All/1/2/3/4/5/6/...). Select here the number of first level subcategories to display. Default is All.
  • Maximum Level Depth. (All/1/2/3/4/5/6/...). Select here the maximum level depth for each subcategory. Default is All.

Module sidebar
  • Show Title. (Show/Hide) Show or hide module title on display. Note: Effect will depend on the module style (chrome) in the template.
  • Position. You may select a module position from the list of pre-defined positions or enter your own module position by typing the name in the field and pressing enter.
  • Status. (Published/Unpublished/Trashed) The published status of the module.
  • Start Publishing. Date and time to start publishing. Use this field if you want to enter content ahead of time and then have it published automatically at a future time.
  • Finish Publishing. Date and time to finish publishing. Use this field if you want to have content automatically changed to Unpublished state at a future time (for example, when it is no longer applicable).
  • Access. Who has access to this module.
    • Public: Everyone has access.
    • Guest: Everyone has access.
    • Registered: Only registered users have access.
    • Special: Only users with author status or higher have access.
    • Super Users: Only super users have access.
  • Ordering. This shows a dropdown of every module in the position that the current module is in. This is the order that the modules will display in when displayed on in the Frontend as well as in Modules.
  • Language. Select the language for this module. If you are not using the multi-language feature of Joomla, keep the default of All.
  • Note. Module note. This is normally for the site administrator's use (for example, to document information about this module) and does not show in the Frontend of the site.

Menu Assignment[edit]

Help30-module-manager-menu-assignment-screenshot-en.png
  • Module Assignment.
    • On all pages: Module is shown on all pages.
    • No pages: Module is not shown on any page.
    • Only on the pages selected: 'Menu Selection' will show with all the menu items on. You can assign modules by selecting the menu links that you want the module associated with on what pages modules appear.
    • On all pages except those selected: 'Menu Selection' list will show with all the menu items on. This allows you to assign modules by selecting the menu links that you want the module associated with on what pages modules don't appear.
    Learn how to assign a module to specific pages.

Advanced[edit]

Help30-module-manager-advanced-options-categories-screenshot-en.png
  • Layout. If you have defined one or more alternative layouts for a module either in the template or Joomla Core, you can select the layout to use for this module.
  • Heading Style. (h1/h2/h3/h4/h5) Set the heading style to use.
  • Module Class Suffix. A suffix applied to the CSS class of the module. This allows you to create customized CSS styles that will apply just to this module. You would then modify the template.css or custom.css file of your template to apply styling to this new class.
    • Enter this parameter with a leading space to create a new CSS class for this module.
    • Enter the parameter without a leading space to change the CSS class name for this module.
  • Caching. (Use Global/No Caching) Whether or not to cache the content of this module. "Use Global" will use the settings from Global Configuration.
  • Cache Time. The number of minutes for which to cache the module locally. It can safely be left at the default.
  • Module Tag. The HTML tag for the module to be placed in. By default this is a div tag but other HTML5 elements (address, article, …) can also be used.
  • Bootstrap Size. (0/…/12) This allows you to choose the width of the module via the span element built into bootstrap.
  • Header Tag. (h1/h2/h3/h4/h5/h6/p/div) The HTML tag to use for the modules header or title. Note: You must use a module style (chrome) of html5 or add your custom module styles in [yourtemplate]/html/modules.php.
  • Header Class. Add optional CSS classes to the modules header or title element.
  • Module Style. Override the templates style for its position.

Permissions[edit]

Manage the permission settings for user groups.

Help30-module-manager-menu-permissions-screenshot-en.png

To change the permissions for this module, do the following.

1. Select the Group by clicking its title located on the left.
2. Find the desired Action. Possible Actions are:
  • Delete. Users can delete content of this module.
  • Edit. Users can edit content of this module.
  • Edit State. Users can change the published state and related information for content of this module.
  • Frontend Editing. Allows users in the group to edit in Frontend.
3. Select the desired Permission for the action you wish to change. Possible settings are:
  • Inherited: Inherited for users in this Group from the module options permissions of this site.
  • Allowed: Allowed for users in this Group. Note that, if this action is Denied at one of the higher levels, the Allowed permission here will not take effect. A Denied setting cannot be overridden.
  • Denied: Denied for users in this Group.
4. Click Save in Toolbar at top. When the screen refreshes, the Calculated Setting column will show the effective permission for this Group and Action.


Toolbar[edit]

At the top left you will see the toolbar.

Help32-Save-SaveClose-SaveNew-SaveAsCopy-Close-toolbar-en.png

The functions are:

  • Save. Saves the module and stays in the current screen.
  • Save & Close. Saves the module and closes the current screen.
  • Save & New. Saves the module and keeps the editing screen open and ready to create another module.
  • Save as Copy. Saves your changes to a copy of the current module. Does not affect the current module.
    Note: This toolbar icon is only shown if you edit an existing module.
  • Close. Closes the current screen and returns to the previous screen without saving any modifications you may have made.
  • Help. Opens this help screen.


Related Information[edit]

  • More about Modules: what is a module position, Description of the default Site and Administrator Modules.