diff --git a/cefxp/Introduction-de.md b/cefxp/Introduction-de.md new file mode 100644 index 0000000..0c799a6 --- /dev/null +++ b/cefxp/Introduction-de.md @@ -0,0 +1,46 @@ +## Einführung + +Joomla! ist eines der beliebtesten, kostenlosen und quelloffenen Content-Management-Systeme (CMS) für die Veröffentlichung von Webinhalten. Es ist benutzerfreundlich, erweiterbar, mehrsprachig, zugänglich, responsiv, suchmaschinenoptimiert und vieles mehr. ___Joomla! 4___ ist die aktuelle Version, die im August 2021 veröffentlicht wurde. + +Es gibt Tausende von kostenlosen und kommerziellen Joomla! Erweiterungen von Dritten für alle möglichen speziellen Zwecke. Joomla! wird jedoch mit genügend ___core___ Erweiterungen geliefert, um Ihnen zu ermöglichen, eine voll funktionsfähige Website in wenigen Minuten zu erstellen. Am besten machen Sie sich mit den Kernfähigkeiten von Joomla! vertraut, bevor Sie nach Erweiterungen von Drittanbietern suchen. + +Joomla! muss auf einem Webserver installiert werden, entweder auf einem Hosting-Service, um Ihre Inhalte dem Rest der Welt zugänglich zu machen, oder auf Ihrem eigenen Laptop oder Desktop-Computer für private Testzwecke. + +## Joomla! Architektur + +Eine Joomla!-Installation besteht aus den Dateien, die zur Verwaltung und Anzeige von Inhalten verwendet werden, und einer Datenbank, in der die meisten Inhalte gespeichert sind. Es gibt getrennte Schnittstellen für die öffentliche Site und für den Site-Administrator, obwohl viele Administratorfunktionen über die Site-Schnittstelle ausgeführt werden können. Das Erscheinungsbild der Oberfläche wird durch eine Reihe von Dateien generiert, die zusammen als Vorlage bezeichnet werden. + +### Website-Vorlage - Cassiopeia + +Diese Vorlage enthält alles, was Sie brauchen, um mit Ihrer eigenen Website zu beginnen. Sie kann mit Template-Einstellungen und benutzerdefinierten Merkmalen wie Bildern und Farben angepasst werden. + +![Cassiopeia-Vorlage](https://docs.joomla.org/images/d/d3/J4.x-introduction-to-joomla-cassiopeia-en.png "Cassiopeia-Vorlage") + +Wenn Cassiopeia nicht ganz das Richtige für Ihre Website ist, gibt es Hunderte von anderen Vorlagen von Drittanbietern, sowohl kostenlos als auch kommerziell. + +### Administrator-Vorlage - Atum + +Diese Vorlage wird von der Öffentlichkeit nicht gesehen, so dass es selten notwendig ist, eine Alternative zu suchen. + +![Atum-Vorlage](https://docs.joomla.org/images/4/4b/J4.x-introduction-to-joomla-atum-en.png "Atum-Vorlage") + +Sie können konfigurieren, was auf verschiedenen Dashboards angezeigt wird, aber das sollte man besser lassen, bis die Erfahrung eine Änderung rechtfertigt. + +## Erweiterungen + +Joomla! besteht aus mehreren verschiedenen Arten von Erweiterungen: + +* ___Komponenten___ kontrollieren, was im Hauptteil jeder Seite erscheint. Beispiele sind die Inhaltskomponente für Artikel und die intelligente Suchkomponente für Suchergebnisse. +* ___Module___ enthalten Code zur Verwaltung der Felder, die oben, links, rechts oder unten auf einer Seite erscheinen. Beispiele sind ein Login-Modul, ein Menü-Modul und ein Footer-Modul. +* ___Plugins___ fügen der Website Funktionen hinzu. Beispiele hierfür sind Authentifizierungsoptionen, Captcha-Optionen und Editor-Optionen. +* ___Vorlagen___ zeigen die Seitenausgabe nach Ihren Vorgaben an. +* ___Sprachen___ ermöglichen es Ihnen, eine oder mehrere Sprachen auszuwählen, in denen Sie Ihre Inhalte anzeigen und/oder verwalten möchten. +* ___Bibliotheken___ sind nur etwas für Entwickler. + +Joomla! hat alle grundlegenden Erweiterungen, die Sie für die meisten Arten von persönlichen und gemeinschaftlichen Websites benötigen. Nur für komplexere Anforderungen wie Verkauf und Marketing müssen Sie nach Erweiterungen von Drittanbietern suchen. + +Sind Sie bereit zu beginnen? + +Übersetzt mit www.DeepL.com/Translator (kostenlose Version) + +Added line \ No newline at end of file diff --git a/manuals/help/admin-modules/admin-modules-action-logs---latest.md b/manuals/help/admin-modules/admin-modules-action-logs---latest.md new file mode 100644 index 0000000..3af948b --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-action-logs---latest.md @@ -0,0 +1,124 @@ +--- +sidebar_position: 1 +id: admin-modules-action-logs---latest +title: "Help4.x:Admin Modules: Action Logs - Latest" +--- +## Description + +The **Action Logs - Latest** module type shows a list of the most recent +actions on the Administrator **Home Dashboard**. + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** Sets the name to give to this instance of the module. + +### Module Tab + +- **Count.** Sets the number of recent actions to display on the Home + Dasboard of your site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +- **Delete:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Delete for + users in the group. Delete Allows users in the group to delete any + content in this extension. +- **Edit:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Edit for + users in the group. Edit Allows users in the group to edit any content + in this extension. +- **Edit State:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Edit + State for users in the group. Edit State Allows users in the group to + change the state of any content in this extension. +- **Frontend Editing:** (*Inherited*/*Allowed*/*Denied*). Allow or deny + Edit from the frontend of the site for users in the group. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Related Information + +- [Joomla 3 Tutorial: User Action + Logs](https://docs.joomla.org/J3.x:User_Action_Logs/en "J3.x:User Action Logs/en") diff --git a/manuals/help/admin-modules/admin-modules-administrator-dashboard-menu.md b/manuals/help/admin-modules/admin-modules-administrator-dashboard-menu.md new file mode 100644 index 0000000..9a2f19d --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-administrator-dashboard-menu.md @@ -0,0 +1,194 @@ +--- +sidebar_position: 2 +id: admin-modules-administrator-dashboard-menu +title: "Help4.x:Admin Modules: Administrator Dashboard Menu" +--- +## Description + +The **Administrator Dashboard Menu** module type displays a collection +of menus in an administrator dashboard. + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Information.** This module displays a collection of menus in an + administrator dashboard. +- **Menu.** Use Preset is the only option at the moment. +- **Preset.** Select one of the Preset Menus from the drop down list. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/admin-modules/admin-modules-administrator-menu.md b/manuals/help/admin-modules/admin-modules-administrator-menu.md new file mode 100644 index 0000000..1969d18 --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-administrator-menu.md @@ -0,0 +1,196 @@ +--- +sidebar_position: 3 +id: admin-modules-administrator-menu +title: "Help4.x:Admin Modules: Administrator Menu" +--- +## Description + +The **Administrator Menu** module type shows the main administrator menu +module. + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Menu to Show.** +- **Choose Preset.** Choose a preset to use as the backend menu. +- **Add New Shortcuts.** +- **Help Menu.** Shows the Help button in the Toolbar. +- **Custom Support Forum URL.** Enter the URL to a forum other than the + default. This allows you to use your own Help server. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/admin-modules/admin-modules-articles---latest.md b/manuals/help/admin-modules/admin-modules-articles---latest.md new file mode 100644 index 0000000..f22a084 --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-articles---latest.md @@ -0,0 +1,198 @@ +--- +sidebar_position: 4 +id: admin-modules-articles---latest +title: "Help4.x:Admin Modules: Articles - Latest" +--- +## Description + +The **Articles - Latest** Module type is used to display the "Recently +Added Articles" in the Control Panel. + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Items to Display .** The number of items to display (default 5). +- **Order.** (*Recently Added First*/*Recently Modified First*) Ordering + options. +- **Category.** (*Any Category*/...) Select Articles from a specific + Category or all Categories. +- **Authors.** (*Anyone*/*Added or modified by me*/*Not added or + modified by me*) A filter for the authors. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/admin-modules/admin-modules-custom.md b/manuals/help/admin-modules/admin-modules-custom.md new file mode 100644 index 0000000..0729fba --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-custom.md @@ -0,0 +1,207 @@ +--- +sidebar_position: 5 +id: admin-modules-custom +title: "Help4.x:Admin Modules: Custom" +--- +## Description + +The **Custom** Module type allows you to create a self-contained HTML +unit and then put it in any valid location on a page. + +There are many cases where you might want to show free-form HTML in the +administrator interface. For example, you might want to show a temporary +system message. You may need to supply additional styling via the +Advance Tab + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Editor.** The 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. Another possibility is (if the + editor has this option) to switch to the HTML mode, enter the code, + save and switch back to normal view. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **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**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Options Tab + +- **Prepare Content.** (*Yes*/*No*). Optionally prepare the content with + the Joomla Content Plug-ins. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/admin-modules/admin-modules-feed-display.md b/manuals/help/admin-modules/admin-modules-feed-display.md new file mode 100644 index 0000000..3d2b47b --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-feed-display.md @@ -0,0 +1,213 @@ +--- +sidebar_position: 6 +id: admin-modules-feed-display +title: "Help4.x:Admin Modules: Feed Display" +--- +## Description + +The **Feed Display** Module shows an RSS News Feed from a website. This +Module is not related to the News Feeds Component or the News Feeds +Layouts and is an alternative that allows a feed to display in a Module +position. + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Feed URL.** Enter the URL of the RSS/RDF/ATOM feed. +- **RTL Feed.** (*Yes*/*No*). Display feed in RTL direction. +- **Feed Date.** (*Yes*/*No*). Display news feed date. +- **Feed Description.** (*Show*/*Hide*). Show the description text for + the entire feed. +- **Feed Image.** (*Show*/*Hide*). Show the image associated with the + entire feed. +- **Items to Display.** Enter number of RSS items to display. +- **Item Description.** (*Show*/*Hide*). Show the description or intro + text of individual RSS items. +- **Publication Date.** ('*Yes*/*No*). + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Administrator View + +An example News Feed is shown below: + + diff --git a/manuals/help/admin-modules/admin-modules-frontend-link.md b/manuals/help/admin-modules/admin-modules-frontend-link.md new file mode 100644 index 0000000..9feecd1 --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-frontend-link.md @@ -0,0 +1,190 @@ +--- +sidebar_position: 7 +id: admin-modules-frontend-link +title: "Help4.x:Admin Modules: Frontend Link" +--- +## Description + +This module shows a link to the frontend. + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Information.** This module shows the Frontend Link information. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **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**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/admin-modules/admin-modules-joomla-version-information.md b/manuals/help/admin-modules/admin-modules-joomla-version-information.md new file mode 100644 index 0000000..cc53549 --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-joomla-version-information.md @@ -0,0 +1,195 @@ +--- +sidebar_position: 8 +id: admin-modules-joomla-version-information +title: "Help4.x:Admin Modules: Joomla Version Information" +--- +## Description + +This module displays the Joomla! version in the Administrator Title Bar. + + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Information.** This module displays the Joomla! version. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/admin-modules/admin-modules-logged-in-users.md b/manuals/help/admin-modules/admin-modules-logged-in-users.md new file mode 100644 index 0000000..7103a26 --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-logged-in-users.md @@ -0,0 +1,192 @@ +--- +sidebar_position: 9 +id: admin-modules-logged-in-users +title: "Help4.x:Admin Modules: Logged-in Users" +--- +## Description + +The **Logged-in Users** module type shows a list of users who are +currently logged into the site. This is displayed in the Control Panel. + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Users to Display.** The number of items to display (default 5). +- **Name.** (*Name*/*Username*) Displays name or username. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/admin-modules/admin-modules-login-form.md b/manuals/help/admin-modules/admin-modules-login-form.md new file mode 100644 index 0000000..9b781d1 --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-login-form.md @@ -0,0 +1,192 @@ +--- +sidebar_position: 10 +id: admin-modules-login-form +title: "Help4.x:Admin Modules: Login Form" +--- +## Description + +The **Login Form** module type displays a Username and Password Login +form. It should not be unpublished. + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Information.** This module displays a username and password login + form. It should not be unpublished. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/admin-modules/admin-modules-login-support-information.md b/manuals/help/admin-modules/admin-modules-login-support-information.md new file mode 100644 index 0000000..b86829a --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-login-support-information.md @@ -0,0 +1,201 @@ +--- +sidebar_position: 11 +id: admin-modules-login-support-information +title: "Help4.x:Admin Modules: Login Support Information" +--- +## Description + +This module displays some useful links to Joomla support sites on the +login screen. + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Login Support Information.** This module displays some useful links + to Joomla support sites on the login screen. +- **Forum URL.** The default is + https://forum.joomla.org/ +- **Documentation URL.** The default is + https://docs.joomla.org/ +- **News URL.** The default is + https://www.joomla.org/ + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **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**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/admin-modules/admin-modules-messages.md b/manuals/help/admin-modules/admin-modules-messages.md new file mode 100644 index 0000000..e6d6abb --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-messages.md @@ -0,0 +1,194 @@ +--- +sidebar_position: 12 +id: admin-modules-messages +title: "Help4.x:Admin Modules: Messages" +--- +## Description + +This module shows the count of private messages in the Title Bar. + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Information.** This module shows the count of private messages + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/admin-modules/admin-modules-multilingual-status.md b/manuals/help/admin-modules/admin-modules-multilingual-status.md new file mode 100644 index 0000000..9df0236 --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-multilingual-status.md @@ -0,0 +1,205 @@ +--- +sidebar_position: 13 +id: admin-modules-multilingual-status +title: "Help4.x:Admin Modules: Multilingual Status" +--- +## Description + +The **Multilingual Status** module type shows an icon in the Title Bar +to provide access to the multilingual parameters in Multilingual sites. + + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Information.** This module shows the status of the multilingual + parameters. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Example Report + + diff --git a/manuals/help/admin-modules/admin-modules-popular-articles.md b/manuals/help/admin-modules/admin-modules-popular-articles.md new file mode 100644 index 0000000..8a1f317 --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-popular-articles.md @@ -0,0 +1,196 @@ +--- +sidebar_position: 14 +id: admin-modules-popular-articles +title: "Help4.x:Admin Modules: Popular Articles" +--- +## Description + +The **Popular Articles** module type shows a list of the most popular +published Articles that are still current. Some that are shown may have +expired even though they are the most recent. + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Items to Display.** The number of items to display (default 5). +- **Category.** (Any Category/...) Select Articles from a specific + Category or all Categories. +- **Authors.** (Anyone/Added or modified by me/Not added or modified by + me) A filter for the authors. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/admin-modules/admin-modules-post-installation-messages.md b/manuals/help/admin-modules/admin-modules-post-installation-messages.md new file mode 100644 index 0000000..650b563 --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-post-installation-messages.md @@ -0,0 +1,195 @@ +--- +sidebar_position: 15 +id: admin-modules-post-installation-messages +title: "Help4.x:Admin Modules: Post Installation Messages" +--- +## Description + +This module shows the latest post installation messages. + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Information.** This module shows the latest post installation + messages. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/admin-modules/admin-modules-privacy-dashboard.md b/manuals/help/admin-modules/admin-modules-privacy-dashboard.md new file mode 100644 index 0000000..d48e9ee --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-privacy-dashboard.md @@ -0,0 +1,230 @@ +--- +sidebar_position: 16 +id: admin-modules-privacy-dashboard +title: "Help4.x:Admin Modules: Privacy Dashboard" +--- +## Description + +The **Privacy Dashboard** module type shows information about privacy +requests. + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Information.** The Privacy Dashboard Module shows information about + privacy requests. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Dashboard Appearance + +This module displays the Request Type (*Export* or *Remove*), the Status +of requests (*Pending* or *Confirmed*) and the number of requests. + + + +## Related Information + +- [The Privacy Tool Suite for Joomla + 3](https://docs.joomla.org/J3.x:Privacy/en "J3.x:Privacy/en") diff --git a/manuals/help/admin-modules/admin-modules-privacy-status-check.md b/manuals/help/admin-modules/admin-modules-privacy-status-check.md new file mode 100644 index 0000000..6092f47 --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-privacy-status-check.md @@ -0,0 +1,205 @@ +--- +sidebar_position: 17 +id: admin-modules-privacy-status-check +title: "Help4.x:Admin Modules: Privacy Status Check" +--- +## Description + +The **Privacy Status Check Module** shows information about your sites +privacy status. + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Information.** The Privacy Status Check Module shows information + about your sites privacy status. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Privacy Status Appearance + + + +## Related Information + +- [The Privacy Tool Suite for Joomla + 3](https://docs.joomla.org/J3.x:Privacy/en "J3.x:Privacy/en") diff --git a/manuals/help/admin-modules/admin-modules-quick-icons.md b/manuals/help/admin-modules/admin-modules-quick-icons.md new file mode 100644 index 0000000..a44eeae --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-quick-icons.md @@ -0,0 +1,207 @@ +--- +sidebar_position: 18 +id: admin-modules-quick-icons +title: "Help4.x:Admin Modules: Quick Icons" +--- +## Description + +The **Quick Icons** module Type shows Quick Icons that are visible on +the Dashboard (administrator area home page). + +## How To Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Information.** This module shows Quick Icons that are visible on the + Dashboard (administrator area home page). +- **Group.** +- **Header Icon.** The Font Awesome icon code. +- **Global Configuration Icon.** +- **Checkin Icon.** +- **Cache Icon.** +- **User Icon.** +- **Articles Icon.** +- **Modules Icon** +- **Categories Icon.** +- **Media Icon.** +- **Menu Items Icon.** +- **Plugins Icon.** +- **Template Styles Icon.** +- **Template Code Icon.** + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/admin-modules/admin-modules-sample-data.md b/manuals/help/admin-modules/admin-modules-sample-data.md new file mode 100644 index 0000000..5ad2dbd --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-sample-data.md @@ -0,0 +1,198 @@ +--- +sidebar_position: 19 +id: admin-modules-sample-data +title: "Help4.x:Admin Modules: Sample Data" +--- +## Description + +The **Sample Data Module** lets you install sample data. + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Information.** This module lets you install sample data. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Sample Data Panel Appearance + + diff --git a/manuals/help/admin-modules/admin-modules-title.md b/manuals/help/admin-modules/admin-modules-title.md new file mode 100644 index 0000000..352d554 --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-title.md @@ -0,0 +1,190 @@ +--- +sidebar_position: 20 +id: admin-modules-title +title: "Help4.x:Admin Modules: Title" +--- +## Description + +The **Title** module type shows the Toolbar Component Title. + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Information.** This module shows the Toolbar Component Title. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/admin-modules/admin-modules-toolbar.md b/manuals/help/admin-modules/admin-modules-toolbar.md new file mode 100644 index 0000000..244bff6 --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-toolbar.md @@ -0,0 +1,192 @@ +--- +sidebar_position: 21 +id: admin-modules-toolbar +title: "Help4.x:Admin Modules: Toolbar" +--- +## Description + +The **Toolbar** module type shows the toolbar icons used to control +actions throughout the Administrator area. + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Information.** This module shows the toolbar icons used to control + actions throughout the Administrator area. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/admin-modules/admin-modules-user-menu.md b/manuals/help/admin-modules/admin-modules-user-menu.md new file mode 100644 index 0000000..5c3b18d --- /dev/null +++ b/manuals/help/admin-modules/admin-modules-user-menu.md @@ -0,0 +1,194 @@ +--- +sidebar_position: 22 +id: admin-modules-user-menu +title: "Help4.x:Admin Modules: User Menu" +--- +## Description + +This module shows the User Menu in the Administrator Title Bar + +## How to Access + +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Information.** This module shows the User Menu. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/articles/articles-categories.md b/manuals/help/articles/articles-categories.md new file mode 100644 index 0000000..c8487e1 --- /dev/null +++ b/manuals/help/articles/articles-categories.md @@ -0,0 +1,228 @@ +--- +sidebar_position: 2 +id: articles-categories +title: "Help4.x:Articles: Categories" +--- +## Description + +The Articles Categories list is used to find, add, and edit articles +categories. + +Categories are are used to organise Articles for ease of management and +display. They can be organised into tree-like structures like file +systems. All Articles must be assigned either to a parent Category or a +child Category. + +## How to Access + +**Home Dashboard **→** Site **→** Article Categories** + +To add a Category: + +- click the **New** toolbar button + +To edit a Category: + +- select a **Title** from the list + +## Screenshot + + + +## Column Headers + +- **Checkbox**. Check this box to select categories. To select all + categories, check the box in the column heading. After boxes are + checked the toolbar button 'Actions' get active. +- **Ordering**. You can change the order of an category within a list as + follows: + - Select the Ordering icon Ordering icon in the List heading to make it active. + - Select one of the Three dots icons Three dots icon and drag it up or down to change the + position of that row in the list. + - In the Filter Options you may limit the list to categories that are + assigned for example to a Language. +- **Status**. Status of category. Hover icon for informations. +- **Title**. The title of the category. Edit the category by clicking on + the Title. +- **Icons**. Counts of number of Published, Unpublished, Archived and + Trashed Articles in each Category. Click on a number to get a list of + the categories. +- **Access**. The viewing [Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en") + for this category. +- **Associations**. Shows the associated categories. Click on the + Language Code to open the category. [Multilingual + only.](https://docs.joomla.org/Help4.x:Multilingual_Associations/en "Help4.x:Multilingual Associations/en") +- **Language**. Categories language, default is 'All'. +- **ID**. A unique identification number for this category, you cannot + change this number. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of categories in a list. + Select from the dropdown list to change the number displayed.The + default for a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +### Filter Options + +Near the top of the page you will see the filter bar shown in the +[Screenshot](#screenshot) above. + +- **Select Status**. Select from Trashed / Unpublished / Published / + Archived / All. +- **Select Access**. Select from the list of available viewing access + levels. +- **Select Language**. Select from the list of available languages. +- **Select Tag**. Select from the list of available tags. +- **Select Max Levels**. Select from the list of available levels. + +### Pagination + +**Page Controls**. When the number of categories is more than one page, +you will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **New**. Opens the editing screen to create a new category. +- **Actions**. Reveals a list of actions for selected categories. Check + one or more categories checkboxes to activate the list. + - **Publish**. Makes the selected categories available to visitors to + your website. + - **Unpublish**. Makes the selected categories unavailable to visitors + to your website. + - **Archive**. Changes the status of the selected categories to + indicate that they are archived. [Learn + more.](https://docs.joomla.org/J4.x:How_to_Archive_an_Article/en "J4.x:How to Archive an Article/en") + - **Check-In**. Checks-in the selected categories. + - **Trash**. Changes the status of the selected categories to indicate + that they are trashed. [Learn + more.](https://docs.joomla.org/J4.x:Deleting_an_Article/en "J4.x:Deleting an Article/en") + - **Batch**. Batch processes the selected categories. +- **Rebuild**. Reconstructs and refreshes the categories table. + Normally, you do not need to rebuild this table. This function is + provided in case the data in the table becomes corrupted. +- **Options**. Opens [Articles: + Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en"). +- **Help**. Opens this help screen. + +## Batch Process + +The Batch Process allows a change in settings for a group of selected +categories. + + + +**How to Batch Process** a group of categories: + +1. Select one or more categories on the list by checking the desired + checkboxes. +2. Click the Batch Toolbar button. +3. Set one or more of the following values: + - To change the **Language**, select the desired language from the + Set Language list box. + - To change the **Access Levels**, select the desired new access + level from the Set Access Level list box. + - To change the **Category**, select a category. To leave the + category unchanged, use the default value of 'Select'. + - To **copy** the categories to a different category, select the + desired category from the category list box and check the Copy + option. In this case, the original categories are unchanged and + the copies are assigned to the new category and, if selected, + the new language, access level, and tag. + - To **move** the categories to a different category, select the + desired category from the category list box and check the Move + option. In this case, the original categories will be moved to a + new category and, if selected, be assigned the new language, + access level, and tag. + - To add **Tags**, select the desired Tags from the dropdown or + choose to keep the tags currently added to the original + categories. +4. When all of the settings are entered, click on Process to perform + the changes. A message **"Batch process completed successfully."** + will show. + +## Quick Tips + +- Click on the icon in the Status column to toggle between Published and + Unpublished. + +## Related Information + +- [Articles: Edit + Category](https://docs.joomla.org/Help4.x:Articles:_Edit_Category/en "Help4.x:Articles: Edit Category/en") + + + +- [Home + Dashboard](https://docs.joomla.org/Help4.x:Home_Dashboard/en "Help4.x:Home Dashboard/en"): + Access to many default Joomla functions. + + + +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Articles: Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en") | 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. | +| [Articles](https://docs.joomla.org/Help4.x:Articles/en "Help4.x:Articles/en") | The Article list is used to find, mark featured, add and edit articles. | +| [Articles: Edit](https://docs.joomla.org/Help4.x:Articles:_Edit/en "Help4.x:Articles: Edit/en") | This is where you can add and edit Articles. You can also select the Category for an Article and indicate whether or not it is Published and if it is selected to appear on the Front Page. | +| [Articles: Featured](https://docs.joomla.org/Help4.x:Articles:_Featured/en "Help4.x:Articles: Featured/en") | Used to control which 'Featured Articles' are displayed on the Front Page and in what order they are displayed. | +| Articles: Categories | The Articles Categories list is used to find, add, and edit articles categories. | +| [Menus: Archived Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Article_Archived/en "Help4.x:Menu Item: Article Archived/en") | Shows a customised list of articles ordered by date or title. Archived articles are no longer published but are still stored on the site. | +| [Menus: Category Blog](https://docs.joomla.org/Help4.x:Menu_Item:_Category_Blog/en "Help4.x:Menu Item: Category Blog/en") | Used to show articles belonging to a specific Category in a blog layout. Controls the Leading Articles, Intro Articles and additional links to more Articles. | +| [Menus: Category List](https://docs.joomla.org/Help4.x:Menu_Item:_Category_List/en "Help4.x:Menu Item: Category List/en") | Used to show articles belonging to a specific Category in a list layout. | +| [Menus: Create Article](https://docs.joomla.org/Help4.x:Menu_Item:_Create_Article/en "Help4.x:Menu Item: Create Article/en") | Allows users to submit an article. Normally this is available only to users who have logged in to the Frontend of the site. Users must have permission to create articles. | +| [Menus: Featured Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Articles/en "Help4.x:Menu Item: Featured Articles/en") | Used to show all Articles that have been tagged as Featured. Articles are shown in a Blog Layout. | +| [Menus: List All Categories in an Article Category Tree](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Categories/en "Help4.x:Menu Item: List All Categories/en") | Used to show a hierarchical list of Categories. Depending on the selected options for this layout, you can click on a category Title to show the articles in that category. | +| [Menus: Single Article](https://docs.joomla.org/Help4.x:Menu_Item:_Single_Article/en "Help4.x:Menu Item: Single Article/en") | Used to show one article. | diff --git a/manuals/help/articles/articles-edit.md b/manuals/help/articles/articles-edit.md new file mode 100644 index 0000000..fa34bd7 --- /dev/null +++ b/manuals/help/articles/articles-edit.md @@ -0,0 +1,491 @@ +--- +sidebar_position: 3 +id: articles-edit +title: "Help4.x:Articles: Edit" +--- +## Description + +This screen is used to add a new or edit a existing Article, usually +using a Wysiwyg editor. The default editor is TinyMCE but if other +editors are installed the default editor may be set to something else +for the site as a whole or for individual users. + +Most parameters have suitable defaults but you might wish to set a +specific Category or provide article-specific Metadata. + +## How to Access + +**Content **→** Articles** + +To add a Article: + +- click the **New** toolbar button + +To edit a Article: + +- select a **Title** from the list + +## Screenshot + + + +## Form Fields + +- **Title**. The Title for this article. +- **Alias**. The internal name of this article. Normally, you can leave + this blank and Joomla will fill in a default value Title in lower case + and with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Alias/en") + +### Content + +**Left Panel** + +- **Article Text**. This is where you enter the contents of the article. + Joomla includes 3 editors, the default [Editor - + TinyMCE](https://docs.joomla.org/Help4.x:Editors/en#tinymce "Help4.x:Editors/en") + is shown here. + + + +The CMS Content dropdown list provides for access to link to an Article, +Contact, Field, Media, Menu, or Module. [Learn +more.](https://docs.joomla.org/Help4.x:Editors/en#cmscontent "Help4.x:Editors/en") + +- **Toggle Editor**. A Toggle Editor button show below the edit window. + This button allows you to toggle between TinyMCE and [Editor - + None](https://docs.joomla.org/Help4.x:Editors/en#none "Help4.x:Editors/en"). + +**Right Panel** + +- **Status**. The published status of this article. + - Published: Article is visible in the Frontend of the site. + - Unpublished: Article is will not be visible to guests in the + Frontend of the site. It may be visible to logged in users who have + [edit state permission](#permissions) for the article. + - Archived: Article will no longer show on menu items [Category + Blog](https://docs.joomla.org/Help4.x:Menu_Item:_Category_Blog/en "Help4.x:Menu Item: Category Blog/en") + or [Category + List.](https://docs.joomla.org/Help4.x:Menu_Item:_Category_List/en "Help4.x:Menu Item: Category List/en") + - Trashed: Article is deleted from the site but still in the database. + [Learn + more.](https://docs.joomla.org/J4.x:Deleting_an_Article/en "J4.x:Deleting an Article/en") +- **Category**. Select the Category for this article. +- **Featured**. Select Yes if article will be shown in the [Featured + menu + item.](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Articles/en "Help4.x:Menu Item: Featured Articles/en") +- **Access**. Select the viewing access level for this article. The + access levels depend on what has been set up in [Users: Access + Levels](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en"). +- **Language**. Select the language for this article. Keep the default + of 'All' if you are not using the [multi-language + feature](https://docs.joomla.org/Help4.x:Extensions:_Languages/en "Help4.x:Extensions: Languages/en"). +- **Tags**. Assign tags to this article. You may select a tag from a + [pre-defined + list](https://docs.joomla.org/Help4.x:Tags/en "Help4.x:Tags/en") or + enter a new tag by typing the name in the field and pressing enter. +- **Note**. This is normally for the administrator's use (for example, + to document information about this article) and does not show in the + Frontend. +- **Version Note**. Optional field to identify the version of this + article in the article's [Version + History](https://docs.joomla.org/Help4.x:Components_Version_History/en "Help4.x:Components Version History/en"). + +### Images and Links + +**Note**: This can be hidden by a user with Admin permissions in the +[Article: +Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en"). +This section lets you display images and links in your articles using +standardised layouts. + + + +**Intro Image** + +- **Intro Image**. Click the Select button to select an image to be + displayed in a fixed location in the Intro Text of this article. This + will open a window that allows you to select an image from your images + folder. [Learn + more.](https://docs.joomla.org/Adding_an_image_to_an_article/en "Adding an image to an article/en") +- **Image Description (Alt Text)**. Set the alt attribute for this + image. A few descriptive words for screen readers. +- **No Description**. Check in the rare instance of a purely decorative + image. Note that if the Image Description is empty and the No + Description checkbox is unchecked then the image will fail to meet + accessibility criteria. If an image description is present this + checkbox has no effect. +- **Image Class**. You can add any CSS class for your own styling ideas. + For image position use for example float-start and float-end. + Learn more. +- **Caption**. Create a caption for this image. + +**Full Article Image** + +- **Full Article Image**. Click the Select button to select an image to + be displayed in a fixed location in the Full Text of this article. + This will open a window that allows you to select an image from your + images folder. [Learn + more.](https://docs.joomla.org/Adding_an_image_to_an_article/en "Adding an image to an article/en") +- **Image Description (Alt Text)**. Set the alt attribute for this + image. A few descriptive words for screen readers. +- **No Description**. Check in the rare instance of a purely decorative + image. Note that if the Image Description is empty and the No + Description checkbox is unchecked then the image will fail to meet + accessibility criteria. If an image description is present this + checkbox has no effect. +- **Image Class**. You can add any CSS class for your own styling ideas. + For image position use for example float-start and float-end. + Learn more. +- **Caption**. Enter an optional caption for this image. + +**Link A** + +- **Link A**. The URL for the first link to be displayed in a fixed + location in the article text. This must be a full URL, not relative. + For example, it normally would start with 'https://'. +- **Link A Text**. The text used for Link A. If blank, the URL will be + displayed. +- **URL Target Window**. Sets the default value for the target for the + first Link in this article. Choices are: + - Open in parent window: Opens the in the main browser window, + replacing the current Joomla article. + - Open in new window: Opens the link in a new browser window. + - Open in popup: Opens the link in a pop-up browser window (without + full navigation controls). + - Modal: Opens the link in a modal pop-up window. + +**Link B**, **Link C**: Same options as Link A. + +### Options + +**Note**: This can be hidden by a user with Admin permissions in the +[Article: +Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en"). +This is a set of options you can use to control how this article will +show in the Frontend. + + + +**Layout** + +- **Layout**. Use a layout from the supplied article view or [overrides + in the + templates](https://docs.joomla.org/Help4.x:Templates:_Customise/en "Help4.x:Templates: Customise/en"). +- **Title**. Show the Article's Title. +- **Linked Titles**. Show the title as a link to the article. +- **Tags**. Enter tags for this article. Select existing tags by + entering in the first few letters or create new tags by entering them + here. [Learn + more.](https://docs.joomla.org/J4.x:How_To_Use_Content_Tags_in_Joomla/en "J4.x:How To Use Content Tags in Joomla/en") +- **Intro Text**. + - Show: The Intro Text of the article will show when you drill down to + the article. + - Hide: Only the part of the article after the Read More break will + show. +- **Position of Article Info**. + - Above: Puts the article information block above the text. + - Below: Puts the article information block below the text. + - Split: Splits the article information block into 2 separate blocks. + One block is above and the other is below the text. +- **Article Info Title**. Displays 'Details' on top of the article + information block. + +**Category** + +- **Category**. Show the Article's Category Title. +- **Link Category**. Show the title as a link to that Category. +- **Parent Category**. Show the Article's Parent Category Title. +- **Link Parent Category**. Show the title as a link to that Category. + +**Associations** + +- **Associations**. Show the associated flags or Language Code. + [Multilingual + only.](https://docs.joomla.org/Help4.x:Multilingual_Associations/en "Help4.x:Multilingual Associations/en") + +**Author** + +- **Author**. Show the author of the Article. +- **Link to Author's Contact Page**. Show it as a link to a Contact + layout for that author.Note: The author must be [set up as a + Contact](https://docs.joomla.org/Help4.x:Contacts/en "Help4.x:Contacts/en"). + +**Date** + +- **Create Date**. Show the Article's create date. +- **Modify Date**. Show the Article's modify date. +- **Publish Date**. Show the Article's start publishing date. + +**Options** + +- **Navigation**. Show a navigation link 'Prev' or 'Next' when you drill + down to the article. +- **Hits**. Show the number of times the article has been displayed by a + user. +- **Unauthorised Links**. 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. +- **Positioning of the Links.** + - Above: Links are shown above the content. + - Below: Links are shown below the content. +- **Read More Text**. Customise the text that shows for the default + wording 'Read more'. +- **Browser Page Title**. Text for the Browser page title to be used + when the article is viewed with a non-article menu item. If blank, the + article's title is used instead. + +### Fields + +This section shows the [custom +fields](https://docs.joomla.org/Help4.x:Fields/en "Help4.x:Fields/en") +which are defined for this article. + + + +### Publishing + +**Note**: This can be hidden by a user with Admin permissions in the +[Article: +Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en"). +This section allows you to enter parameters and +[Metadata](https://docs.joomla.org/Using_The_Meta_Description/en "Using The Meta Description/en") +for this Article. + + + +**Publishing** + +- **Start Publishing**. Date and time to start publishing. Enter article + ahead of time and then have it published automatically at a future + time. +- **Finish Publishing**. Date and time to finish publishing. The article + is automatically changed to Unpublished state at a future time. +- **Start Featured**. Date and time to start featured state. Enter + article ahead of time and then have it featured automatically at a + future time. +- **Finish Featured**. Date and time to finish featured state. The + article is automatically changed to Unfeatured state at a future time. +- **Created Date**. The current time when the Article was created. Enter + in a different date and time or click on the calendar icon to find the + desired date. +- **Created By**. Name of the User who created this Article. This will + default to the currently logged-in user. If you want to change this to + a different user, click the Select User button. +- **Created by Alias**. Enter in an alias for the Author of this + Article. This allows you to display a different Author name. +- **Modified Date**. Date of last modification. +- **Modified By**. Username who performed the last modification. +- **Revision**. Number of revisions to this Article. +- **Hits**. The number of times this Article has been viewed. +- **ID**. A unique identification number for this Article, you cannot + change this number. When creating a new Article, this field displays + "0" until you save the new entry. + +**Metadata** + +- **Meta Description**. An paragraph to be used as the description of + the page. [Learn + more.](https://docs.joomla.org/Using_The_Meta_Description/en "Using The Meta Description/en") +- **Keywords**. Entry for keywords. [Learn + more.](https://docs.joomla.org/Using_Keywords/en "Using Keywords/en") +- **Robots**. The instructions for web 'robots' that browse to this + page. Set 'Use Global' in [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#robots "Help4.x:Site Global Configuration/en"). +- **Author**. Entry for an Author name within the metadata. +- **Content Rights**. Describe what rights others have to use this + content. + +### Associations + +**Note**: This can be hidden by a user with Admin permissions in the +[Article: +Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en"). +Tab is shown on [Multilingual +Sites](https://docs.joomla.org/Help4.x:Multilingual_Associations/en "Help4.x:Multilingual Associations/en") +only. + + + +### Configure Edit Screen + +**Note**: This can be hidden by a user with Admin permissions in the +[Article: +Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en"). + + + +- **Publishing Options**. If Hide, the [Publishing Options + tab](https://docs.joomla.org/Help4.x:Articles:_Edit/en#publishing "Help4.x:Articles: Edit/en") + will not show in the Backend. This means that Backend users will not + be able to edit the fields in this tab. These fields will always be + set to their default values. +- **Article Options**. If Hide, the [Article Options + tab](https://docs.joomla.org/Help4.x:Articles:_Edit/en#options "Help4.x:Articles: Edit/en") + will not show in the Backend. This means that Backend users will not + be able to edit the fields in this tab. These fields will always be + set to their default values. +- **Administrator Images and Links**. If Yes, the [Images and Links + tab](https://docs.joomla.org/Help4.x:Articles:_Edit/en#imagesandlinks "Help4.x:Articles: Edit/en") + will show. +- **Frontend Images and Links**. If Yes, the Images and Links tab will + show in the Frontend article editor screen. + +### Permissions + +**Note**: This can be hidden by a user with Admin permissions in the +[Article: +Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en"). +This is where you can enter permissions for this article. [Learn +more.](https://docs.joomla.org/J3.x:Access_Control_List_Tutorial/en#hierarchylevels "J3.x:Access Control List Tutorial/en") + + + +To change the permissions for this article, do the following. + +1. Select the **Group** by clicking its title located on the left. +2. Find the desired **Action**. + - **Delete**. Users can delete this article. + - **Edit**. Users can edit this article. + - **Edit State**. User can change the published state and related + information for this article. +3. Select the desired permission for the action you wish to change. + - **Inherited**. Inherited for users in this Group from the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#permissions "Help4.x:Site Global Configuration/en"), + [Articles + Options](https://docs.joomla.org/Help4.x:Articles:_Options/en#permissions "Help4.x:Articles: Options/en"), + or [Articles + Category](https://docs.joomla.org/Help4.x:Articles:_Edit_Category/en#permissions "Help4.x:Articles: Edit Category/en"). + - **Allowed**. Allowed for users in this Group.Note: 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 + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **Save**. Saves the article and stays in the current screen. +- **Save & Close**. Saves the article and closes the current screen. + - **Save & New**. Saves the article and keeps the editing screen open + and ready to create another article. + - **Save to Menu**. Saves the article to a menu item and opens the + menu item screen. + - **Save as Copy**. Saves your changes to a copy of the current + article. Does not affect the current article. +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. +- **Versions**. Opens the Article Version History window to show any + prior versions of this article. This allows you to view older versions + of this article and, if desired, restore from an older version. [Learn + more.](https://docs.joomla.org/Help4.x:Components_Version_History/en "Help4.x:Components Version History/en") +- **Preview**. Opens a modal dialog showing a site view of this article. + Requires [shared + sessions](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#sharedsessions "Help4.x:Site Global Configuration/en") + or being logged in into the Frontend. +- **Accessibility Check**. Opens a window showing accessibility check + results of the article. +- **Associations**. With a specific language set for an article, allows + side by side editing in another language. This icon is shown on + [Multilingual + Sites](https://docs.joomla.org/Help4.x:Multilingual_Associations/en "Help4.x:Multilingual Associations/en") + only. +- **Toggle Inline Help**. Show help text below some options. +- **Help**. Opens this help screen. + +## Quick Tips + +- There are 2 methods to insert an image into article using the TinyMCE + editor. + 1. The [CMS + Content](https://docs.joomla.org/Help4.x:Editors/en#cmscontent "Help4.x:Editors/en") + dropdown list provides access to the [Media + screen](https://docs.joomla.org/Help4.x:Media/en "Help4.x:Media/en") + that lets you browse image files and upload images. + 2. The 'Insert' dropdown list is a simple form for which you need to + know the image url. It is used for external images. +- [Read + more](https://docs.joomla.org/Help4.x:Editors/en#readmore "Help4.x:Editors/en") + breaks allow you to save space on the Front Page or on any blog layout + page by showing just the first portion of an Article. [Page + break](https://docs.joomla.org/Help4.x:Editors/en#pagebreak "Help4.x:Editors/en") + allow you to provide multi-page navigation for long Articles. You can + use both on one Article, if desired.For example, you could put a Read + more break after the first paragraph of a multi-page article, and have + Page breaks after each page. No page navigation would display on the + Front Page until the User selects the Read more link. At that time, + the Article's table of contents would display showing links to every + page. + +## Related Information + +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Articles: Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en") | 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. | +| [Articles](https://docs.joomla.org/Help4.x:Articles/en "Help4.x:Articles/en") | The Article list is used to find, mark featured, add and edit articles. | +| Articles: Edit | This is where you can add and edit Articles. You can also select the Category for an Article and indicate whether or not it is Published and if it is selected to appear on the Front Page. | +| [Articles: Featured](https://docs.joomla.org/Help4.x:Articles:_Featured/en "Help4.x:Articles: Featured/en") | Used to control which 'Featured Articles' are displayed on the Front Page and in what order they are displayed. | +| [Articles: Categories](https://docs.joomla.org/Help4.x:Articles:_Categories/en "Help4.x:Articles: Categories/en") | The Articles Categories list is used to find, add, and edit articles categories. | +| [Menus: Archived Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Article_Archived/en "Help4.x:Menu Item: Article Archived/en") | Shows a customised list of articles ordered by date or title. Archived articles are no longer published but are still stored on the site. | +| [Menus: Category Blog](https://docs.joomla.org/Help4.x:Menu_Item:_Category_Blog/en "Help4.x:Menu Item: Category Blog/en") | Used to show articles belonging to a specific Category in a blog layout. Controls the Leading Articles, Intro Articles and additional links to more Articles. | +| [Menus: Category List](https://docs.joomla.org/Help4.x:Menu_Item:_Category_List/en "Help4.x:Menu Item: Category List/en") | Used to show articles belonging to a specific Category in a list layout. | +| [Menus: Create Article](https://docs.joomla.org/Help4.x:Menu_Item:_Create_Article/en "Help4.x:Menu Item: Create Article/en") | Allows users to submit an article. Normally this is available only to users who have logged in to the Frontend of the site. Users must have permission to create articles. | +| [Menus: Featured Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Articles/en "Help4.x:Menu Item: Featured Articles/en") | Used to show all Articles that have been tagged as Featured. Articles are shown in a Blog Layout. | +| [Menus: List All Categories in an Article Category Tree](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Categories/en "Help4.x:Menu Item: List All Categories/en") | Used to show a hierarchical list of Categories. Depending on the selected options for this layout, you can click on a category Title to show the articles in that category. | +| [Menus: Single Article](https://docs.joomla.org/Help4.x:Menu_Item:_Single_Article/en "Help4.x:Menu Item: Single Article/en") | Used to show one article. | diff --git a/manuals/help/articles/articles-featured.md b/manuals/help/articles/articles-featured.md new file mode 100644 index 0000000..175f6be --- /dev/null +++ b/manuals/help/articles/articles-featured.md @@ -0,0 +1,178 @@ +--- +sidebar_position: 4 +id: articles-featured +title: "Help4.x:Articles: Featured" +--- +## Description + +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. + +## How to Access + +**Content **→** Featured Articles** + +To add a Article: + +- click the **New** toolbar button + +To edit a Article: + +- select a **Title** from the list + +## Screenshot + + + +## Column Headers + +- **Checkbox**. Check this box to select articles. To select all + articles, check the box in the column heading. After boxes are checked + the toolbar button 'Actions' get active. +- **Ordering**. You can change the order of an article within a list as + follows: + - Select the Ordering icon Ordering icon in the List heading to make it active. + - Select one of the Three dots icons Three dots icon and drag it up or down to change the + position of that row in the list. + - In the Filter Options you may limit the list to articles that are + assigned for example to a Language. +- **Featured**. Click the icon to unfeature. +- **Status**. Status of article. Hover icon for informations. +- **Title**. The title of the article. Edit the article by clicking on + the Title. +- **Access**. The viewing [Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en") + for this article. +- **Author**. Name of the User who created this article. +- **Associations**. Shows the associated articles. Click on the Language + Code to open the article. [Multilingual + only.](https://docs.joomla.org/Help4.x:Multilingual_Associations/en "Help4.x:Multilingual Associations/en") +- **Language**. Articles language, default is 'All'. +- **Date Created**. The date this article was created. +- **Hits**. The number of times an article has been viewed. +- **ID**. A unique identification number for this article, you cannot + change this number. When creating a new article, this field displays + '0' until you save the new entry. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of articles in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +### Filter Options + +Near the top of the page you will see the filter bar shown in the +[Screenshot](#screenshot) above. + +- **Select Status**. Select from Trashed / Unpublished / Published / + Archived / All. +- **Select Category**. Select from the list of available categories. +- **Select Access**. Select from the list of available viewing access + levels. +- **Select Author**. Select from the list of available authors. +- **Select Language**. Select from the list of available languages. +- **Select Tag**. Select from the list of available tags. +- **Select Max Levels**. Select from the list of available levels. + +### Pagination + +**Page Controls**. When the number of articles is more than one page, +you will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **New**. Opens the editing screen to create a new article. +- **Actions**. Reveals a list of actions for selected articles. Check + one or more articles checkboxes to activate the list. + - **Publish**. Makes the selected articles available to visitors to + your website. + - **Unpublish**. Makes the selected articles unavailable to visitors + to your website. + - **Unfeature**. Changes the status of featured articles to + unfeatured. + - **Archive**. Changes the status of the selected articles to indicate + that they are archived. [Learn + more.](https://docs.joomla.org/J4.x:How_to_Archive_an_Article/en "J4.x:How to Archive an Article/en") + - **Check-In**. Checks-in the selected articles. + - **Trash**. Changes the status of the selected articles to indicate + that they are trashed. [Learn + more.](https://docs.joomla.org/J4.x:Deleting_an_Article/en "J4.x:Deleting an Article/en") +- **Options**. Opens [Articles: + Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en"). +- **Help**. Opens this help screen. + +## Quick Tips + +- If Joomla is installed without sample data, one article category + called 'Uncategorised' is created automatically. +- To see trashed and archived articles, set the Status filter to 'All'. +- To change the ordering of articles within a category, click on the + Ordering column heading to sort by this column. Also, it is easier to + see the ordering if you filter on the desired category. + +## Related Information + +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Articles: Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en") | 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. | +| [Articles](https://docs.joomla.org/Help4.x:Articles/en "Help4.x:Articles/en") | The Article list is used to find, mark featured, add and edit articles. | +| [Articles: Edit](https://docs.joomla.org/Help4.x:Articles:_Edit/en "Help4.x:Articles: Edit/en") | This is where you can add and edit Articles. You can also select the Category for an Article and indicate whether or not it is Published and if it is selected to appear on the Front Page. | +| Articles: Featured | Used to control which 'Featured Articles' are displayed on the Front Page and in what order they are displayed. | +| [Articles: Categories](https://docs.joomla.org/Help4.x:Articles:_Categories/en "Help4.x:Articles: Categories/en") | The Articles Categories list is used to find, add, and edit articles categories. | +| [Menus: Archived Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Article_Archived/en "Help4.x:Menu Item: Article Archived/en") | Shows a customised list of articles ordered by date or title. Archived articles are no longer published but are still stored on the site. | +| [Menus: Category Blog](https://docs.joomla.org/Help4.x:Menu_Item:_Category_Blog/en "Help4.x:Menu Item: Category Blog/en") | Used to show articles belonging to a specific Category in a blog layout. Controls the Leading Articles, Intro Articles and additional links to more Articles. | +| [Menus: Category List](https://docs.joomla.org/Help4.x:Menu_Item:_Category_List/en "Help4.x:Menu Item: Category List/en") | Used to show articles belonging to a specific Category in a list layout. | +| [Menus: Create Article](https://docs.joomla.org/Help4.x:Menu_Item:_Create_Article/en "Help4.x:Menu Item: Create Article/en") | Allows users to submit an article. Normally this is available only to users who have logged in to the Frontend of the site. Users must have permission to create articles. | +| [Menus: Featured Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Articles/en "Help4.x:Menu Item: Featured Articles/en") | Used to show all Articles that have been tagged as Featured. Articles are shown in a Blog Layout. | +| [Menus: List All Categories in an Article Category Tree](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Categories/en "Help4.x:Menu Item: List All Categories/en") | Used to show a hierarchical list of Categories. Depending on the selected options for this layout, you can click on a category Title to show the articles in that category. | +| [Menus: Single Article](https://docs.joomla.org/Help4.x:Menu_Item:_Single_Article/en "Help4.x:Menu Item: Single Article/en") | Used to show one article. | diff --git a/manuals/help/articles/articles-new-or-edit-category.md b/manuals/help/articles/articles-new-or-edit-category.md new file mode 100644 index 0000000..64d3e4f --- /dev/null +++ b/manuals/help/articles/articles-new-or-edit-category.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 5 +id: articles-new-or-edit-category +title: "Help4.x:Articles: New or Edit Category" +--- +Redirect to: + +- [Help4.x:Articles: Edit + Category](https://docs.joomla.org/Help4.x:Articles:_Edit_Category "Help4.x:Articles: Edit Category") diff --git a/manuals/help/articles/articles-options.md b/manuals/help/articles/articles-options.md new file mode 100644 index 0000000..4471d56 --- /dev/null +++ b/manuals/help/articles/articles-options.md @@ -0,0 +1,568 @@ +--- +sidebar_position: 6 +id: articles-options +title: "Help4.x:Articles: Options" +--- +## Description + +Used to set global defaults for [menu items that display +articles](#menus). 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. + +## How To Access + +**Content **→** Articles** + +- click the **Options** toolbar button + +## Screenshot + + + +## Form Fields + +### Articles + +Options used in articles and the menu items +[Blog](https://docs.joomla.org/Help4.x:Menu_Item:_Category_Blog/en#options "Help4.x:Menu Item: Category Blog/en"), +[List](https://docs.joomla.org/Help4.x:Menu_Item:_Category_List/en#options "Help4.x:Menu Item: Category List/en"), +[Featured +Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Articles/en#options "Help4.x:Menu Item: Featured Articles/en"), +[List All +Categories](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Categories/en#options "Help4.x:Menu Item: List All Categories/en"), +and [Single +Article](https://docs.joomla.org/Help4.x:Menu_Item:_Single_Article/en#options "Help4.x:Menu Item: Single Article/en"). + +**Layout** + +- **Choose a Layout**. Select the default value for Single Article menu + items. +- **Title**. Show the Article's Title. +- **Linked Titles**. Show the title as a link to the article. +- **Intro Text**. + - Show: The Intro Text of the article will show when you drill down to + the article. + - Hide: Only the part of the article after the Read More break will + show. +- **Position of Article Info**. + - Above: Puts the article information block above the text. + - Below: Puts the article information block below the text. + - Split: Splits the article information block into 2 separate blocks. + One block is above and the other is below the text. +- **Article Info Title**. Displays 'Details' on top of the article + information block. + +**Category** + +- **Category**. Show the Article's Category Title. + - **Link Category**. Show the title as a link to that Category.Note: + You can set this to be either a blog or list layout with the [Choose + a + Layout](https://docs.joomla.org/Help4.x:Articles:_Options/en#choosealayout "Help4.x:Articles: Options/en") + option in the Category Tab. +- **Parent Category**. Show the Article's Parent Category Title. + - **Link Parent Category**. Show the title as a link to that + Category.Note: You can set this to be either a blog or list layout + with the [Choose a + Layout](https://docs.joomla.org/Help4.x:Articles:_Options/en#choosealayout "Help4.x:Articles: Options/en") + option in the Category Tab. + +**Associations** + +- **Associations**. Show the associated flags or Language Code. + [Multilingual + only.](https://docs.joomla.org/Help4.x:Multilingual_Associations/en "Help4.x:Multilingual Associations/en") + - **Use Image Flags**. Display language choice as image flags. + +**Author** + +- **Author**. Show the author of the Article. + - **Link to Author's Contact Page**. Show it as a link to a Contact + layout for that author.Note: The author must be set up as a + [Contact](https://docs.joomla.org/Help4.x:Contacts:_Edit/en "Help4.x:Contacts: Edit/en"). + Also, a link will not show if there is an [Author + Alias](https://docs.joomla.org/Help4.x:Articles:_Edit/en#createdbyalias "Help4.x:Articles: Edit/en") + value for the article. + +**Date** + +- **Create Date**. Show the Article's create date. +- **Modify Date**. Show the Article's modify date. +- **Publish Date**. Show the Article's start publishing date. + +**Options** + +- **Navigation**. Show a navigation link 'Prev' or 'Next' when you drill + down to the article. +- **"Read More" Link**. Show the Read More link to link from the part of + the article before the Read More break to the rest of the Article. +- **Read More with Title**. + - Show: The article title is part of the Read More link. The link will + be in the format "Read More: \[article title\]". + - Hide: The link will be "Read more". +- **Read More Limit (characters)**. The maximum number of characters + from the title to include.Note: This can prevent the Read More text to + become excessively long if the article has a very long title. +- **Tags**. Show the tags for each article. + + + +- **Record Hits**. Record the number of times the article has been + viewed. +- **Hits**. Show the number of times the article has been displayed by a + user. +- **Unauthorised Links**. + - 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. + - No: Articles that the user is not authorised to view (based on the + viewing access level for the article) will not show. +- **Positioning of the Links**. + - Above: Links are shown above the content. + - Below: Links are shown below the content. + +### Editing Layout + +Options of the article editing page. + + + +- **Allow Captcha on submit**. Select the [captcha + plugin](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_CAPTCHA_Group/en "Chunk4x:Extensions Plugin Manager Edit CAPTCHA Group/en") + that will be used in the article submit form. If 'Use Global' is + selected, make sure a captcha plugin is selected in [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#captcha "Help4.x:Site Global Configuration/en"). +- **Publishing Options**. Hide the [Publishing Options + tab](https://docs.joomla.org/Help4.x:Articles:_Edit/en#publishing "Help4.x:Articles: Edit/en") + in the Backend when editing Articles. This means that Backend users + will not be able to edit the fields in this tab. These fields will + always be set to their default values. +- **Article Options**. Hide the [Article Options + tab](https://docs.joomla.org/Help4.x:Articles:_Edit/en#options "Help4.x:Articles: Edit/en") + in the Backend when editing Articles. This means that Backend users + will not be able to edit the fields in this tab. These fields will + always be set to their default values. +- **Edit Screen Options**. Hide the [Configure Edit Screen + tab](https://docs.joomla.org/Help4.x:Articles:_Edit/en#configureeditscreen "Help4.x:Articles: Edit/en") + when editing Articles. +- **Article Permissions**. Hide the [Permissions + tab](https://docs.joomla.org/Help4.x:Articles:_Edit/en#permissions "Help4.x:Articles: Edit/en") + when editing Articles. +- **Multilingual Associations**. Hide the [Associations + tab](https://docs.joomla.org/Help4.x:Articles:_Edit/en#associations "Help4.x:Articles: Edit/en") + when editing Articles. +- **Enable Versions**. Save version history for Articles and Categories. +- **Maximum Versions**. The maximum number of versions to store for an + Article or Category. If an Article or Category is saved and the + maximum number of versions has been reached, the oldest version will + be deleted automatically. If set to "0", then versions will never be + deleted automatically. [Learn + more.](https://docs.joomla.org/Help4.x:Components_Version_History/en "Help4.x:Components Version History/en") +- **Frontend Images and Links**. Hide the Images and Links tab in the + Frontend article editor screen. +- **Administrator Images and Links**. Hide the [Images and Links + tab](https://docs.joomla.org/Help4.x:Articles:_Edit/en#imagesandlinks "Help4.x:Articles: Edit/en") + in the Backend when editing Articles. + + + +- **URL A Target Window**. Sets the default value for the target for the + first Link in the article. Choices are: + - Open in parent window: Opens the in the main browser window, + replacing the current Joomla article. + - Open in new window: Opens the link in a new browser window. + - Open in popup: Opens the link in a popup browser window (without + full navigation controls). + - Modal: Opens the link in a modal popup window. +- **URL B Target Window**. Sets the default value for the target for the + second Link in the article. Same options as URL A. +- **URL C Target Window**. Sets the default value for the target for the + third Link in the article. Same options as URL A. + + + +- **Intro Image Class**. Sets the class attribute for an Intro Image + selected in the Intro Image field. + Learn more. +- **Full Text Image Class**. Sets the class attribute for an Full + Article Image selected in the Full Article Image field. + Learn more. + +### Category + +Options control how a Category and its articles will show. They are used +in categories and the menu items +[Blog](https://docs.joomla.org/Help4.x:Menu_Item:_Category_Blog/en#category "Help4.x:Menu Item: Category Blog/en"), +[List](https://docs.joomla.org/Help4.x:Menu_Item:_Category_List/en#category "Help4.x:Menu Item: Category List/en"), +and [List All +Categories](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Categories/en#category "Help4.x:Menu Item: List All Categories/en"). + + + +- **Choose a Layout**. Select the default layout to show when you click + on a Category link. +- **Category Title**. Show the title of the category. +- **Category Description**. Show the description for the category. +- **Category Image**. Show the category image. +- **Subcategory Levels**. Control how many levels of subcategories to + show. +- **Empty Categories**. Show categories that don't contain any articles + or subcategories. +- **No Articles Message**. Show a message "There are no articles in this + category". +- **Subcategories Heading**. Show the Subcategories as subheading on the + page. +- **Subcategories Descriptions**. Show the descriptions for + subcategories. +- **\# Articles in Category**. Show a count of the total number of + articles in each category. +- **Tags**. Show the tags for the category. + +### Categories + +Options control the display of the menu item [List All +Categories](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Categories/en#categories "Help4.x:Menu Item: List All Categories/en"). + + + +- **Top Level Category Description**. Show the description for the + top-level category. +- **Subcategory Levels**. Control how many levels of subcategories to + show. +- **Empty Categories**. Show categories that don't contain any articles + or subcategories. +- **Subcategories Descriptions**. Show the description for + subcategories. +- **\# Articles in Category**. Show a count of the total number of + articles in each category. + +### Blog/Featured Layouts + +Options control the layout of the menu items +[Blog](https://docs.joomla.org/Help4.x:Menu_Item:_Category_Blog/en#blog "Help4.x:Menu Item: Category Blog/en"), +[Featured +Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Articles/en#blog "Help4.x:Menu Item: Featured Articles/en"), +and [List All +Categories](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Categories/en#blog "Help4.x:Menu Item: List All Categories/en"). + + + +- **\# 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. +- **Leading Article Class**. You can add any CSS class for your own + styling ideas. Add a border on top with class boxed.For image position + use for example image-left, image-right. Add image-alternate for + alternate ordering of intro images. +- **\# 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 in which to + display the articles is determined by the Category Order and Article + Order parameters below. +- **Article Class**. You can add any CSS class for your own styling + ideas. Add a border on top with class boxed.For image position use for + example image-left, image-right. Add image-alternate for alternate + ordering of intro images. +- **\# Columns**. The number of columns to use in the Intro Articles + area. This is normally between 1 and 3 (depending on the template you + are using). If 1 is used, the Intro Articles will display using the + full width of the display area, just like the Leading Articles. +- **Multi Column Direction**. In multi-column blog layouts, whether to + order articles Down the columns or Across the columns. + + + +- - Down: Order articles going down the first column and then over to + the next column, for example: + +- + + + +- - Across: Order articles going across the columns and then back to the + first column, for example: + +- + + + +- **\# 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. +- **Include Subcategories**. + - None: Only articles from the current category will show. + - All: All articles from the current category and all subcategories + will show. + - 1-5: All articles from the current category and subcategories up to + and including that level will show. +- **Linked Intro Image**. If Yes, a click on the intro image shows the + article. + +### List Layouts + +Options control the layout of the menu items +[List](https://docs.joomla.org/Help4.x:Menu_Item:_Category_List/en#listlayouts "Help4.x:Menu Item: Category List/en") +and [List All +Categories](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Categories/en#listlayouts "Help4.x:Menu Item: List All Categories/en"). + + + +- **Display Select**. Show the Display \# control that allows the user + to select the number of articles to show. +- **Filter Field**. Show a text field in the Frontend where a user can + filter the articles.Options in the Backend menu item edit. + - Hide: Don't show a filter field. + - Title: Filter on article title. + - Author: Filter on the author's name. + - Hits: Filter on the number of article hits. + - Tags: Filter on the article tags. + - Month (published): Filter on the month of published articles. +- **Table Headings**. Show a heading in the article list in the + Frontend. +- **Date**. Show a date in the list. + - Hide: Don't show any date. + - Created: Show the created date. + - Modified: Show the date of the last modification. + - Published: Show the start publishing date. +- **Hits**. Show the number of hits for articles. +- **Author**. Show the name of the author. +- **\# Articles to List**. Number of articles shown in the list. + +### Shared + +Options shared by the menu items +[Blog](https://docs.joomla.org/Help4.x:Menu_Item:_Category_Blog/en#blog "Help4.x:Menu Item: Category Blog/en"), +[List](https://docs.joomla.org/Help4.x:Menu_Item:_Category_List/en#listlayouts "Help4.x:Menu Item: Category List/en"), +and [Featured +Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Articles/en#blog "Help4.x:Menu Item: Featured Articles/en"). + + + +- **Category Order**. + - 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 Order: Categories are ordered according to the Order column + entered in [Articles: + Categories](https://docs.joomla.org/Help4.x:Articles:_Categories/en#ordering "Help4.x:Articles: Categories/en"). +- **Article Order**. + - 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. + - Ordering: Articles are ordered according to the Order column entered + in + [Articles](https://docs.joomla.org/Help4.x:Articles/en#ordering "Help4.x:Articles/en"). + - Ordering Reverse: Articles are ordered reverse to the according of + the Order column entered in + [Articles](https://docs.joomla.org/Help4.x:Articles/en#ordering "Help4.x:Articles/en"). +- **Date for Ordering**. The date used when articles are sorted by date. + - Created: Use the article created date. + - Modified: Use the article modified date. + - Published: Use the article start publishing date. +- **Pagination**. 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. + - Hide: Pagination links not shown. Note: Users will not be able to + navigate to additional pages. + - Show: Pagination links shown if needed. + - Auto: Pagination links shown if needed. +- **Pagination Summary**. Show the current page number and total pages + (e.g., "Page 1 of 2") at the bottom of each page. +- **Featured Articles**. + - Show: Display featured articles and non-featured articles. + - Hide: Display only non-featured articles. + - Only: Display only featured articles. + +### Integration + +Options control how Articles integrate News Feeds, Routing, Custom +Fields, and Workflow. + + + +**News Feeds** + +- **RSS Feed Link**. If set to Show, a Feed Link will show up as a feed + icon in the address bar of most browsers. +- **Include in Feed**. + - Intro Text: Only the article's intro text will show in the feed. + - Full Text: The entire text of the article will show in the feed. +- **"Read More" Link**. Show a "Read more" link in the feed. + +**Routing** + +- **Remove IDs from URLs**. Remove the database id of articles in a + link. + +**Custom Fields** + +- **Edit Custom Fields**. Enable the creation of custom fields. [Learn + more.](https://docs.joomla.org/Help4.x:Fields:_Edit/en "Help4.x:Fields: Edit/en") + +**Workflow** + +- **Enable Workflow**. Use customised workflows to manage articles. + [Learn + more.](https://docs.joomla.org/J4.x:Workflow/en "J4.x:Workflow/en") + +### Permissions + +This section lets you set up the default [Access Control +List](https://docs.joomla.org/Access_Control_List/en "Access Control List/en") +permissions for all articles in all categories. + + + +To change the permissions for articles and categories, do the following. + +1. Select the **Group** by clicking its title located on the left. +2. Find the desired **Action**. + - **Configure ACL & Options**. Users can edit the options and + permissions. + - **Configure Options Only**. Users can edit the options exept the + permissions. + - **Access Administration Interface**. Users can access user + administration interface. + - **Create**. Users can create articles and categories. + - **Delete**. Users can delete articles and categories. + - **Edit**. Users can edit articles and categories. + - **Edit State**. User can change the published state and related + information. + - **Edit Own**. Users can edit own created articles and categories. + - **Edit Custom Field Value**. Users can edit any value of custom + fields submitted in articles and categories. + - **Manage Workflows**. Users can manage workflows. + - **Execute Transition**. Users can execute transitions. +3. Select the desired permission for the action you wish to change. + - **Inherited**. Inherited for users in this Group from the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#permissions "Help4.x:Site Global Configuration/en") + permissions. + - **Allowed**. Allowed for users in this Group.Note: 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 + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **Save**. Saves the articles options and stays in the current screen. +- **Save & Close**. Saves the articles options and closes the current + screen. +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. +- **Toggle Inline Help**. Show help text below some options. +- **Help**. Opens this help screen. + +## Quick Tips + +- If you are a beginning user, you can just keep the default values here + until you learn more about using global options. +- If you are an advanced user, you can save time by creating good + default values here. When you set up menu items and create articles, + you will be able to accept the default values for most options. +- All values set here can be overridden at the menu item, category, or + article level. + +## Related Information + +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| Articles: 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. | +| [Articles](https://docs.joomla.org/Help4.x:Articles/en "Help4.x:Articles/en") | The Article list is used to find, mark featured, add and edit articles. | +| [Articles: Edit](https://docs.joomla.org/Help4.x:Articles:_Edit/en "Help4.x:Articles: Edit/en") | This is where you can add and edit Articles. You can also select the Category for an Article and indicate whether or not it is Published and if it is selected to appear on the Front Page. | +| [Articles: Featured](https://docs.joomla.org/Help4.x:Articles:_Featured/en "Help4.x:Articles: Featured/en") | Used to control which 'Featured Articles' are displayed on the Front Page and in what order they are displayed. | +| [Articles: Categories](https://docs.joomla.org/Help4.x:Articles:_Categories/en "Help4.x:Articles: Categories/en") | The Articles Categories list is used to find, add, and edit articles categories. | +| [Menus: Archived Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Article_Archived/en "Help4.x:Menu Item: Article Archived/en") | Shows a customised list of articles ordered by date or title. Archived articles are no longer published but are still stored on the site. | +| [Menus: Category Blog](https://docs.joomla.org/Help4.x:Menu_Item:_Category_Blog/en "Help4.x:Menu Item: Category Blog/en") | Used to show articles belonging to a specific Category in a blog layout. Controls the Leading Articles, Intro Articles and additional links to more Articles. | +| [Menus: Category List](https://docs.joomla.org/Help4.x:Menu_Item:_Category_List/en "Help4.x:Menu Item: Category List/en") | Used to show articles belonging to a specific Category in a list layout. | +| [Menus: Create Article](https://docs.joomla.org/Help4.x:Menu_Item:_Create_Article/en "Help4.x:Menu Item: Create Article/en") | Allows users to submit an article. Normally this is available only to users who have logged in to the Frontend of the site. Users must have permission to create articles. | +| [Menus: Featured Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Articles/en "Help4.x:Menu Item: Featured Articles/en") | Used to show all Articles that have been tagged as Featured. Articles are shown in a Blog Layout. | +| [Menus: List All Categories in an Article Category Tree](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Categories/en "Help4.x:Menu Item: List All Categories/en") | Used to show a hierarchical list of Categories. Depending on the selected options for this layout, you can click on a category Title to show the articles in that category. | +| [Menus: Single Article](https://docs.joomla.org/Help4.x:Menu_Item:_Single_Article/en "Help4.x:Menu Item: Single Article/en") | Used to show one article. | diff --git a/manuals/help/articles/articles.md b/manuals/help/articles/articles.md new file mode 100644 index 0000000..cfd5b84 --- /dev/null +++ b/manuals/help/articles/articles.md @@ -0,0 +1,233 @@ +--- +sidebar_position: 1 +id: articles +title: "Help4.x:Articles" +--- +## Description + +The Articles list is used to find, mark featured, add, and edit +articles. + +Articles are the basic units of information in the content system and +the bottom level in the content hierarchy. Each Article is in exactly +one Category. + +## How to Access + +**Home Dashboard **→** Site **→** Articles** + +To add a Article: + +- click the **New** toolbar button + +To edit a Article: + +- select a **Title** from the list + +## Screenshot + + + +## Column Headers + +- **Checkbox**. Check this box to select articles. To select all + articles, check the box in the column heading. After boxes are checked + the toolbar button 'Actions' get active. +- **Ordering**. You can change the order of an article within a list as + follows: + - Select the Ordering icon Ordering icon in the List heading to make it active. + - Select one of the Three dots icons Three dots icon and drag it up or down to change the + position of that row in the list. + - In the Filter Options you may limit the list to articles that are + assigned for example to a Language. +- **Featured**. Click the icon to toggle. The article will show on the + [Featured + Articles](https://docs.joomla.org/Help4.x:Articles:_Featured/en "Help4.x:Articles: Featured/en") + page. +- **Status**. Status of article. Hover icon for informations. +- **Title**. The title of the article. Edit the article by clicking on + the Title. +- **Access**. The viewing [Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en") + for this article. +- **Author**. Name of the User who created this article. +- **Associations**. Shows the associated articles. Click on the Language + Code to open the article. [Multilingual + only.](https://docs.joomla.org/Help4.x:Multilingual_Associations/en "Help4.x:Multilingual Associations/en") +- **Language**. Articles language, default is 'All'. +- **Date Created**. The date this article was created. +- **Hits**. The number of times an article has been viewed. +- **ID**. A unique identification number for this article, you cannot + change this number. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of articles in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +### Filter Options + +Near the top of the page you will see the filter bar shown in the +[Screenshot](#screenshot) above. + +- **Select Featured**. Select from Unfeatured Articles / Featured + Articles. +- **Select Status**. Select from Trashed / Unpublished / Published / + Archived / All. +- **Select Category**. Select from the list of available categories. +- **Select Access**. Select from the list of available viewing access + levels. +- **Select Author**. Select from the list of available authors. +- **Select Language**. Select from the list of available languages. +- **Select Tag**. Select from the list of available tags. +- **Select Max Levels**. Select from the list of available levels. + +### Pagination + +**Page Controls**. When the number of articles is more than one page, +you will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **New**. Opens the editing screen to create a new article. +- **Actions**. Reveals a list of actions for selected articles. Check + one or more articles checkboxes to activate the list. + - **Publish**. Makes the selected articles available to visitors to + your website. + - **Unpublish**. Makes the selected articles unavailable to visitors + to your website. + - **Feature**. Marks selected articles as featured. + - **Unfeature**. Changes the status of featured articles to + unfeatured. + - **Archive**. Changes the status of the selected articles to indicate + that they are archived. [Learn + more.](https://docs.joomla.org/J4.x:How_to_Archive_an_Article/en "J4.x:How to Archive an Article/en") + - **Check-in**. Checks-in the selected articles. + - **Trash**. Changes the status of the selected articles to indicate + that they are trashed. [Learn + more.](https://docs.joomla.org/J4.x:Deleting_an_Article/en "J4.x:Deleting an Article/en") + - **Batch**. Batch processes the selected articles. +- **Options**. Opens [Articles: + Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en"). +- **Help**. Opens this help screen. + +## Batch Process + +The Batch Process allows a change in settings for a group of selected +articles. + + + +**How to Batch Process** a group of articles: + +1. Select one or more articles on the list by checking the desired + checkboxes. +2. Click the Batch Toolbar button. +3. Set one or more of the following values: + - To change the **Language**, select the desired new language from + the Set Language list box. + - To change the **Access Levels**, select the desired new access + level from the Set Access Level list box. + - To change the **Category**, select a category. To leave the + category unchanged, use the default value of 'Select'. + - To **copy** the articles to a different category, select the + desired category from the category list box and check the Copy + option. In this case, the original articles are unchanged and + the copies are assigned to the new category and, if selected, + the new language, access level, and tag. + - To **move** the articles to a different category, select the + desired category from the category list box and check the Move + option. In this case, the original articles will be moved to a + new category and, if selected, be assigned the new language, + access level, and tag. + - To add **Tags**, select the desired Tags from the dropdown or + choose to keep the tags currently added to the original articles. +4. When all of the settings are entered, click on Process to perform + the changes. A message **"Batch process completed successfully."** + will show. + +## Quick Tips + +- If Joomla is installed without sample data, one article category + called 'Uncategorised' is created automatically. +- To see trashed and archived articles, set the Status filter to 'All'. +- To change the ordering of articles within a category, click on the + Ordering column heading to sort by this column. Also, it is easier to + see the ordering if you filter on the desired category. + +## Related Information + +- [Home + Dashboard](https://docs.joomla.org/Help4.x:Home_Dashboard/en "Help4.x:Home Dashboard/en"): + Access to many default Joomla functions. + + + +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Articles: Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en") | 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. | +| Articles | The Article list is used to find, mark featured, add and edit articles. | +| [Articles: Edit](https://docs.joomla.org/Help4.x:Articles:_Edit/en "Help4.x:Articles: Edit/en") | This is where you can add and edit Articles. You can also select the Category for an Article and indicate whether or not it is Published and if it is selected to appear on the Front Page. | +| [Articles: Featured](https://docs.joomla.org/Help4.x:Articles:_Featured/en "Help4.x:Articles: Featured/en") | Used to control which 'Featured Articles' are displayed on the Front Page and in what order they are displayed. | +| [Articles: Categories](https://docs.joomla.org/Help4.x:Articles:_Categories/en "Help4.x:Articles: Categories/en") | The Articles Categories list is used to find, add, and edit articles categories. | +| [Menus: Archived Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Article_Archived/en "Help4.x:Menu Item: Article Archived/en") | Shows a customised list of articles ordered by date or title. Archived articles are no longer published but are still stored on the site. | +| [Menus: Category Blog](https://docs.joomla.org/Help4.x:Menu_Item:_Category_Blog/en "Help4.x:Menu Item: Category Blog/en") | Used to show articles belonging to a specific Category in a blog layout. Controls the Leading Articles, Intro Articles and additional links to more Articles. | +| [Menus: Category List](https://docs.joomla.org/Help4.x:Menu_Item:_Category_List/en "Help4.x:Menu Item: Category List/en") | Used to show articles belonging to a specific Category in a list layout. | +| [Menus: Create Article](https://docs.joomla.org/Help4.x:Menu_Item:_Create_Article/en "Help4.x:Menu Item: Create Article/en") | Allows users to submit an article. Normally this is available only to users who have logged in to the Frontend of the site. Users must have permission to create articles. | +| [Menus: Featured Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Articles/en "Help4.x:Menu Item: Featured Articles/en") | Used to show all Articles that have been tagged as Featured. Articles are shown in a Blog Layout. | +| [Menus: List All Categories in an Article Category Tree](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Categories/en "Help4.x:Menu Item: List All Categories/en") | Used to show a hierarchical list of Categories. Depending on the selected options for this layout, you can click on a category Title to show the articles in that category. | +| [Menus: Single Article](https://docs.joomla.org/Help4.x:Menu_Item:_Single_Article/en "Help4.x:Menu Item: Single Article/en") | Used to show one article. | diff --git a/manuals/help/banners/banners-categories.md b/manuals/help/banners/banners-categories.md new file mode 100644 index 0000000..3b11f13 --- /dev/null +++ b/manuals/help/banners/banners-categories.md @@ -0,0 +1,257 @@ +--- +sidebar_position: 2 +id: banners-categories +title: "Help4.x:Banners: Categories" +--- +## Description + +Used to view a list of existing Banner Categories, edit current and +create new Banner Categories. Note that Banner Categories are separate +from other Categories, such as for Articles, Contacts, News Feeds, and +Web Links. There must be at least one Banner Client and Banner Category +**before** a Banner can be created. + +## How to Access + +- Select **Components **→** Banners **→** Categories** + +## Screenshot + + + +## Column Headers + +Click on the column heading to sort the list by that column's value. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **Title**. The name of the item. For a Menu Item, the Title will + display in the Menu. For an Article or Category, the Title may + optionally be displayed on the web page. This entry is required. You + can open the item for editing by clicking on the Title. + + + +- **Hits**. The number of times an item has been viewed. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +### Filter Options + +- ***- Select Status -*** Shows items that are Published and + Unpublished. Does *not* show items that are Trashed or Archived. + - ***Trashed:*** Shows only items that are Trashed. **Important + Note:** To permanently delete items: Change the status of the items + to Trashed. Change the Status filter to Trashed. At this point the + trashed items will show and an icon called "Empty trash" will show + in the toolbar. Select the desired trashed items and click on "Empty + Trash" in the toolbar. The items will be permanently deleted. + - ***Unpublished:*** Shows only items that are Unpublished. + - ***Published:*** Shows only items that are Published. + - ***Archived:*** Shows only items that are Archived. + - ***All:*** Shows all items regardless of published status. + + + +- ***- Select Access -*** Show items with any viewing access level. + - ***\:*** Show items only with this viewing + access level. + + + +- ***- Select Language -*** Shows all items regardless of language set. + - ***\*** Show items only for this language. + - ***All*** Show items in which the language is set to All. This may + be items that are not language specific, such as images. + + + +- ***- Select Tags -*** Show items with any (or no) tag(s). + - ***\*** Show items only with this tag. + + + +- ***- Select Max Levels -:*** Show all items regardless of assigned + level. + - ***1*** Only show items with this level in the hierarchy. + - ***2-10*** Only show items whose category is in the top 2-10 levels + in the category hierarchy. + +### Number of Items to Display + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new item. + + + +- **Actions:** Reveals a list of actions for selected Items. Check one + or more Item checkboxes to activate the list. + + + +- **Rebuild.** Reconstructs and refreshes the relevant table. Normally, + you do *not* need to rebuild this table. This function is provided in + case the data in the table becomes corrupted. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Batch Process + +The Batch Process allows a change in settings for a group of selected +items marked with a check-mark in the corresponding check-mark boxes. To +use: click on the link found below the table of items being viewed to +activate the drop down field area. Using the 'Batch' Toolbar button will +open a pop up window as shown below. + + + +You can change one value or all three values at one time. + +***Note** - if you copy items to a new category, changes you have +selected from access level and language will be applied to the copies, +not the original.* + +**How to Batch Process** a group of items: + +- Select one or more items on the list by checking the desired category + check boxes. +- Click the 'Batch' Toolbar button. +- Set one or more of the following values: + - To change the **Access Levels**, select the desired new access level + from the Set Access Level list box. + - To change the **Language**, select the desired language from the Set + Language list box. + - To change the **Category**, select a category. To leave the category + unchanged, use the default value of "Select". + - To copy the items to a different category, select the desired + category from the category list box and check the Copy option. In + this case, the original items are unchanged and the copies are + assigned to the new category and, if selected, the new access + level and language. + - To move the items to a different category, select the desired + category from the category list box and check the Move option. In + this case, the original items will be moved to a new category and, + if selected, be assigned the new access level and language. +- When all of the settings are entered, click on Process to perform the + changes. A message **"Batch process completed successfully."** will + show. + +Note that nothing will happen if you (a) don't have any items selected +or (b) have not selected an access level, language, or category. If you +wish to clear your entered selections, click on the Cancel button. This +will return all of the Batch controls to their default values. Note that +this does *not* uncheck the check boxes for the items. + +## Quick Tips + +- You must add at least one Banner Client and Banner Category *before* + you can add a Banner. + +## Related Information + +- To create or edit Banners: [Banner - + New/Edit](https://docs.joomla.org/Help4.x:Banners:_Edit/en "Help4.x:Banners: Edit/en") +- To work with Banner Clients: [Banner Client + Manager](https://docs.joomla.org/Help4.x:Banners:_Clients/en "Help4.x:Banners: Clients/en") diff --git a/manuals/help/banners/banners-clients.md b/manuals/help/banners/banners-clients.md new file mode 100644 index 0000000..e89d46e --- /dev/null +++ b/manuals/help/banners/banners-clients.md @@ -0,0 +1,202 @@ +--- +sidebar_position: 3 +id: banners-clients +title: "Help4.x:Banners: Clients" +--- +## Description + +The Banner Client Manager is where you can edit existing Banner Clients +or create new ones. Note that you must have at least one Banner Client +and one Banner Category defined before you can add your first Banner. + +## How to Access + +- Select **Components → Banners → Clients** from the drop-down menu + of the ***Joomla! Administrator Panel***. You can also select the + 'Clients' menu link from the [Banner Categories + Manager](https://docs.joomla.org/Help4.x:Banners:_Categories/en "Help4.x:Banners: Categories/en"), + [Banner + Manager](https://docs.joomla.org/Help4.x:Banners:_Edit/en "Help4.x:Banners: Edit/en") + or the [Banner Tracks + Manager](https://docs.joomla.org/Help4.x:Banners:_Tracks/en "Help4.x:Banners: Tracks/en"). + +## Screenshot + + + +## Column Headers + +Click on the column heading to sort the list by that column's value. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Status**. The published status of the item. + + + +- **Client.** The Client for this Banner. Clients are entered using the + Banner Client Manager. +- **Contact.** The Contact for this Client. + + + +- **Published:** + Help-4x-icon-tick.png The number of published + items. Click the numbered button to show a list of just those items. + + + +- **Unpublished:** + Help-4x-icon-cross.png The number of unpublished + items. Click the numbered button to show a list of just those items. + + + +- **Archived:** Whether and how many items has been archived. You see + the Archived items by clicking on the icon in this column. + + + +- **Trashed** + Help-4x-icon-bin.png The number of trashed items. + Click the numbered button to show a list of just those items. +- **Purchase Type.** The banner purchase type of the client. This is + used to indicate how the client purchased the display time for their + banners - monthly, yearly, etc... + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +### Filter Options + +Near the top of the page you will see the filter bar shown in the +Screenshot above. The functions are: + +- **Select Status**. Select from Trashed / Unpublished / Published / + Archived / All. + +**Filter by Purchase Type** + +Help35-colheader-select-type-en.png + +- **Select Type.** Select the Purchase Type from the drop-down list box + of available Purchase Types. + +### Pagination + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new client. + + + +- **Actions:** Reveals a list of actions for selected Items. Check one + or more Item checkboxes to activate the list. + + + +- - **Publish**. Makes the selected client available to visitors to your + website. + +- - **Unpublish.** Makes the selected client unavailable to visitors to + your website. + +- - **Archive**. Changes the status of the selected client to indicate + that they are archived. Archived client can be moved back to the + published or unpublished state by selecting 'Archived' in the + 'Select Status' filter and changing the status of the client. + +- - **Check-In**. Checks-in the selected client. Works with one or + multiple client selected. + +- - **Trash**. Changes the status of the selected client to indicate + that they are trashed.Trashed client can still be recovered by + selecting 'Trashed' in the 'Select Status' filter and changing the + status of the articles to Published or Unpublished as preferred.To + permanently delete trashed client, select 'Trashed' in the 'Select + Status' filter, select the client to be permanently deleted, then + click the 'Empty Trash' toolbar icon. + + + +- **Help**. Opens this help screen. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + +## Options + +See [Banners: +Options](https://docs.joomla.org/Help4.x:Banners:_Options/en "Help4.x:Banners: Options/en"). + +## Related Information + +- To create or edit Banners: [Banner - + New/Edit](https://docs.joomla.org/Help4.x:Banners:_Edit/en "Help4.x:Banners: Edit/en") +- To work with Banner Categories: [Banner Category + Manager](https://docs.joomla.org/Help4.x:Banners:_Categories/en "Help4.x:Banners: Categories/en") diff --git a/manuals/help/banners/banners-edit.md b/manuals/help/banners/banners-edit.md new file mode 100644 index 0000000..dca01a2 --- /dev/null +++ b/manuals/help/banners/banners-edit.md @@ -0,0 +1,319 @@ +--- +sidebar_position: 4 +id: banners-edit +title: "Help4.x:Banners: Edit" +--- +## Description + +Used to add or edit banners which can be displayed on your Joomla! +website. Remember to create at least one [Banner +Client](https://docs.joomla.org/Help4.x:Banners:_Clients/en "Help4.x:Banners: Clients/en") +and one [Banner +Category](https://docs.joomla.org/Help4.x:Banners:_Categories/en "Help4.x:Banners: Categories/en") +before creating any Banners. + +## How to Access + +To '**add'** a new Banner or '**edit'** an existing Banner, navigate to +the [Banner +Manager](https://docs.joomla.org/Help4.x:Banners/en "Help4.x:Banners/en"): + +- Select **Components **→** Banners **→** New** to create a new Banner. +- Select **Components **→** Banners** and click on a Banner name to + '**Edit'** an existing Banner. + +## Screenshot + +A banner may be a clickable image or some custom code. The Image Type is +shown in the screenshot below. The custom type has the image selection +box replaced with a code text area. + + + +## Form Fields + +- **Name.** The name of the Banner. This is the name that will display + in the *Name* column of the [Banner + Manager](https://docs.joomla.org/Help4.x:Banners/en "Help4.x:Banners/en"). + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Type**. The type of banner to display. Options are an image file or + custom HTML code. + - **Image**. Image file to display for the banner. Click the *Select* + button to browse and select the image file to use. Use the + [Media](https://docs.joomla.org/Help4.x:Media/en "Help4.x:Media/en") + page to upload Banner image files to your site. Images for Banners + have to be in the https://docs.joomla.org/images/banners/ directory. + - **Width**. The fixed width to resize the banner image to. Leave + this blank if you want to use the actual width of the banner image + file. + - **Height**. The fixed height to resize the banner image to. Leave + this blank if you want to use the actual height of the banner + image file. + - **Alternative Text**. Text to display in place of the banner image + in the event the image cannot be displayed. + - **Alternative Text**. Alternative text for the Banner's image. + - **Custom**. Select Custom if you want to enter a custom code for + your banner. + - **Custom Code**. Use {CLICKURL} and {NAME} to merge 'Click URL' + and 'Name' values respectively into your custom code. For example: + `{NAME}`. + Another option is to enter an HTML custom code. For example: + `
` +- **Click URL**. The URL to navigate to when the User clicks on the + Banner. +- **Description**. Enter a description for the Banner. + +**Right Panel** + +- **Status**. The published status of the item. + + + +- **Pinned**. *(Yes or No)* Whether or not the Banner is "pinned". If + one or more Banners in a Category are designated "sticky," they will + take priority over Banners that are not sticky. + +*For example, if two Banners in a Category are pinned and a third Banner +is not pinned, the third Banner will not display if the Banner display +module setting is "Pinned, Randomise" or "Pinned, Ordering." Only the +two pinned Banners will display. If the pinned banners have a fixed +number of impressions, once those impressions are used up, the pinned +banners will no longer display, and the non-pinned banners will begin +displaying automatically.* + +- **Language**. Item language. + + + +- **Version Note**. Optional field to identify this version of the item + in the item's [Version + History](https://docs.joomla.org/Help40:Components_Version_History/en "Special:MyLanguage/Help40:Components Version History/en") + window. + +### Banner Details Tab + + + +- **Max. Impressions.** The number of Impressions purchased for this + Banner. Impressions are the number of times a Banner will be displayed + on a page. Check the 'Unlimited' checkbox if an unlimited number of + Impressions is allowed. +- **Total Impressions.** The number of times this Banner has been + displayed on a web page to a user. No entry is allowed. You can reset + this number to 0 by pressing the 'Reset impressions' button. +- **Total Clicks.** The number of times this Banner has been clicked. No + entry is allowed. You can reset this number to 0 by pressing the + 'Reset clicks' button. + + + +- **Client.** The Client for this Banner. Clients are entered using the + Banner Client Manager. + +Select one from the drop-down list box of existing Clients. + +- **Purchase Type:** The purchase type of the banner. This is used to + indicate how the banner client purchased the display time for the + banner. + +The following options are: (*-Use Client Default-, Unlimited, Yearly, +Monthly, Weekly, Daily*). + +- **Track Impressions.** Whether or not to track the number of times the + banner is displayed to web site visitors. +- **Track Clicks.** Whether or not to track the number of times the + banner is clicked by web site visitors. + +### Publishing Tab + + + +- **Start Publishing**. Date the Banner will publish and be available + for website. + +Enter the date (time optional) in format *year-month-date hrs:min:sec* +as '2013-01-07 14:10:00' or alternatively, use the modal 'pop up' window +and select a date from the calendar. + +- **Finish Publishing**. Date the Banner will stop being published and + will no longer be available for website. + +Enter the date (time optional) in format *year-month-date hrs:min:sec* +as '2013-01-07 14:10:00' or alternatively, use the modal 'pop up' window +and select a date from the calendar. + +- **Created Date**. Date the item(Article, Category, Weblink, etc.) was + created. + + + +- **Created By**. Name of the Joomla User who created this item. This + will default to the currently logged-in user. If you want to change + this to a different user, click the Select User button to select a + different user. + + + +- **Created by Alias**. This optional field allows you to enter in an + alias for this Author for this Article. This allows you to display a + different Author name for this Article. + + + +- **Modified Date**. Date of last modification. + + + +- **Modified By**. Username who performed the last modification. + + + +- **Revision**. Number of revisions to this item. + + + +- **Keywords**. Optional entry for keywords. Must be entered separated + by commas (for example, "cats, dogs, pets") and may be entered in + upper or lower case. (For example, "CATS" will match "cats" or + "Cats"). Keywords can be used in several ways: + 1. To help Search Engines and other systems classify the content of + the Article. + 2. In combination with Banner tags, to display specific Banners based + on the Article content. For example, say you have one Banner with + an ad for dog products and another Banner for cat products. You + can have your dog Banner display when a User is viewing a + dog-related Article and your cat Banner display for a cat-related + Article. To do this, you would: + - Add the keywords "dog" and "cat" to the appropriate Articles. + - Add the Tags "dog" and "cat" to the appropriate Banners in + [Banners: + Edit](https://docs.joomla.org/Help40:Banners:_Edit/en "Special:MyLanguage/Help40:Banners: Edit/en"). + - Set the Banner module Parameter 'Search By Tags' to "Yes" in + [Site Modules: + Banners](https://docs.joomla.org/Help40:Site_Modules:_Banners/en "Special:MyLanguage/Help40:Site Modules: Banners/en"). + 3. For articles only, in combination with the ['Articles - Related' + module](https://docs.joomla.org/Help40:Site_Modules:_Articles_-_Related/en "Special:MyLanguage/Help40:Site Modules: Articles - Related/en"), + to display Articles that share at least one keyword in common. For + example, if the current Article displayed has the keywords "cats, + dogs, monkeys", any other Articles with at least one of these + keywords will show in the 'Articles - Related' module. + + + +- **Use Own Prefix.** Whether or not to use the banner's prefix or that + of the client. Select *No* if you want to use the prefix of the banner + client. + + + +- **Meta Keyword Prefix:** When matching meta keywords, only search for + meta keywords with these optional prefixes. This improves performance. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Versions**. Opens the Item Version History window to show any prior + versions of this item. This allows you to view older versions of this + item and, if desired, restore from an older version. See [Version + History](https://docs.joomla.org/Help40:Components_Version_History/en "Special:MyLanguage/Help40:Components Version History/en") + for more information. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- Banners are placed on specific pages by adding Modules of type + 'Banners' using the [Module + Manager](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en"). +- If you have a series of Banners that you would like to display on one + or more pages in random order: + 1. Create the Banners you wish to include, making sure they have the + same Client and Category. + 2. Create a Banner Module for this Client and Category, and in the + Menu Assignment pick the Menu Selections for the module to display + on. + 3. In the Banner Module, set the 'Randomise' value to 'Sticky, + Randomise'. + +With these settings, the different Banners for that Client and Category +will display on the selected pages in random order. + +## Related Information + +**More Component Banner Help:** + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Banners](https://docs.joomla.org/Help4.x:Banners/en "Help4.x:Banners/en") | Used to view a list of existing Banners, edit current and create new Banners. There must be at least one Banner Client and Banner Category before a Banner can be created. | +| [Banners: Options](https://docs.joomla.org/Help4.x:Banners:_Options/en "Help4.x:Banners: Options/en") | Global options (configuration) for Banner Clients. | +| [Banners: Categories](https://docs.joomla.org/Help4.x:Banners:_Categories/en "Help4.x:Banners: Categories/en") | Used to view a list of existing Banner Categories, edit current and create new Banner Categories. Note that Banner Categories are separate from other Categories, such as for Articles, Contacts, News Feeds, and Web Links. There must be at least one Banner Client and Banner Category before a Banner can be created. | +| [Banners: New or Edit Category](https://docs.joomla.org/Help4.x:Banners:_New_or_Edit_Category/en "Help4.x:Banners: New or Edit Category/en") | This is where you can add a new Banner Category or edit an existing one. Note that you need to create at least one Banner Category before you can create a Banner. Also, Banner Categories are separate from other types of Categories, such as those for Articles, Contacts, and News Feeds. | +| [Banners: Clients](https://docs.joomla.org/Help4.x:Banners:_Clients/en "Help4.x:Banners: Clients/en") | The Banner Client Manager is where you can edit existing Banner Clients or create new ones. Note that you must have at least one Banner Client and one Banner Category defined before you can add your first Banner. | +| [Banners: New or Edit Client](https://docs.joomla.org/Help4.x:Banners:_New_or_Edit_Client/en "Help4.x:Banners: New or Edit Client/en") | This is where you add a new Banner Client or edit an existing one. Note that you need to create at least one Banner Client before you can create a Banner. | +| [Banners Tracks](https://docs.joomla.org/Help4.x:Banners:_Tracks/en "Help4.x:Banners: Tracks/en") | Used to view a list of existing Banner Tracking information. | + +**To place Banners on Pages:** + +| | | +|----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------| +| Related Help Screens | Description | +| [Modules Banners](https://docs.joomla.org/Help4.x:Site_Modules:_Banners/en "Help4.x:Site Modules: Banners/en") | The Banner Module displays the active Banners from the Component. | diff --git a/manuals/help/banners/banners-new-or-edit-category.md b/manuals/help/banners/banners-new-or-edit-category.md new file mode 100644 index 0000000..9c7ae80 --- /dev/null +++ b/manuals/help/banners/banners-new-or-edit-category.md @@ -0,0 +1,283 @@ +--- +sidebar_position: 5 +id: banners-new-or-edit-category +title: "Help4.x:Banners: New or Edit Category" +--- +## Description + +This is where you can add a new Banner Category or edit an existing one. +Note that you need to create at least one Banner Category before you can +create a Banner. Also, Banner Categories are separate from other types +of Categories, such as those for Articles, Contacts, and News Feeds. + +## How to Access + +Navigate to the [Banner Category +Manager](https://docs.joomla.org/Help4.x:Banners:_Categories/en "Help4.x:Banners: Categories/en"), +**Components **→** Banners **→** Categories** + +- **New**. Click on **New** icon in toolbar. +- **Edit**. To edit an existing Banner Category, click on the + **Category's Name** in the table of categories. + +## Screenshot + + + +## Form Fields + +- **Title.** The Title for this item. This may or may not display on the + page, depending on the parameter values you choose. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left panel** + +- **Description**. The description for the item. Category, Subcategory + and Web Link descriptions may be shown on web pages, depending on the + parameter settings. These descriptions are entered using the same + editor that is used for Articles. + +**Right Panel** + +- **Parent**. The item (category, menu item, and so on) that is the + parent of the item being edited. + + + +- **Status**. The published status of this item. + - *Published:* Item is visible in the Frontend of the site. + - *Unpublished:* Item is will not be visible to guests in the Frontend + of the site. It may be visible to logged in users who have edit + state permission for the item. + - *Archived:* Item will no longer show on blog or list menu items. + - *Trashed:* Item is deleted from the site but still in the database. + It can be permanently deleted from the database with the Empty Trash + function in Toolbar (see also [Deleting an + Article](https://docs.joomla.org/Deleting_an_Article/en "Special:MyLanguage/Deleting an Article/en")). + + + +- **Access**. Select the viewing access level for this item from the + list box. The access levels that display will depend on the what has + been set up for this site in [Users → Access + Levels](https://docs.joomla.org/Help40:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help40:Users: Viewing Access Levels/en"). + Note that access levels are separate from ACL permissions. Access + levels control what a user can see. ACL permissions control what + actions a user can perform. + + + +- **Language**. Select the language for this item. If you are not using + the multi-language feature of Joomla, keep the default of 'All'. + + + +- **Tags**. Assign tags to content items. You may select a tag from the + pre-defined list or enter a new tag by typing the name in the field + and pressing enter. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + + + +- **Version Note**. Optional field to identify this version of the item + in the item's [Version + History](https://docs.joomla.org/Help40:Components_Version_History/en "Special:MyLanguage/Help40:Components Version History/en") + window. + +## Options Tab + +- **Layout.** Select a layout from the list. +- **Image.** Optional: Select an image to display alongside this + Category. +- **Alt Text.** Alternative text for the icon - often used by screen + readers. + +## Publishing Tab + + + +### Publishing + +The grayed out fields are for information only and may not be edited. + +- **Created Date.** Date the item(Article, Category, Weblink, etc.) was + created. +- **Created by.** Optional, choose from a popup window of users. Select + User by clicking on the user's name. Defaults to user creating new + category if left blank. +- **Modified Date.** *(Informative only)* Date of last modification. +- **Modified By.** *(Informative only)* Username who performed the last + modification. +- **Hits.** Number of hits on a Category view. +- **ID.** The unique ID number automatically assigned to this item by + Joomla!. This number cannot be changed. +- **Meta Description.** An optional paragraph to be used as the + description of the page in the HTML output. This will generally + display in the results of search engines. If entered, this creates an + HTML meta element with a name attribute of "description" and a content + attribute equal to the entered text. +- **Meta Keywords.** Optional entry for keywords. Must be entered + separated by commas (for example, "cats, dogs, pets") and may be + entered in upper or lower case. (For example, "CATS" will match "cats" + or "Cats"). Keywords can be used in several ways: + - To help Search Engines and other systems classify the content of the + Article. + - In combination with Banner tags, to display specific Banners based + on the Article content. For example, say you have one Banner with an + ad for dog products and another Banner for cat products. You can + have your dog Banner display when a User is viewing a dog-related + Article and your cat Banner display for a cat-related Article. To do + this, you would: + - Add the keywords 'dog' and 'cat' to the appropriate Articles. + - Add the Tags 'dog' and 'cat' to the appropriate Banners in the + [Banner Manager + New/Edit](https://docs.joomla.org/Help4.x:Banners:_Edit/en "Help4.x:Banners: Edit/en") + screen. + - Set the Banner module Parameter 'Search By Tags' to 'Yes in the + [Banner Module + Edit](https://docs.joomla.org/Help4.x:Site_Modules:_Banners/en "Help4.x:Site Modules: Banners/en") + screen. + - For articles only, in combination with the [Related + Articles](https://docs.joomla.org/Help4.x:Site_Modules:_Articles_-_Related/en "Help4.x:Site Modules: Articles - Related/en") + module, to display Articles that share at least one keyword in + common. For example, if the current Article displayed has the + keywords "cats, dogs, monkeys", any other Articles with at least one + of these keywords will show in the Related Articles module. +- **Author.** Optional entry for an Author name within the metadata. If + entered, this creates an HTML meta element with the name attribute of + "author" and the content attribute as entered here. +- **Robots.** The instructions for web "robots" that browse to this + page. + - *Use Global*: Use the value set in the Component→Options for this + component. + - *Index, Follow*: Index this page and follow the links on this page. + - *No index, Follow*: Do not index this page, but still follow the + links on the page. For example, you might do this for a site map + page where you want the links to be indexed but you don't want this + page to show in search engines. + - *Index, No follow*: Index this page, but do not follow any links on + the page. For example, you might want to do this for an events + calendar, where you want the page to show in search engines but you + do not want to index each event. + - *No index, no follow*: Do not index this page or follow any links on + the page. + +## Permissions Tab + + + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Options.** Users can edit the options and + permissions of this extension. + - **Configure Options Only.** Users can edit the options except the + permissions of this extension. + - **Access Administration Interface.** Users can access user + administration interface of this extension. + - **Create.** Users can create content of this extension. + - **Delete.** Users can delete content of this extension. + - **Edit.** Users can edit content of this extension. + - **Edit State.** User can change the published state and related + information for content of this extension. + - **Edit Own.** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Versions**. Opens the Item Version History window to show any prior + versions of this item. This allows you to view older versions of this + item and, if desired, restore from an older version. See [Version + History](https://docs.joomla.org/Help40:Components_Version_History/en "Special:MyLanguage/Help40:Components Version History/en") + for more information. + + + +- **Associations**. With a specific language set for an item, allows + side by side editing in another language. This toolbar icon is shown + on [Multilingual + Sites](https://docs.joomla.org/Help4.x:Multilingual_Associations/en "Special:MyLanguage/Help4.x:Multilingual Associations/en") + only. + + + +- **Help**. Opens this help screen. + +## Related Information + +- To create or edit Banners: [Banner Category Manager - + New/Edit](https://docs.joomla.org/Help4.x:Banners:_Categories/en "Help4.x:Banners: Categories/en") +- To work with Banner Clients: [Banner Client + Manager](https://docs.joomla.org/Help4.x:Banners:_Clients/en "Help4.x:Banners: Clients/en") +- To place Banners on Pages: [Module + Manager](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") diff --git a/manuals/help/banners/banners-new-or-edit-client.md b/manuals/help/banners/banners-new-or-edit-client.md new file mode 100644 index 0000000..c7912c8 --- /dev/null +++ b/manuals/help/banners/banners-new-or-edit-client.md @@ -0,0 +1,158 @@ +--- +sidebar_position: 6 +id: banners-new-or-edit-client +title: "Help4.x:Banners: New or Edit Client" +--- +## Description + +This is where you add a new Banner Client or edit an existing one. Note +that you need to create at least one Banner Client before you can create +a Banner. + +## How to Access + +- Select **Components **→** Banners **→** Clients** in the Administrator + menu. + - To create a new Client click the New button in the Toolbar. + - To edit an existing Client click the name in the Client column. + +## Screenshot + + + +## Form Fields + +- **Name.** The name of this client. + +### Details Tab + +- **Contact Name.** The name of the contact person for this client. +- **Contact E-mail.** The e-mail address of the banner client. +- **Purchase Type.** The purchase type of the banner. This is used to + indicate how the banner client purchased the display time for the + banner - monthly, yearly, etc... +- **Track Impressions.** Whether or not to track the number of times the + banner is displayed to web site visitors. +- **Track Clicks.** Whether or not to track the number of times the + banner is clicked by web site visitors. +- **Additional Information.** Enter any extra information you want to + save for this client. + + + +- **Status**: Published status of the item. Possible values are: + - *Published*: The item is published. This is the only state that will + allow regular website users to view this item. + - *Unpublished*: The item is unpublished. + - *Archived*: The item has been archived. + - *Trashed*: The item has been sent to the Trash. + + + +- **Version Note**. Optional field to identify this version of the item + in the item's [Version + History](https://docs.joomla.org/Help40:Components_Version_History/en "Special:MyLanguage/Help40:Components Version History/en") + window. + +### Metadata Tab + + + +- **Keywords**. Optional entry for keywords. Must be entered separated + by commas (for example, "cats, dogs, pets") and may be entered in + upper or lower case. (For example, "CATS" will match "cats" or + "Cats"). Keywords can be used in several ways: + 1. To help Search Engines and other systems classify the content of + the Article. + 2. In combination with Banner tags, to display specific Banners based + on the Article content. For example, say you have one Banner with + an ad for dog products and another Banner for cat products. You + can have your dog Banner display when a User is viewing a + dog-related Article and your cat Banner display for a cat-related + Article. To do this, you would: + - Add the keywords "dog" and "cat" to the appropriate Articles. + - Add the Tags "dog" and "cat" to the appropriate Banners in + [Banners: + Edit](https://docs.joomla.org/Help40:Banners:_Edit/en "Special:MyLanguage/Help40:Banners: Edit/en"). + - Set the Banner module Parameter 'Search By Tags' to "Yes" in + [Site Modules: + Banners](https://docs.joomla.org/Help40:Site_Modules:_Banners/en "Special:MyLanguage/Help40:Site Modules: Banners/en"). + 3. For articles only, in combination with the ['Articles - Related' + module](https://docs.joomla.org/Help40:Site_Modules:_Articles_-_Related/en "Special:MyLanguage/Help40:Site Modules: Articles - Related/en"), + to display Articles that share at least one keyword in common. For + example, if the current Article displayed has the keywords "cats, + dogs, monkeys", any other Articles with at least one of these + keywords will show in the 'Articles - Related' module. + + + +- **Use Own Prefix.** Whether or not to use the banner's prefix or that + of the client. Select *No* if you want to use the prefix of the banner + client. + + + +- **Meta Keyword Prefix:** When matching meta keywords, only search for + meta keywords with these optional prefixes. This improves performance. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Versions**. Opens the Item Version History window to show any prior + versions of this item. This allows you to view older versions of this + item and, if desired, restore from an older version. See [Version + History](https://docs.joomla.org/Help40:Components_Version_History/en "Special:MyLanguage/Help40:Components Version History/en") + for more information. + + + +- **Help**. Opens this help screen. + +## Related Information + +- To create or edit Banners: [Banner - + New/Edit](https://docs.joomla.org/Help4.x:Banners:_Edit/en "Help4.x:Banners: Edit/en") +- To work with Banner Categories: [Banner Category + Manager](https://docs.joomla.org/Help4.x:Banners:_Categories/en "Help4.x:Banners: Categories/en") +- To place Banners on Pages: [Module + Manager](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") diff --git a/manuals/help/banners/banners-options.md b/manuals/help/banners/banners-options.md new file mode 100644 index 0000000..ab84073 --- /dev/null +++ b/manuals/help/banners/banners-options.md @@ -0,0 +1,132 @@ +--- +sidebar_position: 7 +id: banners-options +title: "Help4.x:Banners: Options" +--- +## Description + +Banner Options used globally for all banners. + +## How to Access + +- Select **Components **→** Banners** from the Administrator menu. + Then... + - Select the **Options** button in the Toolbar. The **Options** button + is available in Banners, Categories, Clients and Tracks pages. + +## Screenshot + +Help-4x-Banner-Options-screen-en.png + +## Form Fields + +### Client Tab + +- **Purchase Type.** (Unlimited/Yearly/Monthly/Weekly/Daily) This is + used to indicate how the banner client purchased the display time for + the banner +- **Track Impressions.** (Yes/No) Whether or not to count how many times + a Banner is displayed. +- **Track Clicks.** (Yes/No) Whether or not to count how many times a + Banner is clicked. +- **Meta Keyword Prefix.** When matching keywords (for matching Banners + to Articles based on Keywords), only search for keywords with this + prefix. This can improve performance. + +### History Tab + +This section allows you to set version history options for Banners, +Banner Clients, and Banner Categories. + + + +- **Enable Versions.** (Yes/No). Whether or not to save version history + for this component. If No, version history will not be saved for + component items or for this component's categories. +- **Maximum Versions.** The maximum number of versions to store for an + item. If an item is saved and the maximum number of versions has been + reached, the oldest version will be deleted automatically. If set to + 0, then versions will never be deleted automatically. Also, specific + versions may be flagged as "Keep Forever" and will not be deleted + automatically. Note that versions may be deleted manually using the + Delete button in the [Version + History](https://docs.joomla.org/Help4.x:Components_Version_History/en "Help4.x:Components Version History/en") + screen. + +### Permissions Tab + +This section shows permissions configuration for Banners. The screen +shows as follows. + + + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Optons**. Users can edit the options and + persimissions of this extension. + - **Configure Optons Only**. Users can edit the options exept the + persimissions of this extension. + - **Access Administration Interface**. Users can access user + administration interface of this extension. + - **Create:** Users can create content of this extension. + - **Delete:** Users can delete content of this extension. + - **Edit:** Users can edit content of this extension. + - **Edit State:** User can change the published state and related + information for content of this extension. + - **Edit Own:** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited:*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **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 + +- Remember, these choices are applied globally. + +## Related Information + +- [Banner Manager: Add/Edit + Banner](https://docs.joomla.org/Help4.x:Banners:_Edit/en "Help4.x:Banners: Edit/en") +- [Banner + Manager](https://docs.joomla.org/Help4.x:Banners/en "Help4.x:Banners/en") +- Banner Manager Configuration diff --git a/manuals/help/banners/banners-tracks.md b/manuals/help/banners/banners-tracks.md new file mode 100644 index 0000000..d53ab17 --- /dev/null +++ b/manuals/help/banners/banners-tracks.md @@ -0,0 +1,137 @@ +--- +sidebar_position: 8 +id: banners-tracks +title: "Help4.x:Banners: Tracks" +--- +## Description + +Used to view a list of existing Banner Tracking information. + +## How to Access + +- Select **Components **→** Banners **→** Tracks** + +## Screenshot + + + +## Column Headers + +Click on a column heading to sort the list by that column's value. + +- **Name.** The name and category of the banner. + + + +- **Client.** The Client for this Banner. Clients are entered using the + Banner Client Manager. +- **Type.** The type of the track. This is an impression or a click. +- **Count.** Number of impressions or clicks. +- **Date.** Date and hour of the impression or click. + +## List Filters + +Near the top of the page you will see the filter bar shown in the +Screenshot above. The functions are: + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + + + +- **Select Category**. Select from the list of available categories. + + + +- **Select Client**. Select from the list of available clients. + + +**Filter by Type.** Lets you show only items assigned to a specific +type. The list box will show the types defined. + + + +- ***- Select Type -:*** Show items assigned to any type. +- ***\:*** Show items assigned only to this type. + + + +- **Select Max Levels**. Select from the list of available levels. + +**Begin and End date.** + +- **Begin date.** The startingdate of the tracks to list. +- **End date.** The enddate of the tracks to list. + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Export**. Opens a window where you will be able export the Banner + Tracks. +- **Delete Tracks**. Will delete the selected Banner Tracks. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +See [Article Manager +Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en") +for more information. + +## Quick Tips + +- You must add at least one Banner Client and Banner Category *before* + you can add a Banner. + +## Related Information + +- To create or edit Banners: [Banner - + New/Edit](https://docs.joomla.org/Help4.x:Banners:_Edit/en "Help4.x:Banners: Edit/en") +- To work with Banner Clients: [Banner Client + Manager](https://docs.joomla.org/Help4.x:Banners:_Clients/en "Help4.x:Banners: Clients/en") +- To work with Banner Categories: [Banner Category + Manager](https://docs.joomla.org/Help4.x:Banners:_Categories/en "Help4.x:Banners: Categories/en") diff --git a/manuals/help/banners/banners.md b/manuals/help/banners/banners.md new file mode 100644 index 0000000..79f3c24 --- /dev/null +++ b/manuals/help/banners/banners.md @@ -0,0 +1,257 @@ +--- +sidebar_position: 1 +id: banners +title: "Help4.x:Banners" +--- +## Description + +Banners are blocks of content containing advertising information. Each +banner has a Client, the person paying for the information, and a Track +record, the number of times the banner has been selected. A site may +have several banners in different locations. The Banners screen shows a +list of existing Banners with links to edit current and create new +Banners. There must be at least one Banner Client and one Banner +Category **before** a Banner can be created. + +## How to Access + +- Select **Components **→** Banners **→** Banners** from the + Administrator menu. +- Or Select a numbered button in the [Banner Categories + Manager](https://docs.joomla.org/Help4.x:Banners:_Categories/en "Help4.x:Banners: Categories/en") + or the [Banner Clients + Manager](https://docs.joomla.org/Help4.x:Banners:_Clients/en "Help4.x:Banners: Clients/en") + pages. + +## Screenshot + + + +## Column Headers + +In the table containing Banners the different columns are listed below. +Click on the column heading on the banner manager screen to sort the +list by that column's value. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **Name.** The name of the Banner. Editing Option - 'click' on the name + to open the Banner for editing. + + + +- **Pinned**. *(Yes or No)* Whether or not the Banner is "pinned". If + one or more Banners in a Category are designated "sticky," they will + take priority over Banners that are not sticky. + +*For example, if two Banners in a Category are pinned and a third Banner +is not pinned, the third Banner will not display if the Banner display +module setting is "Pinned, Randomise" or "Pinned, Ordering." Only the +two pinned Banners will display. If the pinned banners have a fixed +number of impressions, once those impressions are used up, the pinned +banners will no longer display, and the non-pinned banners will begin +displaying automatically.* + +- **Client.** The Client for this Banner. Clients are entered using the + Banner Client Manager. + + + +- **Impressions.** The Impression count is the number of times the + Banner has been displayed on a page. The first number in this column + is the actual number of Impressions so far, and the second number is + how many Impressions were purchased by the client. + + + +- **Clicks.** The first number is the total number of clicks that have + been made on the Banner since the counter was reset. The second number + is what percentage of the time user clicked on the banner when it was + displayed. + + + +- **Language**. Item language. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +**Filter Options** + +Near the top of the page you will see the filter bar shown in the +Screenshot above. The functions are: + +- **Select Status**. Select from Trashed / Unpublished / Published / + Archived / All. + + + +- **Select Category**. Select from the list of available categories. + + + +- **Select Client**. Select from the list of available clients. + + + +- **Select Language**. Select from the list of available languages, if + the site manages more than 1 language. + + + +- **Select Max Levels**. Select from the list of available levels. + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new banner. + + + +- **Actions:** Reveals a list of actions for selected Items. Check one + or more Item checkboxes to activate the list. + + + +- - **Publish**. Makes the selected banner available to visitors to your + website. + +- - **Unpublish.** Makes the selected banner unavailable to visitors to + your website. + +- - **Archive**. Changes the status of the selected banner to indicate + that they are archived. Archived banner can be moved back to the + published or unpublished state by selecting 'Archived' in the + 'Select Status' filter and changing the status of the banner. + +- - **Check-In**. Checks-in the selected banner. Works with one or + multiple banner selected. + +- - **Trash**. Changes the status of the selected banner to indicate + that they are trashed.Trashed banner can still be recovered by + selecting 'Trashed' in the 'Select Status' filter and changing the + status of the articles to Published or Unpublished as preferred.To + permanently delete trashed banner, select 'Trashed' in the 'Select + Status' filter, select the banner to be permanently deleted, then + click the 'Empty Trash' toolbar icon. + +- - **Batch**. Batch processes the selected banner. Works with one or + multiple items selected. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +See [Banner Manager +Options](https://docs.joomla.org/Help4.x:Banners:_Options/en "Help4.x:Banners: Options/en") +for more information. + +## Quick Tips + +- You must add at least one [Banner + Client](https://docs.joomla.org/Help4.x:Banners:_Clients/en "Help4.x:Banners: Clients/en") + and [Banner + Category](https://docs.joomla.org/Help4.x:Banners:_Categories/en "Help4.x:Banners: Categories/en") + *before* you can [add a + Banner](https://docs.joomla.org/Help4.x:Banners:_Edit/en "Help4.x:Banners: Edit/en"). + +## Related Information + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Banners: Edit](https://docs.joomla.org/Help4.x:Banners:_Edit/en "Help4.x:Banners: Edit/en") | Used to add or edit banners which can be displayed on your Joomla! website. Remember to create at least one Banner + Client and oneBanner Category before creating any Banners. | +| [Banners: Options](https://docs.joomla.org/Help4.x:Banners:_Options/en "Help4.x:Banners: Options/en") | Global options (configuration) for Banner Clients. | +| [Banners: Categories](https://docs.joomla.org/Help4.x:Banners:_Categories/en "Help4.x:Banners: Categories/en") | Used to view a list of existing Banner Categories, edit current and create new Banner Categories. Note that Banner Categories are separate from other Categories, such as for Articles, Contacts, News Feeds, and Web Links. There must be at least one Banner Client and Banner Category before a Banner can be created. | +| [Banners: New or Edit Category](https://docs.joomla.org/Help4.x:Banners:_New_or_Edit_Category/en "Help4.x:Banners: New or Edit Category/en") | This is where you can add a new Banner Category or edit an existing one. Note that you need to create at least one Banner Category before you can create a Banner. Also, Banner Categories are separate from other types of Categories, such as those for Articles, Contacts, and News Feeds. | +| [Banners: Clients](https://docs.joomla.org/Help4.x:Banners:_Clients/en "Help4.x:Banners: Clients/en") | The Banner Client Manager is where you can edit existing Banner Clients or create new ones. Note that you must have at least one Banner Client and one Banner Category defined before you can add your first Banner. | +| [Banners: New or Edit Client](https://docs.joomla.org/Help4.x:Banners:_New_or_Edit_Client/en "Help4.x:Banners: New or Edit Client/en") | This is where you add a new Banner Client or edit an existing one. Note that you need to create at least one Banner Client before you can create a Banner. | +| [Banners: Tracks](https://docs.joomla.org/Help4.x:Banners:_Tracks/en "Help4.x:Banners: Tracks/en") | Used to view a list of existing Banner Tracking information. | diff --git a/manuals/help/cache/cache-options.md b/manuals/help/cache/cache-options.md new file mode 100644 index 0000000..f85fc8b --- /dev/null +++ b/manuals/help/cache/cache-options.md @@ -0,0 +1,74 @@ +--- +sidebar_position: 1 +id: cache-options +title: "Help4.x:Cache: Options" +--- +## Description + +Default permissions used for all cache in the Cache Component. + +## How to Access + +- Select **System **→** Clear Cache** from the Administrator menu. + Then... +- Select the **Options** button in the Toolbar. + +## Screenshot + + + +## Permissions + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Optons**. Users can edit the options and + persimissions of this extension. + - **Configure Optons Only**. Users can edit the options exept the + persimissions of this extension. + - **Access Administration Interface**. Users can access user + administration interface of this extension. + - **Create:** Users can create content of this extension. + - **Delete:** Users can delete content of this extension. + - **Edit:** Users can edit content of this extension. + - **Edit State:** User can change the published state and related + information for content of this extension. + - **Edit Own:** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited:*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +- **Save.** Saves the configurations and stays in the current screen. + + + +- **Save & Close**. Saves the configurations and closes the current + screen. + + + +- **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 + +- Remember, these choices are applied globally. diff --git a/manuals/help/cache/check-in-options.md b/manuals/help/cache/check-in-options.md new file mode 100644 index 0000000..967e804 --- /dev/null +++ b/manuals/help/cache/check-in-options.md @@ -0,0 +1,69 @@ +--- +sidebar_position: 2 +id: check-in-options +title: "Help4.x:Check-in: Options" +--- +## Description + +Default permissions used for the Checkin Component. + +## How to Access + +- Select **System **→** Setup panel **→** Global Configuration** from + the Administrator menu. Then... + - Select the **Check-in** item from the Component list. + +## Screenshot + + + +## Permissions + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Optons**. Users can edit the options and + persimissions of this extension. + - **Access Administration Interface**. Users can access user + administration interface of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited:*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the configurations and stays in the current screen. + + + +- **Save & Close**. Saves the configurations and closes the current + screen. + + + +- **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 + +- Remember, these choices are applied globally. diff --git a/manuals/help/chunks/chunks.md b/manuals/help/chunks/chunks.md new file mode 100644 index 0000000..a3bb198 --- /dev/null +++ b/manuals/help/chunks/chunks.md @@ -0,0 +1,794 @@ +--- +sidebar_position: 1 +id: chunks +title: "Help4.x:Chunks" +--- +## Chunks List in alphabet order + +| | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------| +| Chunk name | Notes | +| [Chunk4x:Add_Banners_Category_Permissions](https://docs.joomla.org/Chunk4x:Add_Banners_Category_Permissions "Chunk4x:Add Banners Category Permissions") | | +| [Chunk4x:Add_Category_Associations](https://docs.joomla.org/Chunk4x:Add_Category_Associations "Chunk4x:Add Category Associations") | | +| [Chunk4x:Add_Category_Details](https://docs.joomla.org/Chunk4x:Add_Category_Details "Chunk4x:Add Category Details") | | +| [Chunk4x:Add_Category_Metadata](https://docs.joomla.org/Chunk4x:Add_Category_Metadata "Chunk4x:Add Category Metadata") | | +| [Chunk4x:Add_Category_Options](https://docs.joomla.org/Chunk4x:Add_Category_Options "Chunk4x:Add Category Options") | | +| [Chunk4x:Add_Category_Permissions](https://docs.joomla.org/Chunk4x:Add_Category_Permissions "Chunk4x:Add Category Permissions") | | +| [Chunk4x:Add_Category_Publishing_Options](https://docs.joomla.org/Chunk4x:Add_Category_Publishing_Options "Chunk4x:Add Category Publishing Options") | | +| [Chunk4x:Add_Category_Quick_Edit_Buttons](https://docs.joomla.org/Chunk4x:Add_Category_Quick_Edit_Buttons "Chunk4x:Add Category Quick Edit Buttons") | | +| [Chunk4x:Add_Category_Workflow](https://docs.joomla.org/Chunk4x:Add_Category_Workflow "Chunk4x:Add Category Workflow") | | +| [Chunk4x:ArticleImagesAndLinks](https://docs.joomla.org/Chunk4x:ArticleImagesAndLinks "Chunk4x:ArticleImagesAndLinks") | | +| [Chunk4x:ArticleOptions-tab-articles](https://docs.joomla.org/Chunk4x:ArticleOptions-tab-articles "Chunk4x:ArticleOptions-tab-articles") | | +| [Chunk4x:ArticleOptions-tab-blog-feature-layout](https://docs.joomla.org/Chunk4x:ArticleOptions-tab-blog-feature-layout "Chunk4x:ArticleOptions-tab-blog-feature-layout") | | +| [Chunk4x:ArticleOptions-tab-categories](https://docs.joomla.org/Chunk4x:ArticleOptions-tab-categories "Chunk4x:ArticleOptions-tab-categories") | | +| [Chunk4x:ArticleOptions-tab-category](https://docs.joomla.org/Chunk4x:ArticleOptions-tab-category "Chunk4x:ArticleOptions-tab-category") | | +| [Chunk4x:ArticleOptions-tab-editing-layout](https://docs.joomla.org/Chunk4x:ArticleOptions-tab-editing-layout "Chunk4x:ArticleOptions-tab-editing-layout") | | +| [Chunk4x:ArticleOptions-tab-integration](https://docs.joomla.org/Chunk4x:ArticleOptions-tab-integration "Chunk4x:ArticleOptions-tab-integration") | | +| [Chunk4x:ArticleOptions-tab-list-layout](https://docs.joomla.org/Chunk4x:ArticleOptions-tab-list-layout "Chunk4x:ArticleOptions-tab-list-layout") | | +| [Chunk4x:ArticleOptions-tab-permissions](https://docs.joomla.org/Chunk4x:ArticleOptions-tab-permissions "Chunk4x:ArticleOptions-tab-permissions") | | +| [Chunk4x:ArticleOptions-tab-shared-options](https://docs.joomla.org/Chunk4x:ArticleOptions-tab-shared-options "Chunk4x:ArticleOptions-tab-shared-options") | | +| [Chunk4x:Change_Permissions](https://docs.joomla.org/Chunk4x:Change_Permissions "Chunk4x:Change Permissions") | | +| [Chunk4x:Code_Mirror](https://docs.joomla.org/Chunk4x:Code_Mirror "Chunk4x:Code Mirror") | | +| [Chunk4x:Colheader](https://docs.joomla.org/Chunk4x:Colheader "Chunk4x:Colheader") | | +| [Chunk4x:Colheader_Contact_Detail_List](https://docs.joomla.org/Chunk4x:Colheader_Contact_Detail_List "Chunk4x:Colheader Contact Detail List") | | +| [Chunk4x:Colheader_Enter_Title](https://docs.joomla.org/Chunk4x:Colheader_Enter_Title "Chunk4x:Colheader Enter Title") | | +| [Chunk4x:Colheader_ordering](https://docs.joomla.org/Chunk4x:Colheader_ordering "Chunk4x:Colheader ordering") | | +| [Chunk4x:Column_headers_helpscreens](https://docs.joomla.org/Chunk4x:Column_headers_helpscreens "Chunk4x:Column headers helpscreens") | | +| [Chunk4x:Contact_Display_Option](https://docs.joomla.org/Chunk4x:Contact_Display_Option "Chunk4x:Contact Display Option") | | +| [Chunk4x:Creating_a_Simple_Module_for_Joomla!3.x\_-\_Contents](https://docs.joomla.org/Chunk4x:Creating_a_Simple_Module_for_Joomla!3.x_-_Contents "Chunk4x:Creating a Simple Module for Joomla!3.x - Contents") | | +| [Chunk4x:EditNew](https://docs.joomla.org/Chunk4x:EditNew "Chunk4x:EditNew") | | +| [Chunk4x:ExtensionsModuleManager-tab-Permissions](https://docs.joomla.org/Chunk4x:ExtensionsModuleManager-tab-Permissions "Chunk4x:ExtensionsModuleManager-tab-Permissions") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_API_Authentication_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_API_Authentication_Group "Chunk4x:Extensions Plugin Manager Edit API Authentication Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_Action_Log_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Action_Log_Group "Chunk4x:Extensions Plugin Manager Edit Action Log Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_Authentication_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Authentication_Group "Chunk4x:Extensions Plugin Manager Edit Authentication Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_Behaviour_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Behaviour_Group "Chunk4x:Extensions Plugin Manager Edit Behaviour Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_Button_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Button_Group "Chunk4x:Extensions Plugin Manager Edit Button Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_CAPTCHA_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_CAPTCHA_Group "Chunk4x:Extensions Plugin Manager Edit CAPTCHA Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_Content_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Content_Group "Chunk4x:Extensions Plugin Manager Edit Content Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_Editor_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Editor_Group "Chunk4x:Extensions Plugin Manager Edit Editor Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_Extension_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Extension_Group "Chunk4x:Extensions Plugin Manager Edit Extension Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_Fields_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Fields_Group "Chunk4x:Extensions Plugin Manager Edit Fields Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_FileSystem_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_FileSystem_Group "Chunk4x:Extensions Plugin Manager Edit FileSystem Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_Installer_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Installer_Group "Chunk4x:Extensions Plugin Manager Edit Installer Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_Media_Action_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Media_Action_Group "Chunk4x:Extensions Plugin Manager Edit Media Action Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_Privacy_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Privacy_Group "Chunk4x:Extensions Plugin Manager Edit Privacy Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_Quick_Icon_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Quick_Icon_Group "Chunk4x:Extensions Plugin Manager Edit Quick Icon Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_Sample_Data_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Sample_Data_Group "Chunk4x:Extensions Plugin Manager Edit Sample Data Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_Smart_Search_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Smart_Search_Group "Chunk4x:Extensions Plugin Manager Edit Smart Search Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_System_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_System_Group "Chunk4x:Extensions Plugin Manager Edit System Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_Two_Factor_Authentication_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Two_Factor_Authentication_Group "Chunk4x:Extensions Plugin Manager Edit Two Factor Authentication Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_User_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_User_Group "Chunk4x:Extensions Plugin Manager Edit User Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_Web_Services_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Web_Services_Group "Chunk4x:Extensions Plugin Manager Edit Web Services Group") | | +| [Chunk4x:Extensions_Plugin_Manager_Edit_Workflow_Group](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Workflow_Group "Chunk4x:Extensions Plugin Manager Edit Workflow Group") | | +| [Chunk4x:Help-3x-add-new-access-level](https://docs.joomla.org/Chunk4x:Help-3x-add-new-access-level "Chunk4x:Help-3x-add-new-access-level") | | +| [Chunk4x:Help-3x-add-new-article](https://docs.joomla.org/Chunk4x:Help-3x-add-new-article "Chunk4x:Help-3x-add-new-article") | | +| [Chunk4x:Help-3x-add-new-banner](https://docs.joomla.org/Chunk4x:Help-3x-add-new-banner "Chunk4x:Help-3x-add-new-banner") | | +| [Chunk4x:Help-3x-add-new-banner-client](https://docs.joomla.org/Chunk4x:Help-3x-add-new-banner-client "Chunk4x:Help-3x-add-new-banner-client") | | +| [Chunk4x:Help-3x-add-new-category](https://docs.joomla.org/Chunk4x:Help-3x-add-new-category "Chunk4x:Help-3x-add-new-category") | | +| [Chunk4x:Help-3x-add-new-contact](https://docs.joomla.org/Chunk4x:Help-3x-add-new-contact "Chunk4x:Help-3x-add-new-contact") | | +| [Chunk4x:Help-3x-add-new-group](https://docs.joomla.org/Chunk4x:Help-3x-add-new-group "Chunk4x:Help-3x-add-new-group") | | +| [Chunk4x:Help-3x-add-new-langauge](https://docs.joomla.org/Chunk4x:Help-3x-add-new-langauge "Chunk4x:Help-3x-add-new-langauge") | | +| [Chunk4x:Help-3x-add-new-menu](https://docs.joomla.org/Chunk4x:Help-3x-add-new-menu "Chunk4x:Help-3x-add-new-menu") | | +| [Chunk4x:Help-3x-add-new-newsfeed](https://docs.joomla.org/Chunk4x:Help-3x-add-new-newsfeed "Chunk4x:Help-3x-add-new-newsfeed") | | +| [Chunk4x:Help-3x-add-new-redirect](https://docs.joomla.org/Chunk4x:Help-3x-add-new-redirect "Chunk4x:Help-3x-add-new-redirect") | | +| [Chunk4x:Help-3x-add-new-tag](https://docs.joomla.org/Chunk4x:Help-3x-add-new-tag "Chunk4x:Help-3x-add-new-tag") | | +| [Chunk4x:Help-3x-add-new-user](https://docs.joomla.org/Chunk4x:Help-3x-add-new-user "Chunk4x:Help-3x-add-new-user") | | +| [Chunk4x:Help-3x-add-new-weblink](https://docs.joomla.org/Chunk4x:Help-3x-add-new-weblink "Chunk4x:Help-3x-add-new-weblink") | | +| [Chunk4x:Help-3x-add-user-note](https://docs.joomla.org/Chunk4x:Help-3x-add-user-note "Chunk4x:Help-3x-add-user-note") | | +| [Chunk4x:Help-3x-add-user-note-category](https://docs.joomla.org/Chunk4x:Help-3x-add-user-note-category "Chunk4x:Help-3x-add-user-note-category") | | +| [Chunk4x:Help-3x-articles-configuration](https://docs.joomla.org/Chunk4x:Help-3x-articles-configuration "Chunk4x:Help-3x-articles-configuration") | | +| [Chunk4x:Help-3x-banners-configuration](https://docs.joomla.org/Chunk4x:Help-3x-banners-configuration "Chunk4x:Help-3x-banners-configuration") | | +| [Chunk4x:Help-3x-cache-manager-configuration](https://docs.joomla.org/Chunk4x:Help-3x-cache-manager-configuration "Chunk4x:Help-3x-cache-manager-configuration") | | +| [Chunk4x:Help-3x-check-in-configuration](https://docs.joomla.org/Chunk4x:Help-3x-check-in-configuration "Chunk4x:Help-3x-check-in-configuration") | | +| [Chunk4x:Help-3x-contacts-configuration](https://docs.joomla.org/Chunk4x:Help-3x-contacts-configuration "Chunk4x:Help-3x-contacts-configuration") | | +| [Chunk4x:Help-3x-global-configuration](https://docs.joomla.org/Chunk4x:Help-3x-global-configuration "Chunk4x:Help-3x-global-configuration") | | +| [Chunk4x:Help-3x-installation-manager-configuration](https://docs.joomla.org/Chunk4x:Help-3x-installation-manager-configuration "Chunk4x:Help-3x-installation-manager-configuration") | | +| [Chunk4x:Help-3x-joomla!-update-configuration](https://docs.joomla.org/Chunk4x:Help-3x-joomla!-update-configuration "Chunk4x:Help-3x-joomla!-update-configuration") | | +| [Chunk4x:Help-3x-language-manager-configuration](https://docs.joomla.org/Chunk4x:Help-3x-language-manager-configuration "Chunk4x:Help-3x-language-manager-configuration") | | +| [Chunk4x:Help-3x-main-menu-add-new-menu-item](https://docs.joomla.org/Chunk4x:Help-3x-main-menu-add-new-menu-item "Chunk4x:Help-3x-main-menu-add-new-menu-item") | | +| [Chunk4x:Help-3x-media-manager-configuration](https://docs.joomla.org/Chunk4x:Help-3x-media-manager-configuration "Chunk4x:Help-3x-media-manager-configuration") | | +| [Chunk4x:Help-3x-menu-item-type-articles-archived-articles](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-articles-archived-articles "Chunk4x:Help-3x-menu-item-type-articles-archived-articles") | | +| [Chunk4x:Help-3x-menu-item-type-articles-category-blog](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-articles-category-blog "Chunk4x:Help-3x-menu-item-type-articles-category-blog") | | +| [Chunk4x:Help-3x-menu-item-type-articles-category-list](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-articles-category-list "Chunk4x:Help-3x-menu-item-type-articles-category-list") | | +| [Chunk4x:Help-3x-menu-item-type-articles-create-article](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-articles-create-article "Chunk4x:Help-3x-menu-item-type-articles-create-article") | | +| [Chunk4x:Help-3x-menu-item-type-articles-featured-articles](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-articles-featured-articles "Chunk4x:Help-3x-menu-item-type-articles-featured-articles") | | +| [Chunk4x:Help-3x-menu-item-type-articles-list-all-categories](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-articles-list-all-categories "Chunk4x:Help-3x-menu-item-type-articles-list-all-categories") | | +| [Chunk4x:Help-3x-menu-item-type-articles-single-article](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-articles-single-article "Chunk4x:Help-3x-menu-item-type-articles-single-article") | | +| [Chunk4x:Help-3x-menu-item-type-contacts-featured-contacts](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-contacts-featured-contacts "Chunk4x:Help-3x-menu-item-type-contacts-featured-contacts") | | +| [Chunk4x:Help-3x-menu-item-type-contacts-list-all-contact-categories](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-contacts-list-all-contact-categories "Chunk4x:Help-3x-menu-item-type-contacts-list-all-contact-categories") | | +| [Chunk4x:Help-3x-menu-item-type-contacts-list-contacts-in-a-category](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-contacts-list-contacts-in-a-category "Chunk4x:Help-3x-menu-item-type-contacts-list-contacts-in-a-category") | | +| [Chunk4x:Help-3x-menu-item-type-contacts-single-contact](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-contacts-single-contact "Chunk4x:Help-3x-menu-item-type-contacts-single-contact") | | +| [Chunk4x:Help-3x-menu-item-type-newsfeeds-list-all-news-feed-categories](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-newsfeeds-list-all-news-feed-categories "Chunk4x:Help-3x-menu-item-type-newsfeeds-list-all-news-feed-categories") | | +| [Chunk4x:Help-3x-menu-item-type-newsfeeds-list-news-feeds-in-a-category](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-newsfeeds-list-news-feeds-in-a-category "Chunk4x:Help-3x-menu-item-type-newsfeeds-list-news-feeds-in-a-category") | | +| [Chunk4x:Help-3x-menu-item-type-newsfeeds-single-news-feed](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-newsfeeds-single-news-feed "Chunk4x:Help-3x-menu-item-type-newsfeeds-single-news-feed") | | +| [Chunk4x:Help-3x-menu-item-type-search-search-form-or-search-results](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-search-search-form-or-search-results "Chunk4x:Help-3x-menu-item-type-search-search-form-or-search-results") | | +| [Chunk4x:Help-3x-menu-item-type-smart-search-search](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-smart-search-search "Chunk4x:Help-3x-menu-item-type-smart-search-search") | | +| [Chunk4x:Help-3x-menu-item-type-tags-compact-list-of-tagged-items](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-tags-compact-list-of-tagged-items "Chunk4x:Help-3x-menu-item-type-tags-compact-list-of-tagged-items") | | +| [Chunk4x:Help-3x-menu-item-type-tags-list-of-all-tags](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-tags-list-of-all-tags "Chunk4x:Help-3x-menu-item-type-tags-list-of-all-tags") | | +| [Chunk4x:Help-3x-menu-item-type-tags-tagged-items](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-tags-tagged-items "Chunk4x:Help-3x-menu-item-type-tags-tagged-items") | | +| [Chunk4x:Help-3x-menu-item-type-users-manager-login-form](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-users-manager-login-form "Chunk4x:Help-3x-menu-item-type-users-manager-login-form") | | +| [Chunk4x:Help-3x-menu-item-type-weblinks-list-all-web-link-categories](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-weblinks-list-all-web-link-categories "Chunk4x:Help-3x-menu-item-type-weblinks-list-all-web-link-categories") | | +| [Chunk4x:Help-3x-menu-item-type-weblinks-list-web-links-in-a-category](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-weblinks-list-web-links-in-a-category "Chunk4x:Help-3x-menu-item-type-weblinks-list-web-links-in-a-category") | | +| [Chunk4x:Help-3x-menu-item-type-wrapper-iframe-wrapper](https://docs.joomla.org/Chunk4x:Help-3x-menu-item-type-wrapper-iframe-wrapper "Chunk4x:Help-3x-menu-item-type-wrapper-iframe-wrapper") | | +| [Chunk4x:Help-3x-menus-manager-configuration](https://docs.joomla.org/Chunk4x:Help-3x-menus-manager-configuration "Chunk4x:Help-3x-menus-manager-configuration") | | +| [Chunk4x:Help-3x-messaging-configuration](https://docs.joomla.org/Chunk4x:Help-3x-messaging-configuration "Chunk4x:Help-3x-messaging-configuration") | | +| [Chunk4x:Help-3x-module-administrator-admin-sub-menu](https://docs.joomla.org/Chunk4x:Help-3x-module-administrator-admin-sub-menu "Chunk4x:Help-3x-module-administrator-admin-sub-menu") | | +| [Chunk4x:Help-3x-module-administrator-administrator-menu](https://docs.joomla.org/Chunk4x:Help-3x-module-administrator-administrator-menu "Chunk4x:Help-3x-module-administrator-administrator-menu") | | +| [Chunk4x:Help-3x-module-administrator-common-tabs](https://docs.joomla.org/Chunk4x:Help-3x-module-administrator-common-tabs "Chunk4x:Help-3x-module-administrator-common-tabs") | | +| [Chunk4x:Help-3x-module-administrator-custom-html](https://docs.joomla.org/Chunk4x:Help-3x-module-administrator-custom-html "Chunk4x:Help-3x-module-administrator-custom-html") | | +| [Chunk4x:Help-3x-module-administrator-feed-display](https://docs.joomla.org/Chunk4x:Help-3x-module-administrator-feed-display "Chunk4x:Help-3x-module-administrator-feed-display") | | +| [Chunk4x:Help-3x-module-administrator-joomla!-version-information](https://docs.joomla.org/Chunk4x:Help-3x-module-administrator-joomla!-version-information "Chunk4x:Help-3x-module-administrator-joomla!-version-information") | | +| [Chunk4x:Help-3x-module-administrator-latest-news](https://docs.joomla.org/Chunk4x:Help-3x-module-administrator-latest-news "Chunk4x:Help-3x-module-administrator-latest-news") | | +| [Chunk4x:Help-3x-module-administrator-logged-in-users](https://docs.joomla.org/Chunk4x:Help-3x-module-administrator-logged-in-users "Chunk4x:Help-3x-module-administrator-logged-in-users") | | +| [Chunk4x:Help-3x-module-administrator-login-form](https://docs.joomla.org/Chunk4x:Help-3x-module-administrator-login-form "Chunk4x:Help-3x-module-administrator-login-form") | | +| [Chunk4x:Help-3x-module-administrator-multilingual-status](https://docs.joomla.org/Chunk4x:Help-3x-module-administrator-multilingual-status "Chunk4x:Help-3x-module-administrator-multilingual-status") | | +| [Chunk4x:Help-3x-module-administrator-popular-articles](https://docs.joomla.org/Chunk4x:Help-3x-module-administrator-popular-articles "Chunk4x:Help-3x-module-administrator-popular-articles") | | +| [Chunk4x:Help-3x-module-administrator-quick-icons](https://docs.joomla.org/Chunk4x:Help-3x-module-administrator-quick-icons "Chunk4x:Help-3x-module-administrator-quick-icons") | | +| [Chunk4x:Help-3x-module-administrator-statistics](https://docs.joomla.org/Chunk4x:Help-3x-module-administrator-statistics "Chunk4x:Help-3x-module-administrator-statistics") | | +| [Chunk4x:Help-3x-module-administrator-title](https://docs.joomla.org/Chunk4x:Help-3x-module-administrator-title "Chunk4x:Help-3x-module-administrator-title") | | +| [Chunk4x:Help-3x-module-administrator-toolbar](https://docs.joomla.org/Chunk4x:Help-3x-module-administrator-toolbar "Chunk4x:Help-3x-module-administrator-toolbar") | | +| [Chunk4x:Help-3x-module-administrator-user-status](https://docs.joomla.org/Chunk4x:Help-3x-module-administrator-user-status "Chunk4x:Help-3x-module-administrator-user-status") | | +| [Chunk4x:Help-3x-module-manager-configuration](https://docs.joomla.org/Chunk4x:Help-3x-module-manager-configuration "Chunk4x:Help-3x-module-manager-configuration") | | +| [Chunk4x:Help-3x-module-site-archived-articles](https://docs.joomla.org/Chunk4x:Help-3x-module-site-archived-articles "Chunk4x:Help-3x-module-site-archived-articles") | | +| [Chunk4x:Help-3x-module-site-articles-categories](https://docs.joomla.org/Chunk4x:Help-3x-module-site-articles-categories "Chunk4x:Help-3x-module-site-articles-categories") | | +| [Chunk4x:Help-3x-module-site-articles-category](https://docs.joomla.org/Chunk4x:Help-3x-module-site-articles-category "Chunk4x:Help-3x-module-site-articles-category") | | +| [Chunk4x:Help-3x-module-site-articles-newsflash](https://docs.joomla.org/Chunk4x:Help-3x-module-site-articles-newsflash "Chunk4x:Help-3x-module-site-articles-newsflash") | | +| [Chunk4x:Help-3x-module-site-articles-related-articles](https://docs.joomla.org/Chunk4x:Help-3x-module-site-articles-related-articles "Chunk4x:Help-3x-module-site-articles-related-articles") | | +| [Chunk4x:Help-3x-module-site-banners](https://docs.joomla.org/Chunk4x:Help-3x-module-site-banners "Chunk4x:Help-3x-module-site-banners") | | +| [Chunk4x:Help-3x-module-site-breadcrumbs](https://docs.joomla.org/Chunk4x:Help-3x-module-site-breadcrumbs "Chunk4x:Help-3x-module-site-breadcrumbs") | | +| [Chunk4x:Help-3x-module-site-common-tabs](https://docs.joomla.org/Chunk4x:Help-3x-module-site-common-tabs "Chunk4x:Help-3x-module-site-common-tabs") | | +| [Chunk4x:Help-3x-module-site-custom-html](https://docs.joomla.org/Chunk4x:Help-3x-module-site-custom-html "Chunk4x:Help-3x-module-site-custom-html") | | +| [Chunk4x:Help-3x-module-site-feed-display](https://docs.joomla.org/Chunk4x:Help-3x-module-site-feed-display "Chunk4x:Help-3x-module-site-feed-display") | | +| [Chunk4x:Help-3x-module-site-footer](https://docs.joomla.org/Chunk4x:Help-3x-module-site-footer "Chunk4x:Help-3x-module-site-footer") | | +| [Chunk4x:Help-3x-module-site-language-switcher](https://docs.joomla.org/Chunk4x:Help-3x-module-site-language-switcher "Chunk4x:Help-3x-module-site-language-switcher") | | +| [Chunk4x:Help-3x-module-site-latest-news](https://docs.joomla.org/Chunk4x:Help-3x-module-site-latest-news "Chunk4x:Help-3x-module-site-latest-news") | | +| [Chunk4x:Help-3x-module-site-latest-users](https://docs.joomla.org/Chunk4x:Help-3x-module-site-latest-users "Chunk4x:Help-3x-module-site-latest-users") | | +| [Chunk4x:Help-3x-module-site-login](https://docs.joomla.org/Chunk4x:Help-3x-module-site-login "Chunk4x:Help-3x-module-site-login") | | +| [Chunk4x:Help-3x-module-site-menu](https://docs.joomla.org/Chunk4x:Help-3x-module-site-menu "Chunk4x:Help-3x-module-site-menu") | | +| [Chunk4x:Help-3x-module-site-most-read-content](https://docs.joomla.org/Chunk4x:Help-3x-module-site-most-read-content "Chunk4x:Help-3x-module-site-most-read-content") | | +| [Chunk4x:Help-3x-module-site-popular-tags](https://docs.joomla.org/Chunk4x:Help-3x-module-site-popular-tags "Chunk4x:Help-3x-module-site-popular-tags") | | +| [Chunk4x:Help-3x-module-site-random-image](https://docs.joomla.org/Chunk4x:Help-3x-module-site-random-image "Chunk4x:Help-3x-module-site-random-image") | | +| [Chunk4x:Help-3x-module-site-search](https://docs.joomla.org/Chunk4x:Help-3x-module-site-search "Chunk4x:Help-3x-module-site-search") | | +| [Chunk4x:Help-3x-module-site-similar-tags](https://docs.joomla.org/Chunk4x:Help-3x-module-site-similar-tags "Chunk4x:Help-3x-module-site-similar-tags") | | +| [Chunk4x:Help-3x-module-site-smart-search-module](https://docs.joomla.org/Chunk4x:Help-3x-module-site-smart-search-module "Chunk4x:Help-3x-module-site-smart-search-module") | | +| [Chunk4x:Help-3x-module-site-statistics](https://docs.joomla.org/Chunk4x:Help-3x-module-site-statistics "Chunk4x:Help-3x-module-site-statistics") | | +| [Chunk4x:Help-3x-module-site-syndication-feeds](https://docs.joomla.org/Chunk4x:Help-3x-module-site-syndication-feeds "Chunk4x:Help-3x-module-site-syndication-feeds") | | +| [Chunk4x:Help-3x-module-site-weblinks](https://docs.joomla.org/Chunk4x:Help-3x-module-site-weblinks "Chunk4x:Help-3x-module-site-weblinks") | | +| [Chunk4x:Help-3x-module-site-whos-online](https://docs.joomla.org/Chunk4x:Help-3x-module-site-whos-online "Chunk4x:Help-3x-module-site-whos-online") | | +| [Chunk4x:Help-3x-module-site-wrapper](https://docs.joomla.org/Chunk4x:Help-3x-module-site-wrapper "Chunk4x:Help-3x-module-site-wrapper") | | +| [Chunk4x:Help-3x-newsfeeds-configuration](https://docs.joomla.org/Chunk4x:Help-3x-newsfeeds-configuration "Chunk4x:Help-3x-newsfeeds-configuration") | | +| [Chunk4x:Help-3x-plugin-manager-configuration](https://docs.joomla.org/Chunk4x:Help-3x-plugin-manager-configuration "Chunk4x:Help-3x-plugin-manager-configuration") | | +| [Chunk4x:Help-3x-post-installation-messages-configuration](https://docs.joomla.org/Chunk4x:Help-3x-post-installation-messages-configuration "Chunk4x:Help-3x-post-installation-messages-configuration") | | +| [Chunk4x:Help-3x-redirect-configuration](https://docs.joomla.org/Chunk4x:Help-3x-redirect-configuration "Chunk4x:Help-3x-redirect-configuration") | | +| [Chunk4x:Help-3x-search-configuration](https://docs.joomla.org/Chunk4x:Help-3x-search-configuration "Chunk4x:Help-3x-search-configuration") | | +| [Chunk4x:Help-3x-smart-search-configuration](https://docs.joomla.org/Chunk4x:Help-3x-smart-search-configuration "Chunk4x:Help-3x-smart-search-configuration") | | +| [Chunk4x:Help-3x-tags-configuration](https://docs.joomla.org/Chunk4x:Help-3x-tags-configuration "Chunk4x:Help-3x-tags-configuration") | | +| [Chunk4x:Help-3x-template-manager-configuration](https://docs.joomla.org/Chunk4x:Help-3x-template-manager-configuration "Chunk4x:Help-3x-template-manager-configuration") | | +| [Chunk4x:Help-3x-users-manager-configuration](https://docs.joomla.org/Chunk4x:Help-3x-users-manager-configuration "Chunk4x:Help-3x-users-manager-configuration") | | +| [Chunk4x:Help-3x-weblinks-configuration](https://docs.joomla.org/Chunk4x:Help-3x-weblinks-configuration "Chunk4x:Help-3x-weblinks-configuration") | | +| [Chunk4x:Help-4x-add-new-access-level](https://docs.joomla.org/Chunk4x:Help-4x-add-new-access-level "Chunk4x:Help-4x-add-new-access-level") | | +| [Chunk4x:Help-4x-add-new-group](https://docs.joomla.org/Chunk4x:Help-4x-add-new-group "Chunk4x:Help-4x-add-new-group") | | +| [Chunk4x:Help-4x-add-new-user](https://docs.joomla.org/Chunk4x:Help-4x-add-new-user "Chunk4x:Help-4x-add-new-user") | | +| [Chunk4x:Help-4x-add-user-note-category](https://docs.joomla.org/Chunk4x:Help-4x-add-user-note-category "Chunk4x:Help-4x-add-user-note-category") | | +| [Chunk4x:Help_Screen_Description_Categories](https://docs.joomla.org/Chunk4x:Help_Screen_Description_Categories "Chunk4x:Help Screen Description Categories") | | +| [Chunk4x:Help_Screen_Description_Fields](https://docs.joomla.org/Chunk4x:Help_Screen_Description_Fields "Chunk4x:Help Screen Description Fields") | | +| [Chunk4x:Help_screen_column_header_404hits](https://docs.joomla.org/Chunk4x:Help_screen_column_header_404hits "Chunk4x:Help screen column header 404hits") | | +| [Chunk4x:Help_screen_column_header_Access](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Access "Chunk4x:Help screen column header Access") | | +| [Chunk4x:Help_screen_column_header_Access_Level](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Access_Level "Chunk4x:Help screen column header Access Level") | | +| [Chunk4x:Help_screen_column_header_Add_Menu_Title](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Add_Menu_Title "Chunk4x:Help screen column header Add Menu Title") | | +| [Chunk4x:Help_screen_column_header_Advanced_Search](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Advanced_Search "Chunk4x:Help screen column header Advanced Search") | | +| [Chunk4x:Help_screen_column_header_Alias](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Alias "Chunk4x:Help screen column header Alias") | | +| [Chunk4x:Help_screen_column_header_Allow_Empty_Search](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Allow_Empty_Search "Chunk4x:Help screen column header Allow Empty Search") | | +| [Chunk4x:Help_screen_column_header_Alt](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Alt "Chunk4x:Help screen column header Alt") | | +| [Chunk4x:Help_screen_column_header_Alt_text](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Alt_text "Chunk4x:Help screen column header Alt text") | | +| [Chunk4x:Help_screen_column_header_AlternativeLayout](https://docs.joomla.org/Chunk4x:Help_screen_column_header_AlternativeLayout "Chunk4x:Help screen column header AlternativeLayout") | | +| [Chunk4x:Help_screen_column_header_Alternative_Layout](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Alternative_Layout "Chunk4x:Help screen column header Alternative Layout") | | +| [Chunk4x:Help_screen_column_header_Archived](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Archived "Chunk4x:Help screen column header Archived") | | +| [Chunk4x:Help_screen_column_header_Article](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Article "Chunk4x:Help screen column header Article") | | +| [Chunk4x:Help_screen_column_header_Article_Button](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Article_Button "Chunk4x:Help screen column header Article Button") | | +| [Chunk4x:Help_screen_column_header_Article_Info_Title](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Article_Info_Title "Chunk4x:Help screen column header Article Info Title") | | +| [Chunk4x:Help_screen_column_header_Article_Order](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Article_Order "Chunk4x:Help screen column header Article Order") | | +| [Chunk4x:Help_screen_column_header_Article_Order_Featured](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Article_Order_Featured "Chunk4x:Help screen column header Article Order Featured") | | +| [Chunk4x:Help_screen_column_header_Articles_Field_to_Order_By](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Articles_Field_to_Order_By "Chunk4x:Help screen column header Articles Field to Order By") | | +| [Chunk4x:Help_screen_column_header_Ascending](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Ascending "Chunk4x:Help screen column header Ascending") | | +| [Chunk4x:Help_screen_column_header_Association](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Association "Chunk4x:Help screen column header Association") | | +| [Chunk4x:Help_screen_column_header_Associations](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Associations "Chunk4x:Help screen column header Associations") | | +| [Chunk4x:Help_screen_column_header_Author](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Author "Chunk4x:Help screen column header Author") | | +| [Chunk4x:Help_screen_column_header_Auto_add](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Auto_add "Chunk4x:Help screen column header Auto add") | | +| [Chunk4x:Help_screen_column_header_Auto_height](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Auto_height "Chunk4x:Help screen column header Auto height") | | +| [Chunk4x:Help_screen_column_header_Backendlang](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Backendlang "Chunk4x:Help screen column header Backendlang") | | +| [Chunk4x:Help_screen_column_header_Backendtemplate](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Backendtemplate "Chunk4x:Help screen column header Backendtemplate") | | +| [Chunk4x:Help_screen_column_header_Banner_Column_filter](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Banner_Column_filter "Chunk4x:Help screen column header Banner Column filter") | | +| [Chunk4x:Help_screen_column_header_Banner_List_Filter](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Banner_List_Filter "Chunk4x:Help screen column header Banner List Filter") | | +| [Chunk4x:Help_screen_column_header_Banner_Name](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Banner_Name "Chunk4x:Help screen column header Banner Name") | | +| [Chunk4x:Help_screen_column_header_Banner_Tracks_List_Filter](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Banner_Tracks_List_Filter "Chunk4x:Help screen column header Banner Tracks List Filter") | | +| [Chunk4x:Help_screen_column_header_Banners_Details_Tab](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Banners_Details_Tab "Chunk4x:Help screen column header Banners Details Tab") | | +| [Chunk4x:Help_screen_column_header_Batch_Process](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Batch_Process "Chunk4x:Help screen column header Batch Process") | | +| [Chunk4x:Help_screen_column_header_Batch_Process_Articles](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Batch_Process_Articles "Chunk4x:Help screen column header Batch Process Articles") | | +| [Chunk4x:Help_screen_column_header_Batch_Process_Categories](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Batch_Process_Categories "Chunk4x:Help screen column header Batch Process Categories") | | +| [Chunk4x:Help_screen_column_header_Batch_Process_Field_Groups](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Batch_Process_Field_Groups "Chunk4x:Help screen column header Batch Process Field Groups") | | +| [Chunk4x:Help_screen_column_header_Batch_Process_Fields](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Batch_Process_Fields "Chunk4x:Help screen column header Batch Process Fields") | | +| [Chunk4x:Help_screen_column_header_Blockuser](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Blockuser "Chunk4x:Help screen column header Blockuser") | | +| [Chunk4x:Help_screen_column_header_Blog_Layout](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Blog_Layout "Chunk4x:Help screen column header Blog Layout") | | +| [Chunk4x:Help_screen_column_header_Bootstrap_Size](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Bootstrap_Size "Chunk4x:Help screen column header Bootstrap Size") | | +| [Chunk4x:Help_screen_column_header_Browser_Page_Title](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Browser_Page_Title "Chunk4x:Help screen column header Browser Page Title") | | +| [Chunk4x:Help_screen_column_header_CSS_Class_Tag_Link](https://docs.joomla.org/Chunk4x:Help_screen_column_header_CSS_Class_Tag_Link "Chunk4x:Help screen column header CSS Class Tag Link") | | +| [Chunk4x:Help_screen_column_header_Cache_Group](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Cache_Group "Chunk4x:Help screen column header Cache Group") | | +| [Chunk4x:Help_screen_column_header_Cache_Time](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Cache_Time "Chunk4x:Help screen column header Cache Time") | | +| [Chunk4x:Help_screen_column_header_Caching](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Caching "Chunk4x:Help screen column header Caching") | | +| [Chunk4x:Help_screen_column_header_Caption](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Caption "Chunk4x:Help screen column header Caption") | | +| [Chunk4x:Help_screen_column_header_Category](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Category "Chunk4x:Help screen column header Category") | | +| [Chunk4x:Help_screen_column_header_Category_Created_By](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Category_Created_By "Chunk4x:Help screen column header Category Created By") | | +| [Chunk4x:Help_screen_column_header_Category_Description](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Category_Description "Chunk4x:Help screen column header Category Description") | | +| [Chunk4x:Help_screen_column_header_Category_Descriptions](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Category_Descriptions "Chunk4x:Help screen column header Category Descriptions") | | +| [Chunk4x:Help_screen_column_header_Category_Image](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Category_Image "Chunk4x:Help screen column header Category Image") | | +| [Chunk4x:Help_screen_column_header_Category_Order](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Category_Order "Chunk4x:Help screen column header Category Order") | | +| [Chunk4x:Help_screen_column_header_Category_Parameter](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Category_Parameter "Chunk4x:Help screen column header Category Parameter") | | +| [Chunk4x:Help_screen_column_header_Category_Title](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Category_Title "Chunk4x:Help screen column header Category Title") | | +| [Chunk4x:Help_screen_column_header_Category_hits](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Category_hits "Chunk4x:Help screen column header Category hits") | | +| [Chunk4x:Help_screen_column_header_Characters_count](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Characters_count "Chunk4x:Help screen column header Characters count") | | +| [Chunk4x:Help_screen_column_header_CheckInFilter](https://docs.joomla.org/Chunk4x:Help_screen_column_header_CheckInFilter "Chunk4x:Help screen column header CheckInFilter") | | +| [Chunk4x:Help_screen_column_header_Check_MIME_Types](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Check_MIME_Types "Chunk4x:Help screen column header Check MIME Types") | | +| [Chunk4x:Help_screen_column_header_Checkbox](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Checkbox "Chunk4x:Help screen column header Checkbox") | | +| [Chunk4x:Help_screen_column_header_Checkboxes](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Checkboxes "Chunk4x:Help screen column header Checkboxes") | | +| [Chunk4x:Help_screen_column_header_Checkin](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Checkin "Chunk4x:Help screen column header Checkin") | | +| [Chunk4x:Help_screen_column_header_Child_Tags](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Child_Tags "Chunk4x:Help screen column header Child Tags") | | +| [Chunk4x:Help_screen_column_header_Choose_Login_Redirect_Type](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Choose_Login_Redirect_Type "Chunk4x:Help screen column header Choose Login Redirect Type") | | +| [Chunk4x:Help_screen_column_header_Choose_Logout_Redirect_Type](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Choose_Logout_Redirect_Type "Chunk4x:Help screen column header Choose Logout Redirect Type") | | +| [Chunk4x:Help_screen_column_header_Choose_a_category](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Choose_a_category "Chunk4x:Help screen column header Choose a category") | | +| [Chunk4x:Help_screen_column_header_Clicks](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Clicks "Chunk4x:Help screen column header Clicks") | | +| [Chunk4x:Help_screen_column_header_Client](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Client "Chunk4x:Help screen column header Client") | | +| [Chunk4x:Help_screen_column_header_Column_filter](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Column_filter "Chunk4x:Help screen column header Column filter") | | +| [Chunk4x:Help_screen_column_header_Column_filter-Categories](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Column_filter-Categories "Chunk4x:Help screen column header Column filter-Categories") | | +| [Chunk4x:Help_screen_column_header_Comment](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Comment "Chunk4x:Help screen column header Comment") | | +| [Chunk4x:Help_screen_column_header_ConfirmPassword](https://docs.joomla.org/Chunk4x:Help_screen_column_header_ConfirmPassword "Chunk4x:Help screen column header ConfirmPassword") | | +| [Chunk4x:Help_screen_column_header_Contact](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Contact "Chunk4x:Help screen column header Contact") | | +| [Chunk4x:Help_screen_column_header_Contact_Category](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Contact_Category "Chunk4x:Help screen column header Contact Category") | | +| [Chunk4x:Help_screen_column_header_Content_Help_Screens_Rights](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Content_Help_Screens_Rights "Chunk4x:Help screen column header Content Help Screens Rights") | | +| [Chunk4x:Help_screen_column_header_Content_Rights](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Content_Rights "Chunk4x:Help screen column header Content Rights") | | +| [Chunk4x:Help_screen_column_header_Content_Type](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Content_Type "Chunk4x:Help screen column header Content Type") | | +| [Chunk4x:Help_screen_column_header_Created_Date](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Created_Date "Chunk4x:Help screen column header Created Date") | | +| [Chunk4x:Help_screen_column_header_Database_Table](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Database_Table "Chunk4x:Help screen column header Database Table") | | +| [Chunk4x:Help_screen_column_header_Date](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Date "Chunk4x:Help screen column header Date") | | +| [Chunk4x:Help_screen_column_header_Date_Filters](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Date_Filters "Chunk4x:Help screen column header Date Filters") | | +| [Chunk4x:Help_screen_column_header_Date_Format](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Date_Format "Chunk4x:Help screen column header Date Format") | | +| [Chunk4x:Help_screen_column_header_Date_for_Ordering](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Date_for_Ordering "Chunk4x:Help screen column header Date for Ordering") | | +| [Chunk4x:Help_screen_column_header_Default_Page](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Default_Page "Chunk4x:Help screen column header Default Page") | | +| [Chunk4x:Help_screen_column_header_Delete_All_Associations](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Delete_All_Associations "Chunk4x:Help screen column header Delete All Associations") | | +| [Chunk4x:Help_screen_column_header_Delete_Orphans](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Delete_Orphans "Chunk4x:Help screen column header Delete Orphans") | | +| [Chunk4x:Help_screen_column_header_Description](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Description "Chunk4x:Help screen column header Description") | | +| [Chunk4x:Help_screen_column_header_DescriptionBanner](https://docs.joomla.org/Chunk4x:Help_screen_column_header_DescriptionBanner "Chunk4x:Help screen column header DescriptionBanner") | | +| [Chunk4x:Help_screen_column_header_Description_Length](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Description_Length "Chunk4x:Help screen column header Description Length") | | +| [Chunk4x:Help_screen_column_header_Description_Text](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Description_Text "Chunk4x:Help screen column header Description Text") | | +| [Chunk4x:Help_screen_column_header_Detail_Tab_Banner_Edit](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Detail_Tab_Banner_Edit "Chunk4x:Help screen column header Detail Tab Banner Edit") | | +| [Chunk4x:Help_screen_column_header_Did_You_Mean](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Did_You_Mean "Chunk4x:Help screen column header Did You Mean") | | +| [Chunk4x:Help_screen_column_header_Direction](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Direction "Chunk4x:Help screen column header Direction") | | +| [Chunk4x:Help_screen_column_header_Display](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Display "Chunk4x:Help screen column header Display") | | +| [Chunk4x:Help_screen_column_header_DisplayNum](https://docs.joomla.org/Chunk4x:Help_screen_column_header_DisplayNum "Chunk4x:Help screen column header DisplayNum") | | +| [Chunk4x:Help_screen_column_header_Display_Format](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Display_Format "Chunk4x:Help screen column header Display Format") | | +| [Chunk4x:Help_screen_column_header_Display_In_Menu](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Display_In_Menu "Chunk4x:Help screen column header Display In Menu") | | +| [Chunk4x:Help_screen_column_header_Display_Select](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Display_Select "Chunk4x:Help screen column header Display Select") | | +| [Chunk4x:Help_screen_column_header_Drop_Down](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Drop_Down "Chunk4x:Help screen column header Drop Down") | | +| [Chunk4x:Help_screen_column_header_E-mail](https://docs.joomla.org/Chunk4x:Help_screen_column_header_E-mail "Chunk4x:Help screen column header E-mail") | | +| [Chunk4x:Help_screen_column_header_Editor](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Editor "Chunk4x:Help screen column header Editor") | | +| [Chunk4x:Help_screen_column_header_Email](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Email "Chunk4x:Help screen column header Email") | | +| [Chunk4x:Help_screen_column_header_Empty_Categories](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Empty_Categories "Chunk4x:Help screen column header Empty Categories") | | +| [Chunk4x:Help_screen_column_header_Empty_Subcategories](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Empty_Subcategories "Chunk4x:Help screen column header Empty Subcategories") | | +| [Chunk4x:Help_screen_column_header_Enable_Versions](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Enable_Versions "Chunk4x:Help screen column header Enable Versions") | | +| [Chunk4x:Help_screen_column_header_Enable_flash_uploader](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Enable_flash_uploader "Chunk4x:Help screen column header Enable flash uploader") | | +| [Chunk4x:Help_screen_column_header_Enabled](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Enabled "Chunk4x:Help screen column header Enabled") | | +| [Chunk4x:Help_screen_column_header_Enabled_module](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Enabled_module "Chunk4x:Help screen column header Enabled module") | | +| [Chunk4x:Help_screen_column_header_Enter_Access](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Enter_Access "Chunk4x:Help screen column header Enter Access") | | +| [Chunk4x:Help_screen_column_header_Enter_Access_Level](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Enter_Access_Level "Chunk4x:Help screen column header Enter Access Level") | | +| [Chunk4x:Help_screen_column_header_Enter_Category](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Enter_Category "Chunk4x:Help screen column header Enter Category") | | +| [Chunk4x:Help_screen_column_header_Enter_Created_By](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Enter_Created_By "Chunk4x:Help screen column header Enter Created By") | | +| [Chunk4x:Help_screen_column_header_Enter_Created_By_Alias](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Enter_Created_By_Alias "Chunk4x:Help screen column header Enter Created By Alias") | | +| [Chunk4x:Help_screen_column_header_Enter_Created_Date](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Enter_Created_Date "Chunk4x:Help screen column header Enter Created Date") | | +| [Chunk4x:Help_screen_column_header_Enter_Featured](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Enter_Featured "Chunk4x:Help screen column header Enter Featured") | | +| [Chunk4x:Help_screen_column_header_Enter_Language](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Enter_Language "Chunk4x:Help screen column header Enter Language") | | +| [Chunk4x:Help_screen_column_header_Enter_Menu_Item_Type](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Enter_Menu_Item_Type "Chunk4x:Help screen column header Enter Menu Item Type") | | +| [Chunk4x:Help_screen_column_header_Enter_Published](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Enter_Published "Chunk4x:Help screen column header Enter Published") | | +| [Chunk4x:Help_screen_column_header_Enter_Status](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Enter_Status "Chunk4x:Help screen column header Enter Status") | | +| [Chunk4x:Help_screen_column_header_Enter_Tags](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Enter_Tags "Chunk4x:Help screen column header Enter Tags") | | +| [Chunk4x:Help_screen_column_header_Enter_Title](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Enter_Title "Chunk4x:Help screen column header Enter Title") | | +| [Chunk4x:Help_screen_column_header_Expand_Advanced_Search](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Expand_Advanced_Search "Chunk4x:Help screen column header Expand Advanced Search") | | +| [Chunk4x:Help_screen_column_header_External_Reference](https://docs.joomla.org/Chunk4x:Help_screen_column_header_External_Reference "Chunk4x:Help screen column header External Reference") | | +| [Chunk4x:Help_screen_column_header_Featured](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Featured "Chunk4x:Help screen column header Featured") | | +| [Chunk4x:Help_screen_column_header_Featured_Articles](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Featured_Articles "Chunk4x:Help screen column header Featured Articles") | | +| [Chunk4x:Help_screen_column_header_Feed](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Feed "Chunk4x:Help screen column header Feed") | | +| [Chunk4x:Help_screen_column_header_Feed_Content](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Feed_Content "Chunk4x:Help screen column header Feed Content") | | +| [Chunk4x:Help_screen_column_header_Feed_Description](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Feed_Description "Chunk4x:Help screen column header Feed Description") | | +| [Chunk4x:Help_screen_column_header_Feed_Display_Order](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Feed_Display_Order "Chunk4x:Help screen column header Feed Display Order") | | +| [Chunk4x:Help_screen_column_header_Feed_First_Image](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Feed_First_Image "Chunk4x:Help screen column header Feed First Image") | | +| [Chunk4x:Help_screen_column_header_Feed_First_Image_Float](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Feed_First_Image_Float "Chunk4x:Help screen column header Feed First Image Float") | | +| [Chunk4x:Help_screen_column_header_Feed_Image](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Feed_Image "Chunk4x:Help screen column header Feed Image") | | +| [Chunk4x:Help_screen_column_header_Feed_Links](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Feed_Links "Chunk4x:Help screen column header Feed Links") | | +| [Chunk4x:Help_screen_column_header_Feed_Second_Image](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Feed_Second_Image "Chunk4x:Help screen column header Feed Second Image") | | +| [Chunk4x:Help_screen_column_header_Feed_Second_Image_Float](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Feed_Second_Image_Float "Chunk4x:Help screen column header Feed Second Image Float") | | +| [Chunk4x:Help_screen_column_header_Feed_Show_Tags](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Feed_Show_Tags "Chunk4x:Help screen column header Feed Show Tags") | | +| [Chunk4x:Help_screen_column_header_Feed_Title](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Feed_Title "Chunk4x:Help screen column header Feed Title") | | +| [Chunk4x:Help_screen_column_header_Feed_display_order](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Feed_display_order "Chunk4x:Help screen column header Feed display order") | | +| [Chunk4x:Help_screen_column_header_Field_Group](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Field_Group "Chunk4x:Help screen column header Field Group") | | +| [Chunk4x:Help_screen_column_header_Fields_Automatic_Display](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Automatic_Display "Chunk4x:Help screen column header Fields Automatic Display") | | +| [Chunk4x:Help_screen_column_header_Fields_Checkbox_Values](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Checkbox_Values "Chunk4x:Help screen column header Fields Checkbox Values") | | +| [Chunk4x:Help_screen_column_header_Fields_Columns](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Columns "Chunk4x:Help screen column header Fields Columns") | | +| [Chunk4x:Help_screen_column_header_Fields_Default_Date](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Default_Date "Chunk4x:Help screen column header Fields Default Date") | | +| [Chunk4x:Help_screen_column_header_Fields_Default_User_Groups](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Default_User_Groups "Chunk4x:Help screen column header Fields Default User Groups") | | +| [Chunk4x:Help_screen_column_header_Fields_Default_Users](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Default_Users "Chunk4x:Help screen column header Fields Default Users") | | +| [Chunk4x:Help_screen_column_header_Fields_Default_Value](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Default_Value "Chunk4x:Help screen column header Fields Default Value") | | +| [Chunk4x:Help_screen_column_header_Fields_Description](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Description "Chunk4x:Help screen column header Fields Description") | | +| [Chunk4x:Help_screen_column_header_Fields_Directory](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Directory "Chunk4x:Help screen column header Fields Directory") | | +| [Chunk4x:Help_screen_column_header_Fields_Edit_Class](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Edit_Class "Chunk4x:Help screen column header Fields Edit Class") | | +| [Chunk4x:Help_screen_column_header_Fields_Filter](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Filter "Chunk4x:Help screen column header Fields Filter") | | +| [Chunk4x:Help_screen_column_header_Fields_First](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_First "Chunk4x:Help screen column header Fields First") | | +| [Chunk4x:Help_screen_column_header_Fields_Height](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Height "Chunk4x:Help screen column header Fields Height") | | +| [Chunk4x:Help_screen_column_header_Fields_Hide_Buttons](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Hide_Buttons "Chunk4x:Help screen column header Fields Hide Buttons") | | +| [Chunk4x:Help_screen_column_header_Fields_Image_Class](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Image_Class "Chunk4x:Help screen column header Fields Image Class") | | +| [Chunk4x:Help_screen_column_header_Fields_Label](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Label "Chunk4x:Help screen column header Fields Label") | | +| [Chunk4x:Help_screen_column_header_Fields_Last](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Last "Chunk4x:Help screen column header Fields Last") | | +| [Chunk4x:Help_screen_column_header_Fields_List_Values](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_List_Values "Chunk4x:Help screen column header Fields List Values") | | +| [Chunk4x:Help_screen_column_header_Fields_Maximum_Length](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Maximum_Length "Chunk4x:Help screen column header Fields Maximum Length") | | +| [Chunk4x:Help_screen_column_header_Fields_Multiple](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Multiple "Chunk4x:Help screen column header Fields Multiple") | | +| [Chunk4x:Help_screen_column_header_Fields_Name](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Name "Chunk4x:Help screen column header Fields Name") | | +| [Chunk4x:Help_screen_column_header_Fields_Placeholder](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Placeholder "Chunk4x:Help screen column header Fields Placeholder") | | +| [Chunk4x:Help_screen_column_header_Fields_Preview](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Preview "Chunk4x:Help screen column header Fields Preview") | | +| [Chunk4x:Help_screen_column_header_Fields_Query](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Query "Chunk4x:Help screen column header Fields Query") | | +| [Chunk4x:Help_screen_column_header_Fields_Radio_Values](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Radio_Values "Chunk4x:Help screen column header Fields Radio Values") | | +| [Chunk4x:Help_screen_column_header_Fields_Relative](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Relative "Chunk4x:Help screen column header Fields Relative") | | +| [Chunk4x:Help_screen_column_header_Fields_Render_Class](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Render_Class "Chunk4x:Help screen column header Fields Render Class") | | +| [Chunk4x:Help_screen_column_header_Fields_Required](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Required "Chunk4x:Help screen column header Fields Required") | | +| [Chunk4x:Help_screen_column_header_Fields_Rows](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Rows "Chunk4x:Help screen column header Fields Rows") | | +| [Chunk4x:Help_screen_column_header_Fields_Schemes](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Schemes "Chunk4x:Help screen column header Fields Schemes") | | +| [Chunk4x:Help_screen_column_header_Fields_Show_Buttons](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Show_Buttons "Chunk4x:Help screen column header Fields Show Buttons") | | +| [Chunk4x:Help_screen_column_header_Fields_Show_Time](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Show_Time "Chunk4x:Help screen column header Fields Show Time") | | +| [Chunk4x:Help_screen_column_header_Fields_Step](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Step "Chunk4x:Help screen column header Fields Step") | | +| [Chunk4x:Help_screen_column_header_Fields_Title](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Title "Chunk4x:Help screen column header Fields Title") | | +| [Chunk4x:Help_screen_column_header_Fields_Type](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Type "Chunk4x:Help screen column header Fields Type") | | +| [Chunk4x:Help_screen_column_header_Fields_Width](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Fields_Width "Chunk4x:Help screen column header Fields Width") | | +| [Chunk4x:Help_screen_column_header_Filer_Field](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Filer_Field "Chunk4x:Help screen column header Filer Field") | | +| [Chunk4x:Help_screen_column_header_Filter_Field](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Filter_Field "Chunk4x:Help screen column header Filter Field") | | +| [Chunk4x:Help_screen_column_header_Finish_Publishing](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Finish_Publishing "Chunk4x:Help screen column header Finish Publishing") | | +| [Chunk4x:Help_screen_column_header_Float](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Float "Chunk4x:Help screen column header Float") | | +| [Chunk4x:Help_screen_column_header_For_each_feed_item_show](https://docs.joomla.org/Chunk4x:Help_screen_column_header_For_each_feed_item_show "Chunk4x:Help screen column header For each feed item show") | | +| [Chunk4x:Help_screen_column_header_Frame_border](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Frame_border "Chunk4x:Help screen column header Frame border") | | +| [Chunk4x:Help_screen_column_header_Frontendlang](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Frontendlang "Chunk4x:Help screen column header Frontendlang") | | +| [Chunk4x:Help_screen_column_header_Header_Class](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Header_Class "Chunk4x:Help screen column header Header Class") | | +| [Chunk4x:Help_screen_column_header_Header_Tag](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Header_Tag "Chunk4x:Help screen column header Header Tag") | | +| [Chunk4x:Help_screen_column_header_Heading_Description](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Heading_Description "Chunk4x:Help screen column header Heading Description") | | +| [Chunk4x:Help_screen_column_header_Heading_Image_File](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Heading_Image_File "Chunk4x:Help screen column header Heading Image File") | | +| [Chunk4x:Help_screen_column_header_Heading_Style](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Heading_Style "Chunk4x:Help screen column header Heading Style") | | +| [Chunk4x:Help_screen_column_header_Height](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Height "Chunk4x:Help screen column header Height") | | +| [Chunk4x:Help_screen_column_header_Helpsite](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Helpsite "Chunk4x:Help screen column header Helpsite") | | +| [Chunk4x:Help_screen_column_header_Hits](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Hits "Chunk4x:Help screen column header Hits") | | +| [Chunk4x:Help_screen_column_header_Home](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Home "Chunk4x:Help screen column header Home") | | +| [Chunk4x:Help_screen_column_header_Id](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Id "Chunk4x:Help screen column header Id") | | +| [Chunk4x:Help_screen_column_header_Ignored_Extensions](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Ignored_Extensions "Chunk4x:Help screen column header Ignored Extensions") | | +| [Chunk4x:Help_screen_column_header_Illegal_MIME_Types](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Illegal_MIME_Types "Chunk4x:Help screen column header Illegal MIME Types") | | +| [Chunk4x:Help_screen_column_header_Image](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Image "Chunk4x:Help screen column header Image") | | +| [Chunk4x:Help_screen_column_header_Image_Align](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Image_Align "Chunk4x:Help screen column header Image Align") | | +| [Chunk4x:Help_screen_column_header_Image_Button](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Image_Button "Chunk4x:Help screen column header Image Button") | | +| [Chunk4x:Help_screen_column_header_Image_Float](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Image_Float "Chunk4x:Help screen column header Image Float") | | +| [Chunk4x:Help_screen_column_header_Image_Position](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Image_Position "Chunk4x:Help screen column header Image Position") | | +| [Chunk4x:Help_screen_column_header_Image_tiny](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Image_tiny "Chunk4x:Help screen column header Image tiny") | | +| [Chunk4x:Help_screen_column_header_Impressions](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Impressions "Chunk4x:Help screen column header Impressions") | | +| [Chunk4x:Help_screen_column_header_Include_Subcategories](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Include_Subcategories "Chunk4x:Help screen column header Include Subcategories") | | +| [Chunk4x:Help_screen_column_header_Include_in_Feed](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Include_in_Feed "Chunk4x:Help screen column header Include in Feed") | | +| [Chunk4x:Help_screen_column_header_Intro_Articles](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Intro_Articles "Chunk4x:Help screen column header Intro Articles") | | +| [Chunk4x:Help_screen_column_header_Item_Description](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Item_Description "Chunk4x:Help screen column header Item Description") | | +| [Chunk4x:Help_screen_column_header_Item_Image](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Item_Image "Chunk4x:Help screen column header Item Image") | | +| [Chunk4x:Help_screen_column_header_Item_Images](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Item_Images "Chunk4x:Help screen column header Item Images") | | +| [Chunk4x:Help_screen_column_header_ItemsToCheckin](https://docs.joomla.org/Chunk4x:Help_screen_column_header_ItemsToCheckin "Chunk4x:Help screen column header ItemsToCheckin") | | +| [Chunk4x:Help_screen_column_header_Key_Reference](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Key_Reference "Chunk4x:Help screen column header Key Reference") | | +| [Chunk4x:Help_screen_column_header_Language](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Language "Chunk4x:Help screen column header Language") | | +| [Chunk4x:Help_screen_column_header_Language_Filter](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Language_Filter "Chunk4x:Help screen column header Language Filter") | | +| [Chunk4x:Help_screen_column_header_LastResetDate](https://docs.joomla.org/Chunk4x:Help_screen_column_header_LastResetDate "Chunk4x:Help screen column header LastResetDate") | | +| [Chunk4x:Help_screen_column_header_LastVisitDate](https://docs.joomla.org/Chunk4x:Help_screen_column_header_LastVisitDate "Chunk4x:Help screen column header LastVisitDate") | | +| [Chunk4x:Help_screen_column_header_Last_Updated_Date](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Last_Updated_Date "Chunk4x:Help screen column header Last Updated Date") | | +| [Chunk4x:Help_screen_column_header_Lastvisit](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Lastvisit "Chunk4x:Help screen column header Lastvisit") | | +| [Chunk4x:Help_screen_column_header_Layout](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Layout "Chunk4x:Help screen column header Layout") | | +| [Chunk4x:Help_screen_column_header_Leading_Articles](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Leading_Articles "Chunk4x:Help screen column header Leading Articles") | | +| [Chunk4x:Help_screen_column_header_Legal_Extensions](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Legal_Extensions "Chunk4x:Help screen column header Legal Extensions") | | +| [Chunk4x:Help_screen_column_header_Legal_Image_Extensions](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Legal_Image_Extensions "Chunk4x:Help screen column header Legal Image Extensions") | | +| [Chunk4x:Help_screen_column_header_Legal_MIME_Types](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Legal_MIME_Types "Chunk4x:Help screen column header Legal MIME Types") | | +| [Chunk4x:Help_screen_column_header_Limit_Box](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Limit_Box "Chunk4x:Help screen column header Limit Box") | | +| [Chunk4x:Help_screen_column_header_Link](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Link "Chunk4x:Help screen column header Link") | | +| [Chunk4x:Help_screen_column_header_Link_Author](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Link_Author "Chunk4x:Help screen column header Link Author") | | +| [Chunk4x:Help_screen_column_header_Link_Author_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Link_Author_Blog "Chunk4x:Help screen column header Link Author Blog") | | +| [Chunk4x:Help_screen_column_header_Link_CSS_Style](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Link_CSS_Style "Chunk4x:Help screen column header Link CSS Style") | | +| [Chunk4x:Help_screen_column_header_Link_Category](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Link_Category "Chunk4x:Help screen column header Link Category") | | +| [Chunk4x:Help_screen_column_header_Link_Category_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Link_Category_Blog "Chunk4x:Help screen column header Link Category Blog") | | +| [Chunk4x:Help_screen_column_header_Link_Image](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Link_Image "Chunk4x:Help screen column header Link Image") | | +| [Chunk4x:Help_screen_column_header_Link_Parent](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Link_Parent "Chunk4x:Help screen column header Link Parent") | | +| [Chunk4x:Help_screen_column_header_Link_Parent_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Link_Parent_Blog "Chunk4x:Help screen column header Link Parent Blog") | | +| [Chunk4x:Help_screen_column_header_Link_Title_Attribute](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Link_Title_Attribute "Chunk4x:Help screen column header Link Title Attribute") | | +| [Chunk4x:Help_screen_column_header_Linked_Titles](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Linked_Titles "Chunk4x:Help screen column header Linked Titles") | | +| [Chunk4x:Help_screen_column_header_Linked_Titles_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Linked_Titles_Blog "Chunk4x:Help screen column header Linked Titles Blog") | | +| [Chunk4x:Help_screen_column_header_Linked_User](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Linked_User "Chunk4x:Help screen column header Linked User") | | +| [Chunk4x:Help_screen_column_header_Links_Description](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Links_Description "Chunk4x:Help screen column header Links Description") | | +| [Chunk4x:Help_screen_column_header_LoginName](https://docs.joomla.org/Chunk4x:Help_screen_column_header_LoginName "Chunk4x:Help screen column header LoginName") | | +| [Chunk4x:Help_screen_column_header_Login_Description](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Login_Description "Chunk4x:Help screen column header Login Description") | | +| [Chunk4x:Help_screen_column_header_Login_Description_Text](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Login_Description_Text "Chunk4x:Help screen column header Login Description Text") | | +| [Chunk4x:Help_screen_column_header_Login_Image](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Login_Image "Chunk4x:Help screen column header Login Image") | | +| [Chunk4x:Help_screen_column_header_Login_Redirect](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Login_Redirect "Chunk4x:Help screen column header Login Redirect") | | +| [Chunk4x:Help_screen_column_header_Logout_Description](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Logout_Description "Chunk4x:Help screen column header Logout Description") | | +| [Chunk4x:Help_screen_column_header_Logout_Description_Text](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Logout_Description_Text "Chunk4x:Help screen column header Logout Description Text") | | +| [Chunk4x:Help_screen_column_header_Logout_Image](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Logout_Image "Chunk4x:Help screen column header Logout Image") | | +| [Chunk4x:Help_screen_column_header_Logout_Redirect](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Logout_Redirect "Chunk4x:Help screen column header Logout Redirect") | | +| [Chunk4x:Help_screen_column_header_Logout_Text](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Logout_Text "Chunk4x:Help screen column header Logout Text") | | +| [Chunk4x:Help_screen_column_header_Mach_Type](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Mach_Type "Chunk4x:Help screen column header Mach Type") | | +| [Chunk4x:Help_screen_column_header_Manager_Pagination](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Manager_Pagination "Chunk4x:Help screen column header Manager Pagination") | | +| [Chunk4x:Help_screen_column_header_Map_Count](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Map_Count "Chunk4x:Help screen column header Map Count") | | +| [Chunk4x:Help_screen_column_header_Maximum_Characters](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Maximum_Characters "Chunk4x:Help screen column header Maximum Characters") | | +| [Chunk4x:Help_screen_column_header_Maximum_Items](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Maximum_Items "Chunk4x:Help screen column header Maximum Items") | | +| [Chunk4x:Help_screen_column_header_Maximum_Level_Depth](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Maximum_Level_Depth "Chunk4x:Help screen column header Maximum Level Depth") | | +| [Chunk4x:Help_screen_column_header_Maximum_Size](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Maximum_Size "Chunk4x:Help screen column header Maximum Size") | | +| [Chunk4x:Help_screen_column_header_Maximum_Versions](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Maximum_Versions "Chunk4x:Help screen column header Maximum Versions") | | +| [Chunk4x:Help_screen_column_header_Menu](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu "Chunk4x:Help screen column header Menu") | | +| [Chunk4x:Help_screen_column_header_Menu_Image](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Image "Chunk4x:Help screen column header Menu Image") | | +| [Chunk4x:Help_screen_column_header_Menu_Item](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Item "Chunk4x:Help screen column header Menu Item") | | +| [Chunk4x:Help_screen_column_header_Menu_Item_Category](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Item_Category "Chunk4x:Help screen column header Menu Item Category") | | +| [Chunk4x:Help_screen_column_header_Menu_Item_Child_Tags](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Item_Child_Tags "Chunk4x:Help screen column header Menu Item Child Tags") | | +| [Chunk4x:Help_screen_column_header_Menu_Item_Common](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Item_Common "Chunk4x:Help screen column header Menu Item Common") | | +| [Chunk4x:Help_screen_column_header_Menu_Item_Filter_Field](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Item_Filter_Field "Chunk4x:Help screen column header Menu Item Filter Field") | | +| [Chunk4x:Help_screen_column_header_Menu_Item_Item_Description](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Item_Item_Description "Chunk4x:Help screen column header Menu Item Item Description") | | +| [Chunk4x:Help_screen_column_header_Menu_Item_Item_Image](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Item_Item_Image "Chunk4x:Help screen column header Menu Item Item Image") | | +| [Chunk4x:Help_screen_column_header_Menu_Item_Link](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Item_Link "Chunk4x:Help screen column header Menu Item Link") | | +| [Chunk4x:Help_screen_column_header_Menu_Item_Login_Redirect](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Item_Login_Redirect "Chunk4x:Help screen column header Menu Item Login Redirect") | | +| [Chunk4x:Help_screen_column_header_Menu_Item_Logout_Redirect](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Item_Logout_Redirect "Chunk4x:Help screen column header Menu Item Logout Redirect") | | +| [Chunk4x:Help_screen_column_header_Menu_Item_Match_Type](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Item_Match_Type "Chunk4x:Help screen column header Menu Item Match Type") | | +| [Chunk4x:Help_screen_column_header_Menu_Item_Maximum_Characters](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Item_Maximum_Characters "Chunk4x:Help screen column header Menu Item Maximum Characters") | | +| [Chunk4x:Help_screen_column_header_Menu_Item_Ordering](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Item_Ordering "Chunk4x:Help screen column header Menu Item Ordering") | | +| [Chunk4x:Help_screen_column_header_Menu_Item_Target_Window](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Item_Target_Window "Chunk4x:Help screen column header Menu Item Target Window") | | +| [Chunk4x:Help_screen_column_header_Menu_Item_Template_Style](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Item_Template_Style "Chunk4x:Help screen column header Menu Item Template Style") | | +| [Chunk4x:Help_screen_column_header_Menu_Item_Type](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Item_Type "Chunk4x:Help screen column header Menu Item Type") | | +| [Chunk4x:Help_screen_column_header_Menu_Location](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Location "Chunk4x:Help screen column header Menu Location") | | +| [Chunk4x:Help_screen_column_header_Menu_Title](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Title "Chunk4x:Help screen column header Menu Title") | | +| [Chunk4x:Help_screen_column_header_Menu_Type](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Menu_Type "Chunk4x:Help screen column header Menu Type") | | +| [Chunk4x:Help_screen_column_header_Meta_Keyword_Prefix](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Meta_Keyword_Prefix "Chunk4x:Help screen column header Meta Keyword Prefix") | | +| [Chunk4x:Help_screen_column_header_Metadata_Author](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Metadata_Author "Chunk4x:Help screen column header Metadata Author") | | +| [Chunk4x:Help_screen_column_header_Metadata_Description](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Metadata_Description "Chunk4x:Help screen column header Metadata Description") | | +| [Chunk4x:Help_screen_column_header_Metadata_Keywords](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Metadata_Keywords "Chunk4x:Help screen column header Metadata Keywords") | | +| [Chunk4x:Help_screen_column_header_Metadata_Robots](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Metadata_Robots "Chunk4x:Help screen column header Metadata Robots") | | +| [Chunk4x:Help_screen_column_header_Metadata_Secure](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Metadata_Secure "Chunk4x:Help screen column header Metadata Secure") | | +| [Chunk4x:Help_screen_column_header_Modified_By](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Modified_By "Chunk4x:Help screen column header Modified By") | | +| [Chunk4x:Help_screen_column_header_Modified_Date](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Modified_Date "Chunk4x:Help screen column header Modified Date") | | +| [Chunk4x:Help_screen_column_header_Module_Alternative_Layout](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Module_Alternative_Layout "Chunk4x:Help screen column header Module Alternative Layout") | | +| [Chunk4x:Help_screen_column_header_Module_Class_Suffix](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Module_Class_Suffix "Chunk4x:Help screen column header Module Class Suffix") | | +| [Chunk4x:Help_screen_column_header_Module_Description](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Module_Description "Chunk4x:Help screen column header Module Description") | | +| [Chunk4x:Help_screen_column_header_Module_Name](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Module_Name "Chunk4x:Help screen column header Module Name") | | +| [Chunk4x:Help_screen_column_header_Module_Ordering](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Module_Ordering "Chunk4x:Help screen column header Module Ordering") | | +| [Chunk4x:Help_screen_column_header_Module_Position](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Module_Position "Chunk4x:Help screen column header Module Position") | | +| [Chunk4x:Help_screen_column_header_Module_Style](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Module_Style "Chunk4x:Help screen column header Module Style") | | +| [Chunk4x:Help_screen_column_header_Module_Tag](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Module_Tag "Chunk4x:Help screen column header Module Tag") | | +| [Chunk4x:Help_screen_column_header_Module_Title](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Module_Title "Chunk4x:Help screen column header Module Title") | | +| [Chunk4x:Help_screen_column_header_Multi_Column_Order](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Multi_Column_Order "Chunk4x:Help screen column header Multi Column Order") | | +| [Chunk4x:Help_screen_column_header_Name](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Name "Chunk4x:Help screen column header Name") | | +| [Chunk4x:Help_screen_column_header_Name_global](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Name_global "Chunk4x:Help screen column header Name global") | | +| [Chunk4x:Help_screen_column_header_News_Feed_Description_Hide_Show](https://docs.joomla.org/Chunk4x:Help_screen_column_header_News_Feed_Description_Hide_Show "Chunk4x:Help screen column header News Feed Description Hide Show") | | +| [Chunk4x:Help_screen_column_header_No_Articles_Message](https://docs.joomla.org/Chunk4x:Help_screen_column_header_No_Articles_Message "Chunk4x:Help screen column header No Articles Message") | | +| [Chunk4x:Help_screen_column_header_No_Articles_in_Category](https://docs.joomla.org/Chunk4x:Help_screen_column_header_No_Articles_in_Category "Chunk4x:Help screen column header No Articles in Category") | | +| [Chunk4x:Help_screen_column_header_No_Articles_to_List](https://docs.joomla.org/Chunk4x:Help_screen_column_header_No_Articles_to_List "Chunk4x:Help screen column header No Articles to List") | | +| [Chunk4x:Help_screen_column_header_No_Columns](https://docs.joomla.org/Chunk4x:Help_screen_column_header_No_Columns "Chunk4x:Help screen column header No Columns") | | +| [Chunk4x:Help_screen_column_header_No_First_Subcategories](https://docs.joomla.org/Chunk4x:Help_screen_column_header_No_First_Subcategories "Chunk4x:Help screen column header No First Subcategories") | | +| [Chunk4x:Help_screen_column_header_No_Links](https://docs.joomla.org/Chunk4x:Help_screen_column_header_No_Links "Chunk4x:Help screen column header No Links") | | +| [Chunk4x:Help_screen_column_header_Not_Associated](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Not_Associated "Chunk4x:Help screen column header Not Associated") | | +| [Chunk4x:Help_screen_column_header_Note](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Note "Chunk4x:Help screen column header Note") | | +| [Chunk4x:Help_screen_column_header_Number](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Number "Chunk4x:Help screen column header Number") | | +| [Chunk4x:Help_screen_column_header_Number_Articles_in_Feed](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Number_Articles_in_Feed "Chunk4x:Help screen column header Number Articles in Feed") | | +| [Chunk4x:Help_screen_column_header_Number_Articles_to_List](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Number_Articles_to_List "Chunk4x:Help screen column header Number Articles to List") | | +| [Chunk4x:Help_screen_column_header_Number_Contacts_Category](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Number_Contacts_Category "Chunk4x:Help screen column header Number Contacts Category") | | +| [Chunk4x:Help_screen_column_header_Number_Feeds_in_Category](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Number_Feeds_in_Category "Chunk4x:Help screen column header Number Feeds in Category") | | +| [Chunk4x:Help_screen_column_header_Number_Items_To_List](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Number_Items_To_List "Chunk4x:Help screen column header Number Items To List") | | +| [Chunk4x:Help_screen_column_header_Number_Of_Columns](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Number_Of_Columns "Chunk4x:Help screen column header Number Of Columns") | | +| [Chunk4x:Help_screen_column_header_Number_Web_Links_in_Category](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Number_Web_Links_in_Category "Chunk4x:Help screen column header Number Web Links in Category") | | +| [Chunk4x:Help_screen_column_header_Number_of_Files](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Number_of_Files "Chunk4x:Help screen column header Number of Files") | | +| [Chunk4x:Help_screen_column_header_Number_of_Hits](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Number_of_Hits "Chunk4x:Help screen column header Number of Hits") | | +| [Chunk4x:Help_screen_column_header_Order](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Order "Chunk4x:Help screen column header Order") | | +| [Chunk4x:Help_screen_column_header_Ordering](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Ordering "Chunk4x:Help screen column header Ordering") | | +| [Chunk4x:Help_screen_column_header_Ordering_Direction](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Ordering_Direction "Chunk4x:Help screen column header Ordering Direction") | | +| [Chunk4x:Help_screen_column_header_Page_Subheading](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Page_Subheading "Chunk4x:Help screen column header Page Subheading") | | +| [Chunk4x:Help_screen_column_header_Pagebreak_Button](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Pagebreak_Button "Chunk4x:Help screen column header Pagebreak Button") | | +| [Chunk4x:Help_screen_column_header_Pages](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Pages "Chunk4x:Help screen column header Pages") | | +| [Chunk4x:Help_screen_column_header_Pagination](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Pagination "Chunk4x:Help screen column header Pagination") | | +| [Chunk4x:Help_screen_column_header_Pagination_Results](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Pagination_Results "Chunk4x:Help screen column header Pagination Results") | | +| [Chunk4x:Help_screen_column_header_Parent](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Parent "Chunk4x:Help screen column header Parent") | | +| [Chunk4x:Help_screen_column_header_Parent_Category](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Parent_Category "Chunk4x:Help screen column header Parent Category") | | +| [Chunk4x:Help_screen_column_header_Parent_Item](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Parent_Item "Chunk4x:Help screen column header Parent Item") | | +| [Chunk4x:Help_screen_column_header_Password](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Password "Chunk4x:Help screen column header Password") | | +| [Chunk4x:Help_screen_column_header_PasswordResetCount](https://docs.joomla.org/Chunk4x:Help_screen_column_header_PasswordResetCount "Chunk4x:Help screen column header PasswordResetCount") | | +| [Chunk4x:Help_screen_column_header_Path_to_files_folder](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Path_to_files_folder "Chunk4x:Help screen column header Path to files folder") | | +| [Chunk4x:Help_screen_column_header_Path_to_images_folder](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Path_to_images_folder "Chunk4x:Help screen column header Path to images folder") | | +| [Chunk4x:Help_screen_column_header_Permissions_SetPermissions](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Permissions_SetPermissions "Chunk4x:Help screen column header Permissions SetPermissions") | | +| [Chunk4x:Help_screen_column_header_Plugin_Name](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Plugin_Name "Chunk4x:Help screen column header Plugin Name") | | +| [Chunk4x:Help_screen_column_header_Position](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Position "Chunk4x:Help screen column header Position") | | +| [Chunk4x:Help_screen_column_header_Position_of_Article_Info](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Position_of_Article_Info "Chunk4x:Help screen column header Position of Article Info") | | +| [Chunk4x:Help_screen_column_header_Positioning_of_the_Links](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Positioning_of_the_Links "Chunk4x:Help screen column header Positioning of the Links") | | +| [Chunk4x:Help_screen_column_header_Postion](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Postion "Chunk4x:Help screen column header Postion") | | +| [Chunk4x:Help_screen_column_header_PublishFinishBanner](https://docs.joomla.org/Chunk4x:Help_screen_column_header_PublishFinishBanner "Chunk4x:Help screen column header PublishFinishBanner") | | +| [Chunk4x:Help_screen_column_header_PublishStartBanner](https://docs.joomla.org/Chunk4x:Help_screen_column_header_PublishStartBanner "Chunk4x:Help screen column header PublishStartBanner") | | +| [Chunk4x:Help_screen_column_header_Published](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Published "Chunk4x:Help screen column header Published") | | +| [Chunk4x:Help_screen_column_header_Publishing_Options_Tab](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Publishing_Options_Tab "Chunk4x:Help screen column header Publishing Options Tab") | | +| [Chunk4x:Help_screen_column_header_Purchase_Type](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Purchase_Type "Chunk4x:Help screen column header Purchase Type") | | +| [Chunk4x:Help_screen_column_header_Query_Explanation](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Query_Explanation "Chunk4x:Help screen column header Query Explanation") | | +| [Chunk4x:Help_screen_column_header_Ratings](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Ratings "Chunk4x:Help screen column header Ratings") | | +| [Chunk4x:Help_screen_column_header_Readmore_Button](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Readmore_Button "Chunk4x:Help screen column header Readmore Button") | | +| [Chunk4x:Help_screen_column_header_ReceiveSystemEmails](https://docs.joomla.org/Chunk4x:Help_screen_column_header_ReceiveSystemEmails "Chunk4x:Help screen column header ReceiveSystemEmails") | | +| [Chunk4x:Help_screen_column_header_Receivesystemmail](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Receivesystemmail "Chunk4x:Help screen column header Receivesystemmail") | | +| [Chunk4x:Help_screen_column_header_Redirect_Expired_URL](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Redirect_Expired_URL "Chunk4x:Help screen column header Redirect Expired URL") | | +| [Chunk4x:Help_screen_column_header_Redirect_New_URL](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Redirect_New_URL "Chunk4x:Help screen column header Redirect New URL") | | +| [Chunk4x:Help_screen_column_header_RegistrationDate](https://docs.joomla.org/Chunk4x:Help_screen_column_header_RegistrationDate "Chunk4x:Help screen column header RegistrationDate") | | +| [Chunk4x:Help_screen_column_header_Restrict_Uploads](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Restrict_Uploads "Chunk4x:Help screen column header Restrict Uploads") | | +| [Chunk4x:Help_screen_column_header_Result_Description](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Result_Description "Chunk4x:Help screen column header Result Description") | | +| [Chunk4x:Help_screen_column_header_Result_URL](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Result_URL "Chunk4x:Help screen column header Result URL") | | +| [Chunk4x:Help_screen_column_header_Results_ordering](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Results_ordering "Chunk4x:Help screen column header Results ordering") | | +| [Chunk4x:Help_screen_column_header_Revision](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Revision "Chunk4x:Help screen column header Revision") | | +| [Chunk4x:Help_screen_column_header_Revisions](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Revisions "Chunk4x:Help screen column header Revisions") | | +| [Chunk4x:Help_screen_column_header_Scroll_Bars](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Scroll_Bars "Chunk4x:Help screen column header Scroll Bars") | | +| [Chunk4x:Help_screen_column_header_Search_Content_Maps](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Search_Content_Maps "Chunk4x:Help screen column header Search Content Maps") | | +| [Chunk4x:Help_screen_column_header_Search_Filter](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Search_Filter "Chunk4x:Help screen column header Search Filter") | | +| [Chunk4x:Help_screen_column_header_Search_Query](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Search_Query "Chunk4x:Help screen column header Search Query") | | +| [Chunk4x:Help_screen_column_header_Search_Term](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Search_Term "Chunk4x:Help screen column header Search Term") | | +| [Chunk4x:Help_screen_column_header_Search_for](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Search_for "Chunk4x:Help screen column header Search for") | | +| [Chunk4x:Help_screen_column_header_Select_Access](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Access "Chunk4x:Help screen column header Select Access") | | +| [Chunk4x:Help_screen_column_header_Select_Article](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Article "Chunk4x:Help screen column header Select Article") | | +| [Chunk4x:Help_screen_column_header_Select_Assigned_Category](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Assigned_Category "Chunk4x:Help screen column header Select Assigned Category") | | +| [Chunk4x:Help_screen_column_header_Select_Author](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Author "Chunk4x:Help screen column header Select Author") | | +| [Chunk4x:Help_screen_column_header_Select_Categories](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Categories "Chunk4x:Help screen column header Select Categories") | | +| [Chunk4x:Help_screen_column_header_Select_Category](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Category "Chunk4x:Help screen column header Select Category") | | +| [Chunk4x:Help_screen_column_header_Select_Category_For_Associations](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Category_For_Associations "Chunk4x:Help screen column header Select Category For Associations") | | +| [Chunk4x:Help_screen_column_header_Select_Client](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Client "Chunk4x:Help screen column header Select Client") | | +| [Chunk4x:Help_screen_column_header_Select_Contact](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Contact "Chunk4x:Help screen column header Select Contact") | | +| [Chunk4x:Help_screen_column_header_Select_Enabled_State](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Enabled_State "Chunk4x:Help screen column header Select Enabled State") | | +| [Chunk4x:Help_screen_column_header_Select_Featured](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Featured "Chunk4x:Help screen column header Select Featured") | | +| [Chunk4x:Help_screen_column_header_Select_Feed_For_Associations](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Feed_For_Associations "Chunk4x:Help screen column header Select Feed For Associations") | | +| [Chunk4x:Help_screen_column_header_Select_Field_Group](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Field_Group "Chunk4x:Help screen column header Select Field Group") | | +| [Chunk4x:Help_screen_column_header_Select_Item_Type](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Item_Type "Chunk4x:Help screen column header Select Item Type") | | +| [Chunk4x:Help_screen_column_header_Select_Language](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Language "Chunk4x:Help screen column header Select Language") | | +| [Chunk4x:Help_screen_column_header_Select_Max_Levels](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Max_Levels "Chunk4x:Help screen column header Select Max Levels") | | +| [Chunk4x:Help_screen_column_header_Select_Menu](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Menu "Chunk4x:Help screen column header Select Menu") | | +| [Chunk4x:Help_screen_column_header_Select_Position](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Position "Chunk4x:Help screen column header Select Position") | | +| [Chunk4x:Help_screen_column_header_Select_Stage](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Stage "Chunk4x:Help screen column header Select Stage") | | +| [Chunk4x:Help_screen_column_header_Select_State](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_State "Chunk4x:Help screen column header Select State") | | +| [Chunk4x:Help_screen_column_header_Select_Status](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Status "Chunk4x:Help screen column header Select Status") | | +| [Chunk4x:Help_screen_column_header_Select_Tag](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Tag "Chunk4x:Help screen column header Select Tag") | | +| [Chunk4x:Help_screen_column_header_Select_Tag_Type](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Tag_Type "Chunk4x:Help screen column header Select Tag Type") | | +| [Chunk4x:Help_screen_column_header_Select_Tags](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Tags "Chunk4x:Help screen column header Select Tags") | | +| [Chunk4x:Help_screen_column_header_Select_Template](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Template "Chunk4x:Help screen column header Select Template") | | +| [Chunk4x:Help_screen_column_header_Select_Track_Type](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Track_Type "Chunk4x:Help screen column header Select Track Type") | | +| [Chunk4x:Help_screen_column_header_Select_Type](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_Type "Chunk4x:Help screen column header Select Type") | | +| [Chunk4x:Help_screen_column_header_Select_a_Category](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Select_a_Category "Chunk4x:Help screen column header Select a Category") | | +| [Chunk4x:Help_screen_column_header_Show_Associations](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Associations "Chunk4x:Help screen column header Show Associations") | | +| [Chunk4x:Help_screen_column_header_Show_Author](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Author "Chunk4x:Help screen column header Show Author") | | +| [Chunk4x:Help_screen_column_header_Show_Author_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Author_Blog "Chunk4x:Help screen column header Show Author Blog") | | +| [Chunk4x:Help_screen_column_header_Show_Author_in_List](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Author_in_List "Chunk4x:Help screen column header Show Author in List") | | +| [Chunk4x:Help_screen_column_header_Show_Category](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Category "Chunk4x:Help screen column header Show Category") | | +| [Chunk4x:Help_screen_column_header_Show_Category_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Category_Blog "Chunk4x:Help screen column header Show Category Blog") | | +| [Chunk4x:Help_screen_column_header_Show_Contact_List](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Contact_List "Chunk4x:Help screen column header Show Contact List") | | +| [Chunk4x:Help_screen_column_header_Show_Create_Date](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Create_Date "Chunk4x:Help screen column header Show Create Date") | | +| [Chunk4x:Help_screen_column_header_Show_Create_Date_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Create_Date_Blog "Chunk4x:Help screen column header Show Create Date Blog") | | +| [Chunk4x:Help_screen_column_header_Show_Date](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Date "Chunk4x:Help screen column header Show Date") | | +| [Chunk4x:Help_screen_column_header_Show_Email_Icon](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Email_Icon "Chunk4x:Help screen column header Show Email Icon") | | +| [Chunk4x:Help_screen_column_header_Show_Email_Icon_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Email_Icon_Blog "Chunk4x:Help screen column header Show Email Icon Blog") | | +| [Chunk4x:Help_screen_column_header_Show_Feed](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Feed "Chunk4x:Help screen column header Show Feed") | | +| [Chunk4x:Help_screen_column_header_Show_Feed_Link](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Feed_Link "Chunk4x:Help screen column header Show Feed Link") | | +| [Chunk4x:Help_screen_column_header_Show_Feed_Text](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Feed_Text "Chunk4x:Help screen column header Show Feed Text") | | +| [Chunk4x:Help_screen_column_header_Show_Heading_Image](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Heading_Image "Chunk4x:Help screen column header Show Heading Image") | | +| [Chunk4x:Help_screen_column_header_Show_Hits](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Hits "Chunk4x:Help screen column header Show Hits") | | +| [Chunk4x:Help_screen_column_header_Show_Hits_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Hits_Blog "Chunk4x:Help screen column header Show Hits Blog") | | +| [Chunk4x:Help_screen_column_header_Show_Hits_in_List](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Hits_in_List "Chunk4x:Help screen column header Show Hits in List") | | +| [Chunk4x:Help_screen_column_header_Show_Icons](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Icons "Chunk4x:Help screen column header Show Icons") | | +| [Chunk4x:Help_screen_column_header_Show_Icons_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Icons_Blog "Chunk4x:Help screen column header Show Icons Blog") | | +| [Chunk4x:Help_screen_column_header_Show_Intro_Text](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Intro_Text "Chunk4x:Help screen column header Show Intro Text") | | +| [Chunk4x:Help_screen_column_header_Show_Intro_Text_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Intro_Text_Blog "Chunk4x:Help screen column header Show Intro Text Blog") | | +| [Chunk4x:Help_screen_column_header_Show_Label](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Label "Chunk4x:Help screen column header Show Label") | | +| [Chunk4x:Help_screen_column_header_Show_Modify_Date](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Modify_Date "Chunk4x:Help screen column header Show Modify Date") | | +| [Chunk4x:Help_screen_column_header_Show_Modify_Date_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Modify_Date_Blog "Chunk4x:Help screen column header Show Modify Date Blog") | | +| [Chunk4x:Help_screen_column_header_Show_Module_Title](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Module_Title "Chunk4x:Help screen column header Show Module Title") | | +| [Chunk4x:Help_screen_column_header_Show_Navigation](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Navigation "Chunk4x:Help screen column header Show Navigation") | | +| [Chunk4x:Help_screen_column_header_Show_Navigation_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Navigation_Blog "Chunk4x:Help screen column header Show Navigation Blog") | | +| [Chunk4x:Help_screen_column_header_Show_On](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_On "Chunk4x:Help screen column header Show On") | | +| [Chunk4x:Help_screen_column_header_Show_Parent](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Parent "Chunk4x:Help screen column header Show Parent") | | +| [Chunk4x:Help_screen_column_header_Show_Parent_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Parent_Blog "Chunk4x:Help screen column header Show Parent Blog") | | +| [Chunk4x:Help_screen_column_header_Show_Print_Icon](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Print_Icon "Chunk4x:Help screen column header Show Print Icon") | | +| [Chunk4x:Help_screen_column_header_Show_Print_Icon_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Print_Icon_Blog "Chunk4x:Help screen column header Show Print Icon Blog") | | +| [Chunk4x:Help_screen_column_header_Show_Publish_Date](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Publish_Date "Chunk4x:Help screen column header Show Publish Date") | | +| [Chunk4x:Help_screen_column_header_Show_Publish_Date_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Publish_Date_Blog "Chunk4x:Help screen column header Show Publish Date Blog") | | +| [Chunk4x:Help_screen_column_header_Show_Ratings_in_List](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Ratings_in_List "Chunk4x:Help screen column header Show Ratings in List") | | +| [Chunk4x:Help_screen_column_header_Show_Read_More](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Read_More "Chunk4x:Help screen column header Show Read More") | | +| [Chunk4x:Help_screen_column_header_Show_Tag_Name](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Tag_Name "Chunk4x:Help screen column header Show Tag Name") | | +| [Chunk4x:Help_screen_column_header_Show_Tags](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Tags "Chunk4x:Help screen column header Show Tags") | | +| [Chunk4x:Help_screen_column_header_Show_Title](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Title "Chunk4x:Help screen column header Show Title") | | +| [Chunk4x:Help_screen_column_header_Show_Title_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Title_Blog "Chunk4x:Help screen column header Show Title Blog") | | +| [Chunk4x:Help_screen_column_header_Show_Title_Module](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Title_Module "Chunk4x:Help screen column header Show Title Module") | | +| [Chunk4x:Help_screen_column_header_Show_Title_with_Read_More](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Title_with_Read_More "Chunk4x:Help screen column header Show Title with Read More") | | +| [Chunk4x:Help_screen_column_header_Show_Top_Level_Category_Description](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Top_Level_Category_Description "Chunk4x:Help screen column header Show Top Level Category Description") | | +| [Chunk4x:Help_screen_column_header_Show_Unauthorised_Links](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Unauthorised_Links "Chunk4x:Help screen column header Show Unauthorised Links") | | +| [Chunk4x:Help_screen_column_header_Show_Votes_in_List](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Votes_in_List "Chunk4x:Help screen column header Show Votes in List") | | +| [Chunk4x:Help_screen_column_header_Show_Voting](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Voting "Chunk4x:Help screen column header Show Voting") | | +| [Chunk4x:Help_screen_column_header_Show_Voting_Blog](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Show_Voting_Blog "Chunk4x:Help screen column header Show Voting Blog") | | +| [Chunk4x:Help_screen_column_header_Size](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Size "Chunk4x:Help screen column header Size") | | +| [Chunk4x:Help_screen_column_header_Sort_Direction](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Sort_Direction "Chunk4x:Help screen column header Sort Direction") | | +| [Chunk4x:Help_screen_column_header_Sort_Field](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Sort_Field "Chunk4x:Help screen column header Sort Field") | | +| [Chunk4x:Help_screen_column_header_Sort_by](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Sort_by "Chunk4x:Help screen column header Sort by") | | +| [Chunk4x:Help_screen_column_header_Start_Publishing](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Start_Publishing "Chunk4x:Help screen column header Start Publishing") | | +| [Chunk4x:Help_screen_column_header_State](https://docs.joomla.org/Chunk4x:Help_screen_column_header_State "Chunk4x:Help screen column header State") | | +| [Chunk4x:Help_screen_column_header_Status](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Status "Chunk4x:Help screen column header Status") | | +| [Chunk4x:Help_screen_column_header_Status-Categories](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Status-Categories "Chunk4x:Help screen column header Status-Categories") | | +| [Chunk4x:Help_screen_column_header_Status-Feature](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Status-Feature "Chunk4x:Help screen column header Status-Feature") | | +| [Chunk4x:Help_screen_column_header_Status-Featured_Articles](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Status-Featured_Articles "Chunk4x:Help screen column header Status-Featured Articles") | | +| [Chunk4x:Help_screen_column_header_Status-SmartSearch](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Status-SmartSearch "Chunk4x:Help screen column header Status-SmartSearch") | | +| [Chunk4x:Help_screen_column_header_Status_Articles](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Status_Articles "Chunk4x:Help screen column header Status Articles") | | +| [Chunk4x:Help_screen_column_header_Status_Code](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Status_Code "Chunk4x:Help screen column header Status Code") | | +| [Chunk4x:Help_screen_column_header_Sticky](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Sticky "Chunk4x:Help screen column header Sticky") | | +| [Chunk4x:Help_screen_column_header_Subcategories_Descriptions](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Subcategories_Descriptions "Chunk4x:Help screen column header Subcategories Descriptions") | | +| [Chunk4x:Help_screen_column_header_Subcategory_Levels](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Subcategory_Levels "Chunk4x:Help screen column header Subcategory Levels") | | +| [Chunk4x:Help_screen_column_header_Submission_Redirect](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Submission_Redirect "Chunk4x:Help screen column header Submission Redirect") | | +| [Chunk4x:Help_screen_column_header_Table_Headings](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Table_Headings "Chunk4x:Help screen column header Table Headings") | | +| [Chunk4x:Help_screen_column_header_Tag](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Tag "Chunk4x:Help screen column header Tag") | | +| [Chunk4x:Help_screen_column_header_Tag_Description](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Tag_Description "Chunk4x:Help screen column header Tag Description") | | +| [Chunk4x:Help_screen_column_header_Tag_Full_Image](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Tag_Full_Image "Chunk4x:Help screen column header Tag Full Image") | | +| [Chunk4x:Help_screen_column_header_Tag_Image](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Tag_Image "Chunk4x:Help screen column header Tag Image") | | +| [Chunk4x:Help_screen_column_header_Tag_Publishing_Options_Tab](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Tag_Publishing_Options_Tab "Chunk4x:Help screen column header Tag Publishing Options Tab") | | +| [Chunk4x:Help_screen_column_header_Tags](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Tags "Chunk4x:Help screen column header Tags") | | +| [Chunk4x:Help_screen_column_header_Tags_Column_filter](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Tags_Column_filter "Chunk4x:Help screen column header Tags Column filter") | | +| [Chunk4x:Help_screen_column_header_Tags_List_Filter](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Tags_List_Filter "Chunk4x:Help screen column header Tags List Filter") | | +| [Chunk4x:Help_screen_column_header_Target_Window](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Target_Window "Chunk4x:Help screen column header Target Window") | | +| [Chunk4x:Help_screen_column_header_Teaser_Image](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Teaser_Image "Chunk4x:Help screen column header Teaser Image") | | +| [Chunk4x:Help_screen_column_header_Template_Style](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Template_Style "Chunk4x:Help screen column header Template Style") | | +| [Chunk4x:Help_screen_column_header_Timezone](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Timezone "Chunk4x:Help screen column header Timezone") | | +| [Chunk4x:Help_screen_column_header_Title](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Title "Chunk4x:Help screen column header Title") | | +| [Chunk4x:Help_screen_column_header_Top_Level_Category](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Top_Level_Category "Chunk4x:Help screen column header Top Level Category") | | +| [Chunk4x:Help_screen_column_header_Top_Level_Category_Description_Override](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Top_Level_Category_Description_Override "Chunk4x:Help screen column header Top Level Category Description Override") | | +| [Chunk4x:Help_screen_column_header_Trashed](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Trashed "Chunk4x:Help screen column header Trashed") | | +| [Chunk4x:Help_screen_column_header_Type](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Type "Chunk4x:Help screen column header Type") | | +| [Chunk4x:Help_screen_column_header_URL](https://docs.joomla.org/Chunk4x:Help_screen_column_header_URL "Chunk4x:Help screen column header URL") | | +| [Chunk4x:Help_screen_column_header_Unpublished](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Unpublished "Chunk4x:Help screen column header Unpublished") | | +| [Chunk4x:Help_screen_column_header_Use_Own_Prefix](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Use_Own_Prefix "Chunk4x:Help screen column header Use Own Prefix") | | +| [Chunk4x:Help_screen_column_header_Use_Search_Areas](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Use_Search_Areas "Chunk4x:Help screen column header Use Search Areas") | | +| [Chunk4x:Help_screen_column_header_Use_Search_Options](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Use_Search_Options "Chunk4x:Help screen column header Use Search Options") | | +| [Chunk4x:Help_screen_column_header_UserStatus](https://docs.joomla.org/Chunk4x:Help_screen_column_header_UserStatus "Chunk4x:Help screen column header UserStatus") | | +| [Chunk4x:Help_screen_column_header_Version_Note](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Version_Note "Chunk4x:Help screen column header Version Note") | | +| [Chunk4x:Help_screen_column_header_Votes](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Votes "Chunk4x:Help screen column header Votes") | | +| [Chunk4x:Help_screen_column_header_Width](https://docs.joomla.org/Chunk4x:Help_screen_column_header_Width "Chunk4x:Help screen column header Width") | | +| [Chunk4x:Help_screen_column_header_read_more_text](https://docs.joomla.org/Chunk4x:Help_screen_column_header_read_more_text "Chunk4x:Help screen column header read more text") | | +| [Chunk4x:Help_screen_component_options_permissions_conclusion](https://docs.joomla.org/Chunk4x:Help_screen_component_options_permissions_conclusion "Chunk4x:Help screen component options permissions conclusion") | | +| [Chunk4x:Help_screen_filter_bar_top_descriptor](https://docs.joomla.org/Chunk4x:Help_screen_filter_bar_top_descriptor "Chunk4x:Help screen filter bar top descriptor") | | +| [Chunk4x:Help_screen_filters_Access_Level](https://docs.joomla.org/Chunk4x:Help_screen_filters_Access_Level "Chunk4x:Help screen filters Access Level") | | +| [Chunk4x:Help_screen_filters_Language](https://docs.joomla.org/Chunk4x:Help_screen_filters_Language "Chunk4x:Help screen filters Language") | | +| [Chunk4x:Help_screen_filters_Max_Levels](https://docs.joomla.org/Chunk4x:Help_screen_filters_Max_Levels "Chunk4x:Help screen filters Max Levels") | | +| [Chunk4x:Help_screen_filters_Pagination](https://docs.joomla.org/Chunk4x:Help_screen_filters_Pagination "Chunk4x:Help screen filters Pagination") | | +| [Chunk4x:Help_screen_filters_Search_Bar_Filter](https://docs.joomla.org/Chunk4x:Help_screen_filters_Search_Bar_Filter "Chunk4x:Help screen filters Search Bar Filter") | | +| [Chunk4x:Help_screen_filters_Status](https://docs.joomla.org/Chunk4x:Help_screen_filters_Status "Chunk4x:Help screen filters Status") | | +| [Chunk4x:Help_screen_filters_Tags](https://docs.joomla.org/Chunk4x:Help_screen_filters_Tags "Chunk4x:Help screen filters Tags") | | +| [Chunk4x:Help_screen_form_fields_TemplatesEditSource](https://docs.joomla.org/Chunk4x:Help_screen_form_fields_TemplatesEditSource "Chunk4x:Help screen form fields TemplatesEditSource") | | +| [Chunk4x:Help_screen_language_overrides_Description](https://docs.joomla.org/Chunk4x:Help_screen_language_overrides_Description "Chunk4x:Help screen language overrides Description") | | +| [Chunk4x:Help_screen_module_manager_edit_toolbar](https://docs.joomla.org/Chunk4x:Help_screen_module_manager_edit_toolbar "Chunk4x:Help screen module manager edit toolbar") | | +| [Chunk4x:Help_screen_module_manager_new_toolbar](https://docs.joomla.org/Chunk4x:Help_screen_module_manager_new_toolbar "Chunk4x:Help screen module manager new toolbar") | | +| [Chunk4x:Help_screen_related_Articles](https://docs.joomla.org/Chunk4x:Help_screen_related_Articles "Chunk4x:Help screen related Articles") | | +| [Chunk4x:Help_screen_related_Contacts](https://docs.joomla.org/Chunk4x:Help_screen_related_Contacts "Chunk4x:Help screen related Contacts") | | +| [Chunk4x:Help_screen_related_Newsfeeds](https://docs.joomla.org/Chunk4x:Help_screen_related_Newsfeeds "Chunk4x:Help screen related Newsfeeds") | | +| [Chunk4x:Help_screen_related_Search](https://docs.joomla.org/Chunk4x:Help_screen_related_Search "Chunk4x:Help screen related Search") | | +| [Chunk4x:Help_screen_related_Template](https://docs.joomla.org/Chunk4x:Help_screen_related_Template "Chunk4x:Help screen related Template") | | +| [Chunk4x:Help_screen_related_Users](https://docs.joomla.org/Chunk4x:Help_screen_related_Users "Chunk4x:Help screen related Users") | | +| [Chunk4x:Help_screen_screenshot_disclaimer](https://docs.joomla.org/Chunk4x:Help_screen_screenshot_disclaimer "Chunk4x:Help screen screenshot disclaimer") | | +| [Chunk4x:Help_screen_toolbar_Archive](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_Archive "Chunk4x:Help screen toolbar Archive") | | +| [Chunk4x:Help_screen_toolbar_Edit](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_Edit "Chunk4x:Help screen toolbar Edit") | | +| [Chunk4x:Help_screen_toolbar_Help](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_Help "Chunk4x:Help screen toolbar Help") | | +| [Chunk4x:Help_screen_toolbar_New](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_New "Chunk4x:Help screen toolbar New") | | +| [Chunk4x:Help_screen_toolbar_Publish](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_Publish "Chunk4x:Help screen toolbar Publish") | | +| [Chunk4x:Help_screen_toolbar_Trash](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_Trash "Chunk4x:Help screen toolbar Trash") | | +| [Chunk4x:Help_screen_toolbar_Unpublish](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_Unpublish "Chunk4x:Help screen toolbar Unpublish") | | +| [Chunk4x:Help_screen_toolbar_icon_Actions](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Actions "Chunk4x:Help screen toolbar icon Actions") | | +| [Chunk4x:Help_screen_toolbar_icon_Activate](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Activate "Chunk4x:Help screen toolbar icon Activate") | | +| [Chunk4x:Help_screen_toolbar_icon_Archive](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Archive "Chunk4x:Help screen toolbar icon Archive") | | +| [Chunk4x:Help_screen_toolbar_icon_Article](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Article "Chunk4x:Help screen toolbar icon Article") | | +| [Chunk4x:Help_screen_toolbar_icon_Associations](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Associations "Chunk4x:Help screen toolbar icon Associations") | | +| [Chunk4x:Help_screen_toolbar_icon_Batch](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Batch "Chunk4x:Help screen toolbar icon Batch") | | +| [Chunk4x:Help_screen_toolbar_icon_Block](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Block "Chunk4x:Help screen toolbar icon Block") | | +| [Chunk4x:Help_screen_toolbar_icon_BulkImport](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_BulkImport "Chunk4x:Help screen toolbar icon BulkImport") | | +| [Chunk4x:Help_screen_toolbar_icon_Cancel](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Cancel "Chunk4x:Help screen toolbar icon Cancel") | | +| [Chunk4x:Help_screen_toolbar_icon_Checkin](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Checkin "Chunk4x:Help screen toolbar icon Checkin") | | +| [Chunk4x:Help_screen_toolbar_icon_Clear_Cache](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Clear_Cache "Chunk4x:Help screen toolbar icon Clear Cache") | | +| [Chunk4x:Help_screen_toolbar_icon_Close](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Close "Chunk4x:Help screen toolbar icon Close") | | +| [Chunk4x:Help_screen_toolbar_icon_CloseFile](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_CloseFile "Chunk4x:Help screen toolbar icon CloseFile") | | +| [Chunk4x:Help_screen_toolbar_icon_Contact](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Contact "Chunk4x:Help screen toolbar icon Contact") | | +| [Chunk4x:Help_screen_toolbar_icon_CopyTemplate](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_CopyTemplate "Chunk4x:Help screen toolbar icon CopyTemplate") | | +| [Chunk4x:Help_screen_toolbar_icon_Copy_Reference_to_Target](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Copy_Reference_to_Target "Chunk4x:Help screen toolbar icon Copy Reference to Target") | | +| [Chunk4x:Help_screen_toolbar_icon_CreateFolder](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_CreateFolder "Chunk4x:Help screen toolbar icon CreateFolder") | | +| [Chunk4x:Help_screen_toolbar_icon_Default](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Default "Chunk4x:Help screen toolbar icon Default") | | +| [Chunk4x:Help_screen_toolbar_icon_Delete](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Delete "Chunk4x:Help screen toolbar icon Delete") | | +| [Chunk4x:Help_screen_toolbar_icon_DeleteFile](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_DeleteFile "Chunk4x:Help screen toolbar icon DeleteFile") | | +| [Chunk4x:Help_screen_toolbar_icon_Delete_All](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Delete_All "Chunk4x:Help screen toolbar icon Delete All") | | +| [Chunk4x:Help_screen_toolbar_icon_Disable](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Disable "Chunk4x:Help screen toolbar icon Disable") | | +| [Chunk4x:Help_screen_toolbar_icon_Discover](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Discover "Chunk4x:Help screen toolbar icon Discover") | | +| [Chunk4x:Help_screen_toolbar_icon_Download_Text_JSON_Help](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Download_Text_JSON_Help "Chunk4x:Help screen toolbar icon Download Text JSON Help") | | +| [Chunk4x:Help_screen_toolbar_icon_Duplicate](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Duplicate "Chunk4x:Help screen toolbar icon Duplicate") | | +| [Chunk4x:Help_screen_toolbar_icon_Edit](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Edit "Chunk4x:Help screen toolbar icon Edit") | | +| [Chunk4x:Help_screen_toolbar_icon_EditAssociations](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_EditAssociations "Chunk4x:Help screen toolbar icon EditAssociations") | | +| [Chunk4x:Help_screen_toolbar_icon_Empty_Trash](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Empty_Trash "Chunk4x:Help screen toolbar icon Empty Trash") | | +| [Chunk4x:Help_screen_toolbar_icon_Enable](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Enable "Chunk4x:Help screen toolbar icon Enable") | | +| [Chunk4x:Help_screen_toolbar_icon_Expand_All](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Expand_All "Chunk4x:Help screen toolbar icon Expand All") | | +| [Chunk4x:Help_screen_toolbar_icon_Featured](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Featured "Chunk4x:Help screen toolbar icon Featured") | | +| [Chunk4x:Help_screen_toolbar_icon_Fields](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Fields "Chunk4x:Help screen toolbar icon Fields") | | +| [Chunk4x:Help_screen_toolbar_icon_FindLanguages](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_FindLanguages "Chunk4x:Help screen toolbar icon FindLanguages") | | +| [Chunk4x:Help_screen_toolbar_icon_FindUpdates](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_FindUpdates "Chunk4x:Help screen toolbar icon FindUpdates") | | +| [Chunk4x:Help_screen_toolbar_icon_Fix](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Fix "Chunk4x:Help screen toolbar icon Fix") | | +| [Chunk4x:Help_screen_toolbar_icon_Help](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Help "Chunk4x:Help screen toolbar icon Help") | | +| [Chunk4x:Help_screen_toolbar_icon_Home](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Home "Chunk4x:Help screen toolbar icon Home") | | +| [Chunk4x:Help_screen_toolbar_icon_Image](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Image "Chunk4x:Help screen toolbar icon Image") | | +| [Chunk4x:Help_screen_toolbar_icon_Install](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Install "Chunk4x:Help screen toolbar icon Install") | | +| [Chunk4x:Help_screen_toolbar_icon_Install_Languages](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Install_Languages "Chunk4x:Help screen toolbar icon Install Languages") | | +| [Chunk4x:Help_screen_toolbar_icon_Install_extension](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Install_extension "Chunk4x:Help screen toolbar icon Install extension") | | +| [Chunk4x:Help_screen_toolbar_icon_MakeDefault](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_MakeDefault "Chunk4x:Help screen toolbar icon MakeDefault") | | +| [Chunk4x:Help_screen_toolbar_icon_ManageFolders](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_ManageFolders "Chunk4x:Help screen toolbar icon ManageFolders") | | +| [Chunk4x:Help_screen_toolbar_icon_Menu](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Menu "Chunk4x:Help screen toolbar icon Menu") | | +| [Chunk4x:Help_screen_toolbar_icon_Module](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Module "Chunk4x:Help screen toolbar icon Module") | | +| [Chunk4x:Help_screen_toolbar_icon_New](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_New "Chunk4x:Help screen toolbar icon New") | | +| [Chunk4x:Help_screen_toolbar_icon_NewFile](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_NewFile "Chunk4x:Help screen toolbar icon NewFile") | | +| [Chunk4x:Help_screen_toolbar_icon_Options](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Options "Chunk4x:Help screen toolbar icon Options") | | +| [Chunk4x:Help_screen_toolbar_icon_Page_Break](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Page_Break "Chunk4x:Help screen toolbar icon Page Break") | | +| [Chunk4x:Help_screen_toolbar_icon_Preview](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Preview "Chunk4x:Help screen toolbar icon Preview") | | +| [Chunk4x:Help_screen_toolbar_icon_Publish](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Publish "Chunk4x:Help screen toolbar icon Publish") | | +| [Chunk4x:Help_screen_toolbar_icon_PurgeCache](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_PurgeCache "Chunk4x:Help screen toolbar icon PurgeCache") | | +| [Chunk4x:Help_screen_toolbar_icon_PurgeCache_uninstalled_extensions](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_PurgeCache_uninstalled_extensions "Chunk4x:Help screen toolbar icon PurgeCache uninstalled extensions") | | +| [Chunk4x:Help_screen_toolbar_icon_PurgeDisabled](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_PurgeDisabled "Chunk4x:Help screen toolbar icon PurgeDisabled") | | +| [Chunk4x:Help_screen_toolbar_icon_PurgeExpired](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_PurgeExpired "Chunk4x:Help screen toolbar icon PurgeExpired") | | +| [Chunk4x:Help_screen_toolbar_icon_Read_More](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Read_More "Chunk4x:Help screen toolbar icon Read More") | | +| [Chunk4x:Help_screen_toolbar_icon_Rebuild](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Rebuild "Chunk4x:Help screen toolbar icon Rebuild") | | +| [Chunk4x:Help_screen_toolbar_icon_RefreshCache](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_RefreshCache "Chunk4x:Help screen toolbar icon RefreshCache") | | +| [Chunk4x:Help_screen_toolbar_icon_Remove](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Remove "Chunk4x:Help screen toolbar icon Remove") | | +| [Chunk4x:Help_screen_toolbar_icon_RenameFile](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_RenameFile "Chunk4x:Help screen toolbar icon RenameFile") | | +| [Chunk4x:Help_screen_toolbar_icon_Reset](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Reset "Chunk4x:Help screen toolbar icon Reset") | | +| [Chunk4x:Help_screen_toolbar_icon_Save](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Save "Chunk4x:Help screen toolbar icon Save") | | +| [Chunk4x:Help_screen_toolbar_icon_SaveAndClose](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_SaveAndClose "Chunk4x:Help screen toolbar icon SaveAndClose") | | +| [Chunk4x:Help_screen_toolbar_icon_SaveAndNew](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_SaveAndNew "Chunk4x:Help screen toolbar icon SaveAndNew") | | +| [Chunk4x:Help_screen_toolbar_icon_SaveAsCopy](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_SaveAsCopy "Chunk4x:Help screen toolbar icon SaveAsCopy") | | +| [Chunk4x:Help_screen_toolbar_icon_Save_Reference](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Save_Reference "Chunk4x:Help screen toolbar icon Save Reference") | | +| [Chunk4x:Help_screen_toolbar_icon_Save_Target](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Save_Target "Chunk4x:Help screen toolbar icon Save Target") | | +| [Chunk4x:Help_screen_toolbar_icon_Send](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Send "Chunk4x:Help screen toolbar icon Send") | | +| [Chunk4x:Help_screen_toolbar_icon_Send_Mail](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Send_Mail "Chunk4x:Help screen toolbar icon Send Mail") | | +| [Chunk4x:Help_screen_toolbar_icon_SmartSearchOptions](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_SmartSearchOptions "Chunk4x:Help screen toolbar icon SmartSearchOptions") | | +| [Chunk4x:Help_screen_toolbar_icon_Statistics](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Statistics "Chunk4x:Help screen toolbar icon Statistics") | | +| [Chunk4x:Help_screen_toolbar_icon_TemplatePreview](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_TemplatePreview "Chunk4x:Help screen toolbar icon TemplatePreview") | | +| [Chunk4x:Help_screen_toolbar_icon_Toggle_Editor](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Toggle_Editor "Chunk4x:Help screen toolbar icon Toggle Editor") | | +| [Chunk4x:Help_screen_toolbar_icon_Toggle_Selection](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Toggle_Selection "Chunk4x:Help screen toolbar icon Toggle Selection") | | +| [Chunk4x:Help_screen_toolbar_icon_Trash](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Trash "Chunk4x:Help screen toolbar icon Trash") | | +| [Chunk4x:Help_screen_toolbar_icon_Unblock](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Unblock "Chunk4x:Help screen toolbar icon Unblock") | | +| [Chunk4x:Help_screen_toolbar_icon_Unfeature](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Unfeature "Chunk4x:Help screen toolbar icon Unfeature") | | +| [Chunk4x:Help_screen_toolbar_icon_Uninstall](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Uninstall "Chunk4x:Help screen toolbar icon Uninstall") | | +| [Chunk4x:Help_screen_toolbar_icon_Unpublish](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Unpublish "Chunk4x:Help screen toolbar icon Unpublish") | | +| [Chunk4x:Help_screen_toolbar_icon_Update](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Update "Chunk4x:Help screen toolbar icon Update") | | +| [Chunk4x:Help_screen_toolbar_icon_Upload](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Upload "Chunk4x:Help screen toolbar icon Upload") | | +| [Chunk4x:Help_screen_toolbar_icon_Versions](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_icon_Versions "Chunk4x:Help screen toolbar icon Versions") | | +| [Chunk4x:Help_screen_toolbar_top_descriptor](https://docs.joomla.org/Chunk4x:Help_screen_toolbar_top_descriptor "Chunk4x:Help screen toolbar top descriptor") | | +| [Chunk4x:How_to_access](https://docs.joomla.org/Chunk4x:How_to_access "Chunk4x:How to access") | | +| [Chunk4x:Image](https://docs.joomla.org/Chunk4x:Image "Chunk4x:Image") | | +| [Chunk4x:Link_Type_Options](https://docs.joomla.org/Chunk4x:Link_Type_Options "Chunk4x:Link Type Options") | | +| [Chunk4x:List_of_Plugins](https://docs.joomla.org/Chunk4x:List_of_Plugins "Chunk4x:List of Plugins") | | +| [Chunk4x:Listfiltering](https://docs.joomla.org/Chunk4x:Listfiltering "Chunk4x:Listfiltering") | | +| [Chunk4x:Menu_Assignment](https://docs.joomla.org/Chunk4x:Menu_Assignment "Chunk4x:Menu Assignment") | | +| [Chunk4x:Menu_Item_Details](https://docs.joomla.org/Chunk4x:Menu_Item_Details "Chunk4x:Menu Item Details") | | +| [Chunk4x:Metadata_Options](https://docs.joomla.org/Chunk4x:Metadata_Options "Chunk4x:Metadata Options") | | +| [Chunk4x:ModuleManager-Advanced](https://docs.joomla.org/Chunk4x:ModuleManager-Advanced "Chunk4x:ModuleManager-Advanced") | | +| [Chunk4x:ModuleManager-How-to-access-module](https://docs.joomla.org/Chunk4x:ModuleManager-How-to-access-module "Chunk4x:ModuleManager-How-to-access-module") | | +| [Chunk4x:ModuleManager-MenuAssignment-and-Permissions](https://docs.joomla.org/Chunk4x:ModuleManager-MenuAssignment-and-Permissions "Chunk4x:ModuleManager-MenuAssignment-and-Permissions") | | +| [Chunk4x:ModuleManager_Advanced_Tab](https://docs.joomla.org/Chunk4x:ModuleManager_Advanced_Tab "Chunk4x:ModuleManager Advanced Tab") | | +| [Chunk4x:ModuleManager_How_to_Acces_Site_Module](https://docs.joomla.org/Chunk4x:ModuleManager_How_to_Acces_Site_Module "Chunk4x:ModuleManager How to Acces Site Module") | | +| [Chunk4x:ModuleManager_How_to_Access_Administrator_Module](https://docs.joomla.org/Chunk4x:ModuleManager_How_to_Access_Administrator_Module "Chunk4x:ModuleManager How to Access Administrator Module") | | +| [Chunk4x:ModuleManager_How_to_Access_Site_Module](https://docs.joomla.org/Chunk4x:ModuleManager_How_to_Access_Site_Module "Chunk4x:ModuleManager How to Access Site Module") | | +| [Chunk4x:ModuleManager_Permissions_Tab](https://docs.joomla.org/Chunk4x:ModuleManager_Permissions_Tab "Chunk4x:ModuleManager Permissions Tab") | | +| [Chunk4x:Module_Advanced_Options](https://docs.joomla.org/Chunk4x:Module_Advanced_Options "Chunk4x:Module Advanced Options") | | +| [Chunk4x:Module_Advanced_Options_2](https://docs.joomla.org/Chunk4x:Module_Advanced_Options_2 "Chunk4x:Module Advanced Options 2") | | +| [Chunk4x:Module_Assignment](https://docs.joomla.org/Chunk4x:Module_Assignment "Chunk4x:Module Assignment") | | +| [Chunk4x:Module_Details](https://docs.joomla.org/Chunk4x:Module_Details "Chunk4x:Module Details") | | +| [Chunk4x:Module_Permissions](https://docs.joomla.org/Chunk4x:Module_Permissions "Chunk4x:Module Permissions") | | +| [Chunk4x:NewsfeedOptions-tab-integration](https://docs.joomla.org/Chunk4x:NewsfeedOptions-tab-integration "Chunk4x:NewsfeedOptions-tab-integration") | | +| [Chunk4x:No_Editor](https://docs.joomla.org/Chunk4x:No_Editor "Chunk4x:No Editor") | | +| [Chunk4x:No_editor](https://docs.joomla.org/Chunk4x:No_editor "Chunk4x:No editor") | | +| [Chunk4x:Page_Display_Options](https://docs.joomla.org/Chunk4x:Page_Display_Options "Chunk4x:Page Display Options") | | +| [Chunk4x:TinyMCE](https://docs.joomla.org/Chunk4x:TinyMCE "Chunk4x:TinyMCE") | | +| [Chunk4x:Toolbar](https://docs.joomla.org/Chunk4x:Toolbar "Chunk4x:Toolbar") | | +| [Chunk4x:User_Options](https://docs.joomla.org/Chunk4x:User_Options "Chunk4x:User Options") | | +| [Chunk4x:VersionHistoryOptions-tab-permissions](https://docs.joomla.org/Chunk4x:VersionHistoryOptions-tab-permissions "Chunk4x:VersionHistoryOptions-tab-permissions") | | + +**Joomla 4 Chunks** diff --git a/manuals/help/component/component-field-groups.md b/manuals/help/component/component-field-groups.md new file mode 100644 index 0000000..d9d44d0 --- /dev/null +++ b/manuals/help/component/component-field-groups.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 1 +id: component-field-groups +title: "Help4.x:Component: Field Groups" +--- +Redirect to: + +- [Help4.x:Field + Groups](https://docs.joomla.org/Help4.x:Field_Groups "Help4.x:Field Groups") diff --git a/manuals/help/component/component-fields.md b/manuals/help/component/component-fields.md new file mode 100644 index 0000000..c40309a --- /dev/null +++ b/manuals/help/component/component-fields.md @@ -0,0 +1,8 @@ +--- +sidebar_position: 2 +id: component-fields +title: "Help4.x:Component: Fields" +--- +Redirect to: + +- [Help4.x:Fields](https://docs.joomla.org/Help4.x:Fields "Help4.x:Fields") diff --git a/manuals/help/component/component-new-or-edit-field-group.md b/manuals/help/component/component-new-or-edit-field-group.md new file mode 100644 index 0000000..8786b36 --- /dev/null +++ b/manuals/help/component/component-new-or-edit-field-group.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 4 +id: component-new-or-edit-field-group +title: "Help4.x:Component: New or Edit Field Group" +--- +Redirect to: + +- [Help4.x:Field Groups: + Edit](https://docs.joomla.org/Help4.x:Field_Groups:_Edit "Help4.x:Field Groups: Edit") diff --git a/manuals/help/component/component-new-or-edit-field.md b/manuals/help/component/component-new-or-edit-field.md new file mode 100644 index 0000000..73af993 --- /dev/null +++ b/manuals/help/component/component-new-or-edit-field.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 3 +id: component-new-or-edit-field +title: "Help4.x:Component: New or Edit Field" +--- +Redirect to: + +- [Help4.x:Fields: + Edit](https://docs.joomla.org/Help4.x:Fields:_Edit "Help4.x:Fields: Edit") diff --git a/manuals/help/components/components-banners-banners-edit.md b/manuals/help/components/components-banners-banners-edit.md new file mode 100644 index 0000000..2a810e1 --- /dev/null +++ b/manuals/help/components/components-banners-banners-edit.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 1 +id: components-banners-banners-edit +title: "Help4.x:Components Banners Banners Edit" +--- +Redirect to: + +- [Help4.x:Banners: + Edit/en](https://docs.joomla.org/Help4.x:Banners:_Edit/en "Help4.x:Banners: Edit/en") diff --git a/manuals/help/components/components-banners-banners-options.md b/manuals/help/components/components-banners-banners-options.md new file mode 100644 index 0000000..7aeb7ff --- /dev/null +++ b/manuals/help/components/components-banners-banners-options.md @@ -0,0 +1,85 @@ +--- +sidebar_position: 2 +id: components-banners-banners-options +title: "Help4.x:Components Banners Banners Options" +--- +## Description + +Global options (configuration) for Banner Clients. + +## How to Access + +## Screenshot + + + +## Details + +### Client Options + +These settings apply for all clients unless they are changed for a +specific client. + +- **Purchase Type:** (*Unlimited*/*Yearly*/*Monthly*/*Weekly*/*Daily*). + Select the type of purchase in the list. +- **Track Impressions:** (*Yes*/*No*). Record the impressions (views) of + the banners on a daily basis. +- **Track Clicks:** (*Yes*/*No*). Record the number of clicks on the + banners on a daily basis. +- **Meta Keyword Prefix:** When matching Meta Keywords, only search for + Meta Keywords with this prefix (improves performance). + +### History Options + + + +These settings apply to version history for Banners, Banner Categories, +and Banner Clients. + +- **Save History:** (*Yes*/*No*). Whether to automatically save old + versions of an item. If set to Yes, old versions of items are saved + automatically. When editing, you may restore from a previous version + of the item. +- **Maximum Versions:** The maximum number of old versions of an item to + save. If zero, all old versions will be saved. + +### Permissions + + + +Default permissions used for all content in this component. + +- **Configure:** (*Inherited*/*Allowed*/*Denied*). Allow or deny + Configure for users in the Public group. Configure Allows users in the + group to edit the options of this extension. +- **Access Administration Interface:** (*Inherited*/*Allowed*/*Denied*). + Allow or deny Access Administration Interface for users in the Public + group. Access Administration Interface Allows users in the group to + access the administration interface for this extension. +- **Create:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Create for + users in the Public group. Create Allows users in the group to create + any content in this extension. +- **Delete:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Delete for + users in the Public group. Delete Allows users in the group to delete + any content in this extension. +- **Edit:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Edit for + users in the Public group. Edit Allows users in the group to edit any + content in this extension. +- **Edit State:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Edit + State for users in the Public group. Edit State Allows users in the + group to change the state of any content in this extension. diff --git a/manuals/help/components/components-check-in-configuration.md b/manuals/help/components/components-check-in-configuration.md new file mode 100644 index 0000000..7e3241d --- /dev/null +++ b/manuals/help/components/components-check-in-configuration.md @@ -0,0 +1,78 @@ +--- +sidebar_position: 3 +id: components-check-in-configuration +title: "Help4.x:Components Check-in Configuration" +--- +## Description + +Default permissions for the Check-in Component. + +## How to Access + +- Select **System **→** Global Check-in** from the Administrator menu. + Then... + - Click the **Options** button at the top right. This opens the + **Check-in: Optons - Permissions screen**. + +## Screenshot + + + +## Permissions + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Optons**. Users can edit the options and + persimissions of this extension. + - **Configure Optons Only**. Users can edit the options exept the + persimissions of this extension. + - **Access Administration Interface**. Users can access user + administration interface of this extension. + - **Create:** Users can create content of this extension. + - **Delete:** Users can delete content of this extension. + - **Edit:** Users can edit content of this extension. + - **Edit State:** User can change the published state and related + information for content of this extension. + - **Edit Own:** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited:*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the configurations and stays in the current screen. + + + +- **Save & Close**. Saves the configurations and closes the current + screen. + + + +- **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 + +- Remember, these choices are applied globally. diff --git a/manuals/help/components/components-patch-tester-options.md b/manuals/help/components/components-patch-tester-options.md new file mode 100644 index 0000000..414f498 --- /dev/null +++ b/manuals/help/components/components-patch-tester-options.md @@ -0,0 +1,139 @@ +--- +sidebar_position: 4 +id: components-patch-tester-options +title: "Help4.x:Components Patch Tester Options" +--- +## Description + +The Joomla! Patch Tester is used by Testers to check that code patches +produced by Developers actually do what they are supposed to do without +unwanted side effects. The Options page is used to set up the Github +connection. + +More Information: + +- A Dummies Guide to Joomla Bug + Testing + +## How to Access + +- Select **Components **→** Patch Tester** from the Administrator menu. + - Click the *Options* button on the Toolbar. + +## Screenshot + + + +## Form Fields + +### GitHub Repository Tab + +- **GitHub Repository.** The default is Joomla! CMS. Use it. + +### Github Authentication Tab + +You need a Github account and a Github Token. All free - see the GitHub +Authentication Tab for details. + + + +- **GitHub Authentication Method.** Choose the Token method. The + Credentials method will not work from September 2020. + + + +- **GitHub Token.** Paste in the Token obtained from GitHub. + +### CI Server Settings Tab + +These settings are used for automated testing. Use the defaults for +manual testing + + + +- **CI Server Address.** Default: + https://ci.joomla.org +- **Switch CI Integration.** Default: Off. + +### Permissions Tab + +It is most unlikely that a Tester will wish to change the Permissions +for this Component! + + + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Optons**. Users can edit the options and + persimissions of this extension. + - **Access Administration Interface**. Users can access user + administration interface of this extension. + + + +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited:*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **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 + +## Related Information + +- [Component Patchtester for + Testers](https://docs.joomla.org/Component_Patchtester_for_Testers "Component Patchtester for Testers") +- [Testing Joomla + Patches](https://docs.joomla.org/Testing_Joomla!_patches "Testing Joomla! patches") +- Manual Patch Tester diff --git a/manuals/help/components/components-plug-in-manager-options.md b/manuals/help/components/components-plug-in-manager-options.md new file mode 100644 index 0000000..00b9439 --- /dev/null +++ b/manuals/help/components/components-plug-in-manager-options.md @@ -0,0 +1,75 @@ +--- +sidebar_position: 5 +id: components-plug-in-manager-options +title: "Help4.x:Components Plug-in Manager Options" +--- +## Description + +Plugins Options configuration allows setting of parameters used globally +for Plugins. + +## How to Access + +- Select **System **→** Plugins (in the Manage panel)** from the + Administrator menu. Then... + - Select the **Options** button on the Toolbar. + +## Screenshot + + + +## Form Fields + +### Permissions Tab + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Optons**. Users can edit the options and + persimissions of this extension. + - **Configure Optons Only**. Users can edit the options exept the + persimissions of this extension. + - **Access Administration Interface**. Users can access user + administration interface of this extension. + - **Create:** Users can create content of this extension. + - **Delete:** Users can delete content of this extension. + - **Edit:** Users can edit content of this extension. + - **Edit State:** User can change the published state and related + information for content of this extension. + - **Edit Own:** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited:*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/components/components-privacy-outline.md b/manuals/help/components/components-privacy-outline.md new file mode 100644 index 0000000..e794020 --- /dev/null +++ b/manuals/help/components/components-privacy-outline.md @@ -0,0 +1,71 @@ +--- +sidebar_position: 6 +id: components-privacy-outline +title: "Help4.x:Components Privacy Outline" +--- +## Privacy Outline + +### Content + +The Joomla Privacy Tool Suite consists of the following parts: + +- **Administrator Component.** Manages User information Privacy + requests. +- **Module - Privacy Dashboard.** Places a Privacy panel on the Home + dashboard. +- **Module - Privacy Requests.** Places a Privacy Requests panel on the + Privacy dashboard. +- **Module - Privacy Status.** Places a Privacy Status panel on the + Privacy dashboard. +- **Menu Item - Create Request.** Shows a form to display an Information + Request. To be created. +- **Plugin - System - Privacy Consent.** Adds consent fields to personal + information forms such as Registration. To be enabled. +- **Plugin - User - Terms and Condition.** Requests user's consent to + the site's terms and conditions. To be enabled. +- **Plugin - Content - Confirm Consent.** Adds a required checkbox to a + form, for example the core contact form. To be enabled. +- **Plugin - Privacy - Various.** More plugins, enabled by default, + without significant parameters to set. + +On installation the Privacy Tool Suite is ready for Administrator use +without enabling plugins or creating a menu item. + +### Workflow + +This is a typical sequence of events: + +- An information request arrives. It must include a valid email address + for a data Subject. The Subject does not have to be a registered user. + For example, the Subject may be a contact added by an Administrator. +- If the message is not submitted by the Subject via a site Personal + Information form: + - The Administrator goes to + **Users **→** Privacy **→** Requests **→** New** to create a new + information request. A message is sent to the email address provided + inviting the Subject to confirm this is a genuine request. +- If the message is submitted via a site Personal Information form the + Subject is sent a confirmation request message automatically. +- The Subject selects the link in the email message to open the + confirmation form. On submission the Subject sees a confirmation + message. +- The Administrator sees that Private Messages in the Title Bar has + pending messages. There will also be a system email message. +- The Administrator goes to **Users **→** Privacy **→** Requests** and + sees that the request status has changed to **Confirmed**. +- For a data Export request there are adjacent Export and Email buttons. + - The Administrator selects the Export button to have a look at the + data to be exported. This is in XML format but displays sensible in + Firefox. + - The Adminstrator selects the Email button to send the exported data + to the Subject. +- For a data Remove request there is an adjacent Delete button. + - The Administrator selects the delete button to anonymise the data + for the user. The user is no longer able to login. +- Select the email address of the data Subject to open the Review + Information Request form. +- Select the Complete button in the Toolbar. +- The Information Requests list shows the Status as Complete and the + Action buttons have vanished. + +Note that this suite does not display a Cookie permissions form. diff --git a/manuals/help/components/components-redirect-manager.md b/manuals/help/components/components-redirect-manager.md new file mode 100644 index 0000000..0d0e7e9 --- /dev/null +++ b/manuals/help/components/components-redirect-manager.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 7 +id: components-redirect-manager +title: "Help4.x:Components Redirect Manager" +--- +Redirect to: + +- [Help4.x:Redirects: + Links/en](https://docs.joomla.org/Help4.x:Redirects:_Links/en "Help4.x:Redirects: Links/en") diff --git a/manuals/help/components/components-search-manager-options.md b/manuals/help/components/components-search-manager-options.md new file mode 100644 index 0000000..615064c --- /dev/null +++ b/manuals/help/components/components-search-manager-options.md @@ -0,0 +1,98 @@ +--- +sidebar_position: 9 +id: components-search-manager-options +title: "Help4.x:Components Search Manager Options" +--- +## Description + +- [Details on Component + Options](https://docs.joomla.org/Help4.x:Components_Search_Manager_Options#Component "Special:MyLanguage/Help4.x:Components Search Manager Options") +- [Details on + Permissions](https://docs.joomla.org/Help4.x:Components_Search_Manager_Options#Permissions "Special:MyLanguage/Help4.x:Components Search Manager Options") + configuration + +## How to Access + +- Click the **Global Configuration** button in the [Control + Panel](https://docs.joomla.org/Help4.x:Site_Control_Panel "Special:MyLanguage/Help4.x:Site Control Panel") + and click the **Search** button on left side panel, or +- Select **Components **→** Search **→** Options** from the drop-down + menus. + +## Screenshot + +800px + +## Details + +- **Gather Search Statistics**. (Yes/No) Record the search phrases + submitted by visitors. +- **Use Search Options**. (Yes/No) Show the search options. +- **Use Search Areas**. (Yes/No) Show the search areas checkboxes. +- **Created Date**. (Show/Hide) Show Created Date +- **OpenSearch Name**. Name displayed for this site as a search + provider. +- **OpenSearch Description**. Description displayed for this site as a + search provider. + +## Permissions + +800px + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Optons**. Users can edit the options and + persimissions of this extension. + - **Configure Optons Only**. Users can edit the options exept the + persimissions of this extension. + - **Access Administration Interface**. Users can access user + administration interface of this extension. + - **Create:** Users can create content of this extension. + - **Delete:** Users can delete content of this extension. + - **Edit:** Users can edit content of this extension. + - **Edit State:** User can change the published state and related + information for content of this extension. + - **Edit Own:** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited:*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top left you will see the toolbar: File:Help-4x-Save-SaveClose-Cancel-Help-toolbar-en.png + +The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/components/components-search.md b/manuals/help/components/components-search.md new file mode 100644 index 0000000..912736b --- /dev/null +++ b/manuals/help/components/components-search.md @@ -0,0 +1,338 @@ +--- +sidebar_position: 8 +id: components-search +title: "Help4.x:Components Search" +--- +**Components Help Screens** + +- [Banners](https://docs.joomla.org/Help4.x:Banners "Help4.x:Banners") +- [Banners: + Categories](https://docs.joomla.org/Help4.x:Banners:_Categories "Help4.x:Banners: Categories") +- [Banners: + Clients](https://docs.joomla.org/Help4.x:Banners:_Clients "Help4.x:Banners: Clients") +- [Banners: + Edit](https://docs.joomla.org/Help4.x:Banners:_Edit "Help4.x:Banners: Edit") +- [Banners: New or Edit + Category](https://docs.joomla.org/Help4.x:Banners:_New_or_Edit_Category "Help4.x:Banners: New or Edit Category") +- [Banners: New or Edit + Client](https://docs.joomla.org/Help4.x:Banners:_New_or_Edit_Client "Help4.x:Banners: New or Edit Client") +- [Banners: + Tracks](https://docs.joomla.org/Help4.x:Banners:_Tracks "Help4.x:Banners: Tracks") +- [Components Banners Banners + Options](https://docs.joomla.org/Help4.x:Components_Banners_Banners_Options "Help4.x:Components Banners Banners Options") +- [Components Check-in + Configuration](https://docs.joomla.org/Help4.x:Components_Check-in_Configuration "Help4.x:Components Check-in Configuration") +- [Components Joomla + Update](https://docs.joomla.org/Help4.x:Components_Joomla_Update "Help4.x:Components Joomla Update") +- [Components Plug-in Manager + Options](https://docs.joomla.org/Help4.x:Components_Plug-in_Manager_Options "Help4.x:Components Plug-in Manager Options") +- [Components Search Manager + Options](https://docs.joomla.org/Help4.x:Components_Search_Manager_Options "Help4.x:Components Search Manager Options") +- [Components Version + History](https://docs.joomla.org/Help4.x:Components_Version_History "Help4.x:Components Version History") +- [Components Web Links Manager + Options](https://docs.joomla.org/Help4.x:Components_Web_Links_Manager_Options "Help4.x:Components Web Links Manager Options") +- [Components Weblinks + Categories](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories "Help4.x:Components Weblinks Categories") +- [Components Weblinks Categories + Edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Help4.x:Components Weblinks Categories Edit") +- [Components Weblinks + Links](https://docs.joomla.org/Help4.x:Components_Weblinks_Links "Help4.x:Components Weblinks Links") +- [Components Weblinks Links + Edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Links_Edit "Help4.x:Components Weblinks Links Edit") +- [Contacts](https://docs.joomla.org/Help4.x:Contacts "Help4.x:Contacts") +- [Contacts: + Categories](https://docs.joomla.org/Help4.x:Contacts:_Categories "Help4.x:Contacts: Categories") +- [Contacts: + Edit](https://docs.joomla.org/Help4.x:Contacts:_Edit "Help4.x:Contacts: Edit") +- [Contacts: Edit + Category](https://docs.joomla.org/Help4.x:Contacts:_Edit_Category "Help4.x:Contacts: Edit Category") +- [Content Security Policy: + Options](https://docs.joomla.org/Help4.x:Content_Security_Policy:_Options "Help4.x:Content Security Policy: Options") +- [Content Security Policy + Reports](https://docs.joomla.org/Help4.x:Content_Security_Policy_Reports "Help4.x:Content Security Policy Reports") +- [Field + Groups](https://docs.joomla.org/Help4.x:Field_Groups "Help4.x:Field Groups") +- [Field Groups: + Edit](https://docs.joomla.org/Help4.x:Field_Groups:_Edit "Help4.x:Field Groups: Edit") +- [Fields: + Edit](https://docs.joomla.org/Help4.x:Fields:_Edit "Help4.x:Fields: Edit") +- [Installer: + Options](https://docs.joomla.org/Help4.x:Installer:_Options "Help4.x:Installer: Options") +- [Joomla + Update](https://docs.joomla.org/Help4.x:Joomla_Update "Help4.x:Joomla Update") +- [Languages: + Options](https://docs.joomla.org/Help4.x:Languages:_Options "Help4.x:Languages: Options") +- [Mail Template: + Edit](https://docs.joomla.org/Help4.x:Mail_Template:_Edit "Help4.x:Mail Template: Edit") +- [Mail Templates: + Options](https://docs.joomla.org/Help4.x:Mail_Templates:_Options "Help4.x:Mail Templates: Options") +- [Menus: + Options](https://docs.joomla.org/Help4.x:Menus:_Options "Help4.x:Menus: Options") +- [Messages: + Options](https://docs.joomla.org/Help4.x:Messages:_Options "Help4.x:Messages: Options") +- [Modules: + Options](https://docs.joomla.org/Help4.x:Modules:_Options "Help4.x:Modules: Options") +- [Multilingual + Associations](https://docs.joomla.org/Help4.x:Multilingual_Associations "Help4.x:Multilingual Associations") +- [Multilingual Associations: + Edit](https://docs.joomla.org/Help4.x:Multilingual_Associations:_Edit "Help4.x:Multilingual Associations: Edit") +- [Multilingual Associations: + Options](https://docs.joomla.org/Help4.x:Multilingual_Associations:_Options "Help4.x:Multilingual Associations: Options") +- [News + Feeds](https://docs.joomla.org/Help4.x:News_Feeds "Help4.x:News Feeds") +- [News Feeds: + Categories](https://docs.joomla.org/Help4.x:News_Feeds:_Categories "Help4.x:News Feeds: Categories") +- [News Feeds: + Edit](https://docs.joomla.org/Help4.x:News_Feeds:_Edit "Help4.x:News Feeds: Edit") +- [News Feeds: Edit + Category](https://docs.joomla.org/Help4.x:News_Feeds:_Edit_Category "Help4.x:News Feeds: Edit Category") +- [Plugin: + Options](https://docs.joomla.org/Help4.x:Plugin:_Options "Help4.x:Plugin: Options") +- [Private + Messages](https://docs.joomla.org/Help4.x:Private_Messages "Help4.x:Private Messages") +- [Private Messages: + Read](https://docs.joomla.org/Help4.x:Private_Messages:_Read "Help4.x:Private Messages: Read") +- [Private Messages: + Write](https://docs.joomla.org/Help4.x:Private_Messages:_Write "Help4.x:Private Messages: Write") +- [Redirect: + Options](https://docs.joomla.org/Help4.x:Redirect:_Options "Help4.x:Redirect: Options") +- [Redirects: + Links](https://docs.joomla.org/Help4.x:Redirects:_Links "Help4.x:Redirects: Links") +- [Redirects: New or + Edit](https://docs.joomla.org/Help4.x:Redirects:_New_or_Edit "Help4.x:Redirects: New or Edit") +- [Scheduled + Tasks](https://docs.joomla.org/Help4.x:Scheduled_Tasks "Help4.x:Scheduled Tasks") +- [Scheduled Tasks: + Edit](https://docs.joomla.org/Help4.x:Scheduled_Tasks:_Edit "Help4.x:Scheduled Tasks: Edit") +- [Scheduled Tasks: + Options](https://docs.joomla.org/Help4.x:Scheduled_Tasks:_Options "Help4.x:Scheduled Tasks: Options") +- [Smart Search: Content + Maps](https://docs.joomla.org/Help4.x:Smart_Search:_Content_Maps "Help4.x:Smart Search: Content Maps") +- [Smart Search: Indexed + Content](https://docs.joomla.org/Help4.x:Smart_Search:_Indexed_Content "Help4.x:Smart Search: Indexed Content") +- [Smart Search: New or Edit + Filter](https://docs.joomla.org/Help4.x:Smart_Search:_New_or_Edit_Filter "Help4.x:Smart Search: New or Edit Filter") +- [Smart Search: Search + Filters](https://docs.joomla.org/Help4.x:Smart_Search:_Search_Filters "Help4.x:Smart Search: Search Filters") +- [Smart Search: Search Term + Analysis](https://docs.joomla.org/Help4.x:Smart_Search:_Search_Term_Analysis "Help4.x:Smart Search: Search Term Analysis") +- [Stages List: Basic + Workflow](https://docs.joomla.org/Help4.x:Stages_List:_Basic_Workflow "Help4.x:Stages List: Basic Workflow") +- [Tags](https://docs.joomla.org/Help4.x:Tags "Help4.x:Tags") +- [Tags: New or + Edit](https://docs.joomla.org/Help4.x:Tags:_New_or_Edit "Help4.x:Tags: New or Edit") +- [Tags: + Options](https://docs.joomla.org/Help4.x:Tags:_Options "Help4.x:Tags: Options") +- [Template: + Options](https://docs.joomla.org/Help4.x:Template:_Options "Help4.x:Template: Options") +- [Transitions List: Basic + Workflow](https://docs.joomla.org/Help4.x:Transitions_List:_Basic_Workflow "Help4.x:Transitions List: Basic Workflow") +- [Users: Viewing Access + Levels](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels "Help4.x:Users: Viewing Access Levels") +- [Workflows + List](https://docs.joomla.org/Help4.x:Workflows_List "Help4.x:Workflows List") + +## Overview + +The **Search Manager: Search Term Analysis** back-end screen allows you +to view statistics about searches performed by visitors of your site. +**Note**: By default, statistics functionality is disabled after +installing Joomla! -- refer to [Options](#Options) for information on +enabling statistics. + +## How to Access + +Select **Components → Search** from the drop-down menu of the +***Joomla! Administrator Panel***. + +## Description + +The Search Statistics screen allows you to see how many searches were +done for each keyword combination and how many results were returned for +each search. + +## Screenshot + +800px + +### Column Headers + +- **Search Phrase**. The search text entered by the user. +- **Hits**. The number of times users searched for this phrase. +- **Results**. The number of search results returned to the user for + this search text. + +You can click the 'Search Phrase' or 'Hits' column headers to sort the +list by these values. Click again to sort in the reverse order. + +### List Settings + +#### Filtering by Partial Search Phrase + + + +Above the column headers on the right, there is a drop down to set a +**number** to display. + +#### Statistics Status + +Above the table an alert is shown indicating whether gathering +statistics is enabled or disabled as shown below: + + + + + +- **Gathering statistics enabled / Gathering statistics disabled**. If + the options parameter called "Gather Search Statistics" is set to + "Yes", this will display as "Enabled". Otherwise, it will display as + "Disabled". See [Options](#Options) for information on enabling and + disabling statistics. + +## Toolbar + +At the top left you will see the toolbar: + + + +The functions are: + +- **Show Search Results / Hide Search Results**. Toggle this button to + show or hide the "Results" column values. + + + +- **Reset**. Resets the search log to its initial, empty state. + *Warning: This will erase all prior search statistics information.* + + + +- **Help**. Opens this help screen. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + +## Options + +In the toolbar, click on the **Options** button to open the Search +Manager Options window. + +### Toolbar + +At the top you will see the toolbar: + +800px + +The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +### Search Tab + +In this window, the "Search" tab allows you to set various parameters +for Search Statistics, as shown below: + + + +- **Gather Search Statistics**. Whether or not to gather search + statistics for the web site. If set to "No", no information will be + collected from users searches. This means that no information will be + displayed in the Search Statistics screen. This is set to "No" by + default. +- **Use Search Options**. Whether or not to show the Search Options in + the front-end. +- **Use Search Areas**. Whether or not to show the search areas + checkboxes in the front-end search options, so user can choose what + kind of items to search. This is set to "Yes" by default. Can be + overridden in the [List Search + Results](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Search_Results "Help4.x:Menus Menu Item Search Results") + menu item. +- **Created Date**. Whether or not to show the Creation Date for items + that are displayed in search results in the front-end. This is set to + "Show" by default. Can be overridden in the [List Search + Results](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Search_Results "Help4.x:Menus Menu Item Search Results") + menu item. +- **OpenSearch Name**. Name displayed for this site as search provider. +- **OpenSearch Description**. Description displayed for this site as + search provider. + +### Permissions Tab + + + + +For more information, please refer to: + +- [ACL Tutorial for Joomla + 3.x](https://docs.joomla.org/ACL_Tutorial_for_Joomla!_3.0 "Special:MyLanguage/ACL Tutorial for Joomla! 3.0") + +## Quick Tips + +- This screen does not enable or disable searching of the web site. + Searching is enabled either by adding an [Internal Link - Search Menu + Item](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Internal_Link_-_Search "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit") + or by adding a [Search + Module](https://docs.joomla.org/Help35:Extensions_Module_Manager_Search "Special:MyLanguage/Help35:Extensions Module Manager Search"). +- Search statistics are disabled by default. If you're interested in + knowing what your visitors search for and what they find, you'll need + to enable search statistics. Refer to [Options](#Options) for more + information. + +## Related Information + +- To add a Search Menu Item: [Menu Item Manager - New/Edit - Internal + Link - + Search](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Internal_Link_-_Search "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit") +- To add a Search Module: [Modules Site - + Search](https://docs.joomla.org/Screen.modulessite.edit.15#Search "Special:MyLanguage/Screen.modulessite.edit.15") diff --git a/manuals/help/components/components-tags-manager.md b/manuals/help/components/components-tags-manager.md new file mode 100644 index 0000000..a0084ed --- /dev/null +++ b/manuals/help/components/components-tags-manager.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 10 +id: components-tags-manager +title: "Help4.x:Components Tags Manager" +--- +1. REDIRECT \[\[Help4.x:Tags\]/en\] diff --git a/manuals/help/components/components-version-history.md b/manuals/help/components/components-version-history.md new file mode 100644 index 0000000..97375c4 --- /dev/null +++ b/manuals/help/components/components-version-history.md @@ -0,0 +1,122 @@ +--- +sidebar_position: 11 +id: components-version-history +title: "Help4.x:Components Version History" +--- +## Description + +The Version History screen allows you to manage prior versions of the +item being edited. Version history is available for +[Articles](https://docs.joomla.org/Help4.x:Articles:_Edit/en "Help4.x:Articles: Edit/en"), +[Banners](https://docs.joomla.org/Help4.x:Banners:_Edit/en "Help4.x:Banners: Edit/en") +and +[Clients](https://docs.joomla.org/Help4.x:Banners:_New_or_Edit_Client/en "Help4.x:Banners: New or Edit Client/en"), +[Contacts](https://docs.joomla.org/Help4.x:Contacts:_Edit/en "Help4.x:Contacts: Edit/en"), +[News +Feeds](https://docs.joomla.org/Help4.x:News_Feeds:_Edit/en "Help4.x:News Feeds: Edit/en"), +[User +Notes](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit/en "Help4.x:User Notes: New or Edit/en"), +and all Categories. + +Each time you save the item with new changes, a new version is created +automatically. You can control how many versions to keep for each item +in the Options for the component. You can also choose to keep one or +more versions forever. If so marked, these versions will not be deleted +automatically, even if you exceed the maximum number of versions you +have entered in the options. + +Note: If you use versioning, [custom +fields](https://docs.joomla.org/J3.x:Adding_custom_fields/en "J3.x:Adding custom fields/en") +are not stored in different versions. + +## How to Access + +Click the **Versions** button on the toolbar while editing the item. + +## Screenshot + + + +## Column Headers + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After boxes are + checked, click a toolbar button to take an action on the selected + items. +- **Date**. The time and date that the version was saved. Clicking on + this link opens the Preview of that version in a pop-up window. Note + that one of the dates will be followed by a star symbol. This + indicates that this is the version that is currently saved and being + edited. +- **Version Note**. When you edit an item, you have the option to enter + in a Version Note. This can be used to help you remember which version + has which information. If you entered a Version Note before saving the + item, it will show in this column. +- **Keep Forever**. This column shows whether you have marked the + version as Keep Forever. Normally, each version will be retained + according to the settings in the component options screen. The default + settings are to keep a maximum of 10 prior versions for an item. In + this case, when you save an item that already has 10 saved versions, + the oldest version is deleted. If a version is marked as Keep Forever, + it will not be counted as one of the saved versions and will not be + deleted when the maximum number is reached.To toggle the Keep Forever + on or off, check the version's check box and then click the Keep + On/Off button in the toolbar. +- **Author**. The user who saved this version. +- **Character Count**. The total characters saved in this version. Note + that this includes the database column names as well as the actual + characters typed in. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. The functions are: + +- **Restore**. The current version of the item is marked with a star to + the right of the Date. If you wish to restore one of the other saved + versions, check the check box for the desired version and click on the + Restore button. The current version of the item will be replaced with + the selected version, and the edit screen will reload with the + restored version loaded in the editor. +- **Preview**. To preview a version, either click on the Date column of + the desired version or check the check box and click on the Preview + button. A separate browser window will load showing the selected + version of the item, similar to the screenshot below. Help-4x-Version-History-Help-preview-en.png When you are done + viewing the version, close the browser window. +- **Compare**. To compare two versions to see what was changed, click + the check boxes for each of the versions and click on the Compare + button. A new browser window will open, as shown in the screenshot + below. Help-4x-Version-History-Help-compare-en.png The first column + is the field name, the second is the older version, the third is the + newer version, and the last column highlights the differences between + the two versions. +- **Keep On/Off**. This button allows you to toggle on or off the Keep + Forever feature for a version. Normally, the oldest version of an item + will be deleted automatically when the maximum number of versions (set + in the Options for the component) has been exceeded. If you set the + Keep Forever property for a version, it will never be automatically + deleted. +- **Delete**. This button allows you to manually delete one or more + versions. Check the check box for the versions you wish to delete and + the click on the Delete button. Note that this does *not* delete the + item being edited. It only deletes the version history for the item. + +## Related Information + +To set the options for Version History, click on the Options button for +the desired component. diff --git a/manuals/help/components/components-web-links-manager-options.md b/manuals/help/components/components-web-links-manager-options.md new file mode 100644 index 0000000..e0f6a8a --- /dev/null +++ b/manuals/help/components/components-web-links-manager-options.md @@ -0,0 +1,413 @@ +--- +sidebar_position: 12 +id: components-web-links-manager-options +title: "Help4.x:Components Web Links Manager Options" +--- +**Components Help Screens** + +- [Banners](https://docs.joomla.org/Help4.x:Banners "Help4.x:Banners") +- [Banners: + Categories](https://docs.joomla.org/Help4.x:Banners:_Categories "Help4.x:Banners: Categories") +- [Banners: + Clients](https://docs.joomla.org/Help4.x:Banners:_Clients "Help4.x:Banners: Clients") +- [Banners: + Edit](https://docs.joomla.org/Help4.x:Banners:_Edit "Help4.x:Banners: Edit") +- [Banners: New or Edit + Category](https://docs.joomla.org/Help4.x:Banners:_New_or_Edit_Category "Help4.x:Banners: New or Edit Category") +- [Banners: New or Edit + Client](https://docs.joomla.org/Help4.x:Banners:_New_or_Edit_Client "Help4.x:Banners: New or Edit Client") +- [Banners: + Tracks](https://docs.joomla.org/Help4.x:Banners:_Tracks "Help4.x:Banners: Tracks") +- [Components Banners Banners + Options](https://docs.joomla.org/Help4.x:Components_Banners_Banners_Options "Help4.x:Components Banners Banners Options") +- [Components Check-in + Configuration](https://docs.joomla.org/Help4.x:Components_Check-in_Configuration "Help4.x:Components Check-in Configuration") +- [Components Joomla + Update](https://docs.joomla.org/Help4.x:Components_Joomla_Update "Help4.x:Components Joomla Update") +- [Components Plug-in Manager + Options](https://docs.joomla.org/Help4.x:Components_Plug-in_Manager_Options "Help4.x:Components Plug-in Manager Options") +- [Components + Search](https://docs.joomla.org/Help4.x:Components_Search "Help4.x:Components Search") +- [Components Search Manager + Options](https://docs.joomla.org/Help4.x:Components_Search_Manager_Options "Help4.x:Components Search Manager Options") +- [Components Version + History](https://docs.joomla.org/Help4.x:Components_Version_History "Help4.x:Components Version History") +- [Components Weblinks + Categories](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories "Help4.x:Components Weblinks Categories") +- [Components Weblinks Categories + Edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Help4.x:Components Weblinks Categories Edit") +- [Components Weblinks + Links](https://docs.joomla.org/Help4.x:Components_Weblinks_Links "Help4.x:Components Weblinks Links") +- [Components Weblinks Links + Edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Links_Edit "Help4.x:Components Weblinks Links Edit") +- [Contacts](https://docs.joomla.org/Help4.x:Contacts "Help4.x:Contacts") +- [Contacts: + Categories](https://docs.joomla.org/Help4.x:Contacts:_Categories "Help4.x:Contacts: Categories") +- [Contacts: + Edit](https://docs.joomla.org/Help4.x:Contacts:_Edit "Help4.x:Contacts: Edit") +- [Contacts: Edit + Category](https://docs.joomla.org/Help4.x:Contacts:_Edit_Category "Help4.x:Contacts: Edit Category") +- [Content Security Policy: + Options](https://docs.joomla.org/Help4.x:Content_Security_Policy:_Options "Help4.x:Content Security Policy: Options") +- [Content Security Policy + Reports](https://docs.joomla.org/Help4.x:Content_Security_Policy_Reports "Help4.x:Content Security Policy Reports") +- [Field + Groups](https://docs.joomla.org/Help4.x:Field_Groups "Help4.x:Field Groups") +- [Field Groups: + Edit](https://docs.joomla.org/Help4.x:Field_Groups:_Edit "Help4.x:Field Groups: Edit") +- [Fields: + Edit](https://docs.joomla.org/Help4.x:Fields:_Edit "Help4.x:Fields: Edit") +- [Installer: + Options](https://docs.joomla.org/Help4.x:Installer:_Options "Help4.x:Installer: Options") +- [Joomla + Update](https://docs.joomla.org/Help4.x:Joomla_Update "Help4.x:Joomla Update") +- [Languages: + Options](https://docs.joomla.org/Help4.x:Languages:_Options "Help4.x:Languages: Options") +- [Mail Template: + Edit](https://docs.joomla.org/Help4.x:Mail_Template:_Edit "Help4.x:Mail Template: Edit") +- [Mail Templates: + Options](https://docs.joomla.org/Help4.x:Mail_Templates:_Options "Help4.x:Mail Templates: Options") +- [Menus: + Options](https://docs.joomla.org/Help4.x:Menus:_Options "Help4.x:Menus: Options") +- [Messages: + Options](https://docs.joomla.org/Help4.x:Messages:_Options "Help4.x:Messages: Options") +- [Modules: + Options](https://docs.joomla.org/Help4.x:Modules:_Options "Help4.x:Modules: Options") +- [Multilingual + Associations](https://docs.joomla.org/Help4.x:Multilingual_Associations "Help4.x:Multilingual Associations") +- [Multilingual Associations: + Edit](https://docs.joomla.org/Help4.x:Multilingual_Associations:_Edit "Help4.x:Multilingual Associations: Edit") +- [Multilingual Associations: + Options](https://docs.joomla.org/Help4.x:Multilingual_Associations:_Options "Help4.x:Multilingual Associations: Options") +- [News + Feeds](https://docs.joomla.org/Help4.x:News_Feeds "Help4.x:News Feeds") +- [News Feeds: + Categories](https://docs.joomla.org/Help4.x:News_Feeds:_Categories "Help4.x:News Feeds: Categories") +- [News Feeds: + Edit](https://docs.joomla.org/Help4.x:News_Feeds:_Edit "Help4.x:News Feeds: Edit") +- [News Feeds: Edit + Category](https://docs.joomla.org/Help4.x:News_Feeds:_Edit_Category "Help4.x:News Feeds: Edit Category") +- [Plugin: + Options](https://docs.joomla.org/Help4.x:Plugin:_Options "Help4.x:Plugin: Options") +- [Private + Messages](https://docs.joomla.org/Help4.x:Private_Messages "Help4.x:Private Messages") +- [Private Messages: + Read](https://docs.joomla.org/Help4.x:Private_Messages:_Read "Help4.x:Private Messages: Read") +- [Private Messages: + Write](https://docs.joomla.org/Help4.x:Private_Messages:_Write "Help4.x:Private Messages: Write") +- [Redirect: + Options](https://docs.joomla.org/Help4.x:Redirect:_Options "Help4.x:Redirect: Options") +- [Redirects: + Links](https://docs.joomla.org/Help4.x:Redirects:_Links "Help4.x:Redirects: Links") +- [Redirects: New or + Edit](https://docs.joomla.org/Help4.x:Redirects:_New_or_Edit "Help4.x:Redirects: New or Edit") +- [Scheduled + Tasks](https://docs.joomla.org/Help4.x:Scheduled_Tasks "Help4.x:Scheduled Tasks") +- [Scheduled Tasks: + Edit](https://docs.joomla.org/Help4.x:Scheduled_Tasks:_Edit "Help4.x:Scheduled Tasks: Edit") +- [Scheduled Tasks: + Options](https://docs.joomla.org/Help4.x:Scheduled_Tasks:_Options "Help4.x:Scheduled Tasks: Options") +- [Smart Search: Content + Maps](https://docs.joomla.org/Help4.x:Smart_Search:_Content_Maps "Help4.x:Smart Search: Content Maps") +- [Smart Search: Indexed + Content](https://docs.joomla.org/Help4.x:Smart_Search:_Indexed_Content "Help4.x:Smart Search: Indexed Content") +- [Smart Search: New or Edit + Filter](https://docs.joomla.org/Help4.x:Smart_Search:_New_or_Edit_Filter "Help4.x:Smart Search: New or Edit Filter") +- [Smart Search: Search + Filters](https://docs.joomla.org/Help4.x:Smart_Search:_Search_Filters "Help4.x:Smart Search: Search Filters") +- [Smart Search: Search Term + Analysis](https://docs.joomla.org/Help4.x:Smart_Search:_Search_Term_Analysis "Help4.x:Smart Search: Search Term Analysis") +- [Stages List: Basic + Workflow](https://docs.joomla.org/Help4.x:Stages_List:_Basic_Workflow "Help4.x:Stages List: Basic Workflow") +- [Tags](https://docs.joomla.org/Help4.x:Tags "Help4.x:Tags") +- [Tags: New or + Edit](https://docs.joomla.org/Help4.x:Tags:_New_or_Edit "Help4.x:Tags: New or Edit") +- [Tags: + Options](https://docs.joomla.org/Help4.x:Tags:_Options "Help4.x:Tags: Options") +- [Template: + Options](https://docs.joomla.org/Help4.x:Template:_Options "Help4.x:Template: Options") +- [Transitions List: Basic + Workflow](https://docs.joomla.org/Help4.x:Transitions_List:_Basic_Workflow "Help4.x:Transitions List: Basic Workflow") +- [Users: Viewing Access + Levels](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels "Help4.x:Users: Viewing Access Levels") +- [Workflows + List](https://docs.joomla.org/Help4.x:Workflows_List "Help4.x:Workflows List") + +## Description + +Web Links Options configuration allows setting of parameters used +globally for all web link menu items. + +## How to Access + +On [Web Links Manager: Web +Links](https://docs.joomla.org/Help4.x:Components_Weblinks_Links "Special:MyLanguage/Help4.x:Components Weblinks Links"), +click Options button at top. + +## Screenshot + +800px + +## Details + +Click the Options button to open the **Web Links Manager Options** +window which lets you configure this component. + +### Web Link Tab + +These settings apply for single Web Links unless they are changed for a +specific menu item or Web Link. + +- **Allow Captcha on Web Link.** Select the captcha pugin that will be + used in the web link submit form. You may need to enter required + information for your captcha plugin in the Plugin Manager. If 'Use + Default' is selected, make sure a captcha plugin is selected in Global + Configuration. +- **Target.** Target browser window when the link is selected. + +Chunk4x:VersionHistoryOptions-tab-permissions\en + +- **Count Clicks.** (No/Yes) If Yes, the number of times the link has + been clicked will be recorded. +- **Text/Icon/Web Link Only.** Shows a text, icon, or nothing with the + Web Link. Default is Icon. +- **Select Icon.** This allows you to select an image file to use as the + default icon for web links. When you click on the Select button, a + modal window opens that allows you to browse through the image files + on your site. +- **Image Float.** (Right/Left/None). Where to display the image on the + page. +- **Show Tags.** (Hide/Show). Hide or Show the feed's tags. + +### Category Tab + +Category Options control how weblinks will show when you drill down to a +weblinks to view its links. + +File:Help-4x-Component-Weblinks-Manager-Options-category-options-subscreen-en.png + +- **Choose a layout.** (Blog/List/user defined). This lets you select + the default layout to show when you click on a Category link. If you + create an alternative layout for a category layout, you may select + that as the default. +- **Category Title.** (Hide/Show) Hide or Show the title of the + category. +- **Category Description.** (Hide/Show) Hide or Show the description for + the category. +- **Category Image.** (Hide/Show) Hide or Show the category image. +- **Subcategory Levels.** (None/All/1-5). Categories in Joomla can be + created in a hierarchy. This lets you control how many levels of + subcategories to show when showing a category view. +- **Empty Categories.** (Hide/Show) Hide or Show categories that don't + contain any items or subcategories. +- **Subcategories Descriptions.** (Hide/Show) Hide or Show the + descriptions for subcategories that are shown. +- **\# Web Links.** Show or Hide the number of web links in each + category. +- **Show Tags.** Show or Hide the tags for a single category. + +### Categories Tab + +These settings apply for Web Links Categories Options unless they are +changed for a specific menu item. + +File:Help-4x-Component-Weblinks-Manager-Options-categories-options-subscreen-en.png + +- **Top Level Category Description.** (Hide/Show). Hide or Show the + description of the top-level category. +- **Subcategory Levels.** (All/1-5). How many levels in the hierarchy to + show. +- **Empty Categories.** (Hide/Show). Hide or Show categories that + contain no items and no subcategories. +- **Subcategories Descriptions.** (Hide/Show). Hide or Show the + description of each subcategory. +- **\# Web Links.** Show or Hide the number of web links in each + category. + +### List Layouts Tab + +These settings apply for Weblinks List Options unless they are changed +for a specific menu item. + +File:Help-4x-Component-Weblinks-Manager-Options-list-options-subscreen-en.png + +- **Filter Field.** The Filter Field creates a text field where a user + can enter a field to be used to filter the weblinks shown in the list. + An example of how this looks in the front-end layout is shown below. + +Help30-article-category-list-filter-field-en.png + +The possible options for this (in the back-end menu item edit) are shown +below. + +File:Help-4x-article-category-list-filter-field-options-en.png + +- *Hide:* Don't show a filter field. +- *Title:* Filter on weblink title. +- *Author:* Filter on the author's name. +- *Hits:* Filter on the number of weblinks hits. + + + +- **Display Select.** (Hide/Show) Whether to hide or show the Display \# + control that allows the user to select the number of items to show in + the list. An example is shown below. + + + +If there are more items than this number, you can use the page +navigation buttons (Start, Prev, Next, End, and page numbers) to +navigate between pages. Note that if you have a large number of items, +it may be helpful to use the Filter options, located above the column +headings, to limit which items display. + +- **Table Headings.** (Hide/Show) Table Headings show a heading above + the weblinks list, as shown below. + + + +If set to *Show*, this heading will show about the list. Otherwise the +list will show with no headings. + +- **Links description.** (Hide/Show) Whether to hide or show the + description of the web link. +- **Hits.** (Hide/Show) Whether to hide or show the number of times this + web link has been accessed. + +Chunk4x:Help +screen column header Pagination\en Chunk4x:Help +screen column header Pagination Results\en + +### Integration Tab + +These settings determine how the Weblinks Component will integrate with +other extensions. + +File:Help-4x-Component-Weblinks-Manager-Options-integration-options-subscreen-en.png + +**Show Feed Link.** (Hide or Show) Show or hide the feed links URLs. A +feed link will show up as a feed icon in the address bar of most +browsers. + +### Permissions Tab + +This section shows permissions for web links. The screen shows as +follows. + +File:Help-4x-Component-Weblinks-Manager-Options-permissions-options-subscreen-en.png + + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Options.** Users can edit the options and + permissions of this extension. + - **Configure Options Only.** Users can edit the options except the + permissions of this extension. + - **Access Administration Interface.** Users can access user + administration interface of this extension. + - **Create.** Users can create content of this extension. + - **Delete.** Users can delete content of this extension. + - **Edit.** Users can edit content of this extension. + - **Edit State.** User can change the published state and related + information for content of this extension. + - **Edit Own.** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top left of the **Web Links Manager Options** window you will see +the toolbar. + +File:Help-4x-Save-SaveClose-Cancel-Help-toolbar-en.png + +The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + +Chunk4x:Help +screen toolbar icon Help\en + +## Quick Tips + +- If you are a beginning user, you can just keep the default values here + until you learn more about using global options. +- If you are an advanced user, you can save time by creating good + default values here. When you set up menu items and create web links, + you will be able to accept the default values for most options. +- All values set here can be overridden at the menu item, category, or + web link level. + +## Related Information + +- To create and edit web links and web links categories: [Web Links + Manager](https://docs.joomla.org/Help4.x:Components_Weblinks_Links "Special:MyLanguage/Help4.x:Components Weblinks Links") +- For more information about Joomla's ACL system: [ACL + Tutorial](https://docs.joomla.org/J2.5:Access_Control_List_Tutorial "Special:MyLanguage/J2.5:Access Control List Tutorial") diff --git a/manuals/help/components/components-weblinks-categories-edit.md b/manuals/help/components/components-weblinks-categories-edit.md new file mode 100644 index 0000000..13a940a --- /dev/null +++ b/manuals/help/components/components-weblinks-categories-edit.md @@ -0,0 +1,222 @@ +--- +sidebar_position: 14 +id: components-weblinks-categories-edit +title: "Help4.x:Components Weblinks Categories Edit" +--- +## Description + +The Web Link Category form is used to create a new Category or or edit +an existing one. Note that you need to create at least one Web Link +Category before you can create a Web Link. Also, Web Link Categories are +separate from other types of Categories, such as those for Articles, +Banners, and News Feeds. + +## How to Access + +- Select **Component **→** Web Links **→** Categories** from the + Administrator men. Then... +- Select the **New** button in the Toolbar to add a new Category. Or... +- Select a **Title** from the list Ttitle columns to edit an existing + Category. + +## Screenshot + + + +### Category tab + +- **Title**. The Title for this item. This may or may not display on the + page, depending on the parameter values you choose. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Category Details + +- **Description**. The description for the item. Category, Subcategory + and Web Link descriptions may be shown on web pages, depending on the + parameter settings. These descriptions are entered using the same + editor that is used for Articles. + + + +- **Article.** Click to quickly add an 'Article' link to the description + with a popup window. + + + +- **Image.** Click to quickly add an 'Image' to the description with a + popup window. + +**Toggle Editor**. A Toggle Editor button show below the edit window. +This button allows you to toggle between the TinyMCE editor and No +Editor. + +### Details (sidebar) + +- **Parent.** The item (category, menu item, and so on) that is the + parent of the item being edited. +- **Status.** (Published/Unpublished/Archived/Trashed) The published + status of the item. +- **Access Level.** Who has access to this item. Default options are: + - **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 + + Enter the desired level using the dropdown list box. Custom Access + Control Levels created will show if they exist. +- **Language.** Item language. +- **Tags.** Enter one or more optional tags for this item. You can + select existing tags by entering in the first few letters. You may + also create new tags by entering them here. Tags allow you to see + lists of related items across content types (for example, articles, + contacts, and categories). +- **Note.** Item note. This is normally for the site administrator's use + (for example, to document information about this item) and does not + show in the front end of the site. +- **Version Note.** Optional field to identify this version of the item + in the item's [Version + History](https://docs.joomla.org/Help4.x:Components_Version_History "Help4.x:Components Version History") + window. + +### Options tab + +- **Layout.** Use a different layout from the supplied components view + or overrides in the templates. +- **Image.** Choose an image to be displayed with this item/category in + the front-end. +- **Alt Text.** Alternative text used for visitors without access to + images. + +### Publishing tab + +The grayed out fields are for information only and may not be edited. + +- **Created Date.** Date the item(Article, Category, Weblink, etc.) was + created. +- **Created by.** Optional, choose from a popup window of users. Select + User by clicking on the user's name. Defaults to user creating new + category if left blank. +- **Modified Date.** *(Informative only)* Date of last modification. +- **Modified By.** *(Informative only)* Username who performed the last + modification. +- **Hits.** Number of hits on a Category view. +- **ID.** The unique ID number automatically assigned to this item by + Joomla!. This number cannot be changed. +- **Meta Description.** An optional paragraph to be used as the + description of the page in the HTML output. This will generally + display in the results of search engines. If entered, this creates an + HTML meta element with a name attribute of "description" and a content + attribute equal to the entered text. +- **Meta Keywords.** Optional entry for keywords. Must be entered + separated by commas (for example, "cats, dogs, pets") and may be + entered in upper or lower case. (For example, "CATS" will match "cats" + or "Cats"). Keywords can be used in several ways: + - To help Search Engines and other systems classify the content of the + Article. + - In combination with Banner tags, to display specific Banners based + on the Article content. For example, say you have one Banner with an + ad for dog products and another Banner for cat products. You can + have your dog Banner display when a User is viewing a dog-related + Article and your cat Banner display for a cat-related Article. To do + this, you would: + - Add the keywords 'dog' and 'cat' to the appropriate Articles. + - Add the Tags 'dog' and 'cat' to the appropriate Banners in the + [Banner Manager + New/Edit](https://docs.joomla.org/Help4.x:Banners:_Edit/en "Help4.x:Banners: Edit/en") + screen. + - Set the Banner module Parameter 'Search By Tags' to 'Yes in the + [Banner Module + Edit](https://docs.joomla.org/Help4.x:Site_Modules:_Banners/en "Help4.x:Site Modules: Banners/en") + screen. + - For articles only, in combination with the [Related + Articles](https://docs.joomla.org/Help4.x:Site_Modules:_Articles_-_Related/en "Help4.x:Site Modules: Articles - Related/en") + module, to display Articles that share at least one keyword in + common. For example, if the current Article displayed has the + keywords "cats, dogs, monkeys", any other Articles with at least one + of these keywords will show in the Related Articles module. +- **Author.** Optional entry for an Author name within the metadata. If + entered, this creates an HTML meta element with the name attribute of + "author" and the content attribute as entered here. +- **Robots.** The instructions for web "robots" that browse to this + page. + - *Use Global*: Use the value set in the Component→Options for this + component. + - *Index, Follow*: Index this page and follow the links on this page. + - *No index, Follow*: Do not index this page, but still follow the + links on the page. For example, you might do this for a site map + page where you want the links to be indexed but you don't want this + page to show in search engines. + - *Index, No follow*: Index this page, but do not follow any links on + the page. For example, you might want to do this for an events + calendar, where you want the page to show in search engines but you + do not want to index each event. + - *No index, no follow*: Do not index this page or follow any links on + the page. + +### Associations tab + +- **Select a Category:** Select or Create a Category to associate. + +### Permissions tab + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Options.** Users can edit the options and + permissions of this extension. + - **Configure Options Only.** Users can edit the options except the + permissions of this extension. + - **Access Administration Interface.** Users can access user + administration interface of this extension. + - **Create.** Users can create content of this extension. + - **Delete.** Users can delete content of this extension. + - **Edit.** Users can edit content of this extension. + - **Edit State.** User can change the published state and related + information for content of this extension. + - **Edit Own.** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +- **Save**. Saves the item and stays in the current screen. +- **Save & Close**. Saves the item and closes the current screen. +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. +- **Cancel**. 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 + +- To work with Web Links: [Web Link + Manager](https://docs.joomla.org/Help4.x:Components_Weblinks_Links/en "Help4.x:Components Weblinks Links/en") +- To work with Web Links Categories: [Web Link Category + Manager](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories/en "Help4.x:Components Weblinks Categories/en") diff --git a/manuals/help/components/components-weblinks-categories.md b/manuals/help/components/components-weblinks-categories.md new file mode 100644 index 0000000..632df00 --- /dev/null +++ b/manuals/help/components/components-weblinks-categories.md @@ -0,0 +1,198 @@ +--- +sidebar_position: 13 +id: components-weblinks-categories +title: "Help4.x:Components Weblinks Categories" +--- +## Description + +Web Links Categories are for the Web Links Component only. They are +separate from other Categories, such as those for Articles, Banners, +News Feeds and Contacts. + +## How to Access + +Select **Components **→** Weblinks **→** Categories** from the +Administrator menu. + +## Screenshot + + + +## Column Headers + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Title**. The name of the item. For a Menu Item, the Title will + display in the Menu. For an Article or Category, the Title may + optionally be displayed on the web page. This entry is required. You + can open the item for editing by clicking on the Title. + + + +- **Status**. Status of Category, Published or Unpublished are shown + with icons as follows: + - *Published category*.Help-4x-Article-status-featured-published-feature-manager-en.png + - *Unpublished category*. Help-4x-Article-status-not-published-feature-manager-en.png + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the Screenshot above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched. To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of categories in a list. + Select from the dropdown list to change the number displayed. The + default for a site is 20 set in the Global Configuration. + +### Filter Options + +The selections may be combined. Only items matching all selections will +be displayed in the list. + +- **Select Status.** Use the drop-down list box to select the published + state: Published, Unpublished, Trashed, or All. For Articles, you may + also select Archived. **Important:** With the default setting of + -Select Status-, the screen only shows Published and Unpublished + items. If you have the filter set to -Select Status- and you change + items to Trashed, the Trashed items will disappear from the screen. + However, they have not been permanently deleted. To do that you need + to: + +1. Change the filter to Trashed. The Delete icon will now show in the + toolbar. +2. Select the items you want to permanently delete. +3. Click on the Delete icon. + +You can see all items, regardless of their published state, by selecting +All for this filter. You can also re-publish Trashed items by selecting +them and clicking on the Publish icon in the toolbar. + +- **Select Access**. Select from the list of available viewing access + levels. + + + +- **Select Language**. Select from the list of available languages, if + the site manages more than 1 language. + + + +- **Select Tag**. Select from the list of available tags. + + + +- **Select Max Levels**. Select from the list of available levels. + +## Toolbar + +- **New**. Opens the editing screen to create a new web link category. +- **Edit**. Opens the editing screen for the selected web link category. + If more than one web link category is selected (where applicable), + only the first web link category will be opened. The editing screen + can also be opened by clicking on the Name of the web link category. +- **Publish**. Makes the selected web link categories available to + visitors to your website. +- **Unpublish.** Makes the selected web link categories unavailable to + visitors to your website. +- **Archive**. Changes the status of the selected web link categories to + indicate that they are archived. Archived web link categories can be + moved back to the published or unpublished state by selecting + 'Archived' in the 'Select Status' filter and changing the status of + the web link categories. +- **Check-In**. Checks-in the selected web link categories. Works with + one or multiple web link categories selected. +- **Batch**. Batch processes the selected web link categories. Works + with one or multiple items selected. +- **Rebuild.** Reconstructs and refreshes the web link category table. + Normally, you do *not* need to rebuild this table. This function is + provided in case the data in the table becomes corrupted. +- **Trash**. Changes the status of the selected web link categories to + indicate that they are trashed.Trashed web link categories can still + be recovered by selecting 'Trashed' in the 'Select Status' filter and + changing the status of the articles to Published or Unpublished as + preferred.To permanently delete trashed web link categories, select + 'Trashed' in the 'Select Status' filter, select the web link + categories to be permanently deleted, then click the 'Empty Trash' + toolbar icon. +- **Help**. Opens this help screen. +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + +## Related Information + +- To work with Web Links: [Web + Links](https://docs.joomla.org/Help4.x:Components_Weblinks_Links/en "Help4.x:Components Weblinks Links/en") +- To add new Web Links Categories: [Web Links Category - + New/Edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit/en "Help4.x:Components Weblinks Categories Edit/en") diff --git a/manuals/help/components/components-weblinks-links-edit.md b/manuals/help/components/components-weblinks-links-edit.md new file mode 100644 index 0000000..37cc3f9 --- /dev/null +++ b/manuals/help/components/components-weblinks-links-edit.md @@ -0,0 +1,187 @@ +--- +sidebar_position: 16 +id: components-weblinks-links-edit +title: "Help4.x:Components Weblinks Links Edit" +--- +## Description + +This form is used to add a new Web Link or edit an existing link. Note +that you need to create at least one Web Links Category before you can +create your first Web Link. + +## How to Access + +- Select **Components **→** Web Links **→** Links** from the + Administrator menu. Then... +- Select the **New** button in the Toolbar to create a new link. Or... +- Select a title in the list of links to edit an existing link. + +## Screenshot + + + +## Form Fields + +- **Title.** This is the text that will display in the *Title* column of + the links list. This field is required. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### New Web Link tab + +**Left Panel** + +- **URL.** The URL of the Web Link. +- **Description.** The description for the item. Category, Subcategory + and Web Link descriptions may be shown on web pages, depending on the + parameter settings. These descriptions are entered using the same + editor that is used for Articles. +- **Toggle Editor.** Turns on or off the editor's description box + WYSIWYG features to show HTML markup. + +**Right Panel** + +- **Status.** (Published/Unpublished/Archived/Repoted/Trashed) The + published status of the item. +- **Category.** The Category this item belongs to. +- **Access.** The viewing level access for this item. +- **Language.** Item language. +- **Tags.** Enter one or more optional tags for this item. You can + select existing tags by entering in the first few letters. You may + also create new tags by entering them here. Tags allow you to see + lists of related items across content types (for example, articles, + contacts, and categories). + +### Images tab + +- **First Image.** Click on Select to select an image to display with + this item in the front end. +- **Image Float.** (Use Global/Right/Left/None). Where to place the + image relative to the text on the page. +- **Alt text.** Alternative text to use for visitors who don't have + access to images. This text is replaced with the caption text if + caption text is available. +- **Caption.** The caption for the image. +- **Second Image.** Click on Select to select an image to display with + this item in the front end. +- **Image Float.** (Use Global/Right/Left/None). Where to place the + image relative to the text on the page. +- **Alt text.** Alternative text to use for visitors who don't have + access to images. This text is replaced with the caption text if + caption text is available. +- **Caption.** The caption for the image. + +### Publishing tab + +- **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). +- **Created Date.** This field defaults to the current time when the + Article was created. You can enter in a different date and time or + click on the calendar icon to find the desired date. +- **Created By.** Name of the Joomla! User who created this item. This + will default to the currently logged-in user. If you want to change + this to a different user, click the Select User button to select a + different user. +- **Author's Alias.** This optional field allows you to enter in an + alias for this Author for this Article. This allows you to display a + different Author name for this Article. +- **Modified Date.** (Informative only) Date of last modification. +- **Modified By.** (Informative only) Username who performed the last + modification. +- **Revision.** (Informative only) Number of revisions to this item. +- **Hits.** The number of times an item has been viewed. +- **ID.** This is a unique identification number for this item assigned + automatically by Joomla!. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays 0 until you save the new entry, at which point a new ID + is assigned to it. + + + +- **Meta Description.** An optional paragraph to be used as the + description of the page in the HTML output. This will generally + display in the results of search engines. If entered, this creates an + HTML meta element with a name attribute of "description" and a content + attribute equal to the entered text. +- **Meta Keywords.** Optional entry for keywords. Must be entered + separated by commas (for example, "cats, dogs, pets") and may be + entered in upper or lower case. (For example, "CATS" will match "cats" + or "Cats"). +- **External Reference.** An optional reference used to link to external + data sources. If entered, this creates an HTML meta element with a + name attribute of "xreference" and a content attribute equal to the + entered text. +- **Robots.** The instructions for web "robots" that browse to this + page. + - Use Global: Use the value set in the Component→Options for this + component. + - Index, Follow: Index this page and follow the links on this page. + - No index, Follow: Do not index this page, but still follow the links + on the page. For example, you might do this for a site map page + where you want the links to be indexed but you don't want this page + to show in search engines. + - Index, No follow: Index this page, but do not follow any links on + the page. For example, you might want to do this for an events + calendar, where you want the page to show in search engines but you + do not want to index each event. + - No index, no follow: Do not index this page or follow any links on + the page. +- **Content Rights.** Describe what rights others have to use this + content. + +### Options tab + +- **Target.** How to open the link. Options are: + - Open in parent window. Open the link in the current browser window, + allowing Back and Forward navigation. + - Open in new window. Open the link in a new browser window, allowing + Back and Forward navigation. + - Open in popup. Open link in a popup window. + - Modal. Open link in a modal screen. +- **Width.** Width of the IFrame Window. Enter in a number of pixels or + enter in a percentage (%). For example, "550" means 550 pixels. "75%" + means 75% of the page width. +- **Height.** Height of the IFrame Window. Enter in a number of pixels + or enter in a percentage (%). For example, "550" means 550 pixels. + "75%" means 75% of the page height. +- **Count Clicks.** Whether or not to keep track of how many times this + web link has been opened. + +## Toolbar + +- **Save**. Saves the item and stays in the current screen. +- **Save & Close**. Saves the item and closes the current screen. +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. +- **Cancel**. 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 + +- At least one Web Link Category must be added *before* any Web Links + can be created. + +## Related Information + +- To add or edit Web Link Categories: [Web Link Category + Manager](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories "Special:MyLanguage/Help4.x:Components Weblinks Categories") +- To find and edit existing Web Links: [Web Link + Manager](https://docs.joomla.org/Help4.x:Components_Weblinks_Links "Special:MyLanguage/Help4.x:Components Weblinks Links") +- To create a page layout for Web Links: [Menu Item Manager - New/Edit - + Internal Link - Web + Links](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Internal_Link_-_Web_Links "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit") diff --git a/manuals/help/components/components-weblinks-links.md b/manuals/help/components/components-weblinks-links.md new file mode 100644 index 0000000..780a36f --- /dev/null +++ b/manuals/help/components/components-weblinks-links.md @@ -0,0 +1,143 @@ +--- +sidebar_position: 15 +id: components-weblinks-links +title: "Help4.x:Components Weblinks Links" +--- +## Description + +The Weblinks component allows you to manage links to other web sites and +organize them into categories to display on your site. Optionally you +may allow visitors to add new links. This component is not included in +Joomla 4. It must be obtained from the download site +(https://downloads.joomla.org/extensions/weblinks) +and installed as for any other extension. + +## How to Access + +Select **Components **→** Web Links **→** Links** from the Administrator +menu. + +## Screenshot + + + +## List Filters + +Above the table is a Search Bar for basic searching and sorting: + +- **Search:** Enter any part of a link text or ID:XX where xx is a + number to search for a specific link. +- **Sort Table by:** (preset to **Title ascending**) to choose a sorting + method. +- **A number** (preset to the site default list limit set in Global + Configuration) to choose an alternative number of links to display. + +The column headings also show the current ordering method, set to Title +by default. Click a heading to order by that heading. Click again to +toggle the direction from ascending to descending. + +### Filter Options + +Select the Filter Options button to reveal more filtering options. More +than one filter may be set and only items that meet all of the filter +conditions will appear in the list. + +- **Select Status**. Select from Trashed / Unpublished / Published / + Archived / All. + + + +- **Select Category**. Select from the list of available categories. + + + +- **Select Access**. Select from the list of available viewing access + levels. + + + +- **Select Language**. Select from the list of available languages, if + the site manages more than 1 language. + +**Filter by Tag Type.** Select the Tag Type from the drop-down list box +of available Tag Types. Available tags are components in which tags are +defined. + +- **Select Max Levels**. Select from the list of available levels. + +### Automatic Pagination + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +The functions are: + +- **New**. Opens the editing screen to create a new web link. +- **Actions**. dropdown list activated when one or more list items are + selected. + - **Publish**. Makes the selected web link available to visitors to + your website. + - **Unpublish**. Makes the selected web links unavailable to visitors + to your website. + - **Archive**. Changes the status of the selected web links to + indicate that they are archived. Archived web links can be moved + back to the published or unpublished state by selecting 'Archived' + in the 'Select Status' filter and changing the status of the web + links. + - **Check-In**. Checks-in the selected web links. Works with one or + multiple web links selected. + - **Trash**. Changes the status of the selected web links to indicate + that they are trashed.Trashed web links can still be recovered by + selecting 'Trashed' in the 'Select Status' filter and changing the + status of the articles to Published or Unpublished as preferred.To + permanently delete trashed web links, select 'Trashed' in the + 'Select Status' filter, select the web links to be permanently + deleted, then click the 'Empty Trash' toolbar icon. + - **Batch**. Batch processes the selected web links. Works with one or + multiple items selected. +- **Help**. Opens this help screen. +- **Options**. Opens the Options window where settings such as default + parameters can be edited. + +## Quick Tips + +- You need to add at least one Category for Web Links *before* you can + add your first Web Link. Categories are added using the [Web Link + Category + Manager](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories "Special:MyLanguage/Help4.x:Components Weblinks Categories"). + +## Related Information + +- To add or edit Web Links: [Web Link Manager - + New/Edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Links_Edit "Special:MyLanguage/Help4.x:Components Weblinks Links Edit"). +- To work with Web Links Categories: [Web Link Category + Manager](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories "Special:MyLanguage/Help4.x:Components Weblinks Categories"). +- Web Links-related menu items: [List All Web Link + Categories](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Categories "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Categories"), + [List Web Links in a + Category](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Category "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Category"), + [Submit a Web + Link](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Submit "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Submit"). +- Weblinks module: [Weblinks + module](https://docs.joomla.org/Help4.x:Extensions_Module_Manager_Weblinks "Special:MyLanguage/Help4.x:Extensions Module Manager Weblinks"). diff --git a/manuals/help/contacts/contacts-categories.md b/manuals/help/contacts/contacts-categories.md new file mode 100644 index 0000000..6c7e13c --- /dev/null +++ b/manuals/help/contacts/contacts-categories.md @@ -0,0 +1,291 @@ +--- +sidebar_position: 2 +id: contacts-categories +title: "Help4.x:Contacts: Categories" +--- +## Description + +Contact Categories allow you to organize contacts in your web site. +Contact Categories are separate from other types of Categories, such as +those for Articles, Banners, News Feeds, and so on. + +## How to Access + +- Select **Components **→** Contacts **→** Categories** from the + Administrator menu. + +## Screenshot + + + +## Column Headers + +Click on the column heading to sort the list by that column's value. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **Title**. The name of the item. For a Menu Item, the Title will + display in the Menu. For an Article or Category, the Title may + optionally be displayed on the web page. This entry is required. You + can open the item for editing by clicking on the Title. + + + +- **Published:** + Help-4x-icon-tick.png The number of published + items. Click the numbered button to show a list of just those items. + + + +- **Unpublished:** + Help-4x-icon-cross.png The number of unpublished + items. Click the numbered button to show a list of just those items. + + + +- **Archived:** Whether and how many items has been archived. You see + the Archived items by clicking on the icon in this column. + + + +- **Trashed** + Help-4x-icon-bin.png The number of trashed items. + Click the numbered button to show a list of just those items. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Association:** Shows which menu item this item is associated. + + + +- **Language**. Item language. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + + + +- **Select Status**. Select from Trashed / Unpublished / Published / + Archived / All. + + + +- **Select Access**. Select from the list of available viewing access + levels. + + + +- **Select Language**. Select from the list of available languages, if + the site manages more than 1 language. + + + +- **Select Tag**. Select from the list of available tags. + + + +- **Select Max Levels**. Select from the list of available levels. + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Batch Processing + +The Batch Process allows a change in settings for a group of selected +items marked with a check-mark in the corresponding check-mark boxes. To +use: click on the link found below the table of items being viewed to +activate the drop down field area. Using the 'Batch' Toolbar button will +open a pop up window as shown below. + + + +You can change one value or all four values at one time. + +***Note** - if you copy items to a new category, changes you have +selected from access level and language will be applied to the copies, +not the original.* + +**How to Batch Process** a group of items: + +1. Select one or more items on the list by checking the desired + category check boxes. +2. Click the 'Batch' Toolbar button. +3. Set one or more of the following values: + - To change the **Access Levels**, select the desired new access + level from the Set Access Level list box. + - To change the **Language**, select the desired language from the + Set Language list box. + - To change the **Category**, select a category. To leave the + category unchanged, use the default value of "Select". + + 1. To copy the items to a different category, select the desired + category from the category list box and check the Copy option. + In this case, the original items are unchanged and the copies + are assigned to the new category and, if selected, the new + access level and language. + 2. To move the items to a different category, select the desired + category from the category list box and check the Move option. + In this case, the original items will be moved to a new category + and, if selected, be assigned the new access level and language. +4. When all of the settings are entered, click on Process to perform + the changes. A message **"Batch process completed successfully."** + will show. + +Note that nothing will happen if you (a) don't have any items selected +or (b) have not selected an access level, language, or category. + +If you wish to clear your entered selections, click on the Cancel +button. This will return all of the Batch controls to their default +values. Note that this does *not* uncheck the check boxes for the items. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new category. + + + +- **Actions:** Reveals a list of actions for selected Items. Check one + or more Item checkboxes to activate the list. + + + +- - **Publish**. Makes the selected category available to visitors to + your website. + +- - **Unpublish.** Makes the selected category unavailable to visitors + to your website. + +- - **Archive**. Changes the status of the selected category to indicate + that they are archived. Archived category can be moved back to the + published or unpublished state by selecting 'Archived' in the + 'Select Status' filter and changing the status of the category. + +- - **Check-In**. Checks-in the selected category. Works with one or + multiple category selected. + +- - **Trash**. Changes the status of the selected category to indicate + that they are trashed.Trashed category can still be recovered by + selecting 'Trashed' in the 'Select Status' filter and changing the + status of the articles to Published or Unpublished as preferred.To + permanently delete trashed category, select 'Trashed' in the 'Select + Status' filter, select the category to be permanently deleted, then + click the 'Empty Trash' toolbar icon. + +- - **Batch**. Batch processes the selected category. Works with one or + multiple items selected. + + + +- **Rebuild.** Reconstructs and refreshes the category table. Normally, + you do *not* need to rebuild this table. This function is provided in + case the data in the table becomes corrupted. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. See [Contact Manager + Options](https://docs.joomla.org/Help4.x:Contacts:_Options/en "Help4.x:Contacts: Options/en") + for more information. +- **Help**. Opens this help screen. + +## Related Information + +- To work with Contacts: [Contact Manager: + Contacts](https://docs.joomla.org/Help4.x:Contacts/en "Help4.x:Contacts/en") +- To add new Contact Categories: Category + Manager - New/Edit diff --git a/manuals/help/contacts/contacts-new-or-edit-category.md b/manuals/help/contacts/contacts-new-or-edit-category.md new file mode 100644 index 0000000..fedcc79 --- /dev/null +++ b/manuals/help/contacts/contacts-new-or-edit-category.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 4 +id: contacts-new-or-edit-category +title: "Help4.x:Contacts: New or Edit Category" +--- +Redirect to: + +- [Help4.x:Contacts: Edit + Category](https://docs.joomla.org/Help4.x:Contacts:_Edit_Category "Help4.x:Contacts: Edit Category") diff --git a/manuals/help/contacts/contacts-new-or-edit.md b/manuals/help/contacts/contacts-new-or-edit.md new file mode 100644 index 0000000..f078eec --- /dev/null +++ b/manuals/help/contacts/contacts-new-or-edit.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 3 +id: contacts-new-or-edit +title: "Help4.x:Contacts: New or Edit" +--- +Redirect to: + +- [Help4.x:Contacts: + Edit](https://docs.joomla.org/Help4.x:Contacts:_Edit "Help4.x:Contacts: Edit") diff --git a/manuals/help/contacts/contacts-options.md b/manuals/help/contacts/contacts-options.md new file mode 100644 index 0000000..df1b947 --- /dev/null +++ b/manuals/help/contacts/contacts-options.md @@ -0,0 +1,401 @@ +--- +sidebar_position: 5 +id: contacts-options +title: "Help4.x:Contacts: Options" +--- +## Description + +Contact Options used globally for all contacts. + +## How to Access + +- Select **Components **→** Contacts** from the Administrator menu. + Then... + - Select the **Options** button in the Toolbar. The Options button is + available on Contacts and Categories. + +## Screenshot + + + +## Form Fields + +### Contacts Tab + +These settings apply for single Contact unless they are changed for a +specific menu item or Contact + +- **Choose a Layout.** Default layout to use for items. +- **Contact Category.** If 'Hide', the Contact Category will not show. + If 'Show Without Link', Category will show as text. If 'Show With + Link', Category will show as a link to a Single Category Menu Item. +- **Enable Versions.** (Yes/No). Whether or not to save version history + for this component. If No, version history will not be saved for + component items or for this component's categories. +- **Maximum Versions.** The maximum number of versions to store for an + item. If an item is saved and the maximum number of versions has been + reached, the oldest version will be deleted automatically. If set to + 0, then versions will never be deleted automatically. Also, specific + versions may be flagged as "Keep Forever" and will not be deleted + automatically. Note that versions may be deleted manually using the + Delete button in the [Version + History](https://docs.joomla.org/Help4.x:Components_Version_History/en "Help4.x:Components Version History/en") + screen. +- **Show Contact List.** If 'Show', the user will be able to change + which contact is shown by selecting a contact from a drop-down list of + all contacts in the current contact category. +- **Display Format.** Determines the style used to display sections of + the contact form. +- **Tags.** Whether to hide or show any tags for this item. + + + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show to allow users to select a contact in a drop down list. +- *Hide:* Do not display the Contact list. + + + +- **Contact Information.** Show or hide the contact information. +- **Name.** Show name of the contact. +- **Contact's Position.** Show or Hide position. +- **Email.** Show or Hide contact email. +- **Add Mailto: Link.** Adds a mailto: link to the displayed email + address. +- **Street Address.** Show or Hide street address. +- **City or Suburb.** Show or hide city or suburb. +- **State or County.** Show or Hide state or county. +- **Postal/ZIP Code.** Show or Hide postal or zip code. +- **Country.** Show or Hide Country. +- **Telephone.** Show or Hide telephone number. +- **Mobile Phone.** Show or Hide mobile number. +- **Fax.** Show or Hide fax number. +- **Webpage.** Show or hide webpage. +- **Image.** Show or Hide image. +- **Image.** Choose the image file to use for the contact. +- **Miscellaneous Information.** Show or Hide miscellaneous information. +- **vCard.** Whether or not to allow export to vCard format. +- **Show User Articles.** Show User Articles::If this contact is mapped + to a user, and if this is set to Show, then a list of articles created + by this user will show. +- **\# Articles to List.** Number of articles to list. +- **User Profile.** Show or hide Profile. +- **Show User Custom Fields.** Show user custom fields which belong to + all or only selected field groups. +- **Contact Links.** Show or hide Links. +- **Link A Label.** An additional link for this contact. +- **Link B Label.** An additional link for this contact. +- **Link C Label.** An additional link for this contact. +- **Link D Label.** An additional link for this contact. +- **Link E Label.** An additional link for this contact. + +### Icons Tab + + + +These settings apply for single Contact unless they are changed for a +specific menu item or Contact + +- **Settings.** Choose whether to display icons, text or nothing next to + the information. +- **Address Icon.** Select the Address icon. If none selected, the + default icon will be displayed. +- **Email Icon.** Select the Email icon. If none selected, the default + icon will be displayed. +- **Telephone Icon.** Select the Telephone icon. If none selected, the + default icon will be displayed. +- **Mobile Icon.** Select the Mobile icon. If none selected, the default + icon will be displayed. +- **Fax Icon.** Select the Fax icon. If none selected, the default icon + will be displayed. +- **Misc Icon.** Select the Misc icon. If none selected, the default + icon will be displayed. + +### Category Tab + +Category Options control how contacts will show when you drill down to a +Category to view its contacts. + + + +- **Choose a Layout.** (Blog/List/user defined). This lets you select + the default layout to show when you click on a Category link. If you + create an alternative layout for a category layout, you may select + that as the default. +- **Category Title.** (Show/Hide) Hide or Show the title of the + category. +- **Category Description.** (Show/Hide) Hide or Show the description for + the category. +- **Category Image.** (Show/Hide) Hide or Show the category image. +- **Subcategory Levels.** (None/All/1-5). Categories in Joomla can be + created in a hierarchy. This lets you control how many levels of + subcategories to show when showing a category view. +- **Subcategories Descriptions.** (Show/Hide) Hide or Show the + descriptions for subcategories that are shown. +- **Empty Categories.** (Show/Hide) Hide or Show categories that don't + contain any articles or subcategories. +- **\# Contacts in Category.** Show or Hide the number of Contacts in + category. +- **Category Tags.** Show or Hide the tags for a single category. + +### Categories Tab + +These settings apply for Contact Categories Options unless they are +changed for a specific menu item. + + + +- **Top Level Category Description.** (Show/Hide). Hide or Show the + description of the top-level category. +- **Subcategory Levels.** (All/1-5). How many levels in the hierarchy to + show. +- **Subcategories Descriptions.** (Show/Hide). Hide or Show the + description of each subcategory. +- **Empty Categories.** (Show/Hide). Hide or Show categories that + contain no articles and no subcategories. +- **\# Contacts in Category.** Show or Hide the number of Contacts in + category. + +### List Layouts Tab + +These settings apply for Contact List Options unless they are changed +for a specific menu item. + + + +- **Filter Field.** The Filter Field creates a text field where a user + can enter a field to be used to filter the articles shown in the list. + An example of how this looks in the front-end layout is shown below. + +Help30-article-category-list-filter-field-en.png + +The possible options for this (in the back-end menu item edit) are shown +below. + +- *Hide:* Don't show a filter field. +- *Title:* Filter on article title. +- *Author:* Filter on the author's name. +- *Hits:* Filter on the number of article hits. + + + +- **Display Select.** (Show/Hide) Whether to hide or show the Display \# + control that allows the user to select the number of items to show in + the list. An example is shown below. + + + +If there are more items than this number, you can use the page +navigation buttons (Start, Prev, Next, End, and page numbers) to +navigate between pages. Note that if you have a large number of items, +it may be helpful to use the Filter options, located above the column +headings, to limit which items display. + +- **Table Headings.** (Show/Hide) Table Headings show a heading above + the article list, as shown below. + + + +If set to *Show*, this heading will show about the list. Otherwise the +list will show with no headings. + +- **Image.** Show or Hide an Image column in the list of Contacts. +- **Position.** Show or Hide a Position column in the list of Contacts. +- **Email.** Show or Hide an Email column in the list of Contacts. +- **Phone.** Show or Hide a Phone column in the list of Contacts. +- **Mobile.** Show or Hide show a Mobile column in the list of Contacts. +- **Fax.** Show or Hide a Fax column in the list of Contacts. +- **City or Suburb.** Show or Hide a City or Suburb column in the list + of Contacts. +- **State or County.** Show or Hide a State or County column in the list + of Contacts. +- **Country.** Show or Hide a Country column in the list of Contacts. + + + +- **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 listed items will not fit + on one page. An example is shown below. + +Help30-pagination-en.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. + + + +- **Sort by**. Choose the field name to sort. + +### Form Tab + +These settings apply for single Contact unless they are changed for a +specific menu item or Contact. + + + +- **Allow Captcha on Contact.** Use Default or None Selected. Select the + captcha plugin that will be used in the contact form. Captcha is the + name of a technique to prevent spam user registrations by requiring a + user to type in characters from a distorted image or to mark 'I'am not + a robot'. You may need to enter further information for your captcha + plugin in the Plugin Manager. +- **Contact Form.** Show or Hide contact form. +- **Send Copy to Submitter.** Hide or Show checkbox to allow copy of + email to be sent to submitter. +- **Banned Email.** Email addresses not allowed to submit information + with the contact form. +- **Banned Subject.** Subjects not allowed in contact form. +- **Banned Text.** Text not allowed in contact form body. +- **Session Check.** Check for the existence of session cookie. This + means that users without cookies enabled will not be able to send + emails. +- **Custom Reply.** Turns off the automated reply, allowing for Plugins + to handle integration with other systems. +- **Contact Redirect.** Enter an alternative URL, where the user will be + redirected after mail is send. + +### Integration Tab + +These settings determine how the Contact Component will integrate with +other extensions. + + + +- **Show Feed Links.** (Show or Hide) Show or hide the feed links URLs. + A feed link will show up as a feed icon in the address bar of most + browsers. +- **Remove IDs from URLs.** (Yes or No) Whether or not to show the + database id of a contact in a link. +- **Enable Custom Fields.** (Yes or No) Enable the creation of custom + fields. + +### Permissions Tab + +This section shows permissions for contacts. The screen shows as +follows. + + + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Optons.** Users can edit the options and + permissions of this extension. + - **Configure Options Only.** Users can edit the options except the + permissions of this extension. + - **Access Administration Interface.** Users can access user + administration interface of this extension. + - **Create.** Users can create content of this extension. + - **Delete.** Users can delete content of this extension. + - **Edit.** Users can edit content of this extension. + - **Edit State.** User can change the published state and related + information for content of this extension. + - **Edit Own.** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the Contact Manager options and stays in the current + screen. + + + +- **Save & Close**. Saves the Contact Manager options and closes the + current screen. + + + +- **Cancel**. 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 + +- If you are a beginning user, you can just keep the default values here + until you learn more about using global options. +- If you are an advanced user, you can save time by creating good + default values here. When you set up menu items and create contacts, + you will be able to accept the default values for most options. +- All values set here can be overridden at the menu item, category, or + contact level. + +## Related Information + +- To create and edit contacts and contact categories: [Contact + Manager](https://docs.joomla.org/Help4.x:Contacts/en "Help4.x:Contacts/en") +- For more information about Joomla's ACL system: [Joomla 3 ACL + Tutorial](https://docs.joomla.org/J3.x:Access_Control_List_Tutorial/en "J3.x:Access Control List Tutorial/en") diff --git a/manuals/help/contacts/contacts.md b/manuals/help/contacts/contacts.md new file mode 100644 index 0000000..a2cee84 --- /dev/null +++ b/manuals/help/contacts/contacts.md @@ -0,0 +1,235 @@ +--- +sidebar_position: 1 +id: contacts +title: "Help4.x:Contacts" +--- +## Description + +The Contacts list shows selected information for contacts and provides +links to edit or add information such as name, address, phone and +e-mail. You can also link contacts to registered users. Afterwards, you +can use the [Menu +Manager](https://docs.joomla.org/Help4.x:Menus/en "Help4.x:Menus/en") to +create front-end links to the the contacts. + +## How to access + +- Select **Components **→** Contacts **→** Contacts** from the + Administrator menu. Or... +- Select the numbered button in the [Category Manager: + Contacts](https://docs.joomla.org/Help4.x:Contacts:_Categories/en "Help4.x:Contacts: Categories/en") + screen. + +## Screenshot + + + +## Column Headers + +Click on the column heading to sort the list by that column's value. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Ordering:** (default). The column in which to sort displayed items + in the table. The values are the same as the column heading names. + + + +- **Featured.** Whether or not the item will be displayed in featured + view. + + + +- **Status**. The published status of the item. + + + +- **Title**. The name of the item. For a Menu Item, the Title will + display in the Menu. For an Article or Category, the Title may + optionally be displayed on the web page. This entry is required. You + can open the item for editing by clicking on the Title. + + + +- **Linked User.** The username this contact is linked to (if + applicable). + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + + + +- **Select Featured**. Select from Unfeatured Articles / Featured + Articles. + + + +- **Select Status**. Select from Trashed / Unpublished / Published / + Archived / All. + + + +- **Select Category**. Select from the list of available categories. + + + +- **Select Access**. Select from the list of available viewing access + levels. + + + +- **Select Language**. Select from the list of available languages, if + the site manages more than 1 language. + + + +- **Select Tag**. Select from the list of available tags. + + + +- **Select Max Levels**. Select from the list of available levels. + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new contact. + + + +- **Actions:** Reveals a list of actions for selected Items. Check one + or more Item checkboxes to activate the list. + + + +- - **Publish**. Makes the selected contact available to visitors to + your website. + +- - **Unpublish.** Makes the selected contact unavailable to visitors to + your website. + +- - **Feature.** Marks selected contact as featured. Works with one or + multiple contact selected. + +- - **Unfeature.** Changes the status of featured articles to + unfeatured. Works with one or multiple articles selected. + +- - **Archive**. Changes the status of the selected contact to indicate + that they are archived. Archived contact can be moved back to the + published or unpublished state by selecting 'Archived' in the + 'Select Status' filter and changing the status of the contact. + +- - **Check-In**. Checks-in the selected contact. Works with one or + multiple contact selected. + +- - **Batch**. Batch processes the selected contact. Works with one or + multiple items selected. + +- - **Trash**. Changes the status of the selected contact to indicate + that they are trashed.Trashed contact can still be recovered by + selecting 'Trashed' in the 'Select Status' filter and changing the + status of the articles to Published or Unpublished as preferred.To + permanently delete trashed contact, select 'Trashed' in the 'Select + Status' filter, select the contact to be permanently deleted, then + click the 'Empty Trash' toolbar icon. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- You need to add at least one Category for your Contacts *before* you + can add your first Contact. Categories are added using the Category Manager: + Contacts screen. + +## Related Information + +| | | +|------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Contacts: Categories](https://docs.joomla.org/Help4.x:Contacts:_Categories/en "Help4.x:Contacts: Categories/en") | The Contact Category Manager is where you can edit existing Contact Categories and create new ones. Note that Contact Categories are separate from other Categories, such as for Articles, Banners, News Feeds, and Web Links. From this screen, you can also navigate to the Contact Manager: + Contacts screen. | +| Contacts: + New or Edit Category | This is where you can add a Contact Category or edit an existing Contact Category. Contact Categories allow you to organize contacts in your web site. Contact Categories are separate from other types of Categories, such as those for Articles, Banners, News Feeds, and so on. | +| Contacts: + New or Edit | This is where you can add a Contact or edit an existing Contact. Contacts allow you to list people on your web site. They also allow users to send e-mails to those people. | diff --git a/manuals/help/content-security-policy/content-security-policy-options.md b/manuals/help/content-security-policy/content-security-policy-options.md new file mode 100644 index 0000000..53a1853 --- /dev/null +++ b/manuals/help/content-security-policy/content-security-policy-options.md @@ -0,0 +1,133 @@ +--- +sidebar_position: 1 +id: content-security-policy-options +title: "Help4.x:Content Security Policy: Options" +--- +## Description + +The Content Security Policy Options screen is used to set up the default +CSP. + +## How to Access + +- Select **System **→** Global Configuration** from the Administrator + menu. Then... + - Select **Content Security Policy** from the Component list. + +## Screenshot + + + +## Form Fields + +### Content-Security-Policy (CSP) + +These options control the Content-Security-Policy. + +- **Content Security Policy (CSP).** (Enabled/Disabled) Whether to + Enable or Disable the Content-Security-Policy. +- **Mode.** (Custome/Detect/Automatic) Configures the mode the plugin + generates the Content-Security-Policy on. The Custom mode allows + manual configuration. The Detect mode enables the report collection + and the automatic mode uses the collected reports to generate the + Content-Security-Policy. +- **Report-Only.** (Enabled/Disabled) Use the header + 'Content-Security-Policy-Report-Only' instead of + 'Content-Security-Policy'. +- **Nonce.** (Enabled/Disabled) Enable the whitelist for specific inline + scripts using a cryptographic nonce (number used once) for all scripts + and styles using the Joomla API. Specifying a nonce makes a modern + browser ignore 'unsafe-inline' which should still be set for older + browsers without nonce support. +- **Script hashes.** (Enabled/Disabled) Enable the optional hash based + whitelist inline scripts using a cryptographic hash for all scripts + using the Joomla API. Specifying hashes makes a modern browser ignore + 'unsafe-inline' which should still be set for older browsers without + hash support. +- **Style hashes.** (Enabled/Disabled) Enable the optional hash based + whitelist inline styles using a cryptographic hash for all styles + using the Joomla API. Specifying hashes makes a modern browser ignore + 'unsafe-inline' which should still be set for older browsers without + hash support. +- **frame-ancestors 'self'.** (Enabled/Disabled)Enable the CSP + clickjacking protection frame-ancestors and only allow the origin + 'self'. Please use the form below to allow origins other than 'self'. +- **Add Directive.** (Subform) You can use this subform to add as many + entries as you want for the Content-Security-Policy by setting the + **Policy Directive**, **Value** and **Client**. + +### Permissions + +This section lets you set up the default ACL permissions for the +Content-Security-Policy Component To change the permissions for this +extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Optons**. Users can edit the options and + permissions of this extension. + - **Configure Optons Only**. Users can edit the options exept the + permissions of this extension. + - **Access Administration Interface**. Users can access user + administration interface of this extension. + - **Create:** Users can create content of this extension. + - **Delete:** Users can delete content of this extension. + - **Edit:** Users can edit content of this extension. + - **Edit State:** User can change the published state and related + information for content of this extension. + - **Edit Own:** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited:*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- By default the Content-Security-Policy is disabled and has to be + enabled and configured. +- Please note that this Component requires the Plugin **System - HTTP + Headers** (plg_system_httpheaders) to be enabeld. + +## Related Information + +- To review the collected reports please see: Components + CSP Reports +- More details on HTTP Header Tools: [Tutorial: Http Header Management + in Joomla + 4](https://docs.joomla.org/J4.x:Http_Header_Management/en "J4.x:Http Header Management/en") diff --git a/manuals/help/content-security-policy/content-security-policy-reports.md b/manuals/help/content-security-policy/content-security-policy-reports.md new file mode 100644 index 0000000..3fd127b --- /dev/null +++ b/manuals/help/content-security-policy/content-security-policy-reports.md @@ -0,0 +1,63 @@ +--- +sidebar_position: 2 +id: content-security-policy-reports +title: "Help4.x:Content Security Policy Reports" +--- +## Description + +The Content Security Policy Reports list is used to review and manage +collected CSP reports. + +## How to Access + +- Select **System **→** Manage panel **→** Content Security Policy** + from the Administrator menu. + +## Screenshot + + + +## Toolbar + +The functions are: + +- **Publish.** Makes the selected report available to the automatic + generated Content-Security-Policy rule. +- **Unpublish.** Makes the selected report unavailable to the automatic + generated Content-Security-Policy rule. +- **Trash.** Changes the status of the selected report to indicate that + they are trashed. Trashed reports can still be recovered by selecting + "Trashed" in the Select Status filter and changing the status of the + report to Published or Unpublished as preferred. To permanently delete + trashed article, select "Trashed" in the Select Status filter, select + the article to be permanently deleted, then click the Empty Trash + toolbar icon. +- **Help.** Opens this help screen. + +## Quick Tips + +- By default this view will be empty. You have to first enable the + collection mode form the + options. +- To see trashed reports, set the Status filter to **All**. + +## Related Information + +- To configure the Content-Security-Policy: Components + CSP Reports Options +- More details on HTTP Header Tools in 4.x: [Http Header + Management](https://docs.joomla.org/J4.x:Http_Header_Management/en "J4.x:Http Header Management/en") + - Please note that this Component requires the Plugin **System - HTTP + Headers** (plg_system_httpheaders) to be enabeld. When not enabled + there is a warning in this screen. diff --git a/manuals/help/editors/editors.md b/manuals/help/editors/editors.md new file mode 100644 index 0000000..26a598b --- /dev/null +++ b/manuals/help/editors/editors.md @@ -0,0 +1,285 @@ +--- +sidebar_position: 1 +id: editors +title: "Help4.x:Editors" +--- +## TinyMCE + +TinyMCE is the default editor for Frontend and Backend users. The editor +allows users a familiar word-processing interface to use when editing +Content. + +TinyMCE can be configured with 3 different sets of toolbar buttons. This +is set in the [Editor - +TinyMCE](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Editor_Group/en#tinymce "Chunk4x:Extensions Plugin Manager Edit Editor Group/en") +plugin. + +### Toolbars + +#### Simple Preset + +The toolbar set 2 provides one row of buttons as shown below. The set is +default assigned to the Public [user +group](https://docs.joomla.org/Help4.x:Users:_Groups/en "Help4.x:Users: Groups/en"). + + + +- Buttons allow you to make text: bold, underlined, or strikethrough. +- Undo and Re-do. +- Unordered list, Ordered list. +- Paste as Text: Often when copying and pasting text from other sources, + such as PDF files, Text documents, or web pages, the selected text + contains formatting information that is not needed or wanted. Using + the 'Paste as Text' will strip out all formatting from the text. + +#### Medium Preset + +The toolbar set 1 provides two rows of buttons as shown below. The set +is default assigned to the Manager and Registered [user +group](https://docs.joomla.org/Help4.x:Users:_Groups/en "Help4.x:Users: Groups/en"). + + + +This option provides all of the same buttons as documented in the Set 2 +Toolbar above. In addition, the following options are available. + +**Top Row** + +- CMS Content: The Dropdown list provides access to link to an Article, + Contact, Field, Media, Menu, or Module. + +Article: The example show how to easily create a link to any article on +the current site. + + + +To create a link to the desired article: + +- Place the cursor at the point in the article where you want the linked + article title to be inserted. +- Click on the Article button to open the window. +- Click on the title to select the desired article in the window. You + can use search and the filters to help find the desired article. +- A link with the article's title will be inserted at the current cursor + location. +- If needed, you can edit the link text. + +In the same way you can link other items like Media, Modules, and so on. + +Page Break: This button allows you to insert a pagebreak inside an +article. A pagebreak allows for page navigation when the article is +displayed on a layout. This is useful for long articles. When this +button is pressed, a window is displayed as shown below: + + + +- **Page Title**. Enter the title to display for the new page (for + example, 'Page 2'). +- **Table of Contents Alias**. Optional field to display in the table of + contents for this page. In a multi-page article, Joomla displays a + 'table of contents' for the page that allows the user to select any + page. If this field is blank, the Page Title will be used. If you want + a different title in the table of contents, enter it here. +- **Insert Page Break**. Click this button to insert the pagebreak with + the entered fields. The Pagebreak will display as a gray dashed line + across the article. Note that a pagebreak cannot be edited. If you + need to change a field in the pagebreak, click on the article just + past the pagebreak, press Backspace until the pagebreak is deleted, + then insert a new pagebreak with the desired information. +- The configuration is set in the [Content - Page + Break](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Content_Group/en#pagebreak "Chunk4x:Extensions Plugin Manager Edit Content Group/en") + plugin. + +Read More: This button inserts a Read more break in the article. This +shows as a red dotted line across the article. + +- If an article has a Read more break, only the text before the break, + called the Intro Text, will initially display, along with a Read more + link. If the User clicks this link, either the entire article or just + the part after the Read more link is displayed. This depends on the + setting of the [Intro + Text](https://docs.joomla.org/Help4.x:Articles:_Edit/en#introtext "Help4.x:Articles: Edit/en") + parameters for the article. +- The Read more break allows you to save space on pages by just showing + the Intro Text. +- If you want to insert breaks for an article shown in an Article + Layout, use the Page Break button. + +The buttons in the CMS content dropdown list can be disabled in +[Plugins - +editors-xtd.](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Button_Group/en "Chunk4x:Extensions Plugin Manager Edit Button Group/en") + +- Buttons in the upper left allow you to make text: italic. Next to that + are buttons for align left, right, center, and full. +- Formats: Select pre-defined formats for Headings, Inline, Blocks, and + so on. +- Outdent (move left) and Indent (indent right). +- 3 dots: Show second Toolbar row. + +**Second Row** + +- Insert/edit Link: To insert or edit a link, select the linked text and + press this button. A popup dialog displays that lets you enter details + about the link. +- Remove Link: To remove a link, highlight the linked text and press + this button. +- Anchor: An anchor is a bookmark inside an article that lets you link + directly to that point in the article. [Learn + more.](https://docs.joomla.org/Glossary/en#Anchor "Glossary/en") +- Source code: A popup displays showing the HTML source code, allowing + you to edit the HTML source code. +- Insert a horizontal line: To insert a horizontal line, move the cursor + to the desired location within the article and click this button. +- Table: Insert New Table, Table Row Properties, Table Cell Properties, + Insert Row Before, Insert Row After, Delete Row, Insert Column Before, + Insert Column After, Delete Column, Split Merged Table Cells, Merge + Table Cells. +- Subscript, Superscript, Special Character. +- Preview text in popup. + +#### Advanced Preset + +The toolbar set 0 provides the most extensive editing options, as shown +below. The set is default assigned to the Administrator, Editor, and +Super Users [user +group](https://docs.joomla.org/Help4.x:Users:_Groups/en "Help4.x:Users: Groups/en"). + + + +This option provides all of the same buttons as documented in the Set 1 +Toolbar above. In addition, the following options are available. + +**Top Row** + +- Blocks: Paragraph, Headings, Preformatted. +- Fonts: Select the desired font. +- Font Size: Select the desired font size. +- Find and Replace. +- Insert/edit image: To insert a image, place the cursor at the desired + location and press this button. A popup dialog will display that + allows you to enter the Source, Width or Height and other information + about the image. + +**Second Row** + +- Select Text color or Background color. +- Fullscreen. +- Emoticons. +- Insert media: To insert media, place the cursor at the desired + location and press this button. A popup dialog will display that + allows you to enter the Type, File or URL, and other information about + the media. +- Direction Left to Right or Direction Right to Left: These buttons + allow you to enter or change the text direction, for example for + languages that read right to left. +- Cut, Copy, Paste. +- Show invisible characters (like paragraph endings). +- Show blocks. +- Nonbreaking space. +- Blockquote. +- Insert Template. + +**Third Row** + +- Print the article text. +- Insert/edit code sample. +- Insert date/time. +- Clear formatting. + +### Accessibility + +TinyMCE is compatible with screen readers such as +JAWS and +NVDA. You can use +it effectively even if you don't use the mouse. + +| | | | +|------------------------------------------|------------------------|------------------------| +| Task | PC | macOS | +| Focus/jump to menu bar | Alt+F9 | ⌥+F9 | +| Focus/jump to toolbar | Alt+F10 | ⌥+F10 | +| Focus/jump to element path | Alt+F11 | ⌥+F11 | +| Close menu/submenu/dialog | Esc | esc | +| Return to the editor content area | Esc | esc | +| Navigate left/right through menu/toolbar | Tab and the Arrow Keys | Tab and the Arrow Keys | + +Keyboard shortcuts + +See for more information: + +- TinyMCE - Accessibility +- A list of available + keyboard shortcuts (pc, mac) + within the editor body. + +## CodeMirror + +The 'Editor - CodeMirror' is designed to make it easy to enter HTML code +in an article or description. CodeMirror supports syntax highlighting +and auto-completion, as shown in this screenshot. + + + +- Buttons shown below the edit window provides for access to link to any + item of the site. [Learn more.](#cmscontent) +- CodeMirror offers some of the same advantages of using 'Editor - + None', but makes it somewhat easier to work with raw HTML code. +- The configuration is set in the [Editor - + CodeMirror](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Editor_Group/en#codemirror "Chunk4x:Extensions Plugin Manager Edit Editor Group/en") + plugin. + +## None + +If 'Editor - None' is selected for a User, then a simple text editor +displays. This allows you to enter in raw, unformatted HTML. You can use +the toolbar 'Preview' button to preview how the HTML will display. + +Note that the 'None' option can be useful if you are entering in +'boilerplate' or custom HTML, for example to create a PayPal link. +TinyMCE automatically re-formats and strips some HTML when a file is +saved. This can cause complex HTML to not work correctly. + +If this happens, you can temporarily change the editor to 'None' and +create the desired content. Note that if you wish to edit this content +in the future, you should be careful to change your editor to 'None'. +Otherwise, if you open and save the content with TinyMCE, you may lose +your custom HTML. + +The 'Editor - None' plugin has no configuration. diff --git a/manuals/help/editors/tinymce.md b/manuals/help/editors/tinymce.md new file mode 100644 index 0000000..745a85c --- /dev/null +++ b/manuals/help/editors/tinymce.md @@ -0,0 +1,7 @@ +--- +sidebar_position: 2 +id: tinymce +title: "Help4.x:TinyMCE" +--- +- [TinyMCE - the default WYSIWYG + Editor](https://docs.joomla.org/Help4.x:Editors/en "Help4.x:Editors/en") diff --git a/manuals/help/extensions/extensions-discover.md b/manuals/help/extensions/extensions-discover.md new file mode 100644 index 0000000..3d1461e --- /dev/null +++ b/manuals/help/extensions/extensions-discover.md @@ -0,0 +1,212 @@ +--- +sidebar_position: 1 +id: extensions-discover +title: "Help4.x:Extensions: Discover" +--- +## Description + +This screen allows you to discover extensions that have not gone through +the normal installation process. This provides a method to install large +extensions which are not possible to install using the normal process. +For example, some extensions are too large in file size to upload using +the web interface due to limitations of the web hosting environment. +Using this feature you can upload extension files directly to your web +server using some other means such as FTP or SFTP and place those +extension files into the appropriate directory. You can then use the +discover feature to find the newly uploaded extension and activate it in +your Joomla! installation. Using the discover operation you can also +discover and install multiple extensions at the same time. An extension +can be installed with the discover function by doing the following +steps: + +1. Upload the uncompressed extension files to the appropriate directory + in your Joomla! installation. For example, if you wanted to upload a + site template extension to your Joomla! installation you would + create a directory for the template extension in the /templates + sub-directory of your Joomla! installation. Then you would upload + the template extension files into that directory you created. +2. After you have uploaded the extension files, go back to the + Extension Manager Discover screen and click the **Discover** button + in the toolbar. This will initiate the search function which will + search your Joomla! extension directories looking for uninstalled + extensions. +3. If the extension you uploaded is compatible with Joomla! version and + is not already installed, it will appear in the listing of + discovered extensions in this screen. +4. Click the check-box to the left of the discovered extension and then + click the **Install** button in the toolbar. This will install the + extension into your Joomla! installation. + +## How to Access + +- Select **System **→** Install Panel **→** Discover** from the + Administrator menu. + +## Screenshot + + + +## Column Headers + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Name.** The name of the extension. +- **Location.** Specifies if this is a site or administrator extension. +- **Type.** The extension type - module, plug-in, template, language. +- **Version.** The version number of the Extension. +- **Date.** The date this extension was released. +- **Author.** The author of this extension. +- **Folder.** If the extension is a plug-in, the subdirectory of your + Joomla! installation's /plugins directory where the extension is + located. By default Joomla! 3.x has the following subdirectories in + the plugins directory which each represent the different types of + plug-ins that are defined by default: authentication, content, + editors, editors-xtd, extension, search, system, user. +- **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 cannot change this + number. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +**Filter Options** + +You can use one of the available filters or any combination of them to +limit the number of extensions displayed to just the extensions which +match your filter parameters. + +- **-Select Location-.** Select Site, Administrator or API from the + drop-down list of available locations. +- **-Select Type-.** Select the extension type from the drop-down list + box of available types. +- **-Select Folder-.** Select a plug-in folder from the drop-down list + box of available folders. There is a separate folder for each type of + plug-in defined in your Joomla installation. + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Install**. Installs the selected extension. +- **Discover**. Searches the Joomla! installation directories for + uninstalled extensions. Any uninstalled extensions found will be + displayed in the extension listing. Caches the search results so they + continue to be displayed on subsequent visits to this screen. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- If you have many extensions you want to install you can upload them + all into the appropriate directories of your Joomla! installation and + then use this screen to discover all of them in one operation. You can + then install all of the extensions in one step by selecting all of + them and pressing the **Install** button in the toolbar. + +## Related Information + +- If you install a Component Extension, it will be listed as a new Menu + Item in the *Components* menu. +- You can assign a Menu Item to an installed Component Extension in the + [Menu Item + Manager](https://docs.joomla.org/Help4.x:Menus:_Items/en "Help4.x:Menus: Items/en") + by clicking the *New* toolbar button. The new Component will show in + the Internal Link list of Menu Item Types. +- If you install a Module Extension, it will be added to the list of the + Modules in the [Module + Manager](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en"), + where you can enable/disable it. You can also customize it's + parameters in the [Module + Edit](https://docs.joomla.org/Help4.x:Extensions_Module_Manager_Edit/en "Help4.x:Extensions Module Manager Edit/en") + screen. +- An installed Plugin Extension will be added to the list of the [Plugin + Manager](https://docs.joomla.org/Help4.x:Plugins/en "Help4.x:Plugins/en"), + where you can enable/disable it. You can also customize its parameters + in the [Plugin + Edit](https://docs.joomla.org/Help4.x:Plugins:_Name_of_Plugin/en "Help4.x:Plugins: Name of Plugin/en") + screen. +- An installed Template Extension will be added to the Site or + Administrator list of the [Template + Manager](https://docs.joomla.org/Help4.x:Templates:_Styles/en "Help4.x:Templates: Styles/en") + where you can assign it to all of the pages or to the selected ones. + You can also customize its parameters, edit the HTML or CSS source, or + preview the available Module positions. +- An installed Language Extension will be added to the Site or + Administrator list of the [Language + Manager](https://docs.joomla.org/Help4.x:Languages:_Installed/en "Help4.x:Languages: Installed/en"), + depending on the client attribute of the Extension. This screen let's + you assign it as the default language, if desired. + +**Related Screens** + +- **Install.** Links to the [Install + Screen](https://docs.joomla.org/Help4.x:Extensions:_Install/en "Help4.x:Extensions: Install/en"). +- **Update.** Links to the [Update + Screen](https://docs.joomla.org/Help4.x:Extensions:_Update/en "Help4.x:Extensions: Update/en"). +- **Manage.** Links to the [Manage + Screen](https://docs.joomla.org/Help4.x:Extensions:_Manage/en "Help4.x:Extensions: Manage/en"). +- **Discover.** Links to the Discover + Screen. +- **Database.** Links to the [Database + Screen](https://docs.joomla.org/Help4.x:Information:_Database/en "Help4.x:Information: Database/en"). +- **Warnings.** Links to the [Warnings + Screen](https://docs.joomla.org/Help4.x:Information:_Warnings/en "Help4.x:Information: Warnings/en"). +- **Install Languages.** Links to the [Install Languages + Screen](https://docs.joomla.org/Help4.x:Extensions_Extension_Manager_Languages/en "Help4.x:Extensions Extension Manager Languages/en"). +- **Update Sites.** Links to the Update + Sites Screen. diff --git a/manuals/help/extensions/extensions-extension-manager-languages.md b/manuals/help/extensions/extensions-extension-manager-languages.md new file mode 100644 index 0000000..47f3b57 --- /dev/null +++ b/manuals/help/extensions/extensions-extension-manager-languages.md @@ -0,0 +1,75 @@ +--- +sidebar_position: 6 +id: extensions-extension-manager-languages +title: "Help4.x:Extensions Extension Manager Languages" +--- +## Overview + +This screen is accessed from the back-end Joomla! administrator panel. +It will display a list of languages from the Joomla Accredited Languages +server that you will be able to install with one click. + +## How to Access + +- Select **System **→** Install **→** Install Languages** from the + administrator menu. +- Or select **System **→** Manage **→** Languages** from the + administrator menu and then... + - Click the *Install Languages* button on the Toolbar. + +## Description + +This screen will display any available language in the accredited +languages Joomla server. You will be able to check and install all the +language packages listed in the screen. + +## Screenshot + + + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## List Filters + +**Search bar.** This is a common feature of most Lists. The layout is as +shown below. + + + +- **Search by Text.** Enter part of the search term and click the Search + icon. The search may be of one or more fields. *Hover* to see a + *Tooltip* indicating which fields will be searched. In some cases a + different format is required. For Example, to **Search by ID** enter + "id:xx", where "xx" is the item ID number (for example, "id:9"). +- **Filter Options.** Click to display or hide the additional filters. +- **Clear.** Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering.** Shows the current table ordering field. Select from the + drop down list to change the order or click a column heading. Ordering + may be in ascending or descending order. The column heading toggles + between ascending and descending order. +- **Number to Display.** Shows the number of items in a list. The + default for a site is 20 but this may be changed in the global + configuration. Select from the drop-down list to change the number + displayed. If you select too many complex items they will be slow to + deliver and display. diff --git a/manuals/help/extensions/extensions-install.md b/manuals/help/extensions/extensions-install.md new file mode 100644 index 0000000..752fca8 --- /dev/null +++ b/manuals/help/extensions/extensions-install.md @@ -0,0 +1,224 @@ +--- +sidebar_position: 2 +id: extensions-install +title: "Help4.x:Extensions: Install" +--- +## Description + +Extensions are add-ons that expand the functionality of Joomla!. +Extensions are used to add capabilities to Joomla! that do not exist in +the standard package. Hundreds of Extensions are available for Joomla!, +with more being developed all of the time. + +Extensions are categorised into five types, as follows: + +- A *Component* is a mini-application that renders the main body of the + page. Examples of Components are Contacts, the Front Page, and News + Feeds. +- A *Module* is a smaller Extension typically used for rendering a small + element that displays across multiple pages. Examples of Modules + include Menus and Related Items. +- A *Plugin* is a section of code that runs when a pre-defined event + happens within Joomla!. For example, editors are Plugins that run when + an edit session is opened. +- The *Language* Extension allows for the Front-end and Back-end of + Joomla! to be presented in any language for which a language Extension + exists. This way, Joomla! can be released in a new language with no + changes to the core program. +- A *Template* controls the way the content of a web site is displayed, + including the location and layout of elements, colors, fonts, and so + on. Templates allow the appearance of the web site to be separated + from its content. + +## How to Access + +- Select **System **→** Install Panel **→** Extensions** from the + Adminstrator menu. + +There will be a brief delay as Joomla downloads an initial selection of +Extension data from the Joomla Extensions Directory. + +## Screenshot + + + +## Form Fields + +Joomla! Extensions can be installed using one of four methods, as +indicated below. Only one method is needed to install a given Extension. +The normal procedure for installing a Joomla! Extension is as follows: + +1. Download one or more archive files (normally ".zip" or "tar.gz" + format) from the Extension provider's web site to a local directory + on your computer. Note that some Extensions are installed as one + file (for example, one Component or Module) while other Extensions + might have two or more files (for example, a Component and a + Module). If there are two or more parts, each one will have its own + archive file. +2. Choose one of the methods describe below (**usually Package File**) +3. When it is finished, the screen will display the message "Install + Component Success". If the installation is not successful, an error + message will display. +4. Depending on the Extension, it may be necessary to enable the + Extension (for example, in the [Modules + list](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + or [Plugins + list](https://docs.joomla.org/Help4.x:Plugins/en "Help4.x:Plugins/en")). + +### Install from Web Tab + +If installed, you will see the Install from Web tab, illustrated in the +Screenshot, to install an extension direct from the Joomla Extension +Directory (JED). You can select extensions to list by Category or you +can search by partial name. + +### Upload Package File Tab + + + +- Drag and drop or browse to the location where you downloaded the + Extension's archive file. + +The upload begins automatically. Note the **Maximum upload size: ‎X.00 +MB** defined for your installation. If you cannot increase this value +you can use *Install from Folder*. + +### Install from Folder Tab + + + +1. Create a temporary directory on your local hard drive and unpack the + Extension's archive file in this temporary directory. +2. Using FTP, upload the contents of this directory (including files + and subdirectories) to a directory on your server. +3. In the *Install Directory* field specify the server directory where + you uploaded the files and subdirectories of the package. +4. Click on the *Check and Install* button and Joomla! will install the + contents of the given directory. + +Note that it is common practice to put the folder containing your +unpacked extension in the tmp folder of your Joomla site. + +### Install from URL Tab + + + +Instead of downloading the archive file to your local computer, just +specify the URL of the target archive file. Then click the "Check and +Install" button and Joomla! automatically installs it directly from this +URL. *Note that, with this method, you will not have a copy of the +archive file on your local computer.* + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Links to Other Screens + +- **Install.** Links to the Install + Screen. +- **Update.** Links to the [Update + Screen](https://docs.joomla.org/Help4.x:Extensions:_Update/en "Help4.x:Extensions: Update/en"). +- **Manage.** Links to the [Manage + Screen](https://docs.joomla.org/Help4.x:Extensions:_Manage/en "Help4.x:Extensions: Manage/en"). +- **Discover.** Links to the [Discover + Screen](https://docs.joomla.org/Help4.x:Extensions:_Discover/en "Help4.x:Extensions: Discover/en"). +- **Database.** Links to the [Database + Screen](https://docs.joomla.org/Help4.x:Information:_Database/en "Help4.x:Information: Database/en"). +- **Warnings.** Links to the [Warnings + Screen](https://docs.joomla.org/Help4.x:Information:_Warnings/en "Help4.x:Information: Warnings/en"). +- **Install Languages.** Links to the [Install Languages + Screen](https://docs.joomla.org/Help4.x:Extensions:_Languages/en "Help4.x:Extensions: Languages/en"). +- **Update Sites.** Links to the Update + Sites Screen. + +## Quick Tips + +- Four alternate installation methods are available, as indicated above. + The most common one is the "Upload Package File" method. +- If you want to install a third-party Module or Plugin that belongs to + a Component, you will generally need to install the Component as well + as the Module or Plugin in order to use the Module or Plugin. This is + normally documented in the Extension's installation instructions on + the author's web site. +- Similarly, if you uninstall a third-party Component that also has its + own Modules or Plugins, these Modules and Plugins can no longer be + used. So it is normally recommended to uninstall these dependent + Modules and Plugins as well. +- Some Components developed by third party developers may have their own + Modules or Plugins included in the installer. In this case, make sure + these Module or Plugin directories are writable. Otherwise the + Extension will not work properly. +- **SECURITY WARNING:** It is recommended that you use only those + third-party Extensions on your site that you really need. Do not use + your live site for testing purposes because it may compromise your + site and server. Test new extensions on a local test web site before + deploying them on your live site. +- Do not install Joomla! Extensions downloaded from warez sites because + they may be infected by a virus or malware that cause damage on the + server and can contaminate the computer of your visitors! +- Installing from remote URL can be dangerous. For this reason, it is + generally recommended that you use the "Install from Web", "Upload + Package File" or "Install from Folder" options when installing new + Extensions. + +## Related Information + +- If you install a Component Extension, it will be listed as a new Menu + Item in the *Components* menu. +- You can assign a Menu Item to an installed Component Extension in the + [Menu Items + list](https://docs.joomla.org/Help4.x:Menus:_Items/en "Help4.x:Menus: Items/en") + by clicking the *New* toolbar button. The new Component will show in + the Internal Link list of Menu Item Types. +- If you install a Module Extension, it will be added to the list of the + Modules in the [Modules + list](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en"), + where you can enable/disable it. You can also customize it's + parameters in the [Module + Edit](https://docs.joomla.org/Help4.x:Extensions_Module_Manager_Edit/en "Help4.x:Extensions Module Manager Edit/en") + screen. +- An installed Plugin Extension will be added to the list of the + [Plugins + list](https://docs.joomla.org/Help4.x:Plugins/en "Help4.x:Plugins/en"), + where you can enable/disable it. By clicking the [Plugin + Name](https://docs.joomla.org/Help4.x:Plugins:_Name_of_Plugin/en "Help4.x:Plugins: Name of Plugin/en"), + you can customize its parameters on the following screen. +- An installed Template Extension will be added to the Site or + Administrator list of the [Template Styles + list](https://docs.joomla.org/Help4.x:Templates:_Styles/en "Help4.x:Templates: Styles/en") + where you can assign it to all of the pages or to the selected ones. + You can also customize its parameters, edit the HTML or CSS source, or + preview the available Module positions. +- An installed Language Extension will be added to the Site or + Administrator list of the [Languages + list](https://docs.joomla.org/Help4.x:Languages:_Installed/en "Help4.x:Languages: Installed/en"), + depending on the client attribute of the Extension. This screen let's + you assign it as the default language, if desired. diff --git a/manuals/help/extensions/extensions-languages.md b/manuals/help/extensions/extensions-languages.md new file mode 100644 index 0000000..d68a16a --- /dev/null +++ b/manuals/help/extensions/extensions-languages.md @@ -0,0 +1,66 @@ +--- +sidebar_position: 3 +id: extensions-languages +title: "Help4.x:Extensions: Languages" +--- +## Description + +This screen allows you to install languages. It shows all available +languages and the actual version. + +## How to Access + +- Select **System **→** Install Panel **→** Languages** from the + Administrator menu. + +## Screenshot + + + +## Column Headers + +- **Language.** Name of Language, sometimes with a national variation + such as German AT or German DE. +- **Language Tag.** This is a combination of two-character ISO language + codes and country codes. +- **Version.** The version of the Language package available. +- **Details URL.** URL of the Language package. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/extensions/extensions-manage.md b/manuals/help/extensions/extensions-manage.md new file mode 100644 index 0000000..29fc2ba --- /dev/null +++ b/manuals/help/extensions/extensions-manage.md @@ -0,0 +1,169 @@ +--- +sidebar_position: 4 +id: extensions-manage +title: "Help4.x:Extensions: Manage" +--- +## Description + +This screen is used to Enable or Disable extensions, equivalent Publish +and Unpublish it, or to uninstall extensions no longer required. + +## How to Access + +- Select **System **→** Manage Panel **→** Extensions** from the + Administrator menus. + +## Screenshot + + + +## Column Headers + +In the table containing Extensions, the columns are shown below. Click +on a column heading to sort the list by that column's value. + +- **Checkbox.** Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. +- **Status.** A green check mark or a red circle showing whether the use + of the extension is enabled/disabled. Click the icon to toggle the + item between enabled and disabled. A lock indicates a protected + Extension. +- **Name.** The name of the extension. +- **Location.** Specifies if this is a site or administrator extension. +- **Type.** The extension type. Some examples of extension types are + module, plug-in, template, language or package. +- **Version.** The version number of the Extension. +- **Date.** The date this extension was released. +- **Author.** The author of this extension. +- **Folder.** If the extension is a plug-in, the subdirectory of your + Joomla! installation's /plugins directory where the extension is + located. By default Joomla! has the following subdirectories in the + plugins directory which each represent the different types of plug-ins + that are defined: authentication, content, editors, editors-xtd, + extension, search, system, user. +- **Package ID.** The Package ID number. This is a unique identification + number for this package assigned automatically by Joomla!. It is used + to identify the package internally. You cannot change this number. +- **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 cannot change this + number. + +### List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +### Filter by Location, Status, Type and Folder + +**Location** + +- **-Select Location-.** Select an extension client from the drop-down + list box of available locations. +- **Site.** Site extensions are extensions which are designed for use in + areas outside of the administrator interface. +- **Administrator.** Administrator extensions are for the back-end + administrative functions of your Joomla! installation. Usually you + would only directly interact with these extensions through the + administrator web interface. + +**Status** + +- **-Select Status-.** Select the status of Extensions from the + drop-down list box. +- **Disabled.** Installed extensions that are not activated. +- **Enabled.** Installed extensions that are activated +- **Protected.** Installed extensions that are protected. Extensions of + this type can not be uninstalled or disabled. +- **Unprotected.** Installed extensions that are unprotected. Extensions + of this type can be uninstalled, enabled or disabled. + +**Extension Type** + +- **-Select Type-.** Select the extension type from the drop-down list + box of available types. + +**Folder** + +- **-Select Folder-.** Select a plug-in folder from the drop-down list + box of available folders. There is a separate folder for each type of + plug-in defined in your installation of Joomla. + +### Automatic Pagination + +**Page Controls**. When the number of extension(s) is more than one +page, you will see a page control bar near the bottom of the page shown +in the [Screenshot](#screenshot) above. The current page number being +viewed has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Enable**. Makes the selected item available for use on your website. + + + +- **Disable**. Makes the selected extension(s) unavailable for use on + your website. + + + +- **Refresh cache**. Refresh the information displayed for the selected + extension(s). + + + +- **Uninstall:** Uninstall the selected extension(s). + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- Throughout the administrator interface of Joomla! you will see the + terms "Publish" and "Unpublish". *Publish* means the same thing as + *Enable* or *Activate*. *Unpublish* means the same thing as *Disable* + or *Deactivate*. You may see the terms used interchangeably in + extension screens and help documentation you find online. +- Some information such as *Date* or *Author* may not be displayed for + an extension. This is not a problem. It merely means the information + was not specified by the extension developer in the extension's + installation package. diff --git a/manuals/help/extensions/extensions-module-manager-admin-status-unused.md b/manuals/help/extensions/extensions-module-manager-admin-status-unused.md new file mode 100644 index 0000000..c2c924d --- /dev/null +++ b/manuals/help/extensions/extensions-module-manager-admin-status-unused.md @@ -0,0 +1,54 @@ +--- +sidebar_position: 7 +id: extensions-module-manager-admin-status-unused +title: "Help4.x:Extensions Module Manager Admin Status Unused" +--- +To '**add'** a new Admin Status module or '**edit'** an existing Admin +Status module, navigate to the [Module +Manager](https://docs.joomla.org/Help310:Extensions_Module_Manager "Help310:Extensions Module Manager"): + +- Select **Extensions **→** Module Manager** + +Click the '**New'** button and click on Admin Status in the modal popup +window. + +To '**Edit'** an existing Admin Status module, in the Module Manager +click on the **Admin Status Module's Title** or click the **Admin Status +module's check box** and then click the **Edit** button in the Toolbar. + +# Overview + +Help4.x:AAATest +Original + +## This is a Test Page + +# Toolbar + +At the top left you will see the toolbar: + + + +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. This toolbar icon is not shown if + you are creating a new 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. + +# Details + +# Basic Options + +# Advanced Options diff --git a/manuals/help/extensions/extensions-module-manager-articles-categories.md b/manuals/help/extensions/extensions-module-manager-articles-categories.md new file mode 100644 index 0000000..5baba46 --- /dev/null +++ b/manuals/help/extensions/extensions-module-manager-articles-categories.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 8 +id: extensions-module-manager-articles-categories +title: "Help4.x:Extensions Module Manager Articles Categories" +--- +Redirect to: + +- [Help4.x:Site Modules: Articles - + Categories/en](https://docs.joomla.org/Help4.x:Site_Modules:_Articles_-_Categories/en "Help4.x:Site Modules: Articles - Categories/en") diff --git a/manuals/help/extensions/extensions-module-manager-edit.md b/manuals/help/extensions/extensions-module-manager-edit.md new file mode 100644 index 0000000..ae9b0de --- /dev/null +++ b/manuals/help/extensions/extensions-module-manager-edit.md @@ -0,0 +1,494 @@ +--- +sidebar_position: 1 +id: extensions-module-manager-edit +title: "Help4.x:Extensions Module Manager Edit" +--- +## Description + +The Extensions Module Manager Edit (New) allows editing an existing +Module or creating a new Module by Module type. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Or... +- Select **System **→** Manage Panel **→** Administrator Modules** from + the Administrator menu. Then... + - Select the '**New'** button in the Toolbar to create a new Module. + Or... + - Select a Module title in the **Title** column to edit that module. + +For a New module there is a list of all Site or Administrator installed +modules to choose from: + + + +Select one to move on to the edit screen. + +## Screenshot + +The Module Tab of a Module Edit screen is dependent on Module Type. The +Breadcrumbs site module is illustrated here. For other Modules please +see **[Related information](#Related_Information)** below for links to +specific module types. + + + +## Form Fields + +- **Title**. The Title for this item. This may or may not display on the + page, depending on the parameter values you choose. + +### Module Tab + +**Left Panel** + +The content of the left panel depends on module type and is not covered +here. + +**Right Panel** + +The right panel is common to all modules. + +- **Show Title.** Whether or not to show the Module's Title. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of this item. + - *Published:* Item is visible in the Frontend of the site. + - *Unpublished:* Item is will not be visible to guests in the Frontend + of the site. It may be visible to logged in users who have edit + state permission for the item. + - *Archived:* Item will no longer show on blog or list menu items. + - *Trashed:* Item is deleted from the site but still in the database. + It can be permanently deleted from the database with the Empty Trash + function in Toolbar (see also [Deleting an + Article](https://docs.joomla.org/Deleting_an_Article/en "Special:MyLanguage/Deleting an Article/en")). + + + +- **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**. Select the viewing access level for this item from the + list box. The access levels that display will depend on the what has + been set up for this site in [Users → Access + Levels](https://docs.joomla.org/Help40:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help40:Users: Viewing Access Levels/en"). + Note that access levels are separate from ACL permissions. Access + levels control what a user can see. ACL permissions control what + actions a user can perform. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Language**. Select the language for this item. If you are not using + the multi-language feature of Joomla, keep the default of 'All'. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + +This tab view contains all the menu items configured in your Joomla! +website. This will allow selection of where to show a module by content +page associated with menu item. + + + +#### Menu Assignment Tab - Module Assignment + +- **Module Assignment**. Click for drop down choice of module assignment + + + +- **On all pages**. Module will show on all pages in the selected module + position. +- **No pages**. Module **will not show** on any pages in the selected + module position. +- **Only on the pages selected**. Module will show only on pages in the + selected module position as selected by menu item type(title). See + **Menu Selection** below. +- **On all pages except those selected**. Module will show on all pages + in the selected module position, except those selected by menu item + type(title). See **Menu Selection** below. + +#### Menu Assignment Tab - Menu Selection + +- **Menu Selection**. This will only appear if the **Only on pages + selected** or **On all pages except those selected** is chosen as the + **Module Assignment** as detailed above. + +To apply the module to a menu item's corresponding web page(title), +check the box next to the menu item. + +- Click the Select: *All* or *None* to toggle the selection of menu + items. +- Click the Expand: *All* or *None* to toggle the tree view for + selection of menu items. + +**Note**: If a checkbox is grayed out and cannot be checked then it +could be because the menu item is in use by another user. You can see if +this is the case by going to the [menu manager screen for the +menu](https://docs.joomla.org/Help4.x:Menus:_Items/en "Help4.x:Menus: Items/en") +concerned. If there is a padlock symbol next to the menu item then it is +currently in use by another user. + +### Advanced Tab + + + +### Permissions Tab + + + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the user and stays in the current screen. + + + +- **Save & Close**. Saves the user and closes the current screen. + + + +- **Save & New**. Saves the user and keeps the editing screen open and + ready to create another user. + + + +- **Save as Copy**. Saves your changes to a copy of the current user. + Does not affect the current user. This toolbar icon is not shown if + you are creating a new user. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Related Help ScreensDescription
Site Modules: +Articles - ArchivedThis 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.
Site Modules: +Articles - CategoriesThis module displays a list of categories from one parent +category.
Site Modules: +Articles - CategoryThis module displays a list of published articles from one or more +categories.
Site Modules: +Articles - NewsflashThe Article Newsflash Module will display a fixed number of Articles +from a specific Category or a set of Categories.
Site Modules: +Articles -RelatedThis 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.
SiteModules:BannersThe Banner Module displays the active Banners from the +Component.
Site Modules: +BreadcrumbsThis Module shows a set of navigation links that illustrates where +you are inside the web site and allows you to navigate back.
Site Modules: CustomThis 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.
Site Modules: Feed +DisplayThis Module shows an RSS News Feed from a website. This Module is +not related to the News Feeds Component or the News Feeds Layouts and is +an alternative that allows a feed to display in a Module position.
Site Modules: FooterThis Module displays the web site copyright and Joomla! license +information.
Site Modules: +Language SwitcherThis module allows you to switch between available Content +languages. Selecting a language will take you to the home page for that +language.
Site Modules: +Articles - LatestThis Module shows a list of the most recently published +Articles.
Site Modules: Latest +UsersThe Latest Users module will display the latest users which +registred at the website.
Site Modules: LoginThis Module displays a username and password Login form. It also +displays a link to retrieve a forgotten password. If User registration +is enabled in the User Settings of the Global Configuration screen, then +the link "Create an Account" will be shown to invite Users to +self-register.
Site Modules: MenuThis Module allows you to place your Menus on the page. Every +Joomla! website has at least one Menu that is created in the 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.
Site Modules: +Articles - Most ReadThis Module displays a list of Articles with the highest hit +counts.
Site Modules: Random +ImageThis Module displays a random image from a directory.
Extensions +Module Manager SearchThis Module displays a Search entry field where the user can type in +a phrase and press 'Enter' to search the web site.
Site Modules: Smart +SearchSmart Search is an enhanced site search.
Site Modules: +StatisticsThe Statistics Module shows information about your server +installation together with statistics on the Web site users, number of +Articles in your database and the number of Web links you provide.
Site Modules: +Syndication FeedsThis Module creates a RSS Feed link for the page. This allows a User +to create a newsfeed for the current page. An example is shown +below.
Site Modules: Tags - +PopularDisplays tags used on a site in a tag cloud or list.
Site Modules: Tags - +SimilarDisplays links to other items with similar tags.
Extensions +Module Manager WeblinksThe Weblinks module will display weblinks from within the Weblinks +component.
Site Modules: Who's +OnlineThe "Who's Online" module displays information about users that are +visiting your site at a particular moment.
Site Modules: WrapperThe wrapper module allows you to display an external website in a +module. The functionality is the same to that of the 'iFrame Wrapper' +you can add as a menu item. If the page to which the wrapper is linked +is too big, bars will be shown below and to the right of the wrapper, +allowing you to "navigate" the page.
ModulesThe Module Manager is where you add and edit Joomla! Modules. In +Joomla!, Modules are used to display content and/or media around the +main content. +

Module Facts: All Joomla! websites require at least +1 Menu Module All Other Module Types are Optional. (Examples: News, +Banner, Latest News) Every Menu is accompanied by a menu module. +(Example mod_mainmenu) Multiple occurrences of similar module types.

+

Some Modules are linked to components. For example, +each Menu Module is related to one Menu component. To define a Menu in +Joomla!, you need to create the Menu and Menu Items using the Menus +screens and then create the Module for the Menu using this screen. Other +Modules, such as Custom and Breadcrumbs, do not depend on any other +content. See Module Manager - +New/Edit for information about the different Module Types. The +Joomla! installation is accompanied with 20 module types, additional 3rd +party modules can be located at the JED.

diff --git a/manuals/help/extensions/extensions-module-manager-sample-data.md b/manuals/help/extensions/extensions-module-manager-sample-data.md new file mode 100644 index 0000000..3981172 --- /dev/null +++ b/manuals/help/extensions/extensions-module-manager-sample-data.md @@ -0,0 +1,79 @@ +--- +sidebar_position: 2 +id: extensions-module-manager-sample-data +title: "Help4.x:Extensions Module Manager Sample Data" +--- +## Description + +This module lets you install sample data. + +## How to access + +- Select **Content **→** Administrator Modules** from the Administrator + menu. Then... + - Select **Filter Options **→** Sample Data** to check whether the + module is already installed and enabled. If absent... + - Select **New** in the Toolbar. + - Select the **Sample Data** module. + +There are other access routes! + +## Screenshot + + + +## Form Fields + +### Module Tab + +This tab has no form fields. Just some explanatory text: This module +lets you install sample data. + +### Advanced Tab + +The advanced options are illustrated in the Screenshot. For most users +the default values will be sufficient. + +### Permissions Tab + +It is most unlikely that the Super User will wish to change any +permissions for this module. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **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 + +## Related information diff --git a/manuals/help/extensions/extensions-module-manager-weblinks.md b/manuals/help/extensions/extensions-module-manager-weblinks.md new file mode 100644 index 0000000..47ca60a --- /dev/null +++ b/manuals/help/extensions/extensions-module-manager-weblinks.md @@ -0,0 +1,248 @@ +--- +sidebar_position: 4 +id: extensions-module-manager-weblinks +title: "Help4.x:Extensions Module Manager Weblinks" +--- +## Description + +The Weblinks module will display weblinks from within the Weblinks +component. + +## How to Access + +To '**add'** a new Weblinks/ en module or '**edit'** an existing +Weblinks/ en module, navigate to the [Module +Manager](https://docs.joomla.org/Help310:Extensions_Module_Manager "Help310:Extensions Module Manager"): + +- Select **Extensions **→** Module Manager** + +Click the '**New'** button and click on Weblinks/ en in the modal popup +window. + +To '**Edit'** an existing Weblinks/ en module, in the Module Manager +click on the **Weblinks/ en Module's Title** or click the **Weblinks/ en +module's check box** and then click the **Edit** button in the Toolbar. + +## Screenshot + + + +## Details + +- **Title:** Module must have a title + +### Module + +This modules displays weblinks from a category defined in the Weblinks +component. + +- **Category:** (*Sample Data-Weblinks*/*Park Links*/*Joomla! Specific + Links*/*Other Resources*/*Uncategorised*). Choose the Weblinks + category to display +- **Count:** Number of Web Links to display +- **Direction:** (*Ascending*/*Descending*). Set the ordering direction +- **Target Window:** (*Open in new window*/*Open in popup*/*Open in + parent window*). Target browser window when the link is clicked +- **Follow/No Follow:** (*Follow*/*No follow*). Robots index - allow to + follow or not +- **Description:** (*Show*/*Hide*). Display Web Link description +- **Hits:** (*Show*/*Hide*). Show Hits +- **Count Clicks:** (*Use Global*/*No*/*Yes*). If set to yes, the number + of times the link has been clicked will be recorded + +### Common Details + +Help-4x-module-manager-details-screenshot + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + + + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels "Special:MyLanguage/Help4.x:Users: Viewing Access Levels") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Common Tabs + +#### Menu Assignment + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +#### Module Permissions + + + +- **Delete:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Delete for + users in the Public group. Delete Allows users in the group to delete + any content in this extension. +- **Edit:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Edit for + users in the Public group. Edit Allows users in the group to edit any + content in this extension. +- **Edit State:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Edit + State for users in the Public group. Edit State Allows users in the + group to change the state of any content in this extension. + +#### Advanced + + + +- **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. + + + +- **Module Class.** 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" 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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. + + + +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. + + + +- **Module Style.** You can use this option to override the templates + style for its position. + + + +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. + + + +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. + + + +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of *html5* or add your custom module + styles in \*/html/modules.php*. + + + +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +## Toolbar + +At the top left you will see the toolbar: + + + +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. This toolbar icon is not shown if + you are creating a new 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. + +## Quick Tips + +No tips have been added. diff --git a/manuals/help/extensions/extensions-modules-administrator.md b/manuals/help/extensions/extensions-modules-administrator.md new file mode 100644 index 0000000..9f49cbf --- /dev/null +++ b/manuals/help/extensions/extensions-modules-administrator.md @@ -0,0 +1,47 @@ +--- +sidebar_position: 5 +id: extensions-modules-administrator +title: "Help4.x:Extensions Modules Administrator" +--- +## Description + +This is an overview of the list of over 20 Administrator Modules +available for a Joomla web site. + +## How to access + +- Select **System **→** Manage Panel **→** Adminstrator Modules** from + the Administrator menu. Then... + - Select the **New** button in the toolbar to see a list of available + modules and create a new Module. + - Select a module title in the **Title** column to edit an existing + Module. + +## Screenshots + +**List of Installed Modules** + +Help-4x-Modules-Administrators-en.png + +**List of Available Modules** + + + +## Quick Tips + +- Some Joomla Extensions provide new Module Types. If you have installed + any Extensions, your Joomla! site might have Module Types that are not + listed here. In this case, please refer to the documentation for the + Extension for information about these Module Types. + +## Related information + +- [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") diff --git a/manuals/help/extensions/extensions-update.md b/manuals/help/extensions/extensions-update.md new file mode 100644 index 0000000..0c236de --- /dev/null +++ b/manuals/help/extensions/extensions-update.md @@ -0,0 +1,164 @@ +--- +sidebar_position: 5 +id: extensions-update +title: "Help4.x:Extensions: Update" +--- +## Description + +This screen allows you to update installed extensions that provide an +update server. Live update of the extension occurs without the need to +manually upload and install the updated extension files. They are +obtained from the remote update server using standard HTTP connection +methods. + +## How to Access + +- Select **System **→** Update Panel **→** Extensions** from the + Administrator menu. Then to perform an update... + - Select the checkbox of one or more items to update. + - Select the **Update** button in the Toolbar. + +## Screenshot + + + +## Column Headers + + + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. +- **Name.** The name of the extension. +- **Location.** Specifies if this is a site or administrator extension. +- **Type.** The extension type. Examples of extension types are module, + plug-in, template, component, language or package. +- **Installed.** The version number of the currently installed + extension. +- **Available.** The version number of the available update. +- **Changelog.** The changelog. +- **Folder.** If the extension is a plug-in, the subdirectory of your + Joomla! installation's /plugins directory where the extension is + located. By default Joomla! has the following subdirectories in the + plugins directory which each represent the different types of plug-ins + that are defined: authentication, content, editors, editors-xtd, + extension, search, system, user. +- **Install Type.** The type of installation that will be performed by + the update. Usually this will be type ***Update*** which will perform + an in-place update of the extension. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +**Filter Options** + +- **-Select Location-.** Select Site, Administrator or API from the + drop-down list of available locations. +- **-Select Type-.** Select the extension type from the drop-down list + box of available types. +- **-Select Folder-.** Select a plug-in folder from the drop-down list + box of available folders. There is a separate folder for each type of + plug-in defined in your Joomla installation. + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Update.** Perform update of selected options. This will fetch an + update file from the update server and may take several seconds. + Please be patient! +- **Find Updates.** Query update servers for the latest versions of + installed extensions. Again, this may take a while. +- **Clear Cache.** Clear the available extension update information + displayed in the listing. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- Only extensions which support the Joomla! update system will be listed + in this screen. If you use extensions which do not support the new + update system or you are not sure, consult the extension developer's + website. +- It is critical to keep your extensions up-to-date. Failure to do so + may expose a vulnerability in your Joomla! installation which can be + exploited by hackers. +- It is recommended to backup your Joomla! installation files and + database before attempting to update extensions or the Joomla! + installation itself. This will ensure that you can restore your + Joomla! installation to its previous state if the update fails or + causes unexpected results. + +## Related Information + +- **Install.** Links to the [Install + Screen](https://docs.joomla.org/Help4.x:Extensions:_Install/en "Help4.x:Extensions: Install/en"). +- **Update.** Links to the Update + Screen. +- **Manage.** Links to the [Manage + Screen](https://docs.joomla.org/Help4.x:Extensions:_Manage/en "Help4.x:Extensions: Manage/en"). +- **Discover.** Links to the [Discover + Screen](https://docs.joomla.org/Help4.x:Extensions:_Discover/en "Help4.x:Extensions: Discover/en"). +- **Database.** Links to the [Database + Screen](https://docs.joomla.org/Help4.x:Information:_Database/en "Help4.x:Information: Database/en"). +- **Warnings.** Links to the [Warnings + Screen](https://docs.joomla.org/Help4.x:Information:_Warnings/en "Help4.x:Information: Warnings/en"). +- **Install Languages.** Links to the [Install Languages + Screen](https://docs.joomla.org/Help4.x:Extensions_Extension_Manager_Languages/en "Help4.x:Extensions Extension Manager Languages/en"). +- **Update Sites.** Links to the Update + Sites Screen. diff --git a/manuals/help/fields/fields-fields-edit.md b/manuals/help/fields/fields-fields-edit.md new file mode 100644 index 0000000..80f450e --- /dev/null +++ b/manuals/help/fields/fields-fields-edit.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 1 +id: fields-fields-edit +title: "Help4.x:Fields Fields Edit" +--- +Redirect to: + +- [Help4.x:Fields: + Edit](https://docs.joomla.org/Help4.x:Fields:_Edit "Help4.x:Fields: Edit") diff --git a/manuals/help/glossary/glossary.md b/manuals/help/glossary/glossary.md new file mode 100644 index 0000000..456d13f --- /dev/null +++ b/manuals/help/glossary/glossary.md @@ -0,0 +1,425 @@ +--- +sidebar_position: 1 +id: glossary +title: "Help4.x:Glossary" +--- +The Joomla! Glossary is helpful for learning common terms used in +Joomla! tutorials, help screens and advanced documentation. + +## [Access Control List](https://docs.joomla.org/Access_Control_List "Special:MyLanguage/Access Control List") + +## [Alias](https://docs.joomla.org/Alias "Special:MyLanguage/Alias") + +## Anchor + +An anchor is created using the \ tag in HTML. An anchor allows you +to place a bookmark inside an HTML page. In Joomla!, you can place an +anchor inside an article (for example, using the +[TinyMCE](https://docs.joomla.org/Content_editors#TinyMCE_editor "Content editors") +editor). This lets you create a link that will go directly to that point +in the article. + +The HTML source code for an anchor looks like the following: + + + +You can link to an anchor from within the same page using the HTML code + + + +Clicking that link will take you directly to the location of the anchor +tag. + +You can link to an anchor in a different page by appending "#" plus the +anchor name to the end of the URL. In the example above, if the URL for +the article was `http://www.mysite.com/my_article.html`, then you could +link directly to the anchor in that page with the URL +`http://www.mysite.com/my_article.html#my_anchor`. + +## [Article](https://docs.joomla.org/Article "Special:MyLanguage/Article") + +## Cascading Style Sheet (CSS) + +A Cascading Style Sheet or CSS is used to control the presentation of an +XHTML page. For example, a CSS file will often control the font, +margins, color, background graphics, and other aspects of a web page's +appearance. CSS allows you to separate the content of an XHTML page from +it's appearance. In Joomla!, CSS files (for example, template.css) are +normally part of the template. + +**See also:** [Template](https://docs.joomla.org/Template "Template"), +[Page Class +Suffix](https://docs.joomla.org/Page_Class_Suffix "Page Class Suffix"), +[Module Class +Suffix](https://docs.joomla.org/Module_Class_Suffix "Module Class Suffix") + +## [Category](https://docs.joomla.org/Category "Special:MyLanguage/Category") + +Every part of Joomla! powered web site or any CMS type of web site needs +a method to display and store its content logically. The usual method is +by categories and subcategories. Joomla! allows for multiple ways to +display and use content controlled by categorisation. Some of the +content types which have categorisation are +[articles](https://docs.joomla.org/Article "Article") (Main content of +web pages), banners, contacts and web links. + +Joomla! category named "Uncategorised" is the default category, assigned +to any and all content types. The "Uncategorised" category is not +descriptive and should be used on as needed basis for content types +which do not fall under a specific category. + +When creating and assigning categories, you should have a planned +structure. As an example, this is one way of how you would categorise +several Joomla [articles](https://docs.joomla.org/Article "Article") on +birds. Create two top article categories called "Animals" and "Plants". +Under the "Animals" category, you might have sub categories called +"Birds" and "Mammals". Under the "Birds" sub category, you might have 3 +articles named "Hawks," "Parrots" and "Sparrows". + +- Animals + - Birds + - Hawks + - Parrots + - Sparrows + - Mammals + +The example above could be expanded even more with specific articles on +different species of Hawks, Parrots and Sparrows. Start with using an +"Animal" top Category, placing the sub categories "Birds" and "Mammals" +are under the "Animal" category, and then a "Hawks," "Parrots" and +"Sparrows" sub category under the "Birds" Sub Category as shown below. + +Now you can create multiple articles in the Hawk, Parrot and Sparrow sub +categories using the different genus or common names of the specific +types of these 3 birds. + +Categories and their sub categories are maintained using the "Category +Manager" which can be reached in the administrator back-end interface by +clicking on the "Content" menu type, then the "Category Manager" menu +item for the type. + +**See also**: [Article](https://docs.joomla.org/Article "Article") + +## Chrome + +The visible graphical interface features of an application are sometimes +referred to as *chrome*. See [Applying custom module +chrome](https://docs.joomla.org/Applying_custom_module_chrome "Applying custom module chrome") +for information about how to modify the look of modules (in other words, +the module "chrome"). + +## [Component](https://docs.joomla.org/Component "Special:MyLanguage/Component") + +## Core + +The word "core" in Joomla! pertains to the distributed files which are +needed to create and administrate a Joomla CMS powered web site. These +files can be downloaded from the Joomla website at +http://www.joomla.org/download.html. The +Joomla "core" also contains some basic functionality to get new Joomla +installations working quickly and easily. Included are the user manager, +article manager, weblink manager, category manager, contact manager, and +menu manager. There is also a +[template](https://docs.joomla.org/Template "Template") manager with a +few basic templates to power the front-end (website/user) view, a +[module](https://docs.joomla.org/Module "Module") manager with basic +modules, [plugin](https://docs.joomla.org/Plugin "Plugin") manager with +basic plugins, and a few other "out of the box" +[extensions](https://docs.joomla.org/Extension "Extension") to extend +the functionality of a basic Joomla installation. These core's +extensions should not be confused with extensions which are available +for downloading from the JED (Joomla! Extension Directory). + +**See also:** +Joomla Extension Directory. + +## [Database Table Prefix](https://docs.joomla.org/Database_Table_Prefix "Special:MyLanguage/Database Table Prefix") + +The database table prefix is a string (a few characters long) prepended +to the name of Joomla!'s +[tables](https://docs.joomla.org/Tables "Tables"). Using a prefix +enables you to run multiple installations of Joomla! using a single +database. + +The database table prefix can be set during installation. Changing it +later is possible, but requires access to the database through a +non-Joomla medium or a Joomla Extension such as Akeeba Admin Tools and +will cause some downtime. + +[Extension](https://docs.joomla.org/Extension "Extension") developers +need to use the string `#__` to represent the prefix. This will be +replaced by the real prefix during runtime by Joomla. + +## [Extension](https://docs.joomla.org/Extension "Special:MyLanguage/Extension") + +## [LDAP](https://docs.joomla.org/LDAP "Special:MyLanguage/LDAP") + +## [Language](https://docs.joomla.org/Language "Special:MyLanguage/Language") + +Languages are perhaps the most basic and critical +extension type. Languages are packaged as either +a core language pack or an extension language pack. These packages +consist of INI files which contain key/value pairs. These key/value +pairs provide the translation of static text strings within Joomla! +source code. This allows both the Joomla! core and third party +components and modules to be internationalised. Core language packs also +include an XML meta file describing the language and providing +information about the fonts to use for PDF content generation. + +## [Menu](https://docs.joomla.org/Menu "Special:MyLanguage/Menu") + +In Joomla!, a **Menu** is a set of **menu items** used for website +navigation. Each menu item defines an URL to a page on your site, and +holds settings that control the contents (articles, category(ies) lists, +tagged items, etc) and style (module(s), layout) of that page. + +**[Creating +menus](https://docs.joomla.org/Adding_a_new_menu "Special:MyLanguage/Adding a new menu")** +is rather simple. From the Admin Menu, in the backend of your Joomla! +site, you choose: **Menus \> Menu Manager \> Add New Menu**. On the +opened to you **Menu Manager: Add Menu** page enter your menu title into +the "Title \*" field (mandatory), your menu type into the "Menu type \*" +field (mandatory) and, if you wish, your menu brief description into the +"Description" field (optional). After that you can start **[adding new +menu +items](https://docs.joomla.org/Adding_a_new_menu_item "Special:MyLanguage/Adding a new menu item")** +to this new menu. + +Any website can have more than one menu. + +## [Model-View-Controller](https://docs.joomla.org/Model-View-Controller "Special:MyLanguage/Model-View-Controller") + +Joomla makes extensive use of the +Model-View-Controller design +pattern. + +When Joomla is started to process a request from a user, such as a GET +for a particular page, or a POST containing form data, one of the first +things that Joomla does is to analyse the URL to determine which +component will be responsible for processing the request, and hand +control over to that component. + +If the component has been designed according to the MVC pattern, it will +pass control to the controller. The controller is responsible for +analysing the request and determining which model(s) will be needed to +satisfy the request, and which view should be used to return the results +back to the user. + +The model encapsulates the data used by the component. In most cases +this data will come from a database, either the Joomla database, or some +external database, but it is also possible for the model to obtain data +from other sources, such as via a web services API running on another +server. The model is also responsible for updating the database where +appropriate. The purpose of the model is to isolate the controller and +view from the details of how data is obtained or amended. + +The view is responsible for generating the output that gets sent to the +browser by the component. It calls on the model for any information it +needs and formats it appropriately. For example, a list of data items +pulled from the model could be wrapped into an HTML table by the view. + +Since Joomla is designed to be highly modular, the output from the +component is generally only part of the complete web page that the user +will ultimately see. Once the view has generated the output, the +component hands control back to the Joomla framework which then loads +and executes the template. The template combines the output from the +component, and any modules that are active on the current page, so that +it can be delivered to the browser as a single page. + +To provide additional power and flexibility to web designers, who may +only be concerned with creating new designs rather than manipulating the +underlying code, Joomla splits the traditional view into a separate view +and layout. The view pulls data from the model, as in a traditional MVC +pattern, but then simply makes that data available to the layout, which +is responsible for formatting the data for presentation to the user. The +advantage of having this split is that the Joomla template system +provides a simple mechanism for layouts to be overridden in the +template. These layout overrides (often called "template overrides" +because they form part of the template, although actually it is the +layout that is being overridden) are bundled with the template and give +the template designer complete control over all the output from the +Joomla core and any installed third-party extensions that comply with +the MVC design pattern. + +## [Module](https://docs.joomla.org/Module "Special:MyLanguage/Module") + +## [Module Class Suffix](https://docs.joomla.org/Module_Class_Suffix "Special:MyLanguage/Module Class Suffix") + +Module Class Suffix is a parameter in Joomla! modules. It is set Module: +\[Edit\] screen under Advanced Parameters. Setting this parameter causes +Joomla! to either add a new CSS class or modify the existing CSS class +for the `div` element for this specific module. + +When Joomla! generates a module, it automatically create a CSS class +called "moduletable" to allow styling of the module -- for example, + +
+ +To create a new class, enter the parameter with a leading space. For +example, entering a space plus "myNewClass" will create a new CSS class +called "myNewClass". The HTML will be changed to + +
+ +To change the name of the existing class, enter in the parameter without +a leading space. For example, entering "\_mySuffix" (no leading space) +will cause the HTML to changed to + +
+ +Generally, it is recommended to use a leading space to create a new +class. This way, CSS styling for this module that uses the standard +class names will continue to work. You can use the new class name to add +any desired styling to the module without needing to re-create all of +the existing CSS code. Note that, if you create a new class name, make +sure it has a unique name and doesn't conflict with any existing class +names. + +See [Using Class +Suffixes](https://docs.joomla.org/Using_Class_Suffixes "Using Class Suffixes") +for more information. + +## [Module Position](https://docs.joomla.org/Module_Position "Special:MyLanguage/Module Position") + +## [Module chrome](https://docs.joomla.org/Module_chrome "Special:MyLanguage/Module chrome") + +## [PHP](https://docs.joomla.org/PHP "Special:MyLanguage/PHP") + +PHP is a computer scripting language designed for creating dynamic web +pages. PHP is widely-used for web development and can be embedded into +HTML. It +generally runs on a web server, taking PHP code as its input and +creating web pages as output. Joomla! is primarily written using the PHP +language. For more information, see [Where can you learn about +PHP?](https://docs.joomla.org/Where_can_you_learn_about_PHP "Where can you learn about PHP") + +## [Page Class Suffix](https://docs.joomla.org/Page_Class_Suffix "Special:MyLanguage/Page Class Suffix") + +Page Class Suffix is a parameter in Joomla! content menu items. It is +set in a particular menu item: \[Edit Menu Item\] page, under the "Page +Display" tab. A new page class suffix will cause Joomla! to either add a +new CSS class or modify the existing CSS class for elements in the +assigned to this very menu item page layout. + +When Joomla! generates a page, it automatically creates pre-defined CSS +classes to allow styling of the page. For example, a page might have the +element + +
+ +To create a new class, enter the parameter with a leading space. For +example, entering a space plus "myNewClass" will create a new CSS class +called "myNewClass" and it will be inserted as a class for elements in +that Menu Item. In this case the example above will be changed to + +
+ +To change the name of the existing class, enter in the parameter without +a leading space. For example, entering "\_mySuffix" (no leading space) +will cause the HTML to changed to + +
+ +Generally, it is recommended to use a leading space to create a new +class. This way, CSS styling for this component that uses the standard +class names will continue to work. You can use the new class name to add +any desired styling to the component without needing to re-create all of +the existing CSS code. Note that, if you create a new class name, make +sure it has a unique name and doesn't conflict with any existing class +names. + +**See also:** [Using Class +Suffixes](https://docs.joomla.org/Using_Class_Suffixes "Using Class Suffixes"), +[Using the Page Class Suffix in Template +Code](https://docs.joomla.org/Using_the_Page_Class_Suffix_in_Template_Code "Using the Page Class Suffix in Template Code") + +## [Patch](https://docs.joomla.org/Patch "Special:MyLanguage/Patch") + +## [Plugin](https://docs.joomla.org/Plugin "Special:MyLanguage/Plugin") + +## [Search Engine Friendly URLs](https://docs.joomla.org/Search_Engine_Friendly_URLs "Special:MyLanguage/Search Engine Friendly URLs") + +Search engine friendly URLs is a term commonly abbreviated as SEF URLs +or SEF for short. Normal Joomla! URLs look something like this: + + http://www.yoursite.org/index.php?option=com_content&view=section&id=3&Itemid=41 + +You can optionally have URLs display to look like static HTML pages like +this: + + http://www.yoursite.org/faq.html + +Since Joomla! 1.5, there are built-in options for generating SEF URLs. +These are enabled by changing the "SEO Settings" (Search Engine +Optimisation) in the Site tab in the Global Configuration screen in the +Joomla! back end. There are also third-party extensions that create SEF +URLs for Joomla!. + +## [Split menus](https://docs.joomla.org/Split_menus "Special:MyLanguage/Split menus") + +A [split menu](https://docs.joomla.org/Split_menus "Split menus") is +where different levels of a single menu are displayed in two or more +locations on a single web page. + +For example, a common requirement is for a menu of top-level items to +appear at the top of the page. When one of the items is clicked the user +is taken to a page where a secondary menu, say on the left of the page, +shows second-level items within the scope of the top-level item. + +The menus appear in separate locations on the page, but are related +because one shows only top-level items while the other shows +second-level items. This idea can be extended to include menus for +third-level items and beyond. + +This can be implemented in Joomla using a single multi-level menu then +creating more than one menu module each referring to a different level. + +**See also**: [Menu](https://docs.joomla.org/Menu "Menu") + +## [Template](https://docs.joomla.org/Template "Special:MyLanguage/Template") + +A template is a type of Joomla! +[extension](https://docs.joomla.org/Extension "Extension") that changes +the way your site looks. There are two types of templates used by the +Joomla! CMS: [Front-end +Templates](https://docs.joomla.org/Template#Front-end_Templates "Template") +and [Back-end +Templates](https://docs.joomla.org/Template#Back-end_Templates "Template"). +The Front-end Template controls the way your website is presented to the +user viewing the website's content. The Back-end Template controls the +way your website's administrative tasks are presented for controlling +management functions by a Joomla! Administrator. These would include +common tasks such as: user, menu, article, category, module, component, +plugin and template management. + +**See also**: +[Component](https://docs.joomla.org/Component "Component"), +[Module](https://docs.joomla.org/Module "Module"), +[Plugin](https://docs.joomla.org/Plugin "Plugin") + +## [Template style](https://docs.joomla.org/Template_style "Special:MyLanguage/Template style") + +## Upgrade Package + +An Upgrade Package in Joomla! is an archive of files that contain the +files that have changed between Joomla! versions. When this archive is +unpacked, it replaces the old version of the modified files with the new +version. For example, if fifty files were changed between version 3.x.1 +and 3.x.2, the upgrade package from 3.x.1 to 3.x.2 would contain these +fifty files and, when unpacked, would replace these fifty files and +upgrade the installed version from 3.x.1 to 3.x.2. + +Upgrade Packages are also sometimes referred to as [patch +files](https://docs.joomla.org/Patch "Patch"). Before installing an +Upgrade Package, read the [release +notes](https://docs.joomla.org/Joomla_1.5_version_history "Joomla 1.5 version history") +and the Upgrade +Instructions relating to the Upgrade Package. diff --git a/manuals/help/help-screens/help-screens-styleguide.md b/manuals/help/help-screens/help-screens-styleguide.md new file mode 100644 index 0000000..32b00ae --- /dev/null +++ b/manuals/help/help-screens/help-screens-styleguide.md @@ -0,0 +1,284 @@ +--- +sidebar_position: 1 +id: help-screens-styleguide +title: "Help4.x:Help screens styleguide" +--- +Return to Joomla! 4.x +Help Screen Wiki Page + +This is a work in progress and should be used as a guideline for +creating Help screens for **Joomla 3.x**. The help screens which exist +on the Joomla! Docs Wiki are being accessed by every Joomla! +installation using the default help system. By following this +styleguide, the Joomla! Project can offer consistency throughout the +help screens to allow for easier navigation. + +If you have a question, please post in on the associated talk page of +the help screen by clicking the ***Discussion*** tab at the top of the +help screen page. + +## Help Screen Page Layout + +### Description + +Each and every help screen should have a "**Description**" section. This +goes into more detail about what the screen does and is used in help +screen tables throughout this wiki. Here is an use example. + +There is no specific format to this section because the description +should be in direct correlation with the purpose and functionality of +the screen. There may be subsections to the description that describe +more specific details. Try to keep the description short and to the +point, if the description is long then consider using bullet points to +summarise it. + +## How to Access + +Each and every help screen should have a "**How to access**" section +that gives the steps required to reach the screen that is being +described. This might be redundant because a user must be on the +administrator screen in order to have retrieved the help screen. +Remember, the help screens can be retrieved in a number of different +ways. For example, someone using a search engine to find out how to do +something might come across a help screen on the wiki without ever +having accessed the help system. + +Here's an example: + + + + + + + + +
    +
  • Click the Article Manager icon in the Control +Panel
    • +
  • Select Content → Article Manager from the +drop-down menu of the Joomla! Administrator +Panel.
    • +
  • Click the Article link while viewing the Category Manager or Featured +Articles in the left, upper sidebar.
    • +
+ +\*Note: + +- If the way to reach the screen is from another screen then the name of + that screen should be a link to its help screen. +- You "click" on buttons, including toolbar buttons, but you "select" + menu items. Consistent use of this terminology should help users. +- For ease of rendering the right arrow( **→** ), **This + pointing **→** at that** see the + {{[rarr](https://docs.joomla.org/Template:Rarr "Template:Rarr")}} + template for use. It was designed to make help screen **How to + Access** instructions easy to write. + +### Screenshot + +Screenshot showing the overall look of the screen. + +\*Notes: + +- Screenshot images can be any width, but larger images should have the + \|800px added in the source. +- The filename should follow our + standard naming + conventions for help screens. + **Help-3x-***\***-screen-en.png**. + For example, a screenshot of the Article Manager screen would be + **\[\[File:Help-3x--content-article-manager-screen-en.png\]\]**. +- The filename should always include a language code at the end of the + name, for English -en is added. +- You can use either .png or .jpg files. + +## Form Fields (by Tab) + +### Details Tab + +This section should only be included on help screens that describe +screens which include a form. This includes all the add/edit screens, +but also includes screens like [Help4.x:Site Global +Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration "Help4.x:Site Global Configuration") +and modal popups like Help4.x:Components +Article Manager Options. + +### Other Tab Types + +If fields are grouped into fieldsets or tabs then group the fields under +sub-headings. + +### Column Headers + +This section should only be included on help screens that describe +back-end manager screens; that is, where you have a list of items being +shown. This section should describe each of the list columns. + +### List Filters + +This section should only be included on help screens that describe +back-end manager screens; that is, where you have a list of items being +shown. This section should describe how to use the list filters to +filter the contents of the screen. See +Screen.content.15#List_Filters for example +from 1.5. + +### Options + +This section should only be included on help screens where the screen +has an Options toolbar button which opens a modal options sub-screen. If +there are many options and the help screen would become excessively long +if they were to be described here, then link to a separate help screen +with an "\_Options" suffix. For example, see Components Article +Manager Options. + +Since the Options modal screen is usually tabbed you should add a +sub-section under this section for each tab. For example, if there is a +tab labelled "Editing Layout" then you should add a third-level heading +of that name and within that sub-section you should describe each of the +available fields. You should start each sub-section with a screenshot of +the appropriate Options panel. + +### Toolbar + +Obviously, this section should only be included on help screens where a +toolbar is present. + +Describes the available buttons and their associated functions. Use +**chunks** here because many will be the same for different screens. +Best to provide a picture of the toolbar. + +The first word should always be a verb and, unless it is an irregular +verb, it should also end in the letter "s". This means you should +structure the description as if you are using the word "this" as the +subject, but leave the subject out of the sentence. This will make the +sentence actually a sentence fragment. For instance: + +- Instead of "To find buried treasures, click this button." + - Say, "Finds buried treasures." +- Instead of "You can click this button to insert a picture of John + Stamos into the current document." + - Say, "Inserts a picture of John Stamos." +- Instead of "Inform yourself that a picture of John Stamos is the same + thing as a buried treasure." + - Say, "Informs you that a picture of John Stamos is the same thing as + buried treasure." + +Since many toolbars are the same across multiple screens, the image +filenaming convention for toolbars is aimed at making it easy to re-use +toolbar images wherever possible. Toolbar images should follow this +naming convention: Help\-Toolbar-\.png where +\ is a '-' separated list of the toolbar legends. Each word +should be capitalised, spaces and '&' removed. For example: +Help30-Toolbar-New-Edit-Delete-Options-Help.png + +### Batch Process + +This section should only be included on help screens where the screen +has a batch process feature. For example, see +Help4.x:Components Banners +Categories. + +### Quick Tips + +As the name suggests, this section should include tips, hints, +suggestions that can assist a user in performing tasks involving the +screen. + +### Related Information + +Generally this should be a list of links to further or related +information. All links should be to pages on this wiki. No external +links without very good reason. + +## Notes for help screen editors + +- [Layout of a typical Help + Screen](https://docs.joomla.org/Help_screen_layout "Help screen layout") +- Overview of Help + screen chunks + For usage information and examples see the following templates: + - {{[colheader](https://docs.joomla.org/Template:Colheader "Template:Colheader")\|Column + name}} includes one of the *Help screen column header XYZ* chunks + - {{Joomla 3.x + - Joomla 3.x + - {{[toolbaricon](https://docs.joomla.org/Template:Toolbaricon "Template:Toolbaricon")\|Action + name}} is for *Help screen toolbar XYZ* + - {{[cpanelicon](https://docs.joomla.org/Template:Cpanelicon "Template:Cpanelicon")\|Icon + name}} is for *Help screen icon XYZ* + - for proper categorisation read the instructions of + [Template:cathelp](https://docs.joomla.org/Template:Cathelp "Template:Cathelp") + (talk, + [backlinks](https://docs.joomla.org/Special:WhatLinksHere/Template:cathelp "Special:WhatLinksHere/Template:cathelp"), + edit) +- [Content + editors](https://docs.joomla.org/Content_editors "Content editors") + - {{[Chunk30:TinyMCE](https://docs.joomla.org/Chunk30:TinyMCE "Chunk30:TinyMCE")}} + for TinyMCE + - {{[Chunk30:No + editor](https://docs.joomla.org/Chunk30:No_editor "Chunk30:No editor")}} + for No editor +- Did you notice a mistake or do think it's useful to add some extra + information? You're welcome to modify the Help Screen. Please change + the status of the modified Help Screen after you modified it: + - Is the status at the moment 'Ready' or 'To be moved'? Change it to + 'Modified by \[name\]' (replace \[name\] for your username at the + Joomla! Docs Wiki) + - Is the status at the moment 'To be reviewed'? You don't have to + change the status in that case. +- Image file naming convention: + - help16-*\[menu system path separated by + dashes\]*-*\[screenElementType\]*-en.png,jpg + - Replace *\[menu system path separated by dashes\]* with the names + of the menu items that you would need to select to get to the item + you are taking a screenshot of. Separate menu items with a dash + ( - ) and if the menu item name has more than one word in it, then + separate the words with an underscore ( \_ ). Do not use spaces in + your file name. Replace spaces with the underscore ( \_ ) + character. + - Replace *\[screenElementType\]* with the type of the screen + element that your picture contains. Screen element types are: + - **screen** - This is a screenshot of the entire menu item + - **toolbar** - This is a picture of the menu item's tool bar. + - **menu** - This is a picture of the menu item's menu bar. + - NOTE: As more screen element types are needed, add them to this + style guide so that help documentation developers can refer to + this guide and stay consistent. + - Examples using the image naming convention: + - A screenshot of the Extension Manager's "Discover" screen would + be named: help16-extension_manager-discover-screen-en.png + - A screenshot of the Extension Manager's "Discover" screen tool + bar would be named: + help16-extension_manager-discover-toolbar-en.png diff --git a/manuals/help/help-screens/start-here.md b/manuals/help/help-screens/start-here.md new file mode 100644 index 0000000..74bb7a4 --- /dev/null +++ b/manuals/help/help-screens/start-here.md @@ -0,0 +1,67 @@ +--- +sidebar_position: 1 +id: start-here +title: "Help4.x:Start Here" +--- +Joomla!  4.x + +## Help with Joomla! 4 + +For help with a specific administrator page, within the Joomla +administrator interface you can select the **Help** toolbar button for +further information about the page. It is located at the right of the +Toolbar just beneath the Title bar. Example: + + + +A modal dialog will pop up in the middle of the screen containing Help +information specific to that page. + +## Help Screen Version Notice + +These Help Screens are for Joomla! Version 4. Sometimes Joomla updates +cause a Help screen to differ from the page it is supporting. There may +be new or removed options or differences in functionality. Otherwise, +all help screens will still function as expected. Remember, you should +always **update your Joomla! version** as soon as possible to benefit +from new features and/or security enhancements. + +## Getting started + +If you have only recently started working with Joomla you will probably +have experienced the pain of learning a new system. New terminology, new +ways of doing things, perhaps even the web itself may be new to you. +Then let this guide relieve some of that pain. + +- [Getting Started with Joomla! + 4](https://docs.joomla.org/J4.x:Getting_Started_with_Joomla!/en "Special:MyLanguage/J4.x:Getting Started with Joomla!/en") +- [Getting Started: Site and Administrator + templates](https://docs.joomla.org/J4.x:Getting_Started:_Site_and_Administrator_templates/en "Special:MyLanguage/J4.x:Getting Started: Site and Administrator templates/en") +- [Getting Started: Adding an + Article](https://docs.joomla.org/J4.x:Getting_Started:_Adding_an_Article/en "Special:MyLanguage/J4.x:Getting Started: Adding an Article/en") +- [Getting Started: Adding a Menu + Item](https://docs.joomla.org/J4.x:Getting_Started:_Adding_a_Menu_Item/en "Special:MyLanguage/J4.x:Getting Started: Adding a Menu Item/en") +- [Getting Started: Adding a + Category](https://docs.joomla.org/J4.x:Getting_Started:_Adding_a_Category/en "Special:MyLanguage/J4.x:Getting Started: Adding a Category/en") +- [Getting Started: Adding a + Module](https://docs.joomla.org/J4.x:Getting_Started:_Adding_a_Module/en "Special:MyLanguage/J4.x:Getting Started: Adding a Module/en") + +## Keeping your website secure + +- [Joomla! Security + Checklist](https://docs.joomla.org/Security_Checklist/en "Special:MyLanguage/Security Checklist/en") + +## Further information by reader profile + +- [Administrators](https://docs.joomla.org/Portal:Administrators/en "Special:MyLanguage/Portal:Administrators/en") +- [Web + Designers](https://docs.joomla.org/Web_designers/en "Special:MyLanguage/Web designers/en") +- [Developers](https://docs.joomla.org/Portal:Developers/en "Special:MyLanguage/Portal:Developers/en") +- [Evaluators](https://docs.joomla.org/Evaluators/en "Special:MyLanguage/Evaluators/en") +- [more user + profiles...](https://docs.joomla.org/Start_here/en "Special:MyLanguage/Start here/en") diff --git a/manuals/help/information/information-database.md b/manuals/help/information/information-database.md new file mode 100644 index 0000000..9a7f15e --- /dev/null +++ b/manuals/help/information/information-database.md @@ -0,0 +1,165 @@ +--- +sidebar_position: 1 +id: information-database +title: "Help4.x:Information: Database" +--- +## Description + +This screen checks that your database table structure is up to date with +your Joomla programs and lets you try to fix any problems that are +found. In a normal Joomla version update, changes to the database table +structure (also called "schema") are done automatically to keep the +database version synchronized with the Joomla version. If an update is +done manually, or if some part of an automatic update fails, the +database schema might not be updated to match the version of the Joomla +program files. In this case you will see a list of database problems on +the screen. You can normally fix any problems by clicking on the Fix +button. + +## How to Access + +- Select **System **→** Information Panel **→** Database** from the + Administrator menu. + +## Screenshot + + + +## Column Headers + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Name.** The name of the extension. +- **Location.** Specifies if this is a site or administrator extension. +- **Type.** The extension type - module, plug-in, template, language. +- **Problems.** Any problems will be mentioned here. A hover Tooltip + provides more information. +- **Database Version.** The version number of the Database. +- **Manifest Version.** The version number of Joomla or Extension. +- **Folder.** If the extension is a plug-in, the subdirectory of your + Joomla! installation's /plugins directory where the extension is + located. +- **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 cannot change this + number. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Special:MyLanguage/Help4.x:Site Global Configuration/en"). + +**Filter Options** + +You can use one of the available filters or any combination of them to +limit the number of extensions displayed to just the extensions which +match your filter parameters. + +- **-Select Location-.** Select Site, Administrator or API from the + dropdown list of available locations. +- **-Select Type-.** Select the extension type from the dropdown list + box of available types. +- **-Select Folder-.** Select a plug-in folder from the dropdown list + box of available folders. There is a separate folder for each type of + plug-in defined in your Joomla installation. + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Update Structure**. This program attempts to fix any database table + structure problems found in the Database check. It runs any database + schema change scripts (from the folder + `administrator/components/com_admin/sql/updates`) that were not run + during the version update. It then re-checks whether or not the + database is up to date. If it is successful, the message "Database + table structure is up to date" will show. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- If you experience problems during an update, use this Database check + to see if your database got updated correctly. +- It is strongly recommended that you use the [Joomla + Update](https://docs.joomla.org/Help4.x:Joomla_Update/en "Special:MyLanguage/Help4.x:Joomla Update/en") + component to update your site. This way the database changes will be + done automatically. + +## Related Information + +- You can check for available updates in the [Joomla + Update](https://docs.joomla.org/Help4.x:Joomla_Update/en "Special:MyLanguage/Help4.x:Joomla Update/en") + component or in the + Control + Panel. + +**Links to Other Screens** + +- **Install.** Links to the [Install + Screen](https://docs.joomla.org/Help4.x:Extensions:_Install/en "Special:MyLanguage/Help4.x:Extensions: Install/en"). +- **Update.** Links to the [Update + Screen](https://docs.joomla.org/Help4.x:Extensions:_Update/en "Special:MyLanguage/Help4.x:Extensions: Update/en"). +- **Manage.** Links to the [Manage + Screen](https://docs.joomla.org/Help4.x:Extensions:_Manage/en "Special:MyLanguage/Help4.x:Extensions: Manage/en"). +- **Discover.** Links to the [Discover + Screen](https://docs.joomla.org/Help4.x:Extensions:_Discover/en "Special:MyLanguage/Help4.x:Extensions: Discover/en"). +- **Database.** Links to the [Database + Screen](https://docs.joomla.org/Help4.x:Information:_Database/en "Special:MyLanguage/Help4.x:Information: Database/en"). +- **Warnings.** Links to the [Warnings + Screen](https://docs.joomla.org/Help4.x:Information:_Warnings/en "Special:MyLanguage/Help4.x:Information: Warnings/en"). +- **Install Languages.** Links to the [Languages + Screen](https://docs.joomla.org/Help4.x:Extensions_Extension_Manager_Languages/en "Special:MyLanguage/Help4.x:Extensions Extension Manager Languages/en"). +- **Update Sites.** Links to the [Update + Sites](https://docs.joomla.org/Help4.x:Extensions:_Update/en "Special:MyLanguage/Help4.x:Extensions: Update/en"). diff --git a/manuals/help/information/information-warnings.md b/manuals/help/information/information-warnings.md new file mode 100644 index 0000000..1f83bd3 --- /dev/null +++ b/manuals/help/information/information-warnings.md @@ -0,0 +1,57 @@ +--- +sidebar_position: 2 +id: information-warnings +title: "Help4.x:Information: Warnings" +--- +## Description + +This screen will display any warnings related to extensions you have +installed in your Joomla! installation. Warnings such as possible +conflicts in your installation or dependency failures may appear here. + +## How to Access + +- Select **System **→** Information Panel **→** Warning** from the + Administrator menu. + +## Screenshot + + + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Related Information + +- **Install.** Links to the [Install + Screen](https://docs.joomla.org/Help4.x:Extensions:_Install/en "Help4.x:Extensions: Install/en"). +- **Update.** Links to the [Update + Screen](https://docs.joomla.org/Help4.x:Extensions:_Update/en "Help4.x:Extensions: Update/en"). +- **Manage.** Links to the [Manage + Screen](https://docs.joomla.org/Help4.x:Extensions:_Manage/en "Help4.x:Extensions: Manage/en"). +- **Discover.** Links to the [Discover + Screen](https://docs.joomla.org/Help4.x:Extensions:_Discover/en "Help4.x:Extensions: Discover/en"). +- **Database.** Links to the [Database + Screen](https://docs.joomla.org/Help4.x:Information:_Database/en "Help4.x:Information: Database/en"). +- **Warnings.** Links to the Warnings + Screen. +- **Install Languages.** Links to the [Install Languages + Screen](https://docs.joomla.org/Help4.x:Extensions_Extension_Manager_Languages/en "Help4.x:Extensions Extension Manager Languages/en"). +- **Update Sites.** Links to the Update + Sites Screen. diff --git a/manuals/help/install-or-update/installer-options.md b/manuals/help/install-or-update/installer-options.md new file mode 100644 index 0000000..624582c --- /dev/null +++ b/manuals/help/install-or-update/installer-options.md @@ -0,0 +1,96 @@ +--- +sidebar_position: 1 +id: installer-options +title: "Help4.x:Installer: Options" +--- +## Description + +Installer Options configuration allows setting of parameters used +globally for Installer. + +## How to Access + +- Select **System **→** Manage panel **→** Extensions** from the + Administrator menu. Then... + - Click the **Options** button on the Toolbar. + +## Screenshot + + + +## Form Fields + +### Preferences Tab + +- **Joomla! Extensions Directory.** (Show message/Hide message) Show or + hide the information at the top of the installer page about the + Joomla! Extensions Directory. +- **Updates Caching (in hours).** For how many hours should Joomla cache + update information. This is also the cache time for the Update + Notification Plugin, if enabled. +- **Minimum Stability.** The minimum stability of the extension updates + you would like to see. Development is the least stable, Stable is + production quality. If an extension doesn't specify a level it is + assumed to be Stable. + +### Permissions Tab + + + + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Optons.** Users can edit the options and + permissions of this extension. + - **Configure Options Only.** Users can edit the options except the + permissions of this extension. + - **Access Administration Interface.** Users can access user + administration interface of this extension. + - **Create.** Users can create content of this extension. + - **Delete.** Users can delete content of this extension. + - **Edit.** Users can edit content of this extension. + - **Edit State.** User can change the published state and related + information for content of this extension. + - **Edit Own.** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the Installer options and stays in the current screen. + + + +- **Save & Close**. Saves the Installer options and closes the current + screen. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/install-or-update/joomla-update-options.md b/manuals/help/install-or-update/joomla-update-options.md new file mode 100644 index 0000000..e0a7fd2 --- /dev/null +++ b/manuals/help/install-or-update/joomla-update-options.md @@ -0,0 +1,65 @@ +--- +sidebar_position: 3 +id: joomla-update-options +title: "Help4.x:Joomla Update: Options" +--- +## Description + +Joomla! Updates Options allows setting of parameters used for updates +for Joomla!. + +## How to Access + +- Select **System **→** Update panel **→** Joomla** from the + Administrator menu. Then... + - Click the **Options** button on the Toolbar. + +## Screenshot + + + +## Form Fields + +### Update Source Tab + +- **Update Channel** + - **Default.** For Production sites. + - **Joomla Next.** For ... + - **Testing.** For Joomla Testers. More fields will appear. + - **Custom URL.** For Joomla Developers. More fields will appear. +- **Minimum Stability** The minimum stability of the extension updates + you would like to see. Development is the least stable, Stable is + production quality. If an extension doesn't specify a level it is + assumed to be Stable. + - **Development.** For Joomla Developers sites. + - **Alpha.** For Alpha testing sites. + - **Beta.** For Beta testing sites. + - **Release Candidate.** For Release Candidate sites. + - **Stabel.** For Production sites. +- **Custom URL** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/install-or-update/joomla-update.md b/manuals/help/install-or-update/joomla-update.md new file mode 100644 index 0000000..7d755f5 --- /dev/null +++ b/manuals/help/install-or-update/joomla-update.md @@ -0,0 +1,113 @@ +--- +sidebar_position: 2 +id: joomla-update +title: "Help4.x:Joomla Update" +--- +## Description + +This screen allows Joomla! to be updated quickly using an update package +from the Joomla! code repository. + +## How to Access + +- Select **Home Dashboard **→** Update Checks Panel **→** Joomla ... + icon** from the Administrator menu. Or... +- Select **System **→** Update Panel **→** Joomla** from the + Administrator menu.. + +## Screenshot + + + +You are on the latest version of Joomla, so no action required. + +## Functions + +- **Check for Updates.** Click the Toolbar button to see if an updates + is available. + +**The update screen when an update is available.** + +800px + +### Live Update + +If you are NOT on the latest version of Joomla, you can install the +latest update from this screen. To do so select the **Install the +Update** button in the Toolbar and Joomla will install the latest core +files. + +**The screen while updating.** + + + +### Upload and Update + +**Check the size of the update package!** If it is larger than your PHP +*upload_max_filesize* or *post_max_size* it will fail. You may be able +to increase these sizes. Otherwise... + + + +You can use this feature to update Joomla if your server is behind a +firewall or otherwise unable to contact the update servers. First +download the Joomla Upgrade Package in ZIP format from the official +Joomla download page. + +The Installation method can have the following values: + +- Write files directly +- Hybrid (use FTP only if needed +- Write files using FTP + +The first method is advised. + +### For Developers + +There are options to select the type of update: + +- **Default.** This should be used for production sites. +- **Joomla Next.** For ... +- **Testing.** For ... +- **Custom URL.** For Developers. + +Select the **Options** button in the Toolbar to check or change the +current selection. + +If you set the Custom URL in the Joomla Update Options, after selecting +**Check for Updates** you will see an extra tab, Pre-Update Check: + + + +And the Live Update panel will be ready to go: + + + +## Quick Tips + +- You can look at the [Joomla! Update Quick + Icons](https://docs.joomla.org/Help4.x:Admin_Modules:_Quick_Icons/en "Help4.x:Admin Modules: Quick Icons/en") + in the Backend Control Panel. diff --git a/manuals/help/install-or-update/joomla-version-4-0-0.md b/manuals/help/install-or-update/joomla-version-4-0-0.md new file mode 100644 index 0000000..23c31a4 --- /dev/null +++ b/manuals/help/install-or-update/joomla-version-4-0-0.md @@ -0,0 +1,157 @@ +--- +sidebar_position: 4 +id: joomla-version-4-0-0 +title: "Help4.x:Joomla Version 4 0 0" +--- +| | | +|-------------------------------------------------------------------------|---------------------------------------------------------------------------------------| +| Stop hand nuvola.svg.png | **Joomla! version 4.0.0 is not the current version. Your website is not up-to-date.** | + +## Additional information + +## Announcements and release notes + +#### Version 4.2.x + +- Joomla! + 4.2.6 announcement +- Joomla! + 4.2.5 announcement +- Joomla! + 4.2.4 announcement +- Joomla! + 4.2.3 announcement +- Joomla! + 4.2.2 announcement +- Joomla! + 4.2.1 announcement +- Joomla! + 4.2.0 announcement + +#### Version 4.1.x + +- Joomla! + 4.1.5 announcement +- Joomla! + 4.1.4 announcement +- Joomla! + 4.1.3 announcement +- Joomla! + 4.1.2 announcement +- Joomla! + 4.1.1 announcement +- Joomla! + 4.1.0 announcement + +#### Version 4.0.x + +- Joomla! + 4.0.6 announcement +- Joomla! + 4.0.5 announcement +- Joomla! + 4.0.4 announcement +- Joomla! + 4.0.3 announcement +- Joomla! + 4.0.2 announcement +- Joomla! + 4.0.1 announcement +- Joomla! + 4.0.0 announcement + +## Frequently Asked Questions + +#### Version 4.2.x + +For known issues specific to a 4.2.x version, together with suggested +resolutions. + +- [Version 4.2.6 + FAQ](https://docs.joomla.org/:Category:Version_4.2.6_FAQ "Special:MyLanguage/:Category:Version 4.2.6 FAQ") +- [Version 4.2.5 + FAQ](https://docs.joomla.org/:Category:Version_4.2.5_FAQ "Special:MyLanguage/:Category:Version 4.2.5 FAQ") +- [Version 4.2.4 + FAQ](https://docs.joomla.org/:Category:Version_4.2.4_FAQ "Special:MyLanguage/:Category:Version 4.2.4 FAQ") +- [Version 4.2.3 + FAQ](https://docs.joomla.org/:Category:Version_4.2.3_FAQ "Special:MyLanguage/:Category:Version 4.2.3 FAQ") +- [Version 4.2.2 + FAQ](https://docs.joomla.org/:Category:Version_4.2.2_FAQ "Special:MyLanguage/:Category:Version 4.2.2 FAQ") +- [Version 4.2.1 + FAQ](https://docs.joomla.org/:Category:Version_4.2.1_FAQ "Special:MyLanguage/:Category:Version 4.2.1 FAQ") +- [Version 4.2.0 + FAQ](https://docs.joomla.org/:Category:Version_4.2.0_FAQ "Special:MyLanguage/:Category:Version 4.2.0 FAQ") + +#### Version 4.1.x + +For known issues specific to a 4.1.x version, together with suggested +resolutions. + +- [Version 4.1.2 + FAQ](https://docs.joomla.org/:Category:Version_4.1.2_FAQ "Special:MyLanguage/:Category:Version 4.1.2 FAQ") +- [Version 4.1.1 + FAQ](https://docs.joomla.org/:Category:Version_4.1.1_FAQ "Special:MyLanguage/:Category:Version 4.1.1 FAQ") +- [Version 4.1.0 + FAQ](https://docs.joomla.org/:Category:Version_4.1.0_FAQ "Special:MyLanguage/:Category:Version 4.1.0 FAQ") + +#### Version 4.0.x + +For known issues specific to a 4.0.x version, together with suggested +resolutions. + +- [Version 4.0.6 + FAQ](https://docs.joomla.org/:Category:Version_4.0.6_FAQ "Special:MyLanguage/:Category:Version 4.0.6 FAQ") +- [Version 4.0.5 + FAQ](https://docs.joomla.org/:Category:Version_4.0.5_FAQ "Special:MyLanguage/:Category:Version 4.0.5 FAQ") +- [Version 4.0.4 + FAQ](https://docs.joomla.org/:Category:Version_4.0.4_FAQ "Special:MyLanguage/:Category:Version 4.0.4 FAQ") +- [Version 4.0.3 + FAQ](https://docs.joomla.org/:Category:Version_4.0.3_FAQ "Special:MyLanguage/:Category:Version 4.0.3 FAQ") +- [Version 4.0.2 + FAQ](https://docs.joomla.org/:Category:Version_4.0.2_FAQ "Special:MyLanguage/:Category:Version 4.0.2 FAQ") +- [Version 4.0.1 + FAQ](https://docs.joomla.org/:Category:Version_4.0.1_FAQ "Special:MyLanguage/:Category:Version 4.0.1 FAQ") +- [Version 4.0.0 + FAQ](https://docs.joomla.org/:Category:Version_4.0.0_FAQ "Special:MyLanguage/:Category:Version 4.0.0 FAQ") diff --git a/manuals/help/install-or-update/joomla-version-4-0-1.md b/manuals/help/install-or-update/joomla-version-4-0-1.md new file mode 100644 index 0000000..7efd31c --- /dev/null +++ b/manuals/help/install-or-update/joomla-version-4-0-1.md @@ -0,0 +1,157 @@ +--- +sidebar_position: 5 +id: joomla-version-4-0-1 +title: "Help4.x:Joomla Version 4 0 1" +--- +| | | +|-------------------------------------------------------------------------|---------------------------------------------------------------------------------------| +| Stop hand nuvola.svg.png | **Joomla! version 4.0.1 is not the current version. Your website is not up-to-date.** | + +## Additional information + +## Announcements and release notes + +#### Version 4.2.x + +- Joomla! + 4.2.6 announcement +- Joomla! + 4.2.5 announcement +- Joomla! + 4.2.4 announcement +- Joomla! + 4.2.3 announcement +- Joomla! + 4.2.2 announcement +- Joomla! + 4.2.1 announcement +- Joomla! + 4.2.0 announcement + +#### Version 4.1.x + +- Joomla! + 4.1.5 announcement +- Joomla! + 4.1.4 announcement +- Joomla! + 4.1.3 announcement +- Joomla! + 4.1.2 announcement +- Joomla! + 4.1.1 announcement +- Joomla! + 4.1.0 announcement + +#### Version 4.0.x + +- Joomla! + 4.0.6 announcement +- Joomla! + 4.0.5 announcement +- Joomla! + 4.0.4 announcement +- Joomla! + 4.0.3 announcement +- Joomla! + 4.0.2 announcement +- Joomla! + 4.0.1 announcement +- Joomla! + 4.0.0 announcement + +## Frequently Asked Questions + +#### Version 4.2.x + +For known issues specific to a 4.2.x version, together with suggested +resolutions. + +- [Version 4.2.6 + FAQ](https://docs.joomla.org/:Category:Version_4.2.6_FAQ "Special:MyLanguage/:Category:Version 4.2.6 FAQ") +- [Version 4.2.5 + FAQ](https://docs.joomla.org/:Category:Version_4.2.5_FAQ "Special:MyLanguage/:Category:Version 4.2.5 FAQ") +- [Version 4.2.4 + FAQ](https://docs.joomla.org/:Category:Version_4.2.4_FAQ "Special:MyLanguage/:Category:Version 4.2.4 FAQ") +- [Version 4.2.3 + FAQ](https://docs.joomla.org/:Category:Version_4.2.3_FAQ "Special:MyLanguage/:Category:Version 4.2.3 FAQ") +- [Version 4.2.2 + FAQ](https://docs.joomla.org/:Category:Version_4.2.2_FAQ "Special:MyLanguage/:Category:Version 4.2.2 FAQ") +- [Version 4.2.1 + FAQ](https://docs.joomla.org/:Category:Version_4.2.1_FAQ "Special:MyLanguage/:Category:Version 4.2.1 FAQ") +- [Version 4.2.0 + FAQ](https://docs.joomla.org/:Category:Version_4.2.0_FAQ "Special:MyLanguage/:Category:Version 4.2.0 FAQ") + +#### Version 4.1.x + +For known issues specific to a 4.1.x version, together with suggested +resolutions. + +- [Version 4.1.2 + FAQ](https://docs.joomla.org/:Category:Version_4.1.2_FAQ "Special:MyLanguage/:Category:Version 4.1.2 FAQ") +- [Version 4.1.1 + FAQ](https://docs.joomla.org/:Category:Version_4.1.1_FAQ "Special:MyLanguage/:Category:Version 4.1.1 FAQ") +- [Version 4.1.0 + FAQ](https://docs.joomla.org/:Category:Version_4.1.0_FAQ "Special:MyLanguage/:Category:Version 4.1.0 FAQ") + +#### Version 4.0.x + +For known issues specific to a 4.0.x version, together with suggested +resolutions. + +- [Version 4.0.6 + FAQ](https://docs.joomla.org/:Category:Version_4.0.6_FAQ "Special:MyLanguage/:Category:Version 4.0.6 FAQ") +- [Version 4.0.5 + FAQ](https://docs.joomla.org/:Category:Version_4.0.5_FAQ "Special:MyLanguage/:Category:Version 4.0.5 FAQ") +- [Version 4.0.4 + FAQ](https://docs.joomla.org/:Category:Version_4.0.4_FAQ "Special:MyLanguage/:Category:Version 4.0.4 FAQ") +- [Version 4.0.3 + FAQ](https://docs.joomla.org/:Category:Version_4.0.3_FAQ "Special:MyLanguage/:Category:Version 4.0.3 FAQ") +- [Version 4.0.2 + FAQ](https://docs.joomla.org/:Category:Version_4.0.2_FAQ "Special:MyLanguage/:Category:Version 4.0.2 FAQ") +- [Version 4.0.1 + FAQ](https://docs.joomla.org/:Category:Version_4.0.1_FAQ "Special:MyLanguage/:Category:Version 4.0.1 FAQ") +- [Version 4.0.0 + FAQ](https://docs.joomla.org/:Category:Version_4.0.0_FAQ "Special:MyLanguage/:Category:Version 4.0.0 FAQ") diff --git a/manuals/help/install-or-update/joomla-version-4-0-2.md b/manuals/help/install-or-update/joomla-version-4-0-2.md new file mode 100644 index 0000000..60cf3b9 --- /dev/null +++ b/manuals/help/install-or-update/joomla-version-4-0-2.md @@ -0,0 +1,157 @@ +--- +sidebar_position: 6 +id: joomla-version-4-0-2 +title: "Help4.x:Joomla Version 4 0 2" +--- +| | | +|-------------------------------------------------------------------------|---------------------------------------------------------------------------------------| +| Stop hand nuvola.svg.png | **Joomla! version 4.0.2 is not the current version. Your website is not up-to-date.** | + +## Additional information + +## Announcements and release notes + +#### Version 4.2.x + +- Joomla! + 4.2.6 announcement +- Joomla! + 4.2.5 announcement +- Joomla! + 4.2.4 announcement +- Joomla! + 4.2.3 announcement +- Joomla! + 4.2.2 announcement +- Joomla! + 4.2.1 announcement +- Joomla! + 4.2.0 announcement + +#### Version 4.1.x + +- Joomla! + 4.1.5 announcement +- Joomla! + 4.1.4 announcement +- Joomla! + 4.1.3 announcement +- Joomla! + 4.1.2 announcement +- Joomla! + 4.1.1 announcement +- Joomla! + 4.1.0 announcement + +#### Version 4.0.x + +- Joomla! + 4.0.6 announcement +- Joomla! + 4.0.5 announcement +- Joomla! + 4.0.4 announcement +- Joomla! + 4.0.3 announcement +- Joomla! + 4.0.2 announcement +- Joomla! + 4.0.1 announcement +- Joomla! + 4.0.0 announcement + +## Frequently Asked Questions + +#### Version 4.2.x + +For known issues specific to a 4.2.x version, together with suggested +resolutions. + +- [Version 4.2.6 + FAQ](https://docs.joomla.org/:Category:Version_4.2.6_FAQ "Special:MyLanguage/:Category:Version 4.2.6 FAQ") +- [Version 4.2.5 + FAQ](https://docs.joomla.org/:Category:Version_4.2.5_FAQ "Special:MyLanguage/:Category:Version 4.2.5 FAQ") +- [Version 4.2.4 + FAQ](https://docs.joomla.org/:Category:Version_4.2.4_FAQ "Special:MyLanguage/:Category:Version 4.2.4 FAQ") +- [Version 4.2.3 + FAQ](https://docs.joomla.org/:Category:Version_4.2.3_FAQ "Special:MyLanguage/:Category:Version 4.2.3 FAQ") +- [Version 4.2.2 + FAQ](https://docs.joomla.org/:Category:Version_4.2.2_FAQ "Special:MyLanguage/:Category:Version 4.2.2 FAQ") +- [Version 4.2.1 + FAQ](https://docs.joomla.org/:Category:Version_4.2.1_FAQ "Special:MyLanguage/:Category:Version 4.2.1 FAQ") +- [Version 4.2.0 + FAQ](https://docs.joomla.org/:Category:Version_4.2.0_FAQ "Special:MyLanguage/:Category:Version 4.2.0 FAQ") + +#### Version 4.1.x + +For known issues specific to a 4.1.x version, together with suggested +resolutions. + +- [Version 4.1.2 + FAQ](https://docs.joomla.org/:Category:Version_4.1.2_FAQ "Special:MyLanguage/:Category:Version 4.1.2 FAQ") +- [Version 4.1.1 + FAQ](https://docs.joomla.org/:Category:Version_4.1.1_FAQ "Special:MyLanguage/:Category:Version 4.1.1 FAQ") +- [Version 4.1.0 + FAQ](https://docs.joomla.org/:Category:Version_4.1.0_FAQ "Special:MyLanguage/:Category:Version 4.1.0 FAQ") + +#### Version 4.0.x + +For known issues specific to a 4.0.x version, together with suggested +resolutions. + +- [Version 4.0.6 + FAQ](https://docs.joomla.org/:Category:Version_4.0.6_FAQ "Special:MyLanguage/:Category:Version 4.0.6 FAQ") +- [Version 4.0.5 + FAQ](https://docs.joomla.org/:Category:Version_4.0.5_FAQ "Special:MyLanguage/:Category:Version 4.0.5 FAQ") +- [Version 4.0.4 + FAQ](https://docs.joomla.org/:Category:Version_4.0.4_FAQ "Special:MyLanguage/:Category:Version 4.0.4 FAQ") +- [Version 4.0.3 + FAQ](https://docs.joomla.org/:Category:Version_4.0.3_FAQ "Special:MyLanguage/:Category:Version 4.0.3 FAQ") +- [Version 4.0.2 + FAQ](https://docs.joomla.org/:Category:Version_4.0.2_FAQ "Special:MyLanguage/:Category:Version 4.0.2 FAQ") +- [Version 4.0.1 + FAQ](https://docs.joomla.org/:Category:Version_4.0.1_FAQ "Special:MyLanguage/:Category:Version 4.0.1 FAQ") +- [Version 4.0.0 + FAQ](https://docs.joomla.org/:Category:Version_4.0.0_FAQ "Special:MyLanguage/:Category:Version 4.0.0 FAQ") diff --git a/manuals/help/install-or-update/joomla-version-4-0-3.md b/manuals/help/install-or-update/joomla-version-4-0-3.md new file mode 100644 index 0000000..35ca950 --- /dev/null +++ b/manuals/help/install-or-update/joomla-version-4-0-3.md @@ -0,0 +1,157 @@ +--- +sidebar_position: 7 +id: joomla-version-4-0-3 +title: "Help4.x:Joomla Version 4 0 3" +--- +| | | +|-------------------------------------------------------------------------|---------------------------------------------------------------------------------------| +| Stop hand nuvola.svg.png | **Joomla! version 4.0.3 is not the current version. Your website is not up-to-date.** | + +## Additional information + +## Announcements and release notes + +#### Version 4.2.x + +- Joomla! + 4.2.6 announcement +- Joomla! + 4.2.5 announcement +- Joomla! + 4.2.4 announcement +- Joomla! + 4.2.3 announcement +- Joomla! + 4.2.2 announcement +- Joomla! + 4.2.1 announcement +- Joomla! + 4.2.0 announcement + +#### Version 4.1.x + +- Joomla! + 4.1.5 announcement +- Joomla! + 4.1.4 announcement +- Joomla! + 4.1.3 announcement +- Joomla! + 4.1.2 announcement +- Joomla! + 4.1.1 announcement +- Joomla! + 4.1.0 announcement + +#### Version 4.0.x + +- Joomla! + 4.0.6 announcement +- Joomla! + 4.0.5 announcement +- Joomla! + 4.0.4 announcement +- Joomla! + 4.0.3 announcement +- Joomla! + 4.0.2 announcement +- Joomla! + 4.0.1 announcement +- Joomla! + 4.0.0 announcement + +## Frequently Asked Questions + +#### Version 4.2.x + +For known issues specific to a 4.2.x version, together with suggested +resolutions. + +- [Version 4.2.6 + FAQ](https://docs.joomla.org/:Category:Version_4.2.6_FAQ "Special:MyLanguage/:Category:Version 4.2.6 FAQ") +- [Version 4.2.5 + FAQ](https://docs.joomla.org/:Category:Version_4.2.5_FAQ "Special:MyLanguage/:Category:Version 4.2.5 FAQ") +- [Version 4.2.4 + FAQ](https://docs.joomla.org/:Category:Version_4.2.4_FAQ "Special:MyLanguage/:Category:Version 4.2.4 FAQ") +- [Version 4.2.3 + FAQ](https://docs.joomla.org/:Category:Version_4.2.3_FAQ "Special:MyLanguage/:Category:Version 4.2.3 FAQ") +- [Version 4.2.2 + FAQ](https://docs.joomla.org/:Category:Version_4.2.2_FAQ "Special:MyLanguage/:Category:Version 4.2.2 FAQ") +- [Version 4.2.1 + FAQ](https://docs.joomla.org/:Category:Version_4.2.1_FAQ "Special:MyLanguage/:Category:Version 4.2.1 FAQ") +- [Version 4.2.0 + FAQ](https://docs.joomla.org/:Category:Version_4.2.0_FAQ "Special:MyLanguage/:Category:Version 4.2.0 FAQ") + +#### Version 4.1.x + +For known issues specific to a 4.1.x version, together with suggested +resolutions. + +- [Version 4.1.2 + FAQ](https://docs.joomla.org/:Category:Version_4.1.2_FAQ "Special:MyLanguage/:Category:Version 4.1.2 FAQ") +- [Version 4.1.1 + FAQ](https://docs.joomla.org/:Category:Version_4.1.1_FAQ "Special:MyLanguage/:Category:Version 4.1.1 FAQ") +- [Version 4.1.0 + FAQ](https://docs.joomla.org/:Category:Version_4.1.0_FAQ "Special:MyLanguage/:Category:Version 4.1.0 FAQ") + +#### Version 4.0.x + +For known issues specific to a 4.0.x version, together with suggested +resolutions. + +- [Version 4.0.6 + FAQ](https://docs.joomla.org/:Category:Version_4.0.6_FAQ "Special:MyLanguage/:Category:Version 4.0.6 FAQ") +- [Version 4.0.5 + FAQ](https://docs.joomla.org/:Category:Version_4.0.5_FAQ "Special:MyLanguage/:Category:Version 4.0.5 FAQ") +- [Version 4.0.4 + FAQ](https://docs.joomla.org/:Category:Version_4.0.4_FAQ "Special:MyLanguage/:Category:Version 4.0.4 FAQ") +- [Version 4.0.3 + FAQ](https://docs.joomla.org/:Category:Version_4.0.3_FAQ "Special:MyLanguage/:Category:Version 4.0.3 FAQ") +- [Version 4.0.2 + FAQ](https://docs.joomla.org/:Category:Version_4.0.2_FAQ "Special:MyLanguage/:Category:Version 4.0.2 FAQ") +- [Version 4.0.1 + FAQ](https://docs.joomla.org/:Category:Version_4.0.1_FAQ "Special:MyLanguage/:Category:Version 4.0.1 FAQ") +- [Version 4.0.0 + FAQ](https://docs.joomla.org/:Category:Version_4.0.0_FAQ "Special:MyLanguage/:Category:Version 4.0.0 FAQ") diff --git a/manuals/help/install-or-update/joomla-version-4-0-4.md b/manuals/help/install-or-update/joomla-version-4-0-4.md new file mode 100644 index 0000000..af0e5cf --- /dev/null +++ b/manuals/help/install-or-update/joomla-version-4-0-4.md @@ -0,0 +1,157 @@ +--- +sidebar_position: 8 +id: joomla-version-4-0-4 +title: "Help4.x:Joomla Version 4 0 4" +--- +| | | +|-------------------------------------------------------------------------|---------------------------------------------------------------------------------------| +| Stop hand nuvola.svg.png | **Joomla! version 4.0.4 is not the current version. Your website is not up-to-date.** | + +## Additional information + +## Announcements and release notes + +#### Version 4.2.x + +- Joomla! + 4.2.6 announcement +- Joomla! + 4.2.5 announcement +- Joomla! + 4.2.4 announcement +- Joomla! + 4.2.3 announcement +- Joomla! + 4.2.2 announcement +- Joomla! + 4.2.1 announcement +- Joomla! + 4.2.0 announcement + +#### Version 4.1.x + +- Joomla! + 4.1.5 announcement +- Joomla! + 4.1.4 announcement +- Joomla! + 4.1.3 announcement +- Joomla! + 4.1.2 announcement +- Joomla! + 4.1.1 announcement +- Joomla! + 4.1.0 announcement + +#### Version 4.0.x + +- Joomla! + 4.0.6 announcement +- Joomla! + 4.0.5 announcement +- Joomla! + 4.0.4 announcement +- Joomla! + 4.0.3 announcement +- Joomla! + 4.0.2 announcement +- Joomla! + 4.0.1 announcement +- Joomla! + 4.0.0 announcement + +## Frequently Asked Questions + +#### Version 4.2.x + +For known issues specific to a 4.2.x version, together with suggested +resolutions. + +- [Version 4.2.6 + FAQ](https://docs.joomla.org/:Category:Version_4.2.6_FAQ "Special:MyLanguage/:Category:Version 4.2.6 FAQ") +- [Version 4.2.5 + FAQ](https://docs.joomla.org/:Category:Version_4.2.5_FAQ "Special:MyLanguage/:Category:Version 4.2.5 FAQ") +- [Version 4.2.4 + FAQ](https://docs.joomla.org/:Category:Version_4.2.4_FAQ "Special:MyLanguage/:Category:Version 4.2.4 FAQ") +- [Version 4.2.3 + FAQ](https://docs.joomla.org/:Category:Version_4.2.3_FAQ "Special:MyLanguage/:Category:Version 4.2.3 FAQ") +- [Version 4.2.2 + FAQ](https://docs.joomla.org/:Category:Version_4.2.2_FAQ "Special:MyLanguage/:Category:Version 4.2.2 FAQ") +- [Version 4.2.1 + FAQ](https://docs.joomla.org/:Category:Version_4.2.1_FAQ "Special:MyLanguage/:Category:Version 4.2.1 FAQ") +- [Version 4.2.0 + FAQ](https://docs.joomla.org/:Category:Version_4.2.0_FAQ "Special:MyLanguage/:Category:Version 4.2.0 FAQ") + +#### Version 4.1.x + +For known issues specific to a 4.1.x version, together with suggested +resolutions. + +- [Version 4.1.2 + FAQ](https://docs.joomla.org/:Category:Version_4.1.2_FAQ "Special:MyLanguage/:Category:Version 4.1.2 FAQ") +- [Version 4.1.1 + FAQ](https://docs.joomla.org/:Category:Version_4.1.1_FAQ "Special:MyLanguage/:Category:Version 4.1.1 FAQ") +- [Version 4.1.0 + FAQ](https://docs.joomla.org/:Category:Version_4.1.0_FAQ "Special:MyLanguage/:Category:Version 4.1.0 FAQ") + +#### Version 4.0.x + +For known issues specific to a 4.0.x version, together with suggested +resolutions. + +- [Version 4.0.6 + FAQ](https://docs.joomla.org/:Category:Version_4.0.6_FAQ "Special:MyLanguage/:Category:Version 4.0.6 FAQ") +- [Version 4.0.5 + FAQ](https://docs.joomla.org/:Category:Version_4.0.5_FAQ "Special:MyLanguage/:Category:Version 4.0.5 FAQ") +- [Version 4.0.4 + FAQ](https://docs.joomla.org/:Category:Version_4.0.4_FAQ "Special:MyLanguage/:Category:Version 4.0.4 FAQ") +- [Version 4.0.3 + FAQ](https://docs.joomla.org/:Category:Version_4.0.3_FAQ "Special:MyLanguage/:Category:Version 4.0.3 FAQ") +- [Version 4.0.2 + FAQ](https://docs.joomla.org/:Category:Version_4.0.2_FAQ "Special:MyLanguage/:Category:Version 4.0.2 FAQ") +- [Version 4.0.1 + FAQ](https://docs.joomla.org/:Category:Version_4.0.1_FAQ "Special:MyLanguage/:Category:Version 4.0.1 FAQ") +- [Version 4.0.0 + FAQ](https://docs.joomla.org/:Category:Version_4.0.0_FAQ "Special:MyLanguage/:Category:Version 4.0.0 FAQ") diff --git a/manuals/help/install-or-update/joomla-version-additional-information.md b/manuals/help/install-or-update/joomla-version-additional-information.md new file mode 100644 index 0000000..905ced0 --- /dev/null +++ b/manuals/help/install-or-update/joomla-version-additional-information.md @@ -0,0 +1,149 @@ +--- +sidebar_position: 9 +id: joomla-version-additional-information +title: "Help4.x:Joomla Version Additional Information" +--- +## Announcements and release notes + +#### Version 4.2.x + +- Joomla! + 4.2.6 announcement +- Joomla! + 4.2.5 announcement +- Joomla! + 4.2.4 announcement +- Joomla! + 4.2.3 announcement +- Joomla! + 4.2.2 announcement +- Joomla! + 4.2.1 announcement +- Joomla! + 4.2.0 announcement + +#### Version 4.1.x + +- Joomla! + 4.1.5 announcement +- Joomla! + 4.1.4 announcement +- Joomla! + 4.1.3 announcement +- Joomla! + 4.1.2 announcement +- Joomla! + 4.1.1 announcement +- Joomla! + 4.1.0 announcement + +#### Version 4.0.x + +- Joomla! + 4.0.6 announcement +- Joomla! + 4.0.5 announcement +- Joomla! + 4.0.4 announcement +- Joomla! + 4.0.3 announcement +- Joomla! + 4.0.2 announcement +- Joomla! + 4.0.1 announcement +- Joomla! + 4.0.0 announcement + +## Frequently Asked Questions + +#### Version 4.2.x + +For known issues specific to a 4.2.x version, together with suggested +resolutions. + +- [Version 4.2.6 + FAQ](https://docs.joomla.org/:Category:Version_4.2.6_FAQ "Special:MyLanguage/:Category:Version 4.2.6 FAQ") +- [Version 4.2.5 + FAQ](https://docs.joomla.org/:Category:Version_4.2.5_FAQ "Special:MyLanguage/:Category:Version 4.2.5 FAQ") +- [Version 4.2.4 + FAQ](https://docs.joomla.org/:Category:Version_4.2.4_FAQ "Special:MyLanguage/:Category:Version 4.2.4 FAQ") +- [Version 4.2.3 + FAQ](https://docs.joomla.org/:Category:Version_4.2.3_FAQ "Special:MyLanguage/:Category:Version 4.2.3 FAQ") +- [Version 4.2.2 + FAQ](https://docs.joomla.org/:Category:Version_4.2.2_FAQ "Special:MyLanguage/:Category:Version 4.2.2 FAQ") +- [Version 4.2.1 + FAQ](https://docs.joomla.org/:Category:Version_4.2.1_FAQ "Special:MyLanguage/:Category:Version 4.2.1 FAQ") +- [Version 4.2.0 + FAQ](https://docs.joomla.org/:Category:Version_4.2.0_FAQ "Special:MyLanguage/:Category:Version 4.2.0 FAQ") + +#### Version 4.1.x + +For known issues specific to a 4.1.x version, together with suggested +resolutions. + +- [Version 4.1.2 + FAQ](https://docs.joomla.org/:Category:Version_4.1.2_FAQ "Special:MyLanguage/:Category:Version 4.1.2 FAQ") +- [Version 4.1.1 + FAQ](https://docs.joomla.org/:Category:Version_4.1.1_FAQ "Special:MyLanguage/:Category:Version 4.1.1 FAQ") +- [Version 4.1.0 + FAQ](https://docs.joomla.org/:Category:Version_4.1.0_FAQ "Special:MyLanguage/:Category:Version 4.1.0 FAQ") + +#### Version 4.0.x + +For known issues specific to a 4.0.x version, together with suggested +resolutions. + +- [Version 4.0.6 + FAQ](https://docs.joomla.org/:Category:Version_4.0.6_FAQ "Special:MyLanguage/:Category:Version 4.0.6 FAQ") +- [Version 4.0.5 + FAQ](https://docs.joomla.org/:Category:Version_4.0.5_FAQ "Special:MyLanguage/:Category:Version 4.0.5 FAQ") +- [Version 4.0.4 + FAQ](https://docs.joomla.org/:Category:Version_4.0.4_FAQ "Special:MyLanguage/:Category:Version 4.0.4 FAQ") +- [Version 4.0.3 + FAQ](https://docs.joomla.org/:Category:Version_4.0.3_FAQ "Special:MyLanguage/:Category:Version 4.0.3 FAQ") +- [Version 4.0.2 + FAQ](https://docs.joomla.org/:Category:Version_4.0.2_FAQ "Special:MyLanguage/:Category:Version 4.0.2 FAQ") +- [Version 4.0.1 + FAQ](https://docs.joomla.org/:Category:Version_4.0.1_FAQ "Special:MyLanguage/:Category:Version 4.0.1 FAQ") +- [Version 4.0.0 + FAQ](https://docs.joomla.org/:Category:Version_4.0.0_FAQ "Special:MyLanguage/:Category:Version 4.0.0 FAQ") diff --git a/manuals/help/install-or-update/joomla-version-information.md b/manuals/help/install-or-update/joomla-version-information.md new file mode 100644 index 0000000..9c18482 --- /dev/null +++ b/manuals/help/install-or-update/joomla-version-information.md @@ -0,0 +1,149 @@ +--- +sidebar_position: 10 +id: joomla-version-information +title: "Help4.x:Joomla Version Information" +--- +## Announcements and release notes + +#### Version 4.2.x + +- Joomla! + 4.2.6 announcement +- Joomla! + 4.2.5 announcement +- Joomla! + 4.2.4 announcement +- Joomla! + 4.2.3 announcement +- Joomla! + 4.2.2 announcement +- Joomla! + 4.2.1 announcement +- Joomla! + 4.2.0 announcement + +#### Version 4.1.x + +- Joomla! + 4.1.5 announcement +- Joomla! + 4.1.4 announcement +- Joomla! + 4.1.3 announcement +- Joomla! + 4.1.2 announcement +- Joomla! + 4.1.1 announcement +- Joomla! + 4.1.0 announcement + +#### Version 4.0.x + +- Joomla! + 4.0.6 announcement +- Joomla! + 4.0.5 announcement +- Joomla! + 4.0.4 announcement +- Joomla! + 4.0.3 announcement +- Joomla! + 4.0.2 announcement +- Joomla! + 4.0.1 announcement +- Joomla! + 4.0.0 announcement + +## Frequently Asked Questions + +#### Version 4.2.x + +For known issues specific to a 4.2.x version, together with suggested +resolutions. + +- [Version 4.2.6 + FAQ](https://docs.joomla.org/:Category:Version_4.2.6_FAQ "Special:MyLanguage/:Category:Version 4.2.6 FAQ") +- [Version 4.2.5 + FAQ](https://docs.joomla.org/:Category:Version_4.2.5_FAQ "Special:MyLanguage/:Category:Version 4.2.5 FAQ") +- [Version 4.2.4 + FAQ](https://docs.joomla.org/:Category:Version_4.2.4_FAQ "Special:MyLanguage/:Category:Version 4.2.4 FAQ") +- [Version 4.2.3 + FAQ](https://docs.joomla.org/:Category:Version_4.2.3_FAQ "Special:MyLanguage/:Category:Version 4.2.3 FAQ") +- [Version 4.2.2 + FAQ](https://docs.joomla.org/:Category:Version_4.2.2_FAQ "Special:MyLanguage/:Category:Version 4.2.2 FAQ") +- [Version 4.2.1 + FAQ](https://docs.joomla.org/:Category:Version_4.2.1_FAQ "Special:MyLanguage/:Category:Version 4.2.1 FAQ") +- [Version 4.2.0 + FAQ](https://docs.joomla.org/:Category:Version_4.2.0_FAQ "Special:MyLanguage/:Category:Version 4.2.0 FAQ") + +#### Version 4.1.x + +For known issues specific to a 4.1.x version, together with suggested +resolutions. + +- [Version 4.1.2 + FAQ](https://docs.joomla.org/:Category:Version_4.1.2_FAQ "Special:MyLanguage/:Category:Version 4.1.2 FAQ") +- [Version 4.1.1 + FAQ](https://docs.joomla.org/:Category:Version_4.1.1_FAQ "Special:MyLanguage/:Category:Version 4.1.1 FAQ") +- [Version 4.1.0 + FAQ](https://docs.joomla.org/:Category:Version_4.1.0_FAQ "Special:MyLanguage/:Category:Version 4.1.0 FAQ") + +#### Version 4.0.x + +For known issues specific to a 4.0.x version, together with suggested +resolutions. + +- [Version 4.0.6 + FAQ](https://docs.joomla.org/:Category:Version_4.0.6_FAQ "Special:MyLanguage/:Category:Version 4.0.6 FAQ") +- [Version 4.0.5 + FAQ](https://docs.joomla.org/:Category:Version_4.0.5_FAQ "Special:MyLanguage/:Category:Version 4.0.5 FAQ") +- [Version 4.0.4 + FAQ](https://docs.joomla.org/:Category:Version_4.0.4_FAQ "Special:MyLanguage/:Category:Version 4.0.4 FAQ") +- [Version 4.0.3 + FAQ](https://docs.joomla.org/:Category:Version_4.0.3_FAQ "Special:MyLanguage/:Category:Version 4.0.3 FAQ") +- [Version 4.0.2 + FAQ](https://docs.joomla.org/:Category:Version_4.0.2_FAQ "Special:MyLanguage/:Category:Version 4.0.2 FAQ") +- [Version 4.0.1 + FAQ](https://docs.joomla.org/:Category:Version_4.0.1_FAQ "Special:MyLanguage/:Category:Version 4.0.1 FAQ") +- [Version 4.0.0 + FAQ](https://docs.joomla.org/:Category:Version_4.0.0_FAQ "Special:MyLanguage/:Category:Version 4.0.0 FAQ") diff --git a/manuals/help/languages/languages-content.md b/manuals/help/languages/languages-content.md new file mode 100644 index 0000000..c97c62e --- /dev/null +++ b/manuals/help/languages/languages-content.md @@ -0,0 +1,204 @@ +--- +sidebar_position: 1 +id: languages-content +title: "Help4.x:Languages: Content" +--- +## Description + +Set the Native Title, Language Code, SEF Prefix and Image Prefixes of +the installed or to be installed languages. These are used when you set +your site as multilanguage. See the [Language Switcher +Tutorial](https://docs.joomla.org/J3.x:Setup_a_Multilingual_Site/en "J3.x:Setup a Multilingual Site/en"). + +## How to Access + +- Select **System **→** Manage Panel **→** Content Languages** from the + Administrator menu. + +## Screenshot + + + +## Column Headers + +Click on the column heading to sort the list by that column's value. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Ordering:** (default). The column in which to sort displayed items + in the table. The values are the same as the column heading names. + + + +- **Status**. The published status of the item. +- **Title.** The names of the installed Languages on this web site. +- **Native Title.** Language title in the native language. +- **Language Tag.** The language tag - example: en-GB for English (UK). + This should be the exact prefix used for the language installed or to + be installed. +- **URL Language Code.** The language code used in multilingual site + URLs. +- **Image.** Name of the image file for this language when using the + "Use Image Flags" Language Switcher basic option. Example: If 'en' is + chosen, then the image shall be en.gif. Images and CSS for this module + are in media/mod_languages/ + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. +- **Home.** Whether there is a default page set for this language or + not. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +**Filter Options** + +- **Select State.** Use the drop-down list box to select: Read, Unread + or Trashed. Only languages with this state will show on the list. +- **Select Access.** Use the drop-down list box to select: Public, + Guest, Registered, Special or Super Users. Only languages with this + state will show on the list. + +**Automatic Pagination** + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new item. + + + +- **Actions:** Reveals a list of actions for selected Items. Check one + or more Item checkboxes to activate the list. + + + +- **Publish**. Makes the selected items available to visitors to your + website. + + + +- **Unpublish.** Makes the selected items unavailable to visitors to + your website. + + + +- **Trash**. Changes the status of the selected items to indicate that + they are trashed.Trashed items can still be recovered by selecting + 'Trashed' in the 'Select Status' filter and changing the status of the + articles to Published or Unpublished as preferred.To permanently + delete trashed items, select 'Trashed' in the 'Select Status' filter, + select the items to be permanently deleted, then click the 'Empty + Trash' toolbar icon. + + + +- **Install Languages.** Links to the [Install Languages + Screen](https://docs.joomla.org/Help4.x:Extensions_Extension_Manager_Languages/en "Help4.x:Extensions Extension Manager Languages/en"). + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- Users can use any Language from the list of installed Languages, + either by having it assigned in the [Users + list](https://docs.joomla.org/Help4.x:Users/en "Help4.x:Users/en") or + by filling out a [Menu Items - New/Edit - User Form + Layout](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#User_Form_Layout.2F "Help4.x:Menu Item: New Item/en") + at the Front end. This will cause the Joomla! system prompts to be + generated in this Language just for this User. For example, if a User + chooses Spanish as their language, then the Search Module will show + with prompts in Spanish. +- This User's choice is not affected by the Default Language set for the + Front-end. + + + +- Changing a User's Language or the Default Language does not affect the + web site's Articles and other content. + + + +- **Important**: Do not delete the default language files (for example, + with FTP). This will create errors on both the Front-end and Back-end. +- Additional Languages can be added using the [Install Languages + Screen](https://docs.joomla.org/Help4.x:Extensions_Extension_Manager_Languages/en "Help4.x:Extensions Extension Manager Languages/en"). +- If desired, you can show the Front-end site in one Language and show + the Back-end administration pages in a different Language. Also, + individual articles can be configured to use a different language in + the Advanced Parameter pane when editing the Article. + +## Related Information + +- To install more Languages: [Install Languages + Screen](https://docs.joomla.org/Help4.x:Extensions_Extension_Manager_Languages/en "Help4.x:Extensions Extension Manager Languages/en") +- To uninstall a Language: [Extensions - + Manage](https://docs.joomla.org/Help4.x:Extensions:_Manage/en "Help4.x:Extensions: Manage/en") +- To change the Language for a User: [Users list - + New/Edit](https://docs.joomla.org/Help4.x:Users:_Edit_Profile/en "Help4.x:Users: Edit Profile/en") +- To set the Language of an Article: [Articles list - New/Edit - + Parameters - + Advanced](https://docs.joomla.org/Help4.x:Articles:_Edit/en#Parameters_-_Advanced "Help4.x:Articles: Edit/en") diff --git a/manuals/help/languages/languages-edit-content-language.md b/manuals/help/languages/languages-edit-content-language.md new file mode 100644 index 0000000..e78a9b7 --- /dev/null +++ b/manuals/help/languages/languages-edit-content-language.md @@ -0,0 +1,149 @@ +--- +sidebar_position: 2 +id: languages-edit-content-language +title: "Help4.x:Languages: Edit Content Language" +--- +This Page Needs Your Help + +*This page is tagged because it* **NEEDS COMPLETION***. You can help the +Joomla! Documentation Wiki by contributing to it. +More pages that need help similar to this one are +[here](https://docs.joomla.org/Category:Needs_completion "Category:Needs completion"). +**NOTE-If you feel the need is satistified, please +remove this notice.*** +**Reason:** The section "Options Tab" needs more information + +## Description + +In the Languages: Edit Content Language you can set the title, SEF, +image, code, and description of an installed langauges. You may also +update or add meta keywords and a description. + +## How to Access + +- Select **System **→** Manage Panel **→** Content Languages** from the + Administrator menu. Then... + - Select the language name link from the **Title** columne. + +## Screenshot + + + +## Form Fields + +### Details Tab + +- **Title.** The name of the language as it will appear in the lists. +- **Title in Native Language.** Language title in the native language. +- **Language Tag.** Enter the language tag – example: en-GB for + English (en-GB). This should be the exact prefix used for the language + installed or to be installed. +- **URL Language Code.** Language Code for this language. This Language + Code will be included in the site URL. Note the Language Code must be + unique among all the languages. +- **Image.** Select from the available images for this language when + using the "Use Image Flags" Language Switcher basic option. +- **Status.** Available options are Published, Unpublished, Trashed. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. +- **Description.** Enter a discription for the language + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +### Options Tab + + + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- Users can use any Language from the list of installed Languages, + either by having it assigned in the + [Users](https://docs.joomla.org/Help4.x:Users/en "Help4.x:Users/en") + or by filling out a [Menu Items list - New/Edit - User Form + Layout](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#User_Form_Layout "Help4.x:Menu Item: New Item/en") + at the Front end. This will cause the Joomla! system prompts to be + generated in this Language just for this User. For example, if a User + chooses Spanish as their language, then the Search Module will show + with prompts in Spanish. +- This User's choice is not affected by the Default Language set for the + Front-end. + + + +- Changing a User's Language or the Default Language does not affect the + web site's Articles and other content. + + + +- **Important**: Do not delete the default language files (for example, + with FTP). This will create errors on both the Front-end and Back-end. +- Additional Languages can be added using the [Extensions - Install + Screen](https://docs.joomla.org/Help4.x:Extensions:_Install/en "Help4.x:Extensions: Install/en"). +- If desired, you can show the Front-end site in one Language and show + the Back-end administration pages in a different Language. Also, + individual articles can be configured to use a different language in + the Advanced Parameter pane when editing the Article. + +## Related Information + +- To install more Languages: [Extensions - Install + Screen](https://docs.joomla.org/Help4.x:Extensions:_Install/en "Help4.x:Extensions: Install/en") +- To uninstall a Language: [Extensions - + Manage](https://docs.joomla.org/Help4.x:Extensions:_Manage/en "Help4.x:Extensions: Manage/en") +- To change the Language for a User: [Users list - + New/Edit](https://docs.joomla.org/Help4.x:Users:_Edit_Profile/en "Help4.x:Users: Edit Profile/en") +- To set the Language of an Article: [Articles - New/Edit - Parameters - + Advanced](https://docs.joomla.org/Help4.x:Articles:_Edit/en#Parameters_-_Advanced "Help4.x:Articles: Edit/en") diff --git a/manuals/help/languages/languages-edit-override.md b/manuals/help/languages/languages-edit-override.md new file mode 100644 index 0000000..21e8059 --- /dev/null +++ b/manuals/help/languages/languages-edit-override.md @@ -0,0 +1,93 @@ +--- +sidebar_position: 3 +id: languages-edit-override +title: "Help4.x:Languages: Edit Override" +--- +## Description + +Overrides allow you to change a core Joomla string. + +In the Joomla code, text strings that are to appear in the User +Interface, either the Site interface or the Administrator interface, are +expressed as string constants. For example, the string *Your session has +expired. Please log in again.* is expressed as +*JLIB_ENVIRONMENT_SESSION_EXPIRED*. The text string can be translated +into any language. The default language is British English. There are +thousands of such strings in a Joomla installation. + +If a string does not suit your site you can use the Language Override +feature to replace the original. + +## How to Access + +- Select **System **→** Manage Panel **→** Language Overrides**. Then... + - Select a **Language and Client** from the drop down list. Then... + - Select the **New** button in the Toolbar to create a new override. + Or... + - Select the constant link in the **Constant** column to edit an + existing override. + +## Screenshot + + + +## Form Fields + +**Right Panel: Search text you want to change** + +- **Search For.** Start here! You are more likely to know the Value + (expired) than the Constant (\_EXPIRED). In either case, the search is + a case insensitive for the partial string. +- **Search Text.** Enter the text to search for and select the + **Search** button. +- **Search Results.** A list of strings containing the search term + appears in a separate panel. Select the one you are looking for. The + constant and text will be copied into the **Create a New Override** + panel, labelled **Edit this Override** if you editing an existing + override. + +**Left Panel: Create a New Override or Edit this Override** + +- **Language Constant.** This is the strings used in the code by the + developer. If the value does not exist in the code the string will + never be used. +- **Text.** This is where you override the default term with your + version. +- **File.** This shows where the override file is located in the file + system. You might need to know this for trouble-shooting. + +## Toolbar + +Near the top of the page you will see the filter bar shown in the +Screenshot above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/languages/languages-installed.md b/manuals/help/languages/languages-installed.md new file mode 100644 index 0000000..e12d2f2 --- /dev/null +++ b/manuals/help/languages/languages-installed.md @@ -0,0 +1,172 @@ +--- +sidebar_position: 4 +id: languages-installed +title: "Help4.x:Languages: Installed" +--- +## Description + +In the Installed Languages list you can set the default Languages +independently for the Site and Administrator interfaces. + +## How to Access + +- Select **System **→** Manage Panel **→** Languages** from the + Administrator menu. + +## Screenshot + + + +## Column Headers + +Click on the column heading to sort the list by that column's value. + +- **Radio Buttons.** Select a radio button to make the selected language + the Default Site and/or Administrator language. +- **Title.** The name of the language in English. +- **Native Title.** The name of the language in that language. +- **Language Tag.** Language Tag of the Installed Language. +- **Default.** The default language of the site, marked with a yellow + graphical asterisk in this column. *Note*: to every user a language + can be assigned (see "User Management"), user from groups + "Administrator" and "Super Administrator" can select their preferred + language themselves at login. +- **Version.** The version number of the installed language. +- **Date.** The creation date of the language. +- **Author.** The name of the language translator is displayed in this + column. +- **Author Email.** The email address of the translator. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +**Filter by Site or Administrator** + +- **Site.** Shows the installed Languages for the Frontend part. Here + you can set the default language for the Frontend of your Joomla + website. +- **Administrator.** Shows the installed Languages for the Backend part. + Here you can set the default language for the Backend of your Joomla + website. + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +**Filter Options.** This screen has no Filter Options + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Default:** Makes the selected item the default item. The default + star symbol + (Icon-16-default.png) will show in the Default + column, indicating that this is now the default item. +- **Switch Languages.** In the Administrator screen only, select a + language radio button and then this button. The Administrator language + will change and there will be a message such as *Message La langue de + l'administration a été changée en "French (France)"*. + + + +- **Install Languages.** Links to the [Install Languages + Screen](https://docs.joomla.org/Help4.x:Extensions_Extension_Manager_Languages/en "Help4.x:Extensions Extension Manager Languages/en"). + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- Users can use any Language from the list of installed Languages, + either by having it assigned in the [Users + list](https://docs.joomla.org/Help4.x:Users/en "Help4.x:Users/en") or + by filling out a [Menu Item list - New/Edit - User Form + Layout](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#User_Form_Layout "Help4.x:Menu Item: New Item/en") + at the Frontend. This will cause the Joomla! system prompts to be + generated in this Language just for this User. For example, if a User + chooses Spanish as their language, then the Search Module will show + with prompts in Spanish. +- This User's choice is not affected by the Default Language set for the + Frontend. + + + +- Changing a User's Language or the Default Language does not affect the + website's Articles and other content. + + + +- **Important**: Do not delete the default language files (for example, + with FTP). This will create errors on both the Frontend and Backend. +- Additional Languages can be added using the [Install Languages + Screen](https://docs.joomla.org/Help4.x:Extensions_Extension_Manager_Languages/en "Help4.x:Extensions Extension Manager Languages/en"). +- If desired, you can show the Frontend site in one Language and show + the Backend administration pages in a different Language. Also, + individual articles can be configured to use a different language in + the Advanced Parameter pane when editing the Article. + +## Related Information + +- To install more Languages: [Install Languages + Screen](https://docs.joomla.org/Help4.x:Extensions_Extension_Manager_Languages/en "Help4.x:Extensions Extension Manager Languages/en"). +- To uninstall a Language: [Extensions - + Manage](https://docs.joomla.org/Help4.x:Extensions:_Manage/en "Help4.x:Extensions: Manage/en") +- To change the Language for a User: [Users - + New/Edit](https://docs.joomla.org/Help4.x:Users:_Edit_Profile/en "Help4.x:Users: Edit Profile/en") +- To set the Language of an Article: [Articles - New/Edit - Parameters - + Advanced](https://docs.joomla.org/Help4.x:Articles:_Edit/en#Parameters_-_Advanced "Help4.x:Articles: Edit/en") diff --git a/manuals/help/languages/languages-options.md b/manuals/help/languages/languages-options.md new file mode 100644 index 0000000..d838c71 --- /dev/null +++ b/manuals/help/languages/languages-options.md @@ -0,0 +1,76 @@ +--- +sidebar_position: 5 +id: languages-options +title: "Help4.x:Languages: Options" +--- +## Description + +Languages Options configuration allows setting of parameters used +globally for Languages. + +## How to Access + +- Select **System **→** Languages in the Manage panel** from the + Administration menu. **Beware:** Languages also occurs in the Install + panel. Then + - **Select** the Options button in the Toolbar. + +## Screenshot + + + +## Form Fields + +### Permissions Tab + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Optons.** Users can edit the options and + permissions of this extension. + - **Configure Options Only.** Users can edit the options except the + permissions of this extension. + - **Access Administration Interface.** Users can access user + administration interface of this extension. + - **Create.** Users can create content of this extension. + - **Delete.** Users can delete content of this extension. + - **Edit.** Users can edit content of this extension. + - **Edit State.** User can change the published state and related + information for content of this extension. + - **Edit Own.** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/languages/languages-overrides.md b/manuals/help/languages/languages-overrides.md new file mode 100644 index 0000000..8b07bb0 --- /dev/null +++ b/manuals/help/languages/languages-overrides.md @@ -0,0 +1,114 @@ +--- +sidebar_position: 6 +id: languages-overrides +title: "Help4.x:Languages: Overrides" +--- +## Description + +Overrides allow you to change a core Joomla string. + +In the Joomla code, text strings that are to appear in the User +Interface, either the Site interface or the Administrator interface, are +expressed as string constants. For example, the string *Your session has +expired. Please log in again.* is expressed as +*JLIB_ENVIRONMENT_SESSION_EXPIRED*. The text string can be translated +into any language. The default language is British English. There are +thousands of such strings in a Joomla installation. + +If a string does not suit your site you can use the Language Override +feature to replace the original. + +## How to Access + +- Select **System **→** Manage Panel **→** Language Overrides** + +## Screenshot + + + +## Column Headers + +Click on the column heading to sort the list by that column's value. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. +- **Constant.** The constant in the code created by the developer. +- **Text.** The text substituted for the constant in the override. + Select the constant link to edit this item. +- **Language Tag.** The language that this override is used for. +- **Location.** Site or Administrator. + +## List Filters + +**Language Selector** + +- **Select Language and Client.** The drop down list shows languages + installed for Site and Administrator interfaces. + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Special:MyLanguage/Help4.x:Site Global Configuration/en"). + +**Filter Options** + +- This list has no filter options + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new item. + + + +- **Delete:** Deletes the selected items. Works with one or multiple + items selected. + + + +- **Clear Cache.** Clear the available extension update information + displayed in the listing. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +## Related Information + +[Layout Overrides in Joomla +3](https://docs.joomla.org/J3.x:Language_Overrides_in_Joomla/en "J3.x:Language Overrides in Joomla/en") diff --git a/manuals/help/mail/mail-template-edit.md b/manuals/help/mail/mail-template-edit.md new file mode 100644 index 0000000..f69843f --- /dev/null +++ b/manuals/help/mail/mail-template-edit.md @@ -0,0 +1,54 @@ +--- +sidebar_position: 1 +id: mail-template-edit +title: "Help4.x:Mail Template: Edit" +--- +## Description + +The Mail Template Edit form allows you to change the default text for +the Subject, Body and/or HTML Body. + +## How to Access + +- Select **System **→** Templates panel **→** Mail Templates** from the + Administrator menu. Then... + - Select the Title of the template you wish to edit. Select the + language version you wish to edit from the pop-up list. + +## Screenshot + + + +## Form Fields + +### Mail Tab + +- **Subject.** This displays a string key if the adjacent Edit Subject + toggle is set to **No**. If set to **Yes** the subject contains the + default text for you to change. {SITENAME} is a placeholder that + should not be changed. +- **Body.** Set the adjacent Edit Body toggle to see and edit the + default plain text message. +- **HTML.** Set the adjacent Edit HTML Body toggle to see and edit the + default HTML message. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. diff --git a/manuals/help/mail/mail-templates-options.md b/manuals/help/mail/mail-templates-options.md new file mode 100644 index 0000000..6414a6e --- /dev/null +++ b/manuals/help/mail/mail-templates-options.md @@ -0,0 +1,86 @@ +--- +sidebar_position: 3 +id: mail-templates-options +title: "Help4.x:Mail Templates: Options" +--- +## Description + +Mail Templates: Options sets global parameters used for all system +emails. + +## How to Access + +- Select **System **→** Mail Templates in the Templates panel** from the + Administrator menu. Then ... + - **Select** the Options button in the Toolbar. + +## Screenshot + + + +## Form Fields + +### Mail Tab + +- **Mail Format.** Select whether to send emails in Plaintext, HTML or + Both formats. +- **Per Template Mail Settings.** Select whether to allow each template + to select settings. +- **Send Copy.** Select whether to end a copy to ... who? +- **Attachments Folder.** Provide a relative path to the root of your + installation for the folder with static attachments that you want to + attach to the mails. + +### Permissions Tab + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Optons.** Users can edit the options and + permissions of this extension. + - **Configure Options Only.** Users can edit the options except the + permissions of this extension. + - **Access Administration Interface.** Users can access user + administration interface of this extension. + - **Create.** Users can create content of this extension. + - **Delete.** Users can delete content of this extension. + - **Edit.** Users can edit content of this extension. + - **Edit State.** User can change the published state and related + information for content of this extension. + - **Edit Own.** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/mail/mail-templates.md b/manuals/help/mail/mail-templates.md new file mode 100644 index 0000000..919da9e --- /dev/null +++ b/manuals/help/mail/mail-templates.md @@ -0,0 +1,88 @@ +--- +sidebar_position: 2 +id: mail-templates +title: "Help4.x:Mail Templates" +--- +## Description + +Mail Templates are used to adjust the layout of various system email +messages. + +## How to Access + +- Select **System **→** Templates panel **→** Mail Templates** from the + Administrator menu. + +## Screenshot + +Help-4x-Mail-Templates-screen-en.png + +## Column Headers + +In the table containing Mail Templates, these are the different columns: + +- **Title.** The name of the template. +- **Component.** The component where this template is used. +- **Templates.** Flags in this column indicate languages for which a + custom email template has been created. +- **No Templates.** Flags in this column indicate languages for which a + custom email template has not been created. +- **Description.** Brief description of the template. +- **ID.** Template ID name. This is the template_id of the mail + template's record in the \#\_mail_templates table in the database. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +### Filter Options + +- **Select Language**. Select from the list of available languages, if + the site manages more than 1 language. + +**Filter by Component.** Select from the list of components that may +send emails. + +### Pagination + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/mail/maintenance-clear-cache.md b/manuals/help/mail/maintenance-clear-cache.md new file mode 100644 index 0000000..96b79c2 --- /dev/null +++ b/manuals/help/mail/maintenance-clear-cache.md @@ -0,0 +1,140 @@ +--- +sidebar_position: 4 +id: maintenance-clear-cache +title: "Help4.x:Maintenance: Clear Cache" +--- +## Description + +Clears cache files from the cache folders if enabled under the [Site +Global +Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#Cache_Settings "Help4.x:Site Global Configuration/en") +settings. + +Cache files are temporary files that are created to improve the +performance of your site. If you have made significant changes to your +web site, such as changing your Template or Language, your cache files +may be out of date. To avoid any problems caused by out of date cache +files, you can delete all of the cache files. After deletion of *all* +Cache files the website may be a little slower until the cache files are +re-created with use. + +## How to Access + +- Select **System **→** Maintenance Panel **→** Clear Cache** from the + Administrator menu. + +## Screenshot + + + +## Column Headers + +- **\#**. An indexing number automatically assigned by Joomla! for ease + of reference. + + + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Cache Group**. The type of item being cached in this file. This is + also the name of the subdirectory where this type of cache file is + stored. The cache files are stored in the directory + "\/cache/\". + + + +- **Number of Files**. The number of files currently in this cache + group. + + + +- **Size**. The total size, in KB, of the cache files in this group. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Special:MyLanguage/Help4.x:Site Global Configuration/en"). + +**Filter Options** + +- **None.** This screen has no Filter Options. + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Delete:** Deletes the selected items. Works with one or multiple + items selected. + + + +- **Delete All:** Deletes all the items. Works with all items. + + + +- **Clear Expired Cache**. Deletes all expired cache files. Cache files + that are still current will not be deleted. WARNING: This operation + can be resource intensive on sites with a large number of items. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- Normally you want to delete all cache files. To do this, click the + check box in the column heading to select all files and then click the + Delete icon in the toolbar. + +## Related Information + +- To change the cache settings for your site: [Global Configuration - + Cache + Settings](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en "Help4.x:Site Global Configuration/en") diff --git a/manuals/help/mail/maintenance-global-check-in.md b/manuals/help/mail/maintenance-global-check-in.md new file mode 100644 index 0000000..7d7f61f --- /dev/null +++ b/manuals/help/mail/maintenance-global-check-in.md @@ -0,0 +1,99 @@ +--- +sidebar_position: 5 +id: maintenance-global-check-in +title: "Help4.x:Maintenance: Global Check-in" +--- +## Description + +Allows Administrators to perform a global check-in of all currently +pending or locked items. It then shows the results of the Global +Check-in. This is useful, for example, if an Article is locked by a User +who opened it for editing and never finished the editing session. In +this case, other Users are not able to edit this Article. Performing a +Global Check-in releases all such items. + +## How to access + +- Select **System **→** Maintenance Panel **→** Global Check-in** from + the Administrator menu. + +## Screenshot + + + +## Column Headers + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Database Table**. The name of the table checked. + + + +- **Items to check-in**. Items that need to be checked-in. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Special:MyLanguage/Help4.x:Site Global Configuration/en"). + +**Filter Options** + +- **None.** This screen has no filter options. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Check-In**. Checks-in the selected items. Works with one or multiple + items selected. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- Make sure no one is busy editing any items before you perform a global + check-in. When a Global Check-in is done, *all* items are checked in, + including those currently being edited. + +## Related Information + +- To see all logged in users: + [Users](https://docs.joomla.org/Help4.x:Users/en "Help4.x:Users/en") diff --git a/manuals/help/mail/mass-mail-users.md b/manuals/help/mail/mass-mail-users.md new file mode 100644 index 0000000..543a96a --- /dev/null +++ b/manuals/help/mail/mass-mail-users.md @@ -0,0 +1,215 @@ +--- +sidebar_position: 6 +id: mass-mail-users +title: "Help4.x:Mass Mail Users" +--- +## Description + +The Mass Mail screen allows Users who are members of the "Super +Administrator" group to send an email message to registered users for +the site. Users can be selected based on groups. + +## How to access + +Select **Users **→** Mass Mail Users** from the Administrator menu. + +## Screenshot + +Help-4x-users-mass-mail-en.png + +## Details and Message + +- **Mail to Child Groups.** Whether or not to send the Email to members + of all child groups of the selected group. For example, if this box is + checked and the "Public" group is selected, the email would be sent to + all users, since all groups are child groups of "Public". +- **Send in HTML mode.** Whether or not to send the Email with headers + that identify it as an HTML document. Email clients that support this + will render any HTML codes. +- **Send to Disabled Users.** If checked, disabled users will be + included when sending mail. +- **Recipients as BCC.** If checked, all recipients will be included as + BCC entries, so none will see any of the other recipients' Email + addresses. Because many mail routers treat Email without a *To:* entry + as spam, the site email will be used for the *To:* entry. +- **Group.** Select the groups you want to send the Email to. +- **Subject** Enter the Subject of the Email. Try to make it as + descriptive as possible. Any text entered in the *Subject Prefix* + parameter in Options ([User Options → Mass + Mail](https://docs.joomla.org/Help4.x:Users:_Options/en#Mass_Email "Help4.x:Users: Options/en")) + will be placed in front of the subject you enter here. +- **Message.** Enter the body of the Email. Any text entered in the + *Mailbody Suffix* parameter in Options ([User Options → Mass + Mail](https://docs.joomla.org/Help4.x:Users:_Options/en#Mass_Email "Help4.x:Users: Options/en")) + will be added to the text you enter here. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Send email**. Send the email and return to the main Mass Mail screen + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- To just send a private message to a user, see more on how to write a + [Private + Message](https://docs.joomla.org/Help4.x:Private_Messages:_Write/en "Help4.x:Private Messages: Write/en") + to a user. + +## Related Information + +### Administrative User Tasks + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Related Help ScreensDescription
Users: Options
Users: Viewing +Access_LevelsIn this screen you have the ability to look at a list of your Access +Levels and sort them in different ways. You can also edit and create +Access Levels.
Users: Edit Viewing +Access LevelAccess levels control which users can view which objects on your +site. Objects include menu items, modules, categories, and component +items (articles, contacts, and so on). Each object in the site is +assigned to one access level. User groups are also assigned to each +access level. +

If a user is a member of a group that in turn has permission for an +access level, then that user can view all objects assigned to that +access level. It is important to understand that user groups can be +arranged in a parent-child hierarchy. If so, then a child group has +access to all access levels that the parent group has access to. So you +don't need to assign a child group access to levels that its parent +group already has access to.

Permissions for GroupThe Debug Permissions report maps out the exact permissions for any +given user group across all assets on your Joomla! installation.
Permissions for UserThe Debug Permissions report allows you to map out the exact +permissions for any given user across all extensions on your Joomla +installation.
Users: GroupsUser Groups control what actions a user may take on the site and +which objects a user can view. This screen allows you to create, view, +edit, and delete User Groups.
Users: New or Edit +GroupUser groups play a central role in what a user can do and see on the +site. Creating user groups is normally the first step in setting up the +security system for your site.
Users: UserIn this screen you have the ability to look at a list of your users +and sort them in different ways. You can also edit and create users, +groups and access levels.
Users: Edit ProfileIn this screen, you have the ability to create a new user (if you +clicked on the 'New' button in the User Manager), or edit an existing +user (if you selected a user and clicked on the 'Edit' button in the +User Manager, or clicked on the name of a user).
User Notes: +CategoriesThis screen allows you to look at a list of your user note +categories and sort them in different ways. You can also edit and create +user note categories and access levels.
User_Notes: New or +Edit CategoryThis is where you can add a new Category or edit an existing +Category. Categories are used to organize the User Notes. Categories +allow you to display related User notes together on a page and to filter +User Notes in the User Notes Manager. All User Notes are assigned either +to a Category that you create or to the special Category called +'Uncategorized'.
User NotesUser notes are pieces of information which can be assigned to +registered users on your Joomla! site. These notes can contain for +example comments about 'offending' or 'difficult' users etc.
User Notes: New or +EditUser notes are pieces of information which can be assigned to +registered users on your Joomla! site. These notes can contain for +example comments about 'offending' or 'difficult' users etc. +

In this screen you can create an user note or edit an user note. The +'editor' will be the chosen 'editor' for the user editing the note. +Examples: TinyMCE - JCE - Codemirror.

+ +### Front End User Interaction + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Menu Item: Login Form](https://docs.joomla.org/Help4.x:Menu_Item:_Login_Form/en "Help4.x:Menu Item: Login Form/en") | Used to create a 'User Login Form' page for users to login to the website. | +| [Menu Item: Password Reset](https://docs.joomla.org/Help4.x:Menu_Item:_Password_Reset/en "Help4.x:Menu Item: Password Reset/en") | Used to create a form which allows a user to reset their password with an email sent to the user's email associated with the account. | +| [Menu Item: User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_User_Profile/en "Help4.x:Menu Item: User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Edit User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_Edit_User_Profile/en "Help4.x:Menu Item: Edit User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Registration Form](https://docs.joomla.org/Help4.x:Menu_Item:_Registration_Form/en "Help4.x:Menu Item: Registration Form/en") | Used to create a default User Registration form for user registration. Default form contains basic information: Name, Username, Password, and Email Address. | +| [Menu Item: Username Reminder Request](https://docs.joomla.org/Help4.x:Menu_Item:_Username_Reminder_Request/en "Help4.x:Menu Item: Username Reminder Request/en") | Used to create a form which allows a user to request an e-mail with their username. | diff --git a/manuals/help/media/media-options.md b/manuals/help/media/media-options.md new file mode 100644 index 0000000..cb83507 --- /dev/null +++ b/manuals/help/media/media-options.md @@ -0,0 +1,132 @@ +--- +sidebar_position: 2 +id: media-options +title: "Help4.x:Media: Options" +--- +## Description + +Media Options configuration allows setting of parameters used globally +for Media. Control the file types allowed for uploading, MIME type +check, MIME type blacklisting, and more options. + +## How to Access + +**Content **→** Media** + +- click the **Options** toolbar button + +## Screenshot + + + +## Form Fields + +### Media + +- **Maximum Size (in MB)**. Use zero for no limit. Note: The server has + a maximum limit. +- **Path to Files Folder**. Enter the path to the files folder relative + to the root of your webspace.Changing to another path than the default + 'images' may break your links. Do not start the path with a slash. +- **Path to Images Folder**. Enter the path to the images folder + relative to the root of your webspace.This path has to be the same as + path to files (default) or to a subfolder of the path to file folder. + Do not start the path with a slash. +- **Restrict Uploads**. Restrict uploads for lower than manager users to + images if 'Fileinfo' or 'MIME Magic' isn't installed. + - **Allowed Extensions**. Restrict uploads for lower than manager + users to files in the list. + - **Check MIME Types**. Use 'Fileinfo' or 'MIME Magic' to attempt to + verify files. Try disabling this if you get invalid mime type + errors. +- **Legal Image Extensions (File Types)**. Image extensions (file types) + you are allowed to upload (comma separated). These are used to check + for valid image headers and to select images with the [Media form + field](https://docs.joomla.org/Media_form_field_type "Media form field type"). +- **Legal Audio Extensions (File Types)**. Audio extensions (file types) + you are allowed to upload (comma separated). These are used to check + for valid audio headers and to select audio files with the [Media form + field](https://docs.joomla.org/Media_form_field_type "Media form field type"). +- **Legal Video Extensions (File Types)**. Video extensions (file types) + you are allowed to upload (comma separated). These are used to check + for valid video headers and to select videos with the [Media form + field](https://docs.joomla.org/Media_form_field_type "Media form field type"). +- **Legal Document Extensions (File Types)**. Document extensions (file + types) you are allowed to upload (comma separated). These are used to + check for valid document headers and to select documents with the + [Media form + field](https://docs.joomla.org/Media_form_field_type "Media form field type"). +- **Ignored Extensions**. Ignored file extensions for MIME type checking + and restricted uploads. +- **Legal MIME Types.** A comma separated list of legal MIME types to + upload. + +### Permissions + +This section lets you set up the default [Access Control +List](https://docs.joomla.org/Access_Control_List/en "Access Control List/en") +permissions for all media. + + + +To change the permissions for media, do the following. + +1. Select the **Group** by clicking its title located on the left. +2. Find the desired **Action**. + - **Configure ACL & Options**. Users can edit the options and + permissions. + - **Configure Options Only**. Users can edit the options exept the + permissions. + - **Access Administration Interface**. Users can access user + administration interface. + - **Create**. Users can create media. + - **Delete**. Users can delete media. + - **Edit**. Users can edit media. +3. Select the desired permission for the action you wish to change. + - **Inherited**. Inherited for users in this Group from the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#permissions "Help4.x:Site Global Configuration/en") + permissions. + - **Allowed**. Allowed for users in this Group. Note: 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 + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **Save**. Saves the Media options and stays in the current screen. +- **Save & Close**. Saves the Media options and closes the current + screen. +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. +- **Toggle Inline Help**. Show help text below some options. +- **Help**. Opens this help screen. + +## Quick Tips + +- If you are a beginning user, you can just keep the default values here + until you learn more about using global options. +- If you are an advanced user, you can save time by creating good + default values here. + +## Related Information + +- Related Help screen: + [Media](https://docs.joomla.org/Help4.x:Media/en "Help4.x:Media/en"). +- Tutorial: [Managing + Media](https://docs.joomla.org/J4.x:Managing_Media/en "J4.x:Managing Media/en"). diff --git a/manuals/help/media/media.md b/manuals/help/media/media.md new file mode 100644 index 0000000..996ec97 --- /dev/null +++ b/manuals/help/media/media.md @@ -0,0 +1,118 @@ +--- +sidebar_position: 1 +id: media +title: "Help4.x:Media" +--- +## Description + +The Media Manager is a tool for managing files in the +\[joomlaroot\]https://docs.joomla.org/images/ folder and other user +defined local folders. Tools available include: + +- upload a new image (or document) +- delete an existing image +- rename an image +- edit an image +- get an image link +- create a new folder. + +## How to access + +- **Home Dashboard **→** Site **→** Media**. + +## Screenshot + + + +## Image Display Area + +### Local + +This area shows the structure of the local folders of your site, by +default the **images** folder. [Quick Tip](#quicktips) + +The currently selected folder is also shown in the **Breadcrumbs** above +the image display area. + +### Top Bar + +- **Checkbox**. Select/Deselect All Images. After selection you can + deselect individual images. +- **Breadcrumbs**. Select a breadcrumb item to go back in the folder + hierarchy. +- **Search**. Type some part of an image name in the search box. The + filter works progressively - for example, entering the letter "k" in + the search box will instantly reduce the displayed images to those + containing a letter "k". +- **Magnifier Icons**. Decrease/Increase the visible size of the + thumbnail images. +- **List View/Thumbnail View Icons**. Toggles between Thumbnail and List + views - the icon changes accordingly. +- **Information Icon**. Displays information on whatever is selected. If + an image is selected it will show the file name, folder path, size and + various other properties. Select to open or close the Information + panel. + +### Actions + +Hover over an image and select the menu button labelled with 3 dots. 6 +icons appear offering the following actions: + +1. **Preview**. Select the magnifier icon - the image is shown full + size in a dialog. +2. **Edit**. Select the pencil icon to open the Media Edit window. It + allows you to crop, resize or rotate the image. +3. **Download**. Select the download icon - your computer will respond + by asking you what you want to do with the download. Or it may just + save it or open it in an image display application. +4. **Get a shareable link**. Select the link icon to get a link to the + image that you can use for sharing. A dialog allows you to copy the + link to your clipboard for pasting into an email or document. +5. **Rename**. Select the rename icon to open a dialog that allows you + to rename the image. +6. **Delete**. Select the waste bin icon to delete the image. You will + be prompted to confirm. Once deleted it is gone forever! May be used + also to delete a folder. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **Upload**. Opens window for uploading images. +- **Create New Folder**. Opens a dialog to prompt for a new folder name. + The new folder is created in the currently selected folder. +- **Delete**. Deletes the selected images. +- **Options**. Opens [Media + Options](https://docs.joomla.org/Help4.x:Media:_Options/en "Help4.x:Media: Options/en"). +- **Help**. Opens this help screen. + +## Quick Tips + +- If you wish to keep images and documents in separate local folders: + 1. create a folder in the root of your site, say **files** + 2. go to the [Filesystem - + Local](https://docs.joomla.org/J4.x:Media:_Options/en "J4.x:Media: Options/en") + plugin and add **files** under **Select directories**. + 3. Back in the Media component you will see *images* and *files* as + separate items in the Local panel. +- The Media's maximum upload size can be changed to an amount other than + "10 MB" in the [Media + Options](https://docs.joomla.org/Help4.x:Media:_Options/en "Help4.x:Media: Options/en"). +- You can upload or delete multiple files at the same time. + +## Related information + +- Tutorial: [Managing + Media](https://docs.joomla.org/J4.x:Managing_Media/en "J4.x:Managing Media/en"). +- [Home + Dashboard](https://docs.joomla.org/Help4.x:Home_Dashboard/en "Help4.x:Home Dashboard/en"): + Access to many default Joomla functions. +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. diff --git a/manuals/help/menu-items/menu-item-alias.md b/manuals/help/menu-items/menu-item-alias.md new file mode 100644 index 0000000..e505fa3 --- /dev/null +++ b/manuals/help/menu-items/menu-item-alias.md @@ -0,0 +1,208 @@ +--- +sidebar_position: 1 +id: menu-item-alias +title: "Help4.x:Menu Item: Alias" +--- +## Description + +The **Menu Item Alias** menu type is used to create a link from one Menu +Item to another Menu Item. This link can be to another Menu's, Menu Item +or within the same Menu. + +## How To Access + +To create a new Menu Item Alias: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the New button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the System Links item to open a list and + then select the **Menu Item Alias** item. + +To edit an existing Menu Item Alias: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Menu Item**. Select a Menu Item name to point Alias Menu Item name + at. The drop down list is sectioned by Menu Names, with a list of Menu + Item names under each Menu Name. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. +- **Use Redirection.** The Template Style field is not used if this + options is set to Yes. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Quick Tips + +- Leave the alias field empty if the menu item alias and the menu item + linked to by the alias have the same parent. + + + +- A Main Menu Item Alias could link to an Article Menu's 'Some Menu + Type' Menu Item. By using Module Assignments, a possible use would be + to replace the Main Menu with the Article Menu when the Alias Menu + Item is clicked. A return to Main Menu when another Alias Menu Item is + clicked pointed back to a Menu Item in the Main Menu. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/menu-items/menu-item-article-archived.md b/manuals/help/menu-items/menu-item-article-archived.md new file mode 100644 index 0000000..0145725 --- /dev/null +++ b/manuals/help/menu-items/menu-item-article-archived.md @@ -0,0 +1,240 @@ +--- +sidebar_position: 2 +id: menu-item-article-archived +title: "Help4.x:Menu Item: Article Archived" +--- +## Description + +The Archived Articles Menu Item Type shows a customised list of articles +ordered by date or title. + +Archived articles are no longer published but are still stored on the +site. Articles are Archived using the [Articles list +screen](https://docs.joomla.org/Help4.x:Articles/en "Help4.x:Articles/en"). +Articles assigned to the 'Uncategorised' Category will not show on the +Archived Article Menu Item. + +## How To Access + +**Menus **→** \[name of the menu\]** + +To add a Menu Item: + +1. click the **New** toolbar button. +2. click the Menu Item Type **Select** button. +3. select the **Articles** item. +4. select the **Archived Articles** item. + +To edit a Menu Item: + +- select a **Title** from the list + +## Screenshot + + + +## Form Fields + +- **Title**. The title that will display for this menu item. +- **Alias**. The internal name of the menu item. Normally, you can leave + this blank and Joomla will fill in a default value Title in lower case + and with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Alias/en") + +### Details + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. +- **Category**. Select one or more categories from the dropdown list. +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. +- **Target Window**. Select from the dropdown list. +- **Template Style**. Select from the dropdown list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + +### Archive + +Options include "Use Global". If this is selected, the setting from the +[Articles: +Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en") +will be used. + + + +- **Article Order**. + - Oldest First: Articles are displayed starting with the oldest and + ending with the most recent. + - Most Recent First: Articles are displayed starting with the most + recent and ending with the oldest. + - 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. + - Ordering: Articles are ordered according to the Order column entered + in + [Articles](https://docs.joomla.org/Help4.x:Articles/en#ordering "Help4.x:Articles/en"). +- **Date for Ordering**. The date used when articles are sorted by date. + - Created: Use the article created date. + - Modified: Use the article modified date. + - Published: Use the article start publishing date. +- **\# Articles to List**. Number of articles shown in the list. +- **Filter Field**. Show a text field in the Frontend where a user can + filter the articles. +- **Intro text Limit**. The maximum number of characters of the Intro + Text to show. If the Intro Text is longer than this value, it will be + truncated to this length. + +### Options + +The Options determine how the article will show on the Frontend Site +layout. + + + +**Layout** + +- **Intro Text**. + - Show: The Intro Text of the article will show when you drill down to + the article. + - Hide: Only the part of the article after the Read More break will + show. +- **Position of Article Info**. + - Use Article Settings: Use the value from [Articles: + Edit](https://docs.joomla.org/Help4.x:Articles:_Edit/en "Help4.x:Articles: Edit/en").This + setting allows you to have different options for different articles + in the List layout. + - Above: Puts the article information block above the text. + - Below: Puts the article information block below the text. + - Split: Splits the article information block into 2 separate blocks. + One block is above and the other is below the text. +- **Article Info Title**. Displays 'Details' on top of the article + information block. + +**Category** + +- **Category**. Show the Article's Category Title. +- **Link Category**. Show the title as a link to that Category.Note: You + can set this to be either a blog or list layout with the [Choose a + Layout](https://docs.joomla.org/Help4.x:Articles:_Options/en#choosealayout "Help4.x:Articles: Options/en") + option in the Category Tab. +- **Parent Category**. Show the Article's Parent Category Title. +- **Link Parent Category**. Show the title as a link to that + Category.Note: You can set this to be either a blog or list layout + with the [Choose a + Layout](https://docs.joomla.org/Help4.x:Articles:_Options/en#choosealayout "Help4.x:Articles: Options/en") + option in the Category Tab. +- **Linked Titles**. Show the title as a link to the article. + +**Author** + +- **Author**. Show the author of the Article. +- **Link to Author's Contact Page**. Show it as a link to a Contact + layout for that author.Note: The author must be set up as a + [Contact](https://docs.joomla.org/Help4.x:Contacts:_Edit/en "Help4.x:Contacts: Edit/en"). + Also, a link will not show if there is an [Author + Alias](https://docs.joomla.org/Help4.x:Articles:_Edit/en#createdbyalias "Help4.x:Articles: Edit/en") + value for the article. + +**Date** + +- **Create Date**. Show the Article's create date. +- **Modify Date**. Show the Article's modify date. +- **Publish Date**. Show the Article's start publishing date. + +**Options** + +- **Navigation**. Show a navigation link 'Prev' or 'Next' when you drill + down to the article. +- **Hits**. Show the number of times the article has been displayed by a + user. + +### Common Options + +See [Menus: New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types, including: + +- [Right + Panel](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#rightpanel "Help4.x:Menu Item: New Item/en") +- [Link + Type](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#linktype "Help4.x:Menu Item: New Item/en") +- [Page + Display](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#pagedisplay "Help4.x:Menu Item: New Item/en") +- [Metadata](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#metadata "Help4.x:Menu Item: New Item/en") +- [Associations](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#associations "Help4.x:Menu Item: New Item/en") +- [Module + Assignment](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#moduleassignment "Help4.x:Menu Item: New Item/en") + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **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. +- **Cancel**. 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 + +- The Archived Articles layout allows you to access old or outdated + articles that you don't want to remove entirely from the site. +- If you want to be able to see old articles in a category blog or list, + create a category for older articles and move them to this category + (instead of changing the Published state to Archived). + +## Related Information + +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Articles: Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en") | 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. | +| [Articles](https://docs.joomla.org/Help4.x:Articles/en "Help4.x:Articles/en") | The Article list is used to find, mark featured, add and edit articles. | +| [Articles: Edit](https://docs.joomla.org/Help4.x:Articles:_Edit/en "Help4.x:Articles: Edit/en") | This is where you can add and edit Articles. You can also select the Category for an Article and indicate whether or not it is Published and if it is selected to appear on the Front Page. | +| [Articles: Featured](https://docs.joomla.org/Help4.x:Articles:_Featured/en "Help4.x:Articles: Featured/en") | Used to control which 'Featured Articles' are displayed on the Front Page and in what order they are displayed. | +| [Articles: Categories](https://docs.joomla.org/Help4.x:Articles:_Categories/en "Help4.x:Articles: Categories/en") | The Articles Categories list is used to find, add, and edit articles categories. | +| Menus: Archived Articles | Shows a customised list of articles ordered by date or title. Archived articles are no longer published but are still stored on the site. | +| [Menus: Category Blog](https://docs.joomla.org/Help4.x:Menu_Item:_Category_Blog/en "Help4.x:Menu Item: Category Blog/en") | Used to show articles belonging to a specific Category in a blog layout. Controls the Leading Articles, Intro Articles and additional links to more Articles. | +| [Menus: Category List](https://docs.joomla.org/Help4.x:Menu_Item:_Category_List/en "Help4.x:Menu Item: Category List/en") | Used to show articles belonging to a specific Category in a list layout. | +| [Menus: Create Article](https://docs.joomla.org/Help4.x:Menu_Item:_Create_Article/en "Help4.x:Menu Item: Create Article/en") | Allows users to submit an article. Normally this is available only to users who have logged in to the Frontend of the site. Users must have permission to create articles. | +| [Menus: Featured Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Articles/en "Help4.x:Menu Item: Featured Articles/en") | Used to show all Articles that have been tagged as Featured. Articles are shown in a Blog Layout. | +| [Menus: List All Categories in an Article Category Tree](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Categories/en "Help4.x:Menu Item: List All Categories/en") | Used to show a hierarchical list of Categories. Depending on the selected options for this layout, you can click on a category Title to show the articles in that category. | +| [Menus: Single Article](https://docs.joomla.org/Help4.x:Menu_Item:_Single_Article/en "Help4.x:Menu Item: Single Article/en") | Used to show one article. | diff --git a/manuals/help/menu-items/menu-item-category-blog.md b/manuals/help/menu-items/menu-item-category-blog.md new file mode 100644 index 0000000..c96f2d3 --- /dev/null +++ b/manuals/help/menu-items/menu-item-category-blog.md @@ -0,0 +1,387 @@ +--- +sidebar_position: 3 +id: menu-item-category-blog +title: "Help4.x:Menu Item: Category Blog" +--- +## Description + +A Category Blog menu item typically has one or two leading article +tasters occupying the full width of the content area followed by more +articles tasters in one, two or three columns and additional links to +more Articles in the same category. + +## How To Access + +**Menus **→** \[name of the menu\]** + +To add a Menu Item: + +1. click the **New** toolbar button. +2. click the Menu Item Type **Select** button. +3. select the **Articles** item. +4. select the **Category Blog** item. + +To edit a Menu Item: + +- select a **Title** from the list + +## Screenshot + + + +## Form Fields + +- **Title**. The title that will display for this menu item. +- **Alias**. The internal name of the menu item. Normally, you can leave + this blank and Joomla will fill in a default value Title in lower case + and with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Alias/en") + +### Details + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. +- **Choose a Category**. The articles that are within this category will + be displayed. +- **Tags**. Optionally restrict displayed articles to those having the + selected Tags. +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. +- **Target Window**. Select from the dropdown list. +- **Template Style**. Select from the dropdown list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + +### Category + +The Options control the way that category information is shown in the +menu item. +Options include "Use Global". If this is selected, the setting from the +[Articles: +Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en") +will be used. + + + +- **Category Title**. Show the title of the category. +- **Category Description**. Show the description for the category. +- **Category Image**. Show the category image. +- **Subcategory Levels**. Control how many levels of subcategories to + show. +- **Empty Categories**. Show categories that don't contain any articles + or subcategories. +- **No Articles Message**. Show a message "There are no articles in this + category". +- **Subcategories Heading**. Show the Subcategories as subheading on the + page. +- **Subcategories Descriptions**. Show the descriptions for + subcategories. +- **\# Articles in Category**. Show a count of the total number of + articles in each category. +- **Tags**. Show the tags for the category. + +### Blog Layout + +The Options control the appearance of the blog menu item. + + + +- **\# 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. +- **Leading Article Class**. You can add any CSS class for your own + styling ideas. Add a border on top with class boxed.For image position + use for example image-left, image-right. Add image-alternate for + alternate ordering of intro images. +- **\# 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 in which to + display the articles is determined by the Category Order and Article + Order parameters below. +- **Article Class**. You can add any CSS class for your own styling + ideas. Add a border on top with class boxed.For image position use for + example image-left, image-right. Add image-alternate for alternate + ordering of intro images. +- **\# Columns**. The number of columns to use in the Intro Articles + area. This is normally between 1 and 3 (depending on the template you + are using). If 1 is used, the Intro Articles will display using the + full width of the display area, just like the Leading Articles. +- **Multi Column Direction**. In multi-column blog layouts, whether to + order articles Down the columns or Across the columns. + + + +- - Down: Order articles going down the first column and then over to + the next column, for example: + +- + + + +- - Across: Order articles going across the columns and then back to the + first column, for example: + +- + + + +- **\# 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. +- **Featured Articles**. + - Show: Display featured articles and non-featured articles. + - Hide: Display only non-featured articles. + - Only: Display only featured articles. +- **Linked Intro Image**. If Yes, a click on the intro image shows the + article. +- **Include Subcategories**. + - None: Only articles from the current category will show. + - All: All articles from the current category and all subcategories + will show. + - 1-5: All articles from the current category and subcategories up to + and including that level will show. +- **Category Order**. + - 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 Order: Categories are ordered according to the Order column + entered in [Articles: + Categories](https://docs.joomla.org/Help4.x:Articles:_Categories/en#ordering "Help4.x:Articles: Categories/en"). +- **Article Order**. + - Featured Articles Order: Articles are ordered according to the Order + column entered in [Articles: + Featured](https://docs.joomla.org/Help4.x:Articles:_Featured/en#ordering "Help4.x:Articles: Featured/en"). + - 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. + - Random Order: Articles are displayed in random order. + - Article Order: Articles are ordered according to the Order column + entered in + [Articles](https://docs.joomla.org/Help4.x:Articles/en#ordering "Help4.x:Articles/en"). + - Article Reverse Order: Articles are ordered reverse to the according + of the Order column entered in + [Articles](https://docs.joomla.org/Help4.x:Articles/en#ordering "Help4.x:Articles/en"). +- **Date for Ordering**. The date used when articles are sorted by date. + - Created: Use the article created date. + - Modified: Use the article modified date. + - Published: Use the article start publishing date. + - Unpublished: Use the article unpublished date. +- **Pagination**. 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. + - Hide: Pagination links not shown. Note: Users will not be able to + navigate to additional pages. + - Show: Pagination links shown if needed. + - Auto: Pagination links shown if needed. +- **Pagination Summary**. Show the current page number and total pages + (e.g., "Page 1 of 2") at the bottom of each page. + +### Options + +The Options determine how the articles will show in the blog menu +item. +Options include "Use Article Settings". If this is selected, the setting +from [Articles: +Edit](https://docs.joomla.org/Help4.x:Articles:_Edit/en "Help4.x:Articles: Edit/en") +will be used. + + + +**Layout** + +- **Choose a Layout**. Select from the dropdown list. +- **Title**. Show the Article's Title. +- **Linked Titles**. Show the title as a link to the article. +- **Intro Text**. + - Show: The Intro Text of the article will show when you drill down to + the article. + - Hide: Only the part of the article after the Read More break will + show. +- **Position of Article Info**. + - Above: Puts the article information block above the text. + - Below: Puts the article information block below the text. + - Split: Splits the article information block into 2 separate blocks. + One block is above and the other is below the text. +- **Article Info Title**. Displays 'Details' on top of the article + information block. + +**Category** + +- **Category**. Show the Article's Category Title. +- **Link Category**. Show the title as a link to that Category.Note: You + can set this to be either a blog or list layout with the [Choose a + Layout](https://docs.joomla.org/Help4.x:Articles:_Options/en#choosealayout "Help4.x:Articles: Options/en") + option in the Category Tab. +- **Parent Category**. Show the Article's Parent Category Title. +- **Link Parent Category**. Show the title as a link to that + Category.Note: You can set this to be either a blog or list layout + with the [Choose a + Layout](https://docs.joomla.org/Help4.x:Articles:_Options/en#choosealayout "Help4.x:Articles: Options/en") + option in the Category Tab. + +**Associations** + +- **Associations**. Show the associated flags or Language Code. + [Multilingual + only.](https://docs.joomla.org/Help4.x:Multilingual_Associations/en "Help4.x:Multilingual Associations/en") + +**Author** + +- **Author**. Show the author of the Article. +- **Link to Author's Contact Page**. Show it as a link to a Contact + layout for that author.Note: The author must be set up as a + [Contact](https://docs.joomla.org/Help4.x:Contacts:_Edit/en "Help4.x:Contacts: Edit/en"). + Also, a link will not show if there is an [Author + Alias](https://docs.joomla.org/Help4.x:Articles:_Edit/en#createdbyalias "Help4.x:Articles: Edit/en") + value for the article. + +**Date** + +- **Create Date**. Show the Article's create date. +- **Modify Date**. Show the Article's modify date. +- **Publish Date**. Show the Article's start publishing date. + +**Options** + +- **Navigation**. Show a navigation link 'Prev' or 'Next' when you drill + down to the article. +- **"Read More" Link**. Show the Read More link to link from the part of + the article before the Read More break to the rest of the Article. +- **Read More with Title**. + - Show: The article title is part of the Read More link. The link will + be in the format "Read More: \[article title\]". + - Hide: The link will be "Read more". +- **Hits**. Show the number of times the article has been displayed by a + user. +- **Tags**. Show the tags for each article. +- **Unauthorised Links**. + - 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. + - No: Articles that the user is not authorised to view (based on the + viewing access level for the article) will not show. + +### Integration + +The Options determine whether a news feed will be available for the page +and what information it will show. + + + +- **RSS Feed Link**. If set to Show, a Feed Link will show up as a feed + icon in the address bar of most browsers. +- **Include in Feed**. + - Intro Text: Only the article's intro text will show in the feed. + - Full Text: The entire text of the article will show in the feed. + +### Common Options + +See [Menus: New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types, including: + +- [Right + Panel](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#rightpanel "Help4.x:Menu Item: New Item/en") +- [Link + Type](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#linktype "Help4.x:Menu Item: New Item/en") +- [Page + Display](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#pagedisplay "Help4.x:Menu Item: New Item/en") +- [Metadata](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#metadata "Help4.x:Menu Item: New Item/en") +- [Associations](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#associations "Help4.x:Menu Item: New Item/en") +- [Module + Assignment](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#moduleassignment "Help4.x:Menu Item: New Item/en") + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **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. +- **Cancel**. 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 + +- To create a new Category see [Articles: Edit + Category](https://docs.joomla.org/Help4.x:Articles:_Edit_Category/en "Help4.x:Articles: Edit Category/en"). +- To create a new menu see + [Menus](https://docs.joomla.org/Help4.x:Menus/en "Help4.x:Menus/en"). + +## Related Information + +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Articles: Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en") | 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. | +| [Articles](https://docs.joomla.org/Help4.x:Articles/en "Help4.x:Articles/en") | The Article list is used to find, mark featured, add and edit articles. | +| [Articles: Edit](https://docs.joomla.org/Help4.x:Articles:_Edit/en "Help4.x:Articles: Edit/en") | This is where you can add and edit Articles. You can also select the Category for an Article and indicate whether or not it is Published and if it is selected to appear on the Front Page. | +| [Articles: Featured](https://docs.joomla.org/Help4.x:Articles:_Featured/en "Help4.x:Articles: Featured/en") | Used to control which 'Featured Articles' are displayed on the Front Page and in what order they are displayed. | +| [Articles: Categories](https://docs.joomla.org/Help4.x:Articles:_Categories/en "Help4.x:Articles: Categories/en") | The Articles Categories list is used to find, add, and edit articles categories. | +| [Menus: Archived Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Article_Archived/en "Help4.x:Menu Item: Article Archived/en") | Shows a customised list of articles ordered by date or title. Archived articles are no longer published but are still stored on the site. | +| Menus: Category Blog | Used to show articles belonging to a specific Category in a blog layout. Controls the Leading Articles, Intro Articles and additional links to more Articles. | +| [Menus: Category List](https://docs.joomla.org/Help4.x:Menu_Item:_Category_List/en "Help4.x:Menu Item: Category List/en") | Used to show articles belonging to a specific Category in a list layout. | +| [Menus: Create Article](https://docs.joomla.org/Help4.x:Menu_Item:_Create_Article/en "Help4.x:Menu Item: Create Article/en") | Allows users to submit an article. Normally this is available only to users who have logged in to the Frontend of the site. Users must have permission to create articles. | +| [Menus: Featured Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Articles/en "Help4.x:Menu Item: Featured Articles/en") | Used to show all Articles that have been tagged as Featured. Articles are shown in a Blog Layout. | +| [Menus: List All Categories in an Article Category Tree](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Categories/en "Help4.x:Menu Item: List All Categories/en") | Used to show a hierarchical list of Categories. Depending on the selected options for this layout, you can click on a category Title to show the articles in that category. | +| [Menus: Single Article](https://docs.joomla.org/Help4.x:Menu_Item:_Single_Article/en "Help4.x:Menu Item: Single Article/en") | Used to show one article. | diff --git a/manuals/help/menu-items/menu-item-category-list.md b/manuals/help/menu-items/menu-item-category-list.md new file mode 100644 index 0000000..05e94cd --- /dev/null +++ b/manuals/help/menu-items/menu-item-category-list.md @@ -0,0 +1,344 @@ +--- +sidebar_position: 4 +id: menu-item-category-list +title: "Help4.x:Menu Item: Category List" +--- +## Description + +The Category List menu item type is used to show articles belonging to a +specific Category in a list layout. + +## How To Access + +**Menus **→** \[name of the menu\]** + +To add a Menu Item: + +1. click the **New** toolbar button. +2. click the Menu Item Type **Select** button. +3. select the **Articles** item. +4. select the **Category List** item. + +To edit a Menu Item: + +- select a **Title** from the list + +## Screenshot + + + +## Form Fields + +- **Title**. The title that will display for this menu item. +- **Alias**. The internal name of the menu item. Normally, you can leave + this blank and Joomla will fill in a default value Title in lower case + and with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Alias/en") + +### Details + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. +- **Choose a Category**. The articles that are within this category will + be displayed. +- **Tags**. Optionally restrict displayed articles to those having the + selected Tags. +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. +- **Target Window**. Select from the dropdown list. +- **Template Style**. Select from the dropdown list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + +### Category + +The Options control the way that category information is shown in the +menu item. +Options include "Use Global". If this is selected, the setting from the +[Articles: +Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en") +will be used. + + + +- **Category Title**. Show the title of the category. +- **Category Description**. Show the description for the category. +- **Category Image**. Show the category image. +- **Subcategory Levels**. Control how many levels of subcategories to + show. +- **Empty Categories**. Show categories that don't contain any articles + or subcategories. +- **No Articles Message**. Show a message "There are no articles in this + category". +- **Subcategories Heading**. Show the Subcategories as subheading on the + page. +- **Subcategories Descriptions**. Show the descriptions for + subcategories. +- **\# Articles in Category**. Show a count of the total number of + articles in each category. +- **Tags**. Show the tags for the category. + +### List Layouts + +List Layout Options control the appearance of the menu item. + + + +- **Display Select**. Show the Display \# control that allows the user + to select the number of articles to show. +- **Filter Field**. Show a text field in the Frontend where a user can + filter the articles.Options in the Backend menu item edit. + - Hide: Don't show a filter field. + - Title: Filter on article title. + - Author: Filter on the author's name. + - Hits: Filter on the number of article hits. + - Tags: Filter on the article tags. + - Month (published): Filter on the month of published articles. +- **Table Headings**. Show a heading in the article list in the + Frontend. +- **Date**. Show a date in the list. + - Hide: Don't show any date. + - Created: Show the created date. + - Modified: Show the date of the last modification. + - Published: Show the start publishing date. +- **Date Format**. Optional format string to control the format of the + date. +- **Hits**. Show the number of hits for articles. +- **Author**. Show the name of the author. + + + +- **Category Order**. + - 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 Order: Categories are ordered according to the Order column + entered in [Articles: + Categories](https://docs.joomla.org/Help4.x:Articles:_Categories/en#ordering "Help4.x:Articles: Categories/en"). +- **Article Order**. + - Featured Articles Order: Articles are ordered according to the Order + column entered in [Articles: + Featured](https://docs.joomla.org/Help4.x:Articles:_Featured/en#ordering "Help4.x:Articles: Featured/en"). + - 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. + - Random Order: Articles are displayed in random order. + - Article Order: Articles are ordered according to the Order column + entered in + [Articles](https://docs.joomla.org/Help4.x:Articles/en#ordering "Help4.x:Articles/en"). + - Article Reverse Order: Articles are ordered reverse to the according + of the Order column entered in + [Articles](https://docs.joomla.org/Help4.x:Articles/en#ordering "Help4.x:Articles/en"). +- **Date for Ordering**. The date used when articles are sorted by date. + - Created: Use the article created date. + - Modified: Use the article modified date. + - Published: Use the article start publishing date. +- **Pagination**. 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. + - Hide: Pagination links not shown. Note: Users will not be able to + navigate to additional pages. + - Show: Pagination links shown if needed. + - Auto: Pagination links shown if needed. +- **Pagination Summary**. Show the current page number and total pages + (e.g., "Page 1 of 2") at the bottom of each page. +- **\# Articles to List**. Number of articles shown in the list. +- **Featured Articles**. + - Show: Display featured articles and non-featured articles. + - Hide: Display only non-featured articles. + - Only: Display only featured articles. + +### Options + +The Options determine how the articles will show in the list menu item. + + + +**Layout** + +- **Choose a Layout**. Select from the dropdown list. +- **Title**. Show the Article's Title. +- **Linked Titles**. Show the title as a link to the article. +- **Intro Text**. + - Show: The Intro Text of the article will show when you drill down to + the article. + - Hide: Only the part of the article after the Read More break will + show. + +**Category** + +- **Category**. Show the Article's Category Title. +- **Link Category**. Show the title as a link to that Category.Note: You + can set this to be either a blog or list layout with the [Choose a + Layout](https://docs.joomla.org/Help4.x:Articles:_Options/en#choosealayout "Help4.x:Articles: Options/en") + option in the Category Tab. +- **Parent Category**. Show the Article's Parent Category Title. +- **Link Parent Category**. Show the title as a link to that + Category.Note: You can set this to be either a blog or list layout + with the [Choose a + Layout](https://docs.joomla.org/Help4.x:Articles:_Options/en#choosealayout "Help4.x:Articles: Options/en") + option in the Category Tab. + +**Associations** + +- **Associations**. Show the associated flags or Language Code. + [Multilingual + only.](https://docs.joomla.org/Help4.x:Multilingual_Associations/en "Help4.x:Multilingual Associations/en") + +**Author** + +- **Author**. Show the author of the Article. +- **Link to Author's Contact Page**. Show it as a link to a Contact + layout for that author.Note: The author must be set up as a + [Contact](https://docs.joomla.org/Help4.x:Contacts:_Edit/en "Help4.x:Contacts: Edit/en"). + Also, a link will not show if there is an [Author + Alias](https://docs.joomla.org/Help4.x:Articles:_Edit/en#createdbyalias "Help4.x:Articles: Edit/en") + value for the article. + +**Date** + +- **Create Date**. Show the Article's create date. +- **Modify Date**. Show the Article's modify date. +- **Publish Date**. Show the Article's start publishing date. + +**Options** + +- **Navigation**. Show a navigation link 'Prev' or 'Next' when you drill + down to the article. +- **"Read More" Link**. Show the Read More link to link from the part of + the article before the Read More break to the rest of the Article. +- **Read More with Title**. + - Show: The article title is part of the Read More link. The link will + be in the format "Read More: \[article title\]". + - Hide: The link will be "Read more". +- **Hits**. Show the number of times the article has been displayed by a + user. +- **Unauthorised Links**. + - 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. + - No: Articles that the user is not authorised to view (based on the + viewing access level for the article) will not show. + +### Integration + +The Options determine whether a news feed will be available for the page +and what information it will show. + + + +- **RSS Feed Link**. If set to Show, a Feed Link will show up as a feed + icon in the address bar of most browsers. +- **Include in Feed**. + - Intro Text: Only the article's intro text will show in the feed. + - Full Text: The entire text of the article will show in the feed. + +### Common Options + +See [Menus: New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types, including: + +- [Right + Panel](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#rightpanel "Help4.x:Menu Item: New Item/en") +- [Link + Type](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#linktype "Help4.x:Menu Item: New Item/en") +- [Page + Display](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#pagedisplay "Help4.x:Menu Item: New Item/en") +- [Metadata](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#metadata "Help4.x:Menu Item: New Item/en") +- [Associations](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#associations "Help4.x:Menu Item: New Item/en") +- [Module + Assignment](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#moduleassignment "Help4.x:Menu Item: New Item/en") + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **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. +- **Cancel**. 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 + +- The Category List layout is a convenient way to list a compact + directory of articles in a category that can include filtering and + searching. +- To create a new Category see [Articles: Edit + Category.](https://docs.joomla.org/Help4.x:Articles:_Edit_Category/en "Help4.x:Articles: Edit Category/en") +- To create a new menu see + [Menus.](https://docs.joomla.org/Help4.x:Menus/en "Help4.x:Menus/en") + +## Related Information + +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Articles: Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en") | 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. | +| [Articles](https://docs.joomla.org/Help4.x:Articles/en "Help4.x:Articles/en") | The Article list is used to find, mark featured, add and edit articles. | +| [Articles: Edit](https://docs.joomla.org/Help4.x:Articles:_Edit/en "Help4.x:Articles: Edit/en") | This is where you can add and edit Articles. You can also select the Category for an Article and indicate whether or not it is Published and if it is selected to appear on the Front Page. | +| [Articles: Featured](https://docs.joomla.org/Help4.x:Articles:_Featured/en "Help4.x:Articles: Featured/en") | Used to control which 'Featured Articles' are displayed on the Front Page and in what order they are displayed. | +| [Articles: Categories](https://docs.joomla.org/Help4.x:Articles:_Categories/en "Help4.x:Articles: Categories/en") | The Articles Categories list is used to find, add, and edit articles categories. | +| [Menus: Archived Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Article_Archived/en "Help4.x:Menu Item: Article Archived/en") | Shows a customised list of articles ordered by date or title. Archived articles are no longer published but are still stored on the site. | +| [Menus: Category Blog](https://docs.joomla.org/Help4.x:Menu_Item:_Category_Blog/en "Help4.x:Menu Item: Category Blog/en") | Used to show articles belonging to a specific Category in a blog layout. Controls the Leading Articles, Intro Articles and additional links to more Articles. | +| Menus: Category List | Used to show articles belonging to a specific Category in a list layout. | +| [Menus: Create Article](https://docs.joomla.org/Help4.x:Menu_Item:_Create_Article/en "Help4.x:Menu Item: Create Article/en") | Allows users to submit an article. Normally this is available only to users who have logged in to the Frontend of the site. Users must have permission to create articles. | +| [Menus: Featured Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Articles/en "Help4.x:Menu Item: Featured Articles/en") | Used to show all Articles that have been tagged as Featured. Articles are shown in a Blog Layout. | +| [Menus: List All Categories in an Article Category Tree](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Categories/en "Help4.x:Menu Item: List All Categories/en") | Used to show a hierarchical list of Categories. Depending on the selected options for this layout, you can click on a category Title to show the articles in that category. | +| [Menus: Single Article](https://docs.joomla.org/Help4.x:Menu_Item:_Single_Article/en "Help4.x:Menu Item: Single Article/en") | Used to show one article. | diff --git a/manuals/help/menu-items/menu-item-compact-list-of-tagged-items.md b/manuals/help/menu-items/menu-item-compact-list-of-tagged-items.md new file mode 100644 index 0000000..c357950 --- /dev/null +++ b/manuals/help/menu-items/menu-item-compact-list-of-tagged-items.md @@ -0,0 +1,398 @@ +--- +sidebar_position: 5 +id: menu-item-compact-list-of-tagged-items +title: "Help4.x:Menu Item: Compact List of Tagged Items" +--- +## Description + +The **Compact List of Tagged Items** menu item type is used to create a +page ... + +## How To Access + +To create a new Compact List of Tagged Items menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the New button in the Toolbar. + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Tags item to open a list and then + select the **Compact List of Tagged Items** item. + +To edit an existing Compact List of Tags Items menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Tag**. Select the tag to use. + + + +- **Content Type.** Only tags of the selected types will be displayed + (optional). + + + +- **Language Filter**. (Use Global (All)/All/Current/English + (en-GB)/...). Optionally filter the list of tags based on language. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Tag Options Tab + + + +- **Show Tag Name.** (Use Global(Hide)/Hide/Show). For a layout with one + tag, show the tag name. + + + +- **Tag Image.** (Use Global(Hide)/Hide/Show). For a layout with one + tag, show the image for the tag. + + + +- **Tag Description.** (Use Global(Hide)/Hide/Show). Show or hide the + description for the tag (only used when a single tag is selected). + + + +- **Image.** Select or upload the image. + + + +- **Description**. The description for the item. Category, Subcategory + and Web Link descriptions may be shown on web pages, depending on the + parameter settings. These descriptions are entered using the same + editor that is used for Articles. + + + +- **Ordering:** (default). The column in which to sort displayed items + in the table. The values are the same as the column heading names. + + + +- **Direction.** Sort order. Descending is highest to lowest. Ascending + is lowest to highest. + +### List Layouts Tab + + + +- **Item Image.** (Use Global/Hide/Show). Show the image for each item. + + + +- **Item Description.** (Use Global/Hide/Show). Show or hide the + description for each item in the list. The length may be limited using + the Maximum Character option. + + + +- **Maximum Characters.** The maximum number of characters to display + from the description in each tag. + + + +- **Filter Field.** The Filter Field creates a text field where a user + can enter a field to be used to filter the articles shown in the list. + An example of how this looks in the front-end layout is shown below. + Help30-article-category-list-filter-field-en.png + +The possible options for this (in the back-end menu item edit) are shown +below. + + + +- *Use Global:* Use the value from [Articles: + Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en"). + Only appears in Menu Item Type Options. +- *Hide:* Don't show a filter field. +- *Title:* Filter on article title. +- *Author:* Filter on the author's name. +- *Hits:* Filter on the number of article hits. + + + +- **Display Select.** (Use Global/Hide/Show) Whether to hide or show the + Display \# control that allows the user to select the number of items + to show in the list. An example of how it is shown in the Front End + (website) view below. + + + +If there are more items than this number, you can use the page +navigation buttons (Start, Prev, Next, End, and page numbers) to +navigate between pages. Note that if you have a large number of items, +it may be helpful to use the Filter options, located above the column +headings, to limit which items display. + +- **\# Items to List.** (Use Global, 5, 10, 15...) Default number of + tagged items to list on a page. + + + +- **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 listed items will not fit + on one page. An example is shown below. + +Help30-pagination-en.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. + + + +- **Show Date.** This option allows you to show a date in the list. The + options are as follows. + + + +- *Use Global:* Use the value set in [Article + Manager→Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en"). +- *Hide:* Don't show any date. +- *Created:* Show the created date. +- *Modified:* Show the date of the last modification. +- *Created:* Show the start publishing date. + + + +- **Date Format.** Optional format string to control the format of the + date (if shown). If left blank, the date will use the DATE_FORMAT_LC1 + format from the language file (for example, "D M Y" for "31 December + 2012" or "m-d-y" for "12-31-12"). See + PHP Date Documentation for more + information. + +### Item Selection Options Tab + + + +- **Match Type.** (Use Global (Any), All, Any) All will return items + that have all of the tags. Any will return items that have at least + one of the tags. + + + +- **Child Tags.** (Use Global (Exclude), Exclude, Include) Include or + exclude child tags from the result list for a tag. + +### Integration Tab + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + +*Example Front End Site images are generic images using Joomla! core +installation supplied free Front End Templates. The actual view can +depend on the installed custom template used and the template's style +for those views on a Joomla! website.* Tags List Layout: + +## Related Information + +| | | +|------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------| +| Related Help Screens | Description | +| [Menus Menu Item Tags Items List](https://docs.joomla.org/Help4.x:Menu_Item:_Tagged_Items/en "Help4.x:Menu Item: Tagged Items/en") | Used to create a 'Tagged List of Items' page per tag(s) selected. | +| [Menus Menu Item Tags Items List All](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Tags/en "Help4.x:Menu Item: List All Tags/en") | Used to create a 'List of All Tags' page per tag(s) selected. | diff --git a/manuals/help/menu-items/menu-item-components-menu-container.md b/manuals/help/menu-items/menu-item-components-menu-container.md new file mode 100644 index 0000000..0ab2aed --- /dev/null +++ b/manuals/help/menu-items/menu-item-components-menu-container.md @@ -0,0 +1,180 @@ +--- +sidebar_position: 6 +id: menu-item-components-menu-container +title: "Help4.x:Menu Item: Components Menu Container" +--- +## Description + +The Components Menu Container is used to show a component container in +the Administrator interface. A use case might be as follows: + +Suppose you only wish to show certain users links to a subset of the +Components on your site. Super Users will see links to everything of +course. You can do this as follows: + +- Create a new User Group named, say Branch, with Public as parent. +- Set the Global Permissions for this group to Allow Administrator + Login. +- Create a new menu named, say, Branch Menu with no imported presets. +- Create a linked Module named, say, Branch Menu with menu to show as + Branch Menu. Set Check Menu to No and Access to Public. +- Create a Components Menu Container menu item for the Branch Menu + named, say, Branch Components. + - Hide any components that you do not wish the Branch users to see. + - Show those to which they should have access. +- Set the Component Permissions for the Branch Group to allowed for all + except Configure ACL and Configure Options. + +More information at: https://docs.joomla.org/J4.x:Adding_a_Custom_Administrator_Menu + +For a Super User the Administrator menu will have an obvious duplication +of links. However, a Branch user will only see the Branch Components +menu and the Home Dashboard. You will need to adjust the Access +permissions of the Quick Icon modules there too! And you really need to +create a Dashboard module for any components Branch users have access +to. + +For users who need access to Articles you can add more menu items to the +Branch Menu. In this way you can build a complete custom menu for Branch +users. + +## How To Access + +To create a new Component Container Menu Item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu. +- Select the **New** Toolbar button to create a new menu item. +- Select the Menu Item Type **Select** button Help-4x-Menu-Item-Type-Select-Button-en.png +- Select the **List Component Container** link from **System Links** in + the Menu Item Type modal dialog. + +To edit an existing Component Container Menu Item, select its Title in +the Menu Items list. + +## Screenshot + + + +## Form Fields + +- **Name.** The full name of the menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias "Special:MyLanguage/Alias") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. +- **Show or Hide Menu Items.** List of menu items with buttons to set + visibility status. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent**. The item (category, menu item, and so on) that is the + parent of the item being edited. + + + +- **Ordering:** Indicates the order of this Menu Item in the Menu. The + default Order is to add the Menu Item to the end of the Menu. This + Menu Item will moved to the order position just after the Menu Item + selected from the drop-down list. Note that the Order of Menu Items + can also be changed in the Menu Item Manager. + + + +- **Status**. The published status of the item. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Link Type Tab + +The Options control attributes of the link for this menu item in a +Joomla menu. + +- **Link Title Attribute.** An optional custom description for the title + attribute of the menu hyperlink. +- **Link Icon Class.** If an icon class is entered, it takes precedence + over the link image. +- **Link Image.** An optional image to be used with the menu hyperlink. +- **Image Class** An optional custom CSS style to apply to the menu + image. +- **Display Menu Item Title.** (No/Yes) If an optional image is added, + whether to add the menu title next to the image. +- **Display in Menu.** (No/Yes) Option to display the image in a menu. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Related Information + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Contacts: Options](https://docs.joomla.org/Help4.x:Contacts:_Options/en "Help4.x:Contacts: Options/en") | Contact Options configuration allows setting of parameters used globally for all contacts. | +| [Contacts: Categories](https://docs.joomla.org/Help4.x:Contacts:_Categories/en "Help4.x:Contacts: Categories/en") | The Contact Category Manager is where you can edit existing Contact Categories and create new ones. Note that Contact Categories are separate from other Categories, such as for Articles, Banners, News Feeds, and Web Links. From this screen, you can also navigate to the [Contacts](https://docs.joomla.org/Help4.x:Contacts/en "Help4.x:Contacts/en") screen. | +| Contacts: + New or Edit Category | This is where you can add a Contact Category or edit an existing Contact Category. Contact Categories allow you to organize contacts in your web site. Contact Categories are separate from other types of Categories, such as those for Articles, Banners, News Feeds, and so on. | +| [Contacts](https://docs.joomla.org/Help4.x:Contacts/en "Help4.x:Contacts/en") | The Contact Manager screen allows you to add contact information to your Joomla! site. You can enter information such as name, address, phone and e-mail. You can also link contacts to registered users. Afterwards, you can use the [Menu Manager](https://docs.joomla.org/Help4.x:Menus/en "Help4.x:Menus/en") to create front-end links to the the contacts. | +| Contacts: + New or Edit | This is where you can add a Contact or edit an existing Contact. Contacts allow you to list people on your web site. They also allow users to send e-mails to those people. | +| [Menu Item: List Contacts in a Category](https://docs.joomla.org/Help4.x:Menu_Item:_List_Contacts_in_a_Category/en "Help4.x:Menu Item: List Contacts in a Category/en") | Used to show contacts belonging to a specific Category in a list layout. Settings include: Contact Details, Contact Form, presentation(slider, tabs, plain view), and Email subject and message filters. | +| [Menu Item: Featured Contacts](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Contacts/en "Help4.x:Menu Item: Featured Contacts/en") | Used to show a list of featured contacts. | +| [Menu Item: Single Contact](https://docs.joomla.org/Help4.x:Menu_Item:_Single_Contact/en "Help4.x:Menu Item: Single Contact/en") | Used to show a Single Contact. Settings include: Contact Details, Contact Form, presentation(slider, tabs, plain view), and Email subject and message filters. | diff --git a/manuals/help/menu-items/menu-item-confirm-request.md b/manuals/help/menu-items/menu-item-confirm-request.md new file mode 100644 index 0000000..e3ba1da --- /dev/null +++ b/manuals/help/menu-items/menu-item-confirm-request.md @@ -0,0 +1,198 @@ +--- +sidebar_position: 7 +id: menu-item-confirm-request +title: "Help4.x:Menu Item: Confirm Request" +--- +## Description + +The **Confirm Request** menu item type is used to display a menu link +leading to a page containing a form allowing your users to confirm an +information request (Export or Remove). + +## How To Access + +To create a new *Confirm Request* menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the **New** button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Privacy item to open a list and then + select the **Confirm Request** item. + +To edit an existing Confirm Request menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **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 + +- [The Privacy Tool + Suite](https://docs.joomla.org/J3.x:Privacy/en "J3.x:Privacy/en") +- diff --git a/manuals/help/menu-items/menu-item-create-article.md b/manuals/help/menu-items/menu-item-create-article.md new file mode 100644 index 0000000..79c7a9c --- /dev/null +++ b/manuals/help/menu-items/menu-item-create-article.md @@ -0,0 +1,193 @@ +--- +sidebar_position: 8 +id: menu-item-create-article +title: "Help4.x:Menu Item: Create Article" +--- +## Description + +The Create Article menu item allows users to submit an article via the +Site interface. Normally this is available only to users who have logged +in to the Frontend of the site. + +Users must have permission to create articles. When the Create Article +page is shown in the Frontend, the screen shows as examples in the +[Frontend Screenshot](#frontend) section below. + +## How To Access + +**Menus **→** \[name of the menu\]** + +To add a Menu Item: + +1. click the **New** toolbar button. +2. click the Menu Item Type **Select** button. +3. select the **Articles** item. +4. select the **Create Article** item. + +To edit a Menu Item: + +- select a **Title** from the list + +## Screenshot + + + +## Form Fields + +- **Title**. The title that will display for this menu item. +- **Alias**. The internal name of the menu item. Normally, you can leave + this blank and Joomla will fill in a default value Title in lower case + and with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Alias/en") + +### Details + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. +- **Target Window**. Select from the dropdown list. +- **Template Style**. Select from the dropdown list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + +### Options + + + +- **Specific Category**. + - Yes: Articles will be assigned to the specified category. The user + will not be able to select a category. + - No: The user may select the category from the list box. Only + categories for which the user has 'Create' permission will show. +- **Submission/Cancel Redirect**. Select the page the user will be + redirected to after a successful article submission. +- **Custom Redirect on Cancel**. + - Yes: Set a page to redirect to when user Cancels article submission. + - No: When user Cancels article submission, the user is redirected to + the 'Submission/Cancel Redirect' page. + +### Common Options + +See [Menus: New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types, including: + +- [Right + Panel](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#rightpanel "Help4.x:Menu Item: New Item/en") +- [Link + Type](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#linktype "Help4.x:Menu Item: New Item/en") +- [Page + Display](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#pagedisplay "Help4.x:Menu Item: New Item/en") +- [Metadata](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#metadata "Help4.x:Menu Item: New Item/en") +- [Associations](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#associations "Help4.x:Menu Item: New Item/en") +- [Module + Assignment](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#moduleassignment "Help4.x:Menu Item: New Item/en") + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **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. +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. +- **Help**. Opens this help screen. + +## Frontend Screenshots + +Screenshots shows Joomla core Frontend Template **Cassiopeia**, all +[Editing Layout +options](https://docs.joomla.org/Help4.x:Articles:_Options/en#editinglayout "Help4.x:Articles: Options/en") +set to 'Hide'. + +**Content** + + + +**Fields** + + + +**Publishing** + + + +**Language** + + + +## Quick Tips + +An unauthorised user will normally get an error if they click on a +Create Article menu item. For this reason, it is normal practice to give +the menu item a [viewing Access +Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en") +that can only be seen by users authorised to add articles. + +## Related Information + +- To create a [new + user](https://docs.joomla.org/Help4.x:Users:_Edit_Profile/en "Help4.x:Users: Edit Profile/en"). +- To change [article + permissions](https://docs.joomla.org/Help4.x:Articles:_Options/en#permissions "Help4.x:Articles: Options/en"). + + + +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Articles: Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en") | 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. | +| [Articles](https://docs.joomla.org/Help4.x:Articles/en "Help4.x:Articles/en") | The Article list is used to find, mark featured, add and edit articles. | +| [Articles: Edit](https://docs.joomla.org/Help4.x:Articles:_Edit/en "Help4.x:Articles: Edit/en") | This is where you can add and edit Articles. You can also select the Category for an Article and indicate whether or not it is Published and if it is selected to appear on the Front Page. | +| [Articles: Featured](https://docs.joomla.org/Help4.x:Articles:_Featured/en "Help4.x:Articles: Featured/en") | Used to control which 'Featured Articles' are displayed on the Front Page and in what order they are displayed. | +| [Articles: Categories](https://docs.joomla.org/Help4.x:Articles:_Categories/en "Help4.x:Articles: Categories/en") | The Articles Categories list is used to find, add, and edit articles categories. | +| [Menus: Archived Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Article_Archived/en "Help4.x:Menu Item: Article Archived/en") | Shows a customised list of articles ordered by date or title. Archived articles are no longer published but are still stored on the site. | +| [Menus: Category Blog](https://docs.joomla.org/Help4.x:Menu_Item:_Category_Blog/en "Help4.x:Menu Item: Category Blog/en") | Used to show articles belonging to a specific Category in a blog layout. Controls the Leading Articles, Intro Articles and additional links to more Articles. | +| [Menus: Category List](https://docs.joomla.org/Help4.x:Menu_Item:_Category_List/en "Help4.x:Menu Item: Category List/en") | Used to show articles belonging to a specific Category in a list layout. | +| Menus: Create Article | Allows users to submit an article. Normally this is available only to users who have logged in to the Frontend of the site. Users must have permission to create articles. | +| [Menus: Featured Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Articles/en "Help4.x:Menu Item: Featured Articles/en") | Used to show all Articles that have been tagged as Featured. Articles are shown in a Blog Layout. | +| [Menus: List All Categories in an Article Category Tree](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Categories/en "Help4.x:Menu Item: List All Categories/en") | Used to show a hierarchical list of Categories. Depending on the selected options for this layout, you can click on a category Title to show the articles in that category. | +| [Menus: Single Article](https://docs.joomla.org/Help4.x:Menu_Item:_Single_Article/en "Help4.x:Menu Item: Single Article/en") | Used to show one article. | diff --git a/manuals/help/menu-items/menu-item-create-contact.md b/manuals/help/menu-items/menu-item-create-contact.md new file mode 100644 index 0000000..61e7676 --- /dev/null +++ b/manuals/help/menu-items/menu-item-create-contact.md @@ -0,0 +1,215 @@ +--- +sidebar_position: 9 +id: menu-item-create-contact +title: "Help4.x:Menu Item: Create Contact" +--- +## Description + +The **Create Contact** menu item type is used to provide a form for a +user to provide contact data. + +## How To Access + +To create a new **Create Contact** menu item: + +- Select **Menus **→** \[name of the menu\]** from Administrator menu + (for example, **Menus **→** Main Menu**). Then... + - Select the **New** button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Contacts item to open a list and then + select the **Create Contact** item. + +To edit an existing Create Contact menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Common Options + +See Menus: Edit/New Item +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **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 + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Contacts: Options](https://docs.joomla.org/Help4.x:Contacts:_Options/en "Help4.x:Contacts: Options/en") | Contact Options configuration allows setting of parameters used globally for all contacts. | +| [Contacts: Categories](https://docs.joomla.org/Help4.x:Contacts:_Categories/en "Help4.x:Contacts: Categories/en") | The Contact Category Manager is where you can edit existing Contact Categories and create new ones. Note that Contact Categories are separate from other Categories, such as for Articles, Banners, News Feeds, and Web Links. From this screen, you can also navigate to the [Contacts](https://docs.joomla.org/Help4.x:Contacts/en "Help4.x:Contacts/en") screen. | +| Contacts: + New or Edit Category | This is where you can add a Contact Category or edit an existing Contact Category. Contact Categories allow you to organize contacts in your web site. Contact Categories are separate from other types of Categories, such as those for Articles, Banners, News Feeds, and so on. | +| [Contacts](https://docs.joomla.org/Help4.x:Contacts/en "Help4.x:Contacts/en") | The Contact Manager screen allows you to add contact information to your Joomla! site. You can enter information such as name, address, phone and e-mail. You can also link contacts to registered users. Afterwards, you can use the [Menu Manager](https://docs.joomla.org/Help4.x:Menus/en "Help4.x:Menus/en") to create front-end links to the the contacts. | +| Contacts: + New or Edit | This is where you can add a Contact or edit an existing Contact. Contacts allow you to list people on your web site. They also allow users to send e-mails to those people. | +| [Menu Item: List Contacts in a Category](https://docs.joomla.org/Help4.x:Menu_Item:_List_Contacts_in_a_Category/en "Help4.x:Menu Item: List Contacts in a Category/en") | Used to show contacts belonging to a specific Category in a list layout. Settings include: Contact Details, Contact Form, presentation(slider, tabs, plain view), and Email subject and message filters. | +| [Menu Item: Featured Contacts](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Contacts/en "Help4.x:Menu Item: Featured Contacts/en") | Used to show a list of featured contacts. | +| [Menu Item: Single Contact](https://docs.joomla.org/Help4.x:Menu_Item:_Single_Contact/en "Help4.x:Menu Item: Single Contact/en") | Used to show a Single Contact. Settings include: Contact Details, Contact Form, presentation(slider, tabs, plain view), and Email subject and message filters. | diff --git a/manuals/help/menu-items/menu-item-create-request.md b/manuals/help/menu-items/menu-item-create-request.md new file mode 100644 index 0000000..e52e8ab --- /dev/null +++ b/manuals/help/menu-items/menu-item-create-request.md @@ -0,0 +1,196 @@ +--- +sidebar_position: 10 +id: menu-item-create-request +title: "Help4.x:Menu Item: Create Request" +--- +## Description + +The **Create Request** menu item type is used to display a form allowing +users to submit an information request (Export or Remove). + +## How To Access + +To create a new **Create Request** menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the New button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Privacy item to open a list and then + select the **Create Request** item. + +To edit an existing Create Reques menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **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 + +- [The Privacy Tool + Suite](https://docs.joomla.org/J3.x:Privacy/en "J3.x:Privacy/en") diff --git a/manuals/help/menu-items/menu-item-display-template-options.md b/manuals/help/menu-items/menu-item-display-template-options.md new file mode 100644 index 0000000..1aad89e --- /dev/null +++ b/manuals/help/menu-items/menu-item-display-template-options.md @@ -0,0 +1,218 @@ +--- +sidebar_position: 11 +id: menu-item-display-template-options +title: "Help4.x:Menu Item: Display Template Options" +--- +## Description + +The **Display Template Options** menu item type allows a Joomla! +super-user to easily change some template options from the front-end. +After a change, the super-user will see the results immediately. This +menu item is intended to help new super-users with site development. + +## How To Access + +To create a new **Display Template Options** menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). + - Select the **New** button in the Toolbar. + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Configuration Manager item to open a + list and then select the **Display Template Options** item. + +To edit an existing Display Template Options menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + + + +## Related Items + +| | | +|----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Templates: Styles](https://docs.joomla.org/Help4.x:Templates:_Styles/en "Help4.x:Templates: Styles/en") | | +| [Templates: Edit Style](https://docs.joomla.org/Help4.x:Templates:_Edit_Style/en "Help4.x:Templates: Edit Style/en") | This is where you edit template styles. When a template is first installed, a default style is created for it. The default style for the template will have the same name as the template with a - Default suffix. To make a different variation of the default template style, check the default style's checkbox and press the Duplicate icon in the toolbar. Then edit the duplicate. | +| [Templates: Templates](https://docs.joomla.org/Help4.x:Templates:_Templates/en "Help4.x:Templates: Templates/en") | The Template Manager: Templates screen allows you to preview and edit templates which are installed in your Joomla! installation. | +| [Templates: Customise](https://docs.joomla.org/Help4.x:Templates:_Customise/en "Help4.x:Templates: Customise/en") | This is where you edit a template's source code. You can edit the template's master files and stylesheets from this screen. | +| Templates: + Customise Source | This screen is where the source code of template files is edited. It provides a plain text interface to edit the template files. HTML and PHP programming syntax is highlighted to make the source code files easier to read. | diff --git a/manuals/help/menu-items/menu-item-edit-user-profile.md b/manuals/help/menu-items/menu-item-edit-user-profile.md new file mode 100644 index 0000000..003c896 --- /dev/null +++ b/manuals/help/menu-items/menu-item-edit-user-profile.md @@ -0,0 +1,228 @@ +--- +sidebar_position: 12 +id: menu-item-edit-user-profile +title: "Help4.x:Menu Item: Edit User Profile" +--- +## Description + +The **Edit User Profile** menu item type is used to create a form which +allows a user to edit their own profile settings. + +## How To Access + +To create a new **Edit User Profile** menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the New button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Users item to open a list and then + select the **Edit User Profile** item. + +To edit an existing User Profile Edit menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + +*Example Front End Site images are generic images using Joomla! core +installation supplied free Front End Templates. The actual view can +depend on the installed custom template used and the template's style +for those views on a Joomla! website.* + +User Profile Edit shown: + + + +## Related Information + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Users: Options](https://docs.joomla.org/Help4.x:Users:_Options/en "Help4.x:Users: Options/en") | User Options configuration allows setting of parameters used globally for all users. Control the use of Captcha, registration allowed and type of registration, default user group new users, reset password or username counter, and new user registration email notice to administration. | +| [Users](https://docs.joomla.org/Help4.x:Users/en "Help4.x:Users/en") | The Users list is used to find, add, and edit users. | +| [Users: Viewing Access Levels](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en") | In this screen you have the ability to look at a list of your Access Levels and sort them in different ways. You can also edit and create Access Levels. | +| [Users: Edit Viewing Access Level](https://docs.joomla.org/Help4.x:Users:_Edit_Viewing_Access_Level/en "Help4.x:Users: Edit Viewing Access Level/en") | Access levels control which users can view which objects on your site. Objects include menu items, modules, categories, and component items (articles, contacts, and so on). Each object in the site is assigned to one access level. User groups are also assigned to each access level.If a user is a member of a group that in turn has permission for an access level, then that user can view all objects assigned to that access level. It is important to understand that user groups can be arranged in a parent-child hierarchy. If so, then a child group has access to all access levels that the parent group has access to. So you don't need to assign a child group access to levels that its parent group already has access to. | +| [Permissions for Group](https://docs.joomla.org/Help4.x:Permissions_for_Group/en "Help4.x:Permissions for Group/en") | The Debug Permissions report maps out the exact permissions for any given user group across all assets on your Joomla! installation. | +| [Permissions for User](https://docs.joomla.org/Help4.x:Permissions_for_User/en "Help4.x:Permissions for User/en") | The Debug Permissions report allows you to map out the exact permissions for any given user across all extensions on your Joomla installation. | +| [Users: Groups](https://docs.joomla.org/Help4.x:Users:_Groups/en "Help4.x:Users: Groups/en") | User Groups control what actions a user may take on the site and which objects a user can view. This screen allows you to create, view, edit, and delete User Groups. | +| [Users: New or Edit Group](https://docs.joomla.org/Help4.x:Users:_New_or_Edit_Group/en "Help4.x:Users: New or Edit Group/en") | User groups play a central role in what a user can do and see on the site. Creating user groups is normally the first step in setting up the security system for your site. | +| [Mass Mail Users](https://docs.joomla.org/Help4.x:Mass_Mail_Users/en "Help4.x:Mass Mail Users/en") | The Mass Mail screen allows Users who are members of the "Super Administrator" group to send an email message to registered users for the site. Users can be selected based on groups. | +| [Users: Edit Profile](https://docs.joomla.org/Help4.x:Users:_Edit_Profile/en "Help4.x:Users: Edit Profile/en") | In this screen, you have the ability to create a new user (if you clicked on the 'New' button in the User Manager), or edit an existing user (if you selected a user and clicked on the 'Edit' button in the User Manager, or clicked on the name of a user). | +| [User Notes: Categories](https://docs.joomla.org/Help4.x:User_Notes:_Categories/en "Help4.x:User Notes: Categories/en") | This screen allows you to look at a list of your user note categories and sort them in different ways. You can also edit and create user note categories and access levels. | +| [User Notes: New or Edit Category](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit_Category/en "Help4.x:User Notes: New or Edit Category/en") | This is where you can add a new Category or edit an existing Category. Categories are used to organize the User Notes. Categories allow you to display related User notes together on a page and to filter User Notes in the User Notes Manager. All User Notes are assigned either to a Category that you create or to the special Category called 'Uncategorized'. | +| [User Notes](https://docs.joomla.org/Help4.x:User_Notes/en "Help4.x:User Notes/en") | User notes are pieces of information which can be assigned to registered users on your Joomla! site. These notes can contain for example comments about 'offending' or 'difficult' users etc. | +| [User Notes:New or Edit](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit/en "Help4.x:User Notes: New or Edit/en") | In this screen you can create an user note or edit an user note. The 'editor' will be the chosen 'editor' for the user editing the note. Examples: TinyMCE - JCE - Codemirror. | +| [Menu Item: Password Reset](https://docs.joomla.org/Help4.x:Menu_Item:_Password_Reset/en "Help4.x:Menu Item: Password Reset/en") | Used to create a form which allows a user to reset their password with an email sent to the user's email associated with the account. | +| [Menu Item: User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_User_Profile/en "Help4.x:Menu Item: User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| Menu Item: Edit User Profile | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Registration Form](https://docs.joomla.org/Help4.x:Menu_Item:_Registration_Form/en "Help4.x:Menu Item: Registration Form/en") | Used to create a default User Registration form for user registration. Default form contains basic information: Name, Username, Password, and Email Address. | +| [Menu Item: Username Reminder Request](https://docs.joomla.org/Help4.x:Menu_Item:_Username_Reminder_Request/en "Help4.x:Menu Item: Username Reminder Request/en") | Used to create a form which allows a user to request an e-mail with their username. | diff --git a/manuals/help/menu-items/menu-item-extend-consent.md b/manuals/help/menu-items/menu-item-extend-consent.md new file mode 100644 index 0000000..8e9e789 --- /dev/null +++ b/manuals/help/menu-items/menu-item-extend-consent.md @@ -0,0 +1,196 @@ +--- +sidebar_position: 13 +id: menu-item-extend-consent +title: "Help4.x:Menu Item: Extend Consent" +--- +## Description + +The **Extend Consent** menu item type is used to display a form allowing +users to renew their privacy consent. + +## How To Access + +To create a new **Extend Consent** menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the New button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Privacy item to open a list and then + select the **Extend Consent** item. + +To edit an existing Extend Consent menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **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 + +- [The Privacy Tool + Suite](https://docs.joomla.org/J3.x:Privacy/en "J3.x:Privacy/en") diff --git a/manuals/help/menu-items/menu-item-featured-articles.md b/manuals/help/menu-items/menu-item-featured-articles.md new file mode 100644 index 0000000..8562260 --- /dev/null +++ b/manuals/help/menu-items/menu-item-featured-articles.md @@ -0,0 +1,349 @@ +--- +sidebar_position: 14 +id: menu-item-featured-articles +title: "Help4.x:Menu Item: Featured Articles" +--- +## Description + +The Featured Articles menu item type is used to show all Articles that +have been tagged as Featured in a Blog Layout. + +## How To Access + +**Menus **→** \[name of the menu\]** + +To add a Menu Item: + +1. click the **New** toolbar button. +2. click the Menu Item Type **Select** button. +3. select the **Articles** item. +4. select the **Featured Articles** item. + +To edit a Menu Item: + +- select a **Title** from the list + +## Screenshot + + + +## Form Fields + +- **Title**. The title that will display for this menu item. +- **Alias**. The internal name of the menu item. Normally, you can leave + this blank and Joomla will fill in a default value Title in lower case + and with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Alias/en") + +### Details + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. +- **Target Window**. Select from the dropdown list. +- **Template Style**. Select from the dropdown list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + +### Blog Layout + +The Options control the appearance of the blog menu item. + + + +- **Select Categories**. Select the categories you want to include in + this layout. Click the 'X' in the category box to remove category. +- **\# 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. +- **Leading Article Class**. You can add any CSS class for your own + styling ideas. Add a border on top with class boxed.For image position + use for example image-left, image-right. Add image-alternate for + alternate ordering of intro images. +- **\# 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 in which to + display the articles is determined by the Category Order and Article + Order parameters below. +- **Article Class**. You can add any CSS class for your own styling + ideas. Add a border on top with class boxed.For image position use for + example image-left, image-right. Add image-alternate for alternate + ordering of intro images. +- **\# Columns**. The number of columns to use in the Intro Articles + area. This is normally between 1 and 3 (depending on the template you + are using). If 1 is used, the Intro Articles will display using the + full width of the display area, just like the Leading Articles. +- **Multi Column Direction**. In multi-column blog layouts, whether to + order articles Down the columns or Across the columns. + + + +- - Down: Order articles going down the first column and then over to + the next column, for example: + +- + + + +- - Across: Order articles going across the columns and then back to the + first column, for example: + +- + + + +- **\# 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. +- **Linked Intro Image**. If Yes, a click on the intro image shows the + article. +- **Category Order**. + - 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 Order: Categories are ordered according to the Order column + entered in [Articles: + Categories](https://docs.joomla.org/Help4.x:Articles:_Categories/en#ordering "Help4.x:Articles: Categories/en"). +- **Article Order**. + - Featured Articles Order: Articles are ordered according to the Order + column entered in [Articles: + Featured](https://docs.joomla.org/Help4.x:Articles:_Featured/en#ordering "Help4.x:Articles: Featured/en"). + - 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. + - Random Order: Articles are displayed in random order. + - Article Order: Articles are ordered according to the Order column + entered in + [Articles](https://docs.joomla.org/Help4.x:Articles/en#ordering "Help4.x:Articles/en"). + - Article Reverse Order: Articles are ordered reverse to the according + of the Order column entered in + [Articles](https://docs.joomla.org/Help4.x:Articles/en#ordering "Help4.x:Articles/en"). +- **Date for Ordering**. The date used when articles are sorted by date. + - Created: Use the article created date. + - Modified: Use the article modified date. + - Published: Use the article start publishing date. + - Unpublished: Use the article unpublished date. +- **Pagination**. 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. + - Hide: Pagination links not shown. Note: Users will not be able to + navigate to additional pages. + - Show: Pagination links shown if needed. + - Auto: Pagination links shown if needed. +- **Pagination Summary**. Show the current page number and total pages + (e.g., "Page 1 of 2") at the bottom of each page. + +### Options + +The Options determine how the articles will show in the blog menu +item. +Options include "Use Article Settings". If this is selected, the setting +from [Articles: +Edit](https://docs.joomla.org/Help4.x:Articles:_Edit/en "Help4.x:Articles: Edit/en") +will be used. + + + +**Layout** + +- **Title**. Show the Article's Title. +- **Linked Titles**. Show the title as a link to the article. +- **Intro Text**. + - Show: The Intro Text of the article will show when you drill down to + the article. + - Hide: Only the part of the article after the Read More break will + show. +- **Position of Article Info**. + - Above: Puts the article information block above the text. + - Below: Puts the article information block below the text. + - Split: Splits the article information block into 2 separate blocks. + One block is above and the other is below the text. +- **Article Info Title**. Displays 'Details' on top of the article + information block. + +**Category** + +- **Category**. Show the Article's Category Title. +- **Link Category**. Show the title as a link to that Category.Note: You + can set this to be either a blog or list layout with the [Choose a + Layout](https://docs.joomla.org/Help4.x:Articles:_Options/en#choosealayout "Help4.x:Articles: Options/en") + option in the Category Tab. +- **Parent Category**. Show the Article's Parent Category Title. +- **Link Parent Category**. Show the title as a link to that + Category.Note: You can set this to be either a blog or list layout + with the [Choose a + Layout](https://docs.joomla.org/Help4.x:Articles:_Options/en#choosealayout "Help4.x:Articles: Options/en") + option in the Category Tab. + +**Associations** + +- **Associations**. Show the associated flags or Language Code. + [Multilingual + only.](https://docs.joomla.org/Help4.x:Multilingual_Associations/en "Help4.x:Multilingual Associations/en") + +**Author** + +- **Author**. Show the author of the Article. +- **Link to Author's Contact Page**. Show it as a link to a Contact + layout for that author.Note: The author must be set up as a + [Contact](https://docs.joomla.org/Help4.x:Contacts:_Edit/en "Help4.x:Contacts: Edit/en"). + Also, a link will not show if there is an [Author + Alias](https://docs.joomla.org/Help4.x:Articles:_Edit/en#createdbyalias "Help4.x:Articles: Edit/en") + value for the article. + +**Date** + +- **Create Date**. Show the Article's create date. +- **Modify Date**. Show the Article's modify date. +- **Publish Date**. Show the Article's start publishing date. + +**Options** + +- **Navigation**. Show a navigation link 'Prev' or 'Next' when you drill + down to the article. +- **"Read More" Link**. Show the Read More link to link from the part of + the article before the Read More break to the rest of the Article. +- **Read More with Title**. + - Show: The article title is part of the Read More link. The link will + be in the format "Read More: \[article title\]". + - Hide: The link will be "Read more". +- **Hits**. Show the number of times the article has been displayed by a + user. +- **Tags**. Show the tags for each article. +- **Unauthorised Links**. + - 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. + - No: Articles that the user is not authorised to view (based on the + viewing access level for the article) will not show. + +### Integration + +The Options determine whether a news feed will be available for the page +and what information it will show. + + + +- **RSS Feed Link**. If set to Show, a Feed Link will show up as a feed + icon in the address bar of most browsers. +- **Include in Feed**. + - Intro Text: Only the article's intro text will show in the feed. + - Full Text: The entire text of the article will show in the feed. + +### Common Options + +See [Menus: New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types, including: + +- [Right + Panel](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#rightpanel "Help4.x:Menu Item: New Item/en") +- [Link + Type](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#linktype "Help4.x:Menu Item: New Item/en") +- [Page + Display](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#pagedisplay "Help4.x:Menu Item: New Item/en") +- [Metadata](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#metadata "Help4.x:Menu Item: New Item/en") +- [Associations](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#associations "Help4.x:Menu Item: New Item/en") +- [Module + Assignment](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#moduleassignment "Help4.x:Menu Item: New Item/en") + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **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. +- **Cancel**. 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 + +- To see an example of the featured layout, install Joomla with the + sample data and select the Home page. +- Featured articles are selected using [Articles: + Featured](https://docs.joomla.org/Help4.x:Articles:_Featured/en "Help4.x:Articles: Featured/en"). + +## Related Information + +- To create a new Category see [Articles: Edit + Category](https://docs.joomla.org/Help4.x:Articles:_Edit_Category/en "Help4.x:Articles: Edit Category/en"). + + + +- To create a new menu see + [Menus](https://docs.joomla.org/Help4.x:Menus/en "Help4.x:Menus/en"). + + + +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Articles: Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en") | 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. | +| [Articles](https://docs.joomla.org/Help4.x:Articles/en "Help4.x:Articles/en") | The Article list is used to find, mark featured, add and edit articles. | +| [Articles: Edit](https://docs.joomla.org/Help4.x:Articles:_Edit/en "Help4.x:Articles: Edit/en") | This is where you can add and edit Articles. You can also select the Category for an Article and indicate whether or not it is Published and if it is selected to appear on the Front Page. | +| [Articles: Featured](https://docs.joomla.org/Help4.x:Articles:_Featured/en "Help4.x:Articles: Featured/en") | Used to control which 'Featured Articles' are displayed on the Front Page and in what order they are displayed. | +| [Articles: Categories](https://docs.joomla.org/Help4.x:Articles:_Categories/en "Help4.x:Articles: Categories/en") | The Articles Categories list is used to find, add, and edit articles categories. | +| [Menus: Archived Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Article_Archived/en "Help4.x:Menu Item: Article Archived/en") | Shows a customised list of articles ordered by date or title. Archived articles are no longer published but are still stored on the site. | +| [Menus: Category Blog](https://docs.joomla.org/Help4.x:Menu_Item:_Category_Blog/en "Help4.x:Menu Item: Category Blog/en") | Used to show articles belonging to a specific Category in a blog layout. Controls the Leading Articles, Intro Articles and additional links to more Articles. | +| [Menus: Category List](https://docs.joomla.org/Help4.x:Menu_Item:_Category_List/en "Help4.x:Menu Item: Category List/en") | Used to show articles belonging to a specific Category in a list layout. | +| [Menus: Create Article](https://docs.joomla.org/Help4.x:Menu_Item:_Create_Article/en "Help4.x:Menu Item: Create Article/en") | Allows users to submit an article. Normally this is available only to users who have logged in to the Frontend of the site. Users must have permission to create articles. | +| Menus: Featured Articles | Used to show all Articles that have been tagged as Featured. Articles are shown in a Blog Layout. | +| [Menus: List All Categories in an Article Category Tree](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Categories/en "Help4.x:Menu Item: List All Categories/en") | Used to show a hierarchical list of Categories. Depending on the selected options for this layout, you can click on a category Title to show the articles in that category. | +| [Menus: Single Article](https://docs.joomla.org/Help4.x:Menu_Item:_Single_Article/en "Help4.x:Menu Item: Single Article/en") | Used to show one article. | diff --git a/manuals/help/menu-items/menu-item-featured-contacts.md b/manuals/help/menu-items/menu-item-featured-contacts.md new file mode 100644 index 0000000..becf910 --- /dev/null +++ b/manuals/help/menu-items/menu-item-featured-contacts.md @@ -0,0 +1,466 @@ +--- +sidebar_position: 15 +id: menu-item-featured-contacts +title: "Help4.x:Menu Item: Featured Contacts" +--- +## Description + +The **Featured Contacts** menu item type is used to show a list of +featured contacts. + +## How To Access + +To create a new Featured Contacts Menu Item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the New button in the Toolbar. Then... + - Select the Menu Item Type Select button Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Contacts item to open a list and then + select the **Featured Contacts** item. + +To edit an existing Featured Contacts menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### List Layouts Tab + +List Layout Options control the appearance of the list layout. + + + +- **Display Select.** (Use Global/Hide/Show) Whether to hide or show the + Display \# control that allows the user to select the number of items + to show in the list. An example of how it is shown in the Front End + (website) view below. + + + +If there are more items than this number, you can use the page +navigation buttons (Start, Prev, Next, End, and page numbers) to +navigate between pages. Note that if you have a large number of items, +it may be helpful to use the Filter options, located above the column +headings, to limit which items display. + +- **Table Headings.** (Use Global/Hide/Show) Table Headings show a + heading above a list, like generic heading image shown below. + +Help30-article-category-list-table-headings-en.png + +If set to *Show*, this heading will show above the list. If set to +*Hide*, the list will show with no headings. + +- **Position**. Show or hide a Position column in the list of Contacts. + + + +- **Email**. Set to control the Email's display in list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **Phone**. Set to control the Phone's display in list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **Mobile**. Set to control the Mobile's display in list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **Fax**. Set to control the Fax's display in list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **City or Suburb**. Set to control the City or Suburb's display in + list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **State or County**. Set to control the State or County's display in + list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **Country**. Set to control the Country's display in list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **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 listed items will not fit + on one page. An example is shown below. + +Help30-pagination-en.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. + +### Form Tab + +Form Options control the appearance of the list layout. + + + +**Common Contact Form Fields** are: + +- **Tags**. Display the contact's *Tags*. + + + +- **Contact Information**. Display the contact's *Contact Information*. + + + +- **vCard**. Display the contact's *vCard*. + + + +- **Miscellaneous Information**. Display the contact's *Miscellaneous + Information*. + + + +- **User Articles**. Display the contact's *User Articles*. + + + +- **\# Articles to List**. Display the contact's *\# Articles to List*. + + + +- **Contact Links**. Display the contact's *Contact Links*. +- **Link \ Label**. \ Labels (5) to override shown + link's label. + +### Mail Options Tab + +Contact Mail Options control the appearance of a Contact's + **→** *Contact Form* if it is enabled. + + + +- **Show Contact Form**. Display the contact's *contact form*. + +It has the following options available: + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Display this. +- *Hide:* Do not display. + + + +- **Send Copy to Submitter**. Display the a check box to allow a + Submitter to send a copy of email to themselves. + +It has the following options available: + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Display this. +- *Hide:* Do not display. + + + +- **Session Check**. Check for the existence of session cookie. Users + without cookies enabled will not be able to send emails. + +It has the following options available: + +- *Use Global:* Use the default value from the contacts options screen. +- *Yes:* Check for session cookie. +- *No:* Do not check for session cookie. + + + +- **Custom Reply**. Turn on or off the custom message reply to contact + form's submitter, allowing for Plugins to handle integration with + other systems. + +It has the following options available: + +- *Use Global:* Use the default value from the contacts options screen. +- *Yes:* Send an automated reply email. +- *No:* Do not send an automated reply email. + + + +- **Contact Redirect**. Enter alternative URL to redirect submitter + after email is sent. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **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 + +- In order to make your contact featured do one of the following: From + the [Contact + Manager](https://docs.joomla.org/Help4.x:Components_Contacts_Contacts "Special:MyLanguage/Help4.x:Components Contacts Contacts"), + either click on the Featured symbol (circle with a star) in the + Featured column, or click on the Item select check box and select + Feature in the Actions drop-down list in the Toolbar. Several items + can be selected to Feature or Unfeature via the Actions list. + + + +## Related Information + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Contacts: Options](https://docs.joomla.org/Help4.x:Contacts:_Options/en "Help4.x:Contacts: Options/en") | Contact Options configuration allows setting of parameters used globally for all contacts. | +| [Contacts: Categories](https://docs.joomla.org/Help4.x:Contacts:_Categories/en "Help4.x:Contacts: Categories/en") | The Contact Category Manager is where you can edit existing Contact Categories and create new ones. Note that Contact Categories are separate from other Categories, such as for Articles, Banners, News Feeds, and Web Links. From this screen, you can also navigate to the [Contacts](https://docs.joomla.org/Help4.x:Contacts/en "Help4.x:Contacts/en") screen. | +| Contacts: + New or Edit Category | This is where you can add a Contact Category or edit an existing Contact Category. Contact Categories allow you to organize contacts in your web site. Contact Categories are separate from other types of Categories, such as those for Articles, Banners, News Feeds, and so on. | +| [Contacts](https://docs.joomla.org/Help4.x:Contacts/en "Help4.x:Contacts/en") | The Contact Manager screen allows you to add contact information to your Joomla! site. You can enter information such as name, address, phone and e-mail. You can also link contacts to registered users. Afterwards, you can use the [Menu Manager](https://docs.joomla.org/Help4.x:Menus/en "Help4.x:Menus/en") to create front-end links to the the contacts. | +| Contacts: + New or Edit | This is where you can add a Contact or edit an existing Contact. Contacts allow you to list people on your web site. They also allow users to send e-mails to those people. | +| [Menu Item: List Contacts in a Category](https://docs.joomla.org/Help4.x:Menu_Item:_List_Contacts_in_a_Category/en "Help4.x:Menu Item: List Contacts in a Category/en") | Used to show contacts belonging to a specific Category in a list layout. Settings include: Contact Details, Contact Form, presentation(slider, tabs, plain view), and Email subject and message filters. | +| Menu Item: Featured Contacts | Used to show a list of featured contacts. | +| [Menu Item: Single Contact](https://docs.joomla.org/Help4.x:Menu_Item:_Single_Contact/en "Help4.x:Menu Item: Single Contact/en") | Used to show a Single Contact. Settings include: Contact Details, Contact Form, presentation(slider, tabs, plain view), and Email subject and message filters. | diff --git a/manuals/help/menu-items/menu-item-heading.md b/manuals/help/menu-items/menu-item-heading.md new file mode 100644 index 0000000..dd0fcf7 --- /dev/null +++ b/manuals/help/menu-items/menu-item-heading.md @@ -0,0 +1,236 @@ +--- +sidebar_position: 16 +id: menu-item-heading +title: "Help4.x:Menu Item: Heading" +--- +## Description + +The **Menu Heading** menu item type is used to separate menu links with +text or images in a menu. For example, to give a title to a group of +links or allow a short description before each link or groups of links. +See the [Front End Example](#Front_End_Screenshot) screenshot below. + +## How To Access + +To create a new Menu Heading menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the **New** button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the System Links item to open a list and + then select the **Menu Heading** item. + +To edit an existing Menu Heading item type: + +- Select its Title in Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Link Type Tab + + + +- **Link Title Attribute**. An optional, custom description for the + title attribute of the menu hyperlink. + + + +- **Link CSS Style**. An optional, custom style to apply to the menu + hyperlink. + + + +- **Link Image**. Select an image to use with 'Menu Title'. Use 'Add + Menu Title' set to 'No' to show just image. +- **Image Class.** ... + + + +- **Add Menu Title**. If optional image is selected, shows a 'Menu + Title' next to image. Default is 'Yes'. + + + +- **Display in Menu**. Select 'No' if you want to exclude this menu item + from displaying in the menu. Note any submenu items will also be + hidden. + +### Module Assignments Tab + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + + + +*Example Front End Site images are generic images using Joomla! core +installation supplied free Front End Templates. The actual view can +depend on the installed custom template used and the template's style +for those views on a Joomla! website.* + +## Quick Tips + +- It is possible to use an image as a Text Separator. Since a Menu Title + is required, to use only image as a separator, the Menu Title can be a + "space". diff --git a/manuals/help/menu-items/menu-item-iframe-wrapper.md b/manuals/help/menu-items/menu-item-iframe-wrapper.md new file mode 100644 index 0000000..01b11d3 --- /dev/null +++ b/manuals/help/menu-items/menu-item-iframe-wrapper.md @@ -0,0 +1,220 @@ +--- +sidebar_position: 17 +id: menu-item-iframe-wrapper +title: "Help4.x:Menu Item: Iframe Wrapper" +--- +## Description + +The Iframe Wrapper menu item type is used to create a page with embedded +content using an +IFrame with control of +iframe size, width and height. + +## How To Access + +To create a new IFrame Wrapper 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 the New Toolbar button to create a new menu item. +- Click the Menu Item Type Select button Help-4x-Menu-Item-Type-Select-Button-en.png and + then click the Iframe Wrapper Menu Item link under Wrapper. + +To edit an existing IFrame Wrapper Menu Item, click its Title in [Menu +Manager: Menu +Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Help4.x:Menus: Items/en"). + +## Screenshot + +Help-4x-Menus-Menu-Item-Wrapper-en.png + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **URL**. Field to enter a URL (web page address. + +Generally, it is a good idea to always add http:// or https:// when +providing a URL. There is a [Auto +add](https://docs.joomla.org/Help4.x:Menu_Item:_Iframe_Wrapper/en#Advanced_Tab "Help4.x:Menu Item: Iframe Wrapper/en") +function to prefix a URL with http:// unless it detects the prefix in +the URL. *NOTE - Use the relative path to a web page address on Joomla +installation. If your Joomla! website is `http://www.example.com`, then +use ` /html_docs/example.html` omitting `http://www.example.com` and +make sure the 'Auto add' function is disabled.* + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu:** (*Main Menu*/*User Menu*/...). Shows which menu a link will + appear in. +- **Parent Item:** (*Menu Item Root*/...). Select a parent item. +- **Ordering:** Ordering will be available after saving +- **Status:** (*Published*/*Unpublished*/*Trashed*). Set publication + status. +- **Default Page:** (*Yes*/*No*). Sets this menu item as the default or + home page of the site. You must have a default page set at all times. +- **Access:** (*Guest*/*Public*/*Registered*/*Special*/*Customer Access + Level (Example)*). The access level group that is allowed to view this + item. +- **Language:** (*All*/*English (en-GB)*). Assign a language to this + menu item +- **Note:** An optional note to display in the Menu Manager. + +### Scroll Bar Parameters Tab + + + +- **Scroll Bars:** *(No/Yes/Auto)* Whether or not to include horizontal + and vertical scroll bars, no or yes. Auto will add the scroll bars + automatically when needed because of embedded page size. + + + +- **Width:** Width of the IFrame Window. Enter in a number of pixels or + enter in a percentage (%). For example, "550" means 550 pixels. "75%" + means 75% of the page width. + + + +- **Height**. Height of the IFrame Window. Enter in a number of pixels + or enter in a percentage (%). For example, "550" means 550 pixels. + "75%" means 75% of the page height. + +### Advanced Tab + + + +- **Auto height**. Automatically set height to height of external page. + *Note* - this will only work if the external page is on the **same + domain**. For example, `http://www.example.com` the external html must + be in the `example.com` root file structure. Sub domains will not + work, as a sub domain is considered a separate domain. + + + +- **Auto add**. Automatically prefix web address with http://. This + feature will automatically detect and not prefix a URL with http:// or + https:// already used in the URL. + + + +- **Frame border**. Add a border around the IFrame window. + +### Link Type Tab + +See [Menus: New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +page. + +(ToDo - make chunk) + +### Page Display + +See [Menus: New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +page. + +(ToDo - make chunk) + +### Metadata Tab + +See [Menus: New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +page. + +(ToDo - make chunk) + +### Associations Tab + +If the Language in the Details tab is not set to All a list of languages +will appear here to allow selection of alternative languages in which to +display this page. + + + +### Module Assignment Tab + +See [Menu Item Manager: New Menu +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields in **[Module +Assignments](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#Module_Assignment_Tab "Help4.x:Menu Item: New Item/en")** +for this Menu Item. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/menu-items/menu-item-list-all-categories.md b/manuals/help/menu-items/menu-item-list-all-categories.md new file mode 100644 index 0000000..f34d99a --- /dev/null +++ b/manuals/help/menu-items/menu-item-list-all-categories.md @@ -0,0 +1,438 @@ +--- +sidebar_position: 18 +id: menu-item-list-all-categories +title: "Help4.x:Menu Item: List All Categories" +--- +## Description + +The List All Categories menu item type is used to show Categories in a +hierarchical list. Depending on the selected options for this layout, +you can click on a category Title to show the articles in that category. + +## How To Access + +**Menus **→** \[name of the menu\]** + +To add a Menu Item: + +1. click the **New** toolbar button. +2. click the Menu Item Type **Select** button. +3. select the **Articles** item. +4. select the **List All Categories in an Article Category Tree** item. + +To edit a Menu Item: + +- select a **Title** from the list + +## Screenshot + + + +## Form Fields + +- **Title**. The title that will display for this menu item. +- **Alias**. The internal name of the menu item. Normally, you can leave + this blank and Joomla will fill in a default value Title in lower case + and with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Alias/en") + +### Details + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. +- **Select the Top Level Category**. + - Root: Include all article categories. + - Otherwise, select the desired top-level category. All child + categories of the selected category will show in the menu item. +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. +- **Target Window**. Select from the dropdown list. +- **Template Style**. Select from the dropdown list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + +### Categories + +The Categories Options allow you to control various aspects of the menu +item. + + + +Note: Options include "**Use Global**". If this is selected, the setting +from the [Articles: +Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en") +will be used. + +- **Top Level Category Description**. Show the description for the + top-level category. +- **Alternative Description**. Enter an description to override the + category description for the menu item. +- **Subcategory Levels**. Control how many levels of subcategories to + show. +- **Empty Categories**. Show categories that don't contain any articles + or subcategories. +- **Subcategories Descriptions**. Show the description for + subcategories. +- **\# Articles in Category**. Show a count of the total number of + articles in each category. + +### Category + +The Options control the way that category information is shown in the +menu item. + + + +- **Category Title**. Show the title of the category. +- **Category Description**. Show the description for the category. +- **Category Image**. Show the category image. +- **Subcategory Levels**. Control how many levels of subcategories to + show. +- **Empty Categories**. Show categories that don't contain any articles + or subcategories. +- **No Articles Message**. Show a message "There are no articles in this + category". +- **Subcategories Descriptions**. Show the descriptions for + subcategories. +- **\# Articles in Category**. Show a count of the total number of + articles in each category. + +### Blog Layout + +Blog Layout Options control the appearance of the category drill down if +that results in a blog layout. + +Note: If there is a Category Blog menu item defined for a category, the +drill down will navigate to that menu item and the options for that menu +item will control the layout. The options here only take effect if there +is no menu item for a category. + + + +- **Leading Article Class**. You can add any CSS class for your own + styling ideas. Add a border on top with class boxed.For image position + use for example image-left, image-right. Add image-alternate for + alternate ordering of intro images. +- **Article Class**. You can add any CSS class for your own styling + ideas. Add a border on top with class boxed.For image position use for + example image-left, image-right. Add image-alternate for alternate + ordering of intro images. +- **\# 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. +- **\# 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 in which to + display the articles is determined by the Category Order and Article + Order parameters below. +- **\# 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. +- **Include Subcategories**. + - None: Only articles from the current category will show. + - All: All articles from the current category and all subcategories + will show. + - 1-5: All articles from the current category and subcategories up to + and including that level will show. +- **Category Order**. + - 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 Order: Categories are ordered according to the Order column + entered in [Articles: + Categories](https://docs.joomla.org/Help4.x:Articles:_Categories/en#ordering "Help4.x:Articles: Categories/en"). +- **Article Order**. + - Featured Articles Order: Articles are ordered according to the Order + column entered in [Articles: + Featured](https://docs.joomla.org/Help4.x:Articles:_Featured/en#ordering "Help4.x:Articles: Featured/en"). + - 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 Order: Articles are ordered according to the Order column + entered in + [Articles](https://docs.joomla.org/Help4.x:Articles/en#ordering "Help4.x:Articles/en"). + - Article Reverse Order: Articles are ordered reverse to the according + of the Order column entered in + [Articles](https://docs.joomla.org/Help4.x:Articles/en#ordering "Help4.x:Articles/en"). +- **Date for Ordering**. The date used when articles are sorted by date. + - Created: Use the article created date. + - Modified: Use the article modified date. + - Published: Use the article start publishing date. + +### List Layouts + +The Options control the appearance of the category drill-down page when +that is presented as a Category List. + + + +- **Display Select**. Show the Display \# control that allows the user + to select the number of articles to show. +- **Filter Field**. Show a text field in the Frontend where a user can + filter the articles.Options in the Backend menu item edit. + - Hide: Don't show a filter field. + - Title: Filter on article title. + - Author: Filter on the author's name. + - Hits: Filter on the number of article hits. +- **Table Headings**. Show a heading in the article list in the + Frontend. +- **Date**. Show a date in the list. + - Hide: Don't show any date. + - Created: Show the created date. + - Modified: Show the date of the last modification. + - Published: Show the start publishing date. +- **Date Format**. Optional format string to control the format of the + date. [Quick Tip](#dateformat) +- **Hits**. Show the number of hits for articles. +- **Author**. Show the name of the author. +- **\# Articles to List**. Number of articles shown in the list. + +### Shared + +The Shared Options apply for Shared Options in List, Blog and Featured +unless they are changed by the menu settings. + + + +- **Pagination**. 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. + - Hide: Pagination links not shown. Note: Users will not be able to + navigate to additional pages. + - Show: Pagination links shown if needed. + - Auto: Pagination links shown if needed. +- **Pagination Summary**. Show the current page number and total pages + (e.g., "Page 1 of 2") at the bottom of each page. + +### Options + +The Options determine how the articles will show in the list menu item. + + + +**Layout** + +- **Choose a Layout**. Select from the dropdown list. +- **Title**. Show the Article's Title. +- **Linked Titles**. Show the title as a link to the article. +- **Intro Text**. + - Show: The Intro Text of the article will show when you drill down to + the article. + - Hide: Only the part of the article after the Read More break will + show. + +**Category** + +- **Category**. Show the Article's Category Title. +- **Link Category**. Show the title as a link to that Category.Note: You + can set this to be either a blog or list layout with the [Choose a + Layout](https://docs.joomla.org/Help4.x:Articles:_Options/en#choosealayout "Help4.x:Articles: Options/en") + option in the Category Tab. +- **Parent Category**. Show the Article's Parent Category Title. +- **Link Parent Category**. Show the title as a link to that + Category.Note: You can set this to be either a blog or list layout + with the [Choose a + Layout](https://docs.joomla.org/Help4.x:Articles:_Options/en#choosealayout "Help4.x:Articles: Options/en") + option in the Category Tab. + +**Author** + +- **Author**. Show the author of the Article. +- **Link to Author's Contact Page**. Show it as a link to a Contact + layout for that author.Note: The author must be set up as a + [Contact](https://docs.joomla.org/Help4.x:Contacts:_Edit/en "Help4.x:Contacts: Edit/en"). + Also, a link will not show if there is an [Author + Alias](https://docs.joomla.org/Help4.x:Articles:_Edit/en#createdbyalias "Help4.x:Articles: Edit/en") + value for the article. + +**Date** + +- **Create Date**. Show the Article's create date. +- **Modify Date**. Show the Article's modify date. +- **Publish Date**. Show the Article's start publishing date. + +**Options** + +- **Navigation**. Show a navigation link 'Prev' or 'Next' when you drill + down to the article. +- **"Read More" Link**. Show the Read More link to link from the part of + the article before the Read More break to the rest of the Article. +- **Read More with Title**. + - Show: The article title is part of the Read More link. The link will + be in the format "Read More: \[article title\]". + - Hide: The link will be "Read more". +- **Hits**. Show the number of times the article has been displayed by a + user. +- **Unauthorised Links**. + - 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. + - No: Articles that the user is not authorised to view (based on the + viewing access level for the article) will not show. + +### Integration + +The Options determine whether a news feed will be available for the page +and what information it will show. + + + +- **RSS Feed Link**. If set to Show, a Feed Link will show up as a feed + icon in the address bar of most browsers. +- **Include in Feed**. + - Intro Text: Only the article's intro text will show in the feed. + - Full Text: The entire text of the article will show in the feed. + +### Common Options + +See [Menus: New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types, including: + +- [Right + Panel](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#rightpanel "Help4.x:Menu Item: New Item/en") +- [Link + Type](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#linktype "Help4.x:Menu Item: New Item/en") +- [Page + Display](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#pagedisplay "Help4.x:Menu Item: New Item/en") +- [Metadata](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#metadata "Help4.x:Menu Item: New Item/en") +- [Associations](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#associations "Help4.x:Menu Item: New Item/en") +- [Module + Assignment](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#moduleassignment "Help4.x:Menu Item: New Item/en") + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **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. +- **Cancel**. 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 + +- Categories can be "nested" into levels, similar to folders on a disk + drive. In theory there is no absolute limit on the number of levels + you can have. However, as a practical matter it is recommended to keep + the levels to a minimum. The Show All Categories layout may not work + correctly if the number of levels shown is greater than 5. +- If you set up category titles as linkable, the user can drill down on + the category. When they do, they will normally see either a Category + List or Category Blog menu item, depending on which option is + selected. If there is a pre-existing menu item for this category (for + example, a Category Blog menu item), then that menu item will show in + the drill down and the options set for that menu item will control the + page display. Otherwise, the options set for the current Show All + Categories menu item will control the page display. +- You can set the option to drill down to a list or blog in 2 places. + - In [Articles: + Options](https://docs.joomla.org/Help4.x:Articles:_Options/en#choosealayout "Help4.x:Articles: Options/en") + you can set the default value for all categories. + - In [Category: + Edit](https://docs.joomla.org/Help4.x:Articles:_Edit_Category/en#choosealayout "Help4.x:Articles: Edit Category/en") + you can set a value for a specific category. If this is set, it + overrides the default value. +- Customise 'Date Format': You can use D M Y for day month year or d-m-y + for a short version for example 17-08-05 (see + PHP: Date - Examples). If left + blank, it uses DATE_FORMAT_LC1 from your language file. + +## Related Information + +- To create a new menu see + [Menus.](https://docs.joomla.org/Help4.x:Menus/en "Help4.x:Menus/en") + + + +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. + +| | | +|---------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Articles: Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en") | 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. | +| [Articles](https://docs.joomla.org/Help4.x:Articles/en "Help4.x:Articles/en") | The Article list is used to find, mark featured, add and edit articles. | +| [Articles: Edit](https://docs.joomla.org/Help4.x:Articles:_Edit/en "Help4.x:Articles: Edit/en") | This is where you can add and edit Articles. You can also select the Category for an Article and indicate whether or not it is Published and if it is selected to appear on the Front Page. | +| [Articles: Featured](https://docs.joomla.org/Help4.x:Articles:_Featured/en "Help4.x:Articles: Featured/en") | Used to control which 'Featured Articles' are displayed on the Front Page and in what order they are displayed. | +| [Articles: Categories](https://docs.joomla.org/Help4.x:Articles:_Categories/en "Help4.x:Articles: Categories/en") | The Articles Categories list is used to find, add, and edit articles categories. | +| [Menus: Archived Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Article_Archived/en "Help4.x:Menu Item: Article Archived/en") | Shows a customised list of articles ordered by date or title. Archived articles are no longer published but are still stored on the site. | +| [Menus: Category Blog](https://docs.joomla.org/Help4.x:Menu_Item:_Category_Blog/en "Help4.x:Menu Item: Category Blog/en") | Used to show articles belonging to a specific Category in a blog layout. Controls the Leading Articles, Intro Articles and additional links to more Articles. | +| [Menus: Category List](https://docs.joomla.org/Help4.x:Menu_Item:_Category_List/en "Help4.x:Menu Item: Category List/en") | Used to show articles belonging to a specific Category in a list layout. | +| [Menus: Create Article](https://docs.joomla.org/Help4.x:Menu_Item:_Create_Article/en "Help4.x:Menu Item: Create Article/en") | Allows users to submit an article. Normally this is available only to users who have logged in to the Frontend of the site. Users must have permission to create articles. | +| [Menus: Featured Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Articles/en "Help4.x:Menu Item: Featured Articles/en") | Used to show all Articles that have been tagged as Featured. Articles are shown in a Blog Layout. | +| Menus: List All Categories in an Article Category Tree | Used to show a hierarchical list of Categories. Depending on the selected options for this layout, you can click on a category Title to show the articles in that category. | +| [Menus: Single Article](https://docs.joomla.org/Help4.x:Menu_Item:_Single_Article/en "Help4.x:Menu Item: Single Article/en") | Used to show one article. | diff --git a/manuals/help/menu-items/menu-item-list-all-contact-categories.md b/manuals/help/menu-items/menu-item-list-all-contact-categories.md new file mode 100644 index 0000000..eb1a360 --- /dev/null +++ b/manuals/help/menu-items/menu-item-list-all-contact-categories.md @@ -0,0 +1,618 @@ +--- +sidebar_position: 19 +id: menu-item-list-all-contact-categories +title: "Help4.x:Menu Item: List All Contact Categories" +--- +## Description + +The **List All Contact Categories** menu item type is used to show a +list of contact categories within a category. + +## How To Access + +To create a new List All Contact Categories menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). +- Select the New Toolbar button. +- Select the Menu Item Type Select button Help-4x-Menu-Item-Type-Select-Button-en.png. + Then... + - In the modal dialog select the Contacts item to open a list and then + select the **List All Contact Categories** item. + +To edit an existing List All Contact Categories Menu Item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. +- **Top Level Category.** Categories that are within this category will + be displayed. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. +- **Target Window.** This determines how the new page will be opened. + Options are: + - *Parent:* Open new menu item in parent window. This is the default. + - *New Window With Navigation:* Open menu item in a new window with + full browser navigation (for example, "back" button). + - *New Without Navigation:* Open menu item in a new window without + browser navigation. +- **Template Style.** Controls the template style for this menu item. A + list box will show the available template styles for your site, + similar to the following: + + + +Select "Use Default" to use the default style for the site. Select a +specific template style to always show this menu item with that style. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Categories Tab + +The Categories Options control the way categories information is +displayed in the layout. Things that you can modify are: + + + +- **Top Level Category Description.** (Use Global/Hide/Show) Show + description of the top level category or optionally override with the + text from the description field found in menu item. If using Root as + top level category, the description field has to be filled. +- **Alternative Description.** If you enter some text in this field, it + will override the Top Level Category Description, if it has one. +- **Subcategory Levels.** The number of subcategory levels to display. + - *Use Global* Use the default value from the contacts options screen. + - *All* All subcategories under parent category. + - *\<#\>* Select a number, 1 to 5 to set depth of subcategories. +- **Empty Categories.** (Use Global/Hide/Show) If Show, empty categories + will display. A category is only empty - if it has no Contacts or + subcategories. +- **Subcategories Descriptions.** (Use Global/Hide/Show) Show or hide + the subcategories description. +- **\# Contacts in Category.** (Use Global/Hide/Show) Show or hide + number of contacts in a category. + +### Category Tab + +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. + + + +- **Category Title.** (Use Global/Hide/Show) If Show, the Category Title + will show as a subheading on the page. The subheading is usually + displayed inside the "H2" tag. + + + +- **Category Description**. (Use Global/Hide/Show) Show or hide the + description of the selected Category. + + + +- **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. + + + +- **Subcategories Descriptions.** (Use Global/Hide/Show) Whether to hide + or show the category description of subcategories. + + + +- **\# Contacts in Category**. (Use Global/Hide/Show) Whether to hide or + show the number of Contact in a Contact Category. + +### List Layouts Tab + +List Layout Options control the appearance of the list layout. + + + +- **Filter Field:** (Use Global/Hide/Show) Whether to show a Filter + field for the list. Select Hide to hide the filer field + + + +- **Display Select.** (Use Global/Hide/Show) Whether to hide or show the + Display \# control that allows the user to select the number of items + to show in the list. An example of how it is shown in the Front End + (website) view below. + + + +If there are more items than this number, you can use the page +navigation buttons (Start, Prev, Next, End, and page numbers) to +navigate between pages. Note that if you have a large number of items, +it may be helpful to use the Filter options, located above the column +headings, to limit which items display. + +- **Table Headings.** (Use Global/Hide/Show) Table Headings show a + heading above a list, like generic heading image shown below. + +Help30-article-category-list-table-headings-en.png + +If set to *Show*, this heading will show above the list. If set to +*Hide*, the list will show with no headings. + +- **Position**. The Contact's current position. + + + +- **Email**. Set to control the Email's display in list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **Phone**. Set to control the Phone's display in list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **Mobile**. Set to control the Mobile's display in list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **Fax**. Set to control the Fax's display in list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **City or Suburb**. Set to control the City or Suburb's display in + list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **State or County**. Set to control the State or County's display in + list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **Country**. Set to control the Country's display in list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **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 listed items will not fit + on one page. An example is shown below. + +Help30-pagination-en.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. + +### Contact Display Options Tab + +Contact Display Options control the appearance of the list layout. + + + +- **Display Format**. Determines the style used to display sections of + the contact form. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Sliders:* Slider contact view. +- *Tabs:* Tabbed contact view. +- *Plain:* Plain text contact view. + + + +- **Contact Category**. Set to control the Contacts Category display + view. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Hide:* Do not show the Category name of the contacts. +- *Show Without Link:* Show Category name of contacts as heading styled + text only. +- *Show With Link* Show Category name of contacts as heading styled text + linked to Category. + + + +- **Show Contacts List**. Allow the user to use a drop down list of all + contacts in one contact category. Set one of the following options: + + + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show to allow users to select a contact in a drop down list. +- *Hide:* Do not display the Contact list. + + **Common Contact Display Fields** are: + +- **Tags**. Display the contact's *Tags*. + + + +- **Name**. Display the contact's *Name*. + + + +- **Contact's Position**. Display the contact's *Contact's Position*. + + + +- **Email**. Display the contact's *Email*. + + + +- **Street Address**. Display the contact's *Street Address*. + + + +- **City or Suburb**. Display the contact's *City or Suburb*. + + + +- **State or County**. Display the contact's *State or County*. + + + +- **Postal Code**. Display the contact's *Postal Code*. + + + +- **Country**. Display the contact's *Country*. + + + +- **Telephone**. Display the contact's *Telephone*. + + + +- **Mobile phone**. Display the contact's *Mobile phone*. + + + +- **Fax**. Display the contact's *Fax*. + + + +- **Webpage**. Display the contact's *Webpage*. + + + +- **Misc. Information**. Display the contact's *Misc. Information*. + + + +- **Image**. Display the contact's *Image*. + + + +- **vCard**. Display the contact's *vCard*. + + + +- **Show User Articles**. Display the contact's *Articles*. + + + +- **\# Articles to List**. Display the contact's *Number Articles to + list*. + + + +- **Show Links**. Display the contact's *additional links*. These could + be links to Social Media accounts, such as Twitter, Facebook, Skype... + +All of the **Common Contact Display Fields** have the following options +available: + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show this field. +- *Hide:* Do not display this field. + + + +- **Link \ Label**. \ Labels (5) to override shown + link's label. + +### Mail Options Tab + +Contact Mail Options control the appearance of a Contact's + **→** *Contact Form* if it is enabled. + + + +- **Show Contact Form**. Display the contact's *contact form*. +- **Send Copy to Submitter.** (Use Global/Hide/Show) Display the a check + box to allow a Submitter to send a copy of email to themselves. +- **Session Check.** (Use Global/Yes/No) Check for the existence of + session cookie. Users without cookies enabled will not be able to send + emails. +- **Custom Reply.** (Use Global/Yes/No) Turn on or off the custom + message reply to contact form's submitter. +- **Contact Redirect.** Enter alternative URL to redirect submitter + after a successful contact form email was sent. + +### Integration Tab + +The Featured Articles layout has the following Integration Options. + + + +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. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made.Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Related Information + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Contacts: Options](https://docs.joomla.org/Help4.x:Contacts:_Options/en "Help4.x:Contacts: Options/en") | Contact Options configuration allows setting of parameters used globally for all contacts. | +| [Contacts: Categories](https://docs.joomla.org/Help4.x:Contacts:_Categories/en "Help4.x:Contacts: Categories/en") | The Contact Category Manager is where you can edit existing Contact Categories and create new ones. Note that Contact Categories are separate from other Categories, such as for Articles, Banners, News Feeds, and Web Links. From this screen, you can also navigate to the [Contacts](https://docs.joomla.org/Help4.x:Contacts/en "Help4.x:Contacts/en") screen. | +| Contacts: + New or Edit Category | This is where you can add a Contact Category or edit an existing Contact Category. Contact Categories allow you to organize contacts in your web site. Contact Categories are separate from other types of Categories, such as those for Articles, Banners, News Feeds, and so on. | +| [Contacts](https://docs.joomla.org/Help4.x:Contacts/en "Help4.x:Contacts/en") | The Contact Manager screen allows you to add contact information to your Joomla! site. You can enter information such as name, address, phone and e-mail. You can also link contacts to registered users. Afterwards, you can use the [Menu Manager](https://docs.joomla.org/Help4.x:Menus/en "Help4.x:Menus/en") to create front-end links to the the contacts. | +| Contacts: + New or Edit | This is where you can add a Contact or edit an existing Contact. Contacts allow you to list people on your web site. They also allow users to send e-mails to those people. | +| [Menu Item: List Contacts in a Category](https://docs.joomla.org/Help4.x:Menu_Item:_List_Contacts_in_a_Category/en "Help4.x:Menu Item: List Contacts in a Category/en") | Used to show contacts belonging to a specific Category in a list layout. Settings include: Contact Details, Contact Form, presentation(slider, tabs, plain view), and Email subject and message filters. | +| [Menu Item: Featured Contacts](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Contacts/en "Help4.x:Menu Item: Featured Contacts/en") | Used to show a list of featured contacts. | +| [Menu Item: Single Contact](https://docs.joomla.org/Help4.x:Menu_Item:_Single_Contact/en "Help4.x:Menu Item: Single Contact/en") | Used to show a Single Contact. Settings include: Contact Details, Contact Form, presentation(slider, tabs, plain view), and Email subject and message filters. | diff --git a/manuals/help/menu-items/menu-item-list-all-news-feed-categories.md b/manuals/help/menu-items/menu-item-list-all-news-feed-categories.md new file mode 100644 index 0000000..4416e00 --- /dev/null +++ b/manuals/help/menu-items/menu-item-list-all-news-feed-categories.md @@ -0,0 +1,423 @@ +--- +sidebar_position: 20 +id: menu-item-list-all-news-feed-categories +title: "Help4.x:Menu Item: List All News Feed Categories" +--- +## Description + +The **List All News Feed Categories** menu item type is 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. + +## How To Access + +To create a new List All News Feed Categories menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the New button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the News Feeds item to open a list and + then select the **List All News Feed Categories** item. + +To edit an existing List All News Feeds Categories menu item: + +- Select its Title in Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Choose a Category**. The Categories that are within this category + will be displayed. This layout requires a starting top-level category + selection. To include all article categories, select *Root*. + Otherwise, select the desired top-level category. All child categories + of the selected category will show in the layout. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Categories Tab + + + +- **Top Level Category Description.** (Use Global/Hide/Show) Whether to + hide or show the description of the top-level category. Note that this + description can be overridden for this layout by entering a + Alternative Description below. +- **Alternative Description.** If you enter some text in this field, it + will replace the Top Level Category Description, if it has one. If the + Top Level Description option is set to *Show*, this entered + description will show instead of the normal category description. + + + +- **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. + + + +- **Subcategories Descriptions.** (Use Global/Hide/Show) Whether to hide + or show the category description of subcategories. +- **\# Feeds in Category**. (Use Global/Hide/Show) Show or hide the + number of News Feeds in a Category. + +### Category Tab + + + +- **Category Title.** (Use Global/Hide/Show) If Show, the Category Title + will show as a subheading on the page. The subheading is usually + displayed inside the "H2" tag. + + + +- **Category Description**. (Use Global/Hide/Show) Show or hide the + description of the selected Category. + + + +- **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. + + + +- **Subcategories Descriptions.** (Use Global/Hide/Show) Whether to hide + or show the category description of subcategories. +- **\# Feeds in Category**. (Use Global/Hide/Show) Show or hide the + number of News Feeds in a Category. + +### List Layouts Tab + + + +- **Filter Field:** (Use Global/Hide/Show) Whether to show a Filter + field for the list. Select Hide to hide the filer field + + + +- **Display Select.** (Use Global/Hide/Show) Whether to hide or show the + Display \# control that allows the user to select the number of items + to show in the list. An example of how it is shown in the Front End + (website) view below. + + + +If there are more items than this number, you can use the page +navigation buttons (Start, Prev, Next, End, and page numbers) to +navigate between pages. Note that if you have a large number of items, +it may be helpful to use the Filter options, located above the column +headings, to limit which items display. + +- **Table Headings.** (Use Global/Hide/Show) Table Headings show a + heading above a list, like generic heading image shown below. + +Help30-article-category-list-table-headings-en.png + +If set to *Show*, this heading will show above the list. If set to +*Hide*, the list will show with no headings. + +- **\# Articles**. (Use Global/Hide/Show) Show or hide the number of + Articles in each News Feed. Other options are available to set this + value in each individual News Feed. +- **Feed Links**. (Use Global/Hide/Show) Show or hide the feed links + URLs. + + + +- **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 listed items will not fit + on one page. An example is shown below. + +Help30-pagination-en.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. + +### Feed Display Options Tab + + + +The List All News Feed Categories Layout has the following Feed Display +Options, as shown below. In addition to Yes/No or Hide/Show, these +options allow the "Use Global" setting. This uses the default value from +[News Feed: +Options](https://docs.joomla.org/Help4.x:News_Feed:_Options/en "Help4.x:News Feed: Options/en"). + +The Feed Display Options are as follows. + +- **Feed Image**. (Use Global/Hide/Show) Show or hide the image of News + Feeds. + + + +- **Feed Description.** (Use Global/Hide/Show) Hide or Show the + description text of the News Feed. + + + +- **Feed Content**. (Use Global/Hide/Show) Show or hide the content of + News Feeds. +- **Characters count**. Number of characters to show if Feed Content + from News Feeds is set to show. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **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 + +- Categories can be "nested" into levels, similar to folders on a disk + drive. In theory there is no absolute limit on the number of levels + you can have. However, as a practical matter it is recommended to keep + the levels to a minimum. The Show All Categories layout may not work + correctly if the number of levels shown is greater than five. +- If you set up category titles as linkable, the user can drill down on + the category. If there is a pre-existing menu item for this category + (for example, a Category List menu item), then that menu item will + show in the drill down and the options set for that menu item will + control the page display. Otherwise, the options set for the current + Show All Categories menu item will control the page display. +- You can set the option to drill down to a list in two places. + - In [News Feeds Manager + Options](https://docs.joomla.org/Help4.x:News_Feed:_Options/en "Help4.x:News Feed: Options/en") + you can set the default value for all categories. + - In Category + Manager: Edit A Newsfeeds Category you can set a value for a + specific category. If this is set, it overrides the default value. + +## Related Information + +- Categories are created using Category + Manager: Edit A Newsfeeds Category. + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [News Feeds: Categories](https://docs.joomla.org/Help4.x:News_Feeds:_Categories/en "Help4.x:News Feeds: Categories/en") | News Feed Categories allow you to categorize different website feeds entering your site for better organization. | +| [News Feeds: Edit Category](https://docs.joomla.org/Help4.x:News_Feeds:_Edit_Category/en "Help4.x:News Feeds: Edit Category/en") | 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!* | +| [News Feeds](https://docs.joomla.org/Help4.x:News_Feeds/en "Help4.x:News Feeds/en") | 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 [News Feeds: Edit](https://docs.joomla.org/Help4.x:News_Feeds:_Edit "Help4.x:News Feeds: Edit"). | +| [News Feeds: Edit](https://docs.joomla.org/Help4.x:News_Feeds:_Edit/en "Help4.x:News Feeds: Edit/en") | This is where you add a new News Feed or edit an existing one. Note that you need to create at least one [News Feeds Category](https://docs.joomla.org/Help4.x:News_Feeds:_Categories "Help4.x:News Feeds: Categories") before you can create your first News Feed. | +| [Menu Item: List News Feeds in a Category](https://docs.joomla.org/Help4.x:Menu_Item:_List_News_Feeds_in_a_Category/en "Help4.x:Menu Item: List News Feeds in a Category/en") | 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. | +| [Menu Item: Single News Feed](https://docs.joomla.org/Help4.x:Menu_Item:_Single_News_Feed/en "Help4.x:Menu Item: Single News Feed/en") | Used to show a single RSS News Feed. The News Feed is selected from the list of News Feeds created in [News Feeds: Edit](https://docs.joomla.org/Help4.x:News_Feeds:_Edit "Help4.x:News Feeds: Edit"). | diff --git a/manuals/help/menu-items/menu-item-list-all-tags.md b/manuals/help/menu-items/menu-item-list-all-tags.md new file mode 100644 index 0000000..cf5ffd2 --- /dev/null +++ b/manuals/help/menu-items/menu-item-list-all-tags.md @@ -0,0 +1,347 @@ +--- +sidebar_position: 21 +id: menu-item-list-all-tags +title: "Help4.x:Menu Item: List All Tags" +--- +## Description + +The **List All Tags** menu item type is Used to create a page containing +items with selected tags. + +## How To Access + +To create a new **List All Tags** menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the New button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Tags item to open a list and then + select the **List All Tags** item. + +To edit an existing List All Tags menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Parent**. The item (category, menu item, and so on) that is the + parent of the item being edited. + + + +- **Language Filter**. (Use Global (All)/All/Current/English + (en-GB)/...). Optionally filter the list of tags based on language. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Options Tab + + + +- **Number of Columns:** The number of columns to arrange the tags in. + Note that this may not be the number displayed if 12 does not divide + evenly into it because display is based on a 12 column grid. + + + +- **Heading Description.** Description to display at the heading of tags + list. + + + +- **Show Heading Image.** (Use Global/Hide/Show). Show an image at the + heading of the tags list. + + + +- **Heading Image File.** Select or upload the image to display in the + heading of the tags list. + + + +- **Ordering:** (default). The column in which to sort displayed items + in the table. The values are the same as the column heading names. + + + +- **Direction.** Sort order. Descending is highest to lowest. Ascending + is lowest to highest. + + + +- **Item Images.** (Use Global(Hide),Hide, Show) Shows the firts image + for each item in the list. + + + +- **Tag Description.** (Use Global(Hide)/Hide/Show). Show or hide the + description for the tag (only used when a single tag is selected). + + + +- **Maximum Characters.** The maximum number of characters to display + from the description in each tag. + + + +- **Hits**. The number of times an item has been viewed. + +### Selection Options Tab + + + +- **Maximum Items.** The maximum number of results to return. + + + +- **Filter Field.** The Filter Field creates a text field where a user + can enter a field to be used to filter the articles shown in the list. + An example of how this looks in the front-end layout is shown below. + Help30-article-category-list-filter-field-en.png + +The possible options for this (in the back-end menu item edit) are shown +below. + + + +- *Use Global:* Use the value from [Articles: + Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en"). + Only appears in Menu Item Type Options. +- *Hide:* Don't show a filter field. +- *Title:* Filter on article title. +- *Author:* Filter on the author's name. +- *Hits:* Filter on the number of article hits. + + + +- **Display Select.** (Use Global/Hide/Show) Whether to hide or show the + Display \# control that allows the user to select the number of items + to show in the list. An example of how it is shown in the Front End + (website) view below. + + + +If there are more items than this number, you can use the page +navigation buttons (Start, Prev, Next, End, and page numbers) to +navigate between pages. Note that if you have a large number of items, +it may be helpful to use the Filter options, located above the column +headings, to limit which items display. + +- **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 listed items will not fit + on one page. An example is shown below. + +Help30-pagination-en.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. + +### Integration Tab + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + +*Example Front End Site images are generic images using Joomla! core +installation supplied free Front End Templates. The actual view can +depend on the installed custom template used and the template's style +for those views on a Joomla! website.* Tags List Layout: + +## Related Information + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Menus Menu Item Tags Items Compact List](https://docs.joomla.org/Help4.x:Menu_Item:_Compact_List_of_Tagged_Items/en "Help4.x:Menu Item: Compact List of Tagged Items/en") | Used to create a 'Compact List of Tagged Items' page per tag(s) selected. | +| [Menus Menu Item Tags Items List](https://docs.joomla.org/Help4.x:Menu_Item:_Tagged_Items/en "Help4.x:Menu Item: Tagged Items/en") | Used to create a 'Tagged List of Items' page per tag(s) selected. | diff --git a/manuals/help/menu-items/menu-item-list-contacts-in-a-category.md b/manuals/help/menu-items/menu-item-list-contacts-in-a-category.md new file mode 100644 index 0000000..7a4b75d --- /dev/null +++ b/manuals/help/menu-items/menu-item-list-contacts-in-a-category.md @@ -0,0 +1,584 @@ +--- +sidebar_position: 22 +id: menu-item-list-contacts-in-a-category +title: "Help4.x:Menu Item: List Contacts in a Category" +--- +## Description + +The **List Contacts in a Category** menu item type is used to show +contacts in a given Category in a list layout. Settings include: Contact +Details, Contact Form, presentation(slider, tabs, plain view), and Email +subject and message filters. + +## How To Access + +To create a new List Contacts in a Category menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). + - Select the **New** Toolbar button. Then... + - Select the Menu Item Type Select button Help30-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Contacts item to open a list and then + select the **List Contacts in a Category** item. + +To edit an existing List Contacts in a Category menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. +- **Select a Category.** Select a contact category to display. +- **Target Window.** This determines how the new page will be opened. + Options are: + - *Parent* Open new menu item in parent window. This is the default. + - *New Window With Navigation* Open menu item in a new window with + full browser navigation (for example, "back" button). + - *New Without Navigation* Open menu item in a new window without + browser navigation. +- **Template Style.** Controls the template style for this menu item. A + list box will show the available template styles for your site, + similar to the following: + + + +Select "Use Default" to use the default style for the site. Select a +specific template style to always show this menu item with that style. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Category Tab + +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. + + + +- **Category Title.** (Use Global/Hide/Show) If Show, the Category Title + will show as a subheading on the page. The subheading is usually + displayed inside the "H2" tag. + + + +- **Category Description**. (Use Global/Hide/Show) Show or hide the + description of the selected Category. + + + +- **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. + + + +- **Subcategories Descriptions.** (Use Global/Hide/Show) Whether to hide + or show the category description of subcategories. + + + +- **\# Contacts in Category**. (Use Global/Hide/Show) Whether to hide or + show the number of Contact in a Contact Category. + +### List Layouts Tab + +List Layout Options control the appearance of the list layout. + + + +- **Filter Field.** (Use Global/Hide/Show) The Filter Field creates a + text field for the front-end user to enter some part of a contact name + to search for. + + + +- **Display Select.** (Use Global/Hide/Show) Whether to hide or show the + Display \# control that allows the user to select the number of items + to show in the list. An example of how it is shown in the Front End + (website) view below. + + + +If there are more items than this number, you can use the page +navigation buttons (Start, Prev, Next, End, and page numbers) to +navigate between pages. Note that if you have a large number of items, +it may be helpful to use the Filter options, located above the column +headings, to limit which items display. + +- **Table Headings.** (Use Global/Hide/Show) Table Headings show a + heading above a list, like generic heading image shown below. + +Help30-article-category-list-table-headings-en.png + +If set to *Show*, this heading will show above the list. If set to +*Hide*, the list will show with no headings. + +- **Image**. (Use Global/Hide/Show) Show or hide an Image column in the + list of Contacts. +- **Position.** (Use Global/Hide/Show) The position this contact holds + in the organisation. For example CEO, Secretary, Janitor. + + + +- **Email**. Set to control the Email's display in list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **Phone**. Set to control the Phone's display in list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **Mobile**. Set to control the Mobile's display in list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **Fax**. Set to control the Fax's display in list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **City or Suburb**. Set to control the City or Suburb's display in + list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **State or County**. Set to control the State or County's display in + list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **Country**. Set to control the Country's display in list. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show in list. +- *Hide:* Do not show in list. + + + +- **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 listed items will not fit + on one page. An example is shown below. + +Help30-pagination-en.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. + + + +- **Sort by**. Choose the field name to sort. + +### Contact Display Tab + +Contact Display fields control the appearance of the list layout. + + + +- **Choose a Layout.** Select from the list of templates. + + + +- **Contact Category**. Set to control the Contacts Category display + view. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Hide:* Do not show the Category name of the contacts. +- *Show Without Link:* Show Category name of contacts as heading styled + text only. +- *Show With Link* Show Category name of contacts as heading styled text + linked to Category. + + + +- **Show Contacts List**. Allow the user to use a drop down list of all + contacts in one contact category. Set one of the following options: + + + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show to allow users to select a contact in a drop down list. +- *Hide:* Do not display the Contact list. + + + +- **Tags**. Whether to hide or show any tags for this item. + +**Common Contact Display Fields** are: + +- **Name**. Display the contact's *Name*. + + + +- **Contact's Position**. Display the contact's *Contact's Position*. + + + +- **Email**. Display the contact's *Email*. + + + +- **Street Address**. Display the contact's *Street Address*. + + + +- **City or Suburb**. Display the contact's *City or Suburb*. + + + +- **State or County**. Display the contact's *State or County*. + + + +- **Postal Code**. Display the contact's *Postal Code*. + + + +- **Country**. Display the contact's *Country*. + + + +- **Telephone**. Display the contact's *Telephone*. + + + +- **Mobile phone**. Display the contact's *Mobile phone*. + + + +- **Fax**. Display the contact's *Fax*. + + + +- **Webpage**. Display the contact's *Webpage*. + + + +- **Misc. Information**. Display the contact's *Misc. Information*. + + + +- **Image**. Display the contact's *Image*. + + + +- **vCard**. Display the contact's *vCard*. + + + +- **Show User Articles**. Display the contact's *Articles*. + + + +- **\# Articles to List**. Display the contact's *Number of Articles*. + + + +- **Show Links**. Display the contact's *additional links*. These could + be links to Social Media accounts, such as Twitter, Facebook, Skype... + +All of the **Common Contact Display Fields** have the following options +available: + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show this field. +- *Hide:* Do not display this field. + + + +- **Link \ Label**. \ Labels (5) to override shown + link's label. + +### Mail Options Tab + +Contact Mail Options control the appearance of a Contact's + **→** *Contact Form* if it is enabled. + + + +- **Contact Form**. Display the contact's *contact form*. +- **Send Copy to Submitter.** (Use Global/Hide/Show) Display the a check + box to allow a Submitter to send a copy of email to themselves. +- **Session Check.** (Use Global/No/Yes) Check for the existence of + session cookie. Users without cookies enabled will not be able to send + emails. +- **Custom Reply.** (Use Global/No/Yes) Turn on or off the custom + message reply to contact form's submitter. +- **Contact Redirect.** Enter alternative URL to redirect submitter + after a successful contact form email was sent. + +### Integration Tab + +The List Contacts in a Category Menu Item has the following Integration +Options. + + + +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. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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 & Close**. Saves the menu item and closes the current screen. + + + +- **Cancel**. 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 + +- The Category List layout is a convenient way to list a compact + directory of contacts in a category that can include filtering and + searching. + +## Related Information + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Contacts: Options](https://docs.joomla.org/Help4.x:Contacts:_Options/en "Help4.x:Contacts: Options/en") | Contact Options configuration allows setting of parameters used globally for all contacts. | +| [Contacts: Categories](https://docs.joomla.org/Help4.x:Contacts:_Categories/en "Help4.x:Contacts: Categories/en") | The Contact Category Manager is where you can edit existing Contact Categories and create new ones. Note that Contact Categories are separate from other Categories, such as for Articles, Banners, News Feeds, and Web Links. From this screen, you can also navigate to the [Contacts](https://docs.joomla.org/Help4.x:Contacts/en "Help4.x:Contacts/en") screen. | +| Contacts: + New or Edit Category | This is where you can add a Contact Category or edit an existing Contact Category. Contact Categories allow you to organize contacts in your web site. Contact Categories are separate from other types of Categories, such as those for Articles, Banners, News Feeds, and so on. | +| [Contacts](https://docs.joomla.org/Help4.x:Contacts/en "Help4.x:Contacts/en") | The Contact Manager screen allows you to add contact information to your Joomla! site. You can enter information such as name, address, phone and e-mail. You can also link contacts to registered users. Afterwards, you can use the [Menu Manager](https://docs.joomla.org/Help4.x:Menus/en "Help4.x:Menus/en") to create front-end links to the the contacts. | +| Contacts: + New or Edit | This is where you can add a Contact or edit an existing Contact. Contacts allow you to list people on your web site. They also allow users to send e-mails to those people. | +| Menu Item: List Contacts in a Category | Used to show contacts belonging to a specific Category in a list layout. Settings include: Contact Details, Contact Form, presentation(slider, tabs, plain view), and Email subject and message filters. | +| [Menu Item: Featured Contacts](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Contacts/en "Help4.x:Menu Item: Featured Contacts/en") | Used to show a list of featured contacts. | +| [Menu Item: Single Contact](https://docs.joomla.org/Help4.x:Menu_Item:_Single_Contact/en "Help4.x:Menu Item: Single Contact/en") | Used to show a Single Contact. Settings include: Contact Details, Contact Form, presentation(slider, tabs, plain view), and Email subject and message filters. | diff --git a/manuals/help/menu-items/menu-item-list-news-feeds-in-a-category.md b/manuals/help/menu-items/menu-item-list-news-feeds-in-a-category.md new file mode 100644 index 0000000..2901ea2 --- /dev/null +++ b/manuals/help/menu-items/menu-item-list-news-feeds-in-a-category.md @@ -0,0 +1,381 @@ +--- +sidebar_position: 23 +id: menu-item-list-news-feeds-in-a-category +title: "Help4.x:Menu Item: List News Feeds in a Category" +--- +## Description + +The **List News Feeds in a Category** menu item type is 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. + +## How To Access + +To create a new **List News Feeds in a Category** menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the **New** button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the News Feeds item to open a list and + then select the **List News Feeds in a Category** item. + +To edit an existing List News Feeds in a Category menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Choose a Category**. The Categories that are within this category + will be displayed. This layout requires a category selection. Select + the desired top-level category. All child categories can be shown in + the selected category if sub categories are selected to be shown in + the 'Category Options' Tab. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Category Tab + + + +- **Category Title.** (Use Global/Hide/Show) If Show, the Category Title + will show as a subheading on the page. The subheading is usually + displayed inside the "H2" tag. + + + +- **Category Description**. (Use Global/Hide/Show) Show or hide the + description of the selected Category. + + + +- **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. + + + +- **Subcategories Descriptions.** (Use Global/Hide/Show) Whether to hide + or show the category description of subcategories. +- **Feeds in Category.** (Use Global/Hide/Show) Show or hide the number + of News Feeds in a Category. + +### List Layout Tab + + + +- **Filter Field:** (Use Global/Hide/Show) Whether to show a Filter + field for the list. Select Hide to hide the filer field + + + +- **Display Select.** (Use Global/Hide/Show) Whether to hide or show the + Display \# control that allows the user to select the number of items + to show in the list. An example of how it is shown in the Front End + (website) view below. + + + +If there are more items than this number, you can use the page +navigation buttons (Start, Prev, Next, End, and page numbers) to +navigate between pages. Note that if you have a large number of items, +it may be helpful to use the Filter options, located above the column +headings, to limit which items display. + +- **Table Headings.** (Use Global/Hide/Show) Table Headings show a + heading above a list, like generic heading image shown below. + +Help30-article-category-list-table-headings-en.png + +If set to *Show*, this heading will show above the list. If set to +*Hide*, the list will show with no headings. + +- **\# Articles.** (Use Global/Hide/Show) Show or hide the number of + Articles in each News Feed. Other options are available to set this + value in each individual News Feed. +- **Feed Links.** (Use Global/Hide/Show) Show or hide the feed links + URLs. + + + +- **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 listed items will not fit + on one page. An example is shown below. + +Help30-pagination-en.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. + +### Feed Display Options Tab + + + +- **Feed Image**. (Use Global/Hide/Show) Show or hide the image of News + Feeds. + + + +- **Feed Description.** (Use Global/Hide/Show) Hide or Show the + description text of the News Feed. + + + +- **Feed Content**. (Use Global/Hide/Show) Show or hide the content of + News Feeds. +- **Characters count.** Number of characters to show if Feed Content + from News Feeds is set to show. +- **Feed display order.** (Use Global/Most recent first/Oldest first) + Select the feed display order, most recent first, oldest first, or + Global, the setting in News Feeds Options. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **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 + +- Categories can be "nested" into levels, similar to folders on a disk + drive. In theory there is no absolute limit on the number of levels + you can have. However, as a practical matter it is recommended to keep + the levels to a minimum. The Show All Categories layout may not work + correctly if the number of levels shown is greater than five. +- If you set up category titles as linkable, the user can drill down on + the category. If there is a pre-existing menu item for this category + (for example, a Category List menu item), then that menu item will + show in the drill down and the options set for that menu item will + control the page display. Otherwise, the options set for the current + Show All Categories menu item will control the page display. +- You can set the option to drill down to a list in two places. + - In [News Feeds Manager + Options](https://docs.joomla.org/Help4.x:News_Feed:_Options/en "Help4.x:News Feed: Options/en") + you can set the default value for all categories. + - In Category + Manager: Edit A Newsfeeds Category you can set a value for a + specific category. If this is set, it overrides the default value. + +## Related Information + +- Categories are created using Category + Manager: Edit A Newsfeeds Category. + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [News Feeds: Categories](https://docs.joomla.org/Help4.x:News_Feeds:_Categories/en "Help4.x:News Feeds: Categories/en") | News Feed Categories allow you to categorize different website feeds entering your site for better organization. | +| [News Feeds: Edit Category](https://docs.joomla.org/Help4.x:News_Feeds:_Edit_Category/en "Help4.x:News Feeds: Edit Category/en") | 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!* | +| [News Feeds](https://docs.joomla.org/Help4.x:News_Feeds/en "Help4.x:News Feeds/en") | 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 [News Feeds: Edit](https://docs.joomla.org/Help4.x:News_Feeds:_Edit "Help4.x:News Feeds: Edit"). | +| [News Feeds: Edit](https://docs.joomla.org/Help4.x:News_Feeds:_Edit/en "Help4.x:News Feeds: Edit/en") | This is where you add a new News Feed or edit an existing one. Note that you need to create at least one [News Feeds Category](https://docs.joomla.org/Help4.x:News_Feeds:_Categories "Help4.x:News Feeds: Categories") before you can create your first News Feed. | +| Menu Item: List News Feeds in a 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. | +| [Menu Item: Single News Feed](https://docs.joomla.org/Help4.x:Menu_Item:_Single_News_Feed/en "Help4.x:Menu Item: Single News Feed/en") | Used to show a single RSS News Feed. The News Feed is selected from the list of News Feeds created in [News Feeds: Edit](https://docs.joomla.org/Help4.x:News_Feeds:_Edit "Help4.x:News Feeds: Edit"). | diff --git a/manuals/help/menu-items/menu-item-login-form.md b/manuals/help/menu-items/menu-item-login-form.md new file mode 100644 index 0000000..1496922 --- /dev/null +++ b/manuals/help/menu-items/menu-item-login-form.md @@ -0,0 +1,291 @@ +--- +sidebar_position: 24 +id: menu-item-login-form +title: "Help4.x:Menu Item: Login Form" +--- +## Description + +The **Login Form** menu item type is used to create a page containing a +Login form. + +## How To Access + +To create a new **Login Form** menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the New button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Users item to open a list and then + select the **Login Form** item. + +To edit an existing Login Form menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Options Tab + + + +- **Choose Login Redirect Type:** 'Internal URL' lets you manually enter + any internal URL in the Redirect field. 'Menu Item' lets you directly + select an existing menu item. For a multilingual site, it is + recommended to use 'Menu Item'. + + + +- **Menu Item Login Redirect:** Select or create the page the user will + be redirected to after a succesful login. The default is to remain on + the same page. + + + +- **Login Description:** *(Show or Hide)* Show or hide the login + description. + + + +- **Login Description Text:** Enter text to display on Login page. + + + +- **Login Image:** Select or upload an image to display on Login page. + + + +- **Choose Logout Redirect Type:** 'Internal URL' lets you manually + enter any internal URL in the Redirect field. 'Menu Item' lets you + directly select an existing menu item. For a multilingual site, it is + recommended to use 'Menu Item'. + + + +- **Menu Item Logout Redirect:** Select or create the page the user will + be redirected to after succesfully ending their current session by + logging out. The default is to remain on the same page. + + + +- **Logout Description:** Show or hide logout description. + + + +- **Logout Description Text:** Enter text to display on Logout page. + + + +- **Logout Image:** Select or upload an image to display on Logout page. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + +*Example Front End Site images are generic images using Joomla! core +installation supplied free Front End Templates. The actual view can +depend on the installed custom template used and the template's style +for those views on a Joomla! website.* + +User Login shown: + + + +## Quick Tips + +- The **Login and Logout URL** can be used to send a user to a specific + page('article') created to provide some feedback to the user. For + example, a page titled, 'You are now Logged In' with some general + information. The use of a User Module to show links for Updating User + Profile, Viewing User Profile and other User functions could be shown + on this page enhancing a user's site experience. + +## Related Information + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Users: Options](https://docs.joomla.org/Help4.x:Users:_Options/en "Help4.x:Users: Options/en") | User Options configuration allows setting of parameters used globally for all users. Control the use of Captcha, registration allowed and type of registration, default user group new users, reset password or username counter, and new user registration email notice to administration. | +| [Users](https://docs.joomla.org/Help4.x:Users/en "Help4.x:Users/en") | The Users list is used to find, add, and edit users. | +| [Users: Viewing Access Levels](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en") | In this screen you have the ability to look at a list of your Access Levels and sort them in different ways. You can also edit and create Access Levels. | +| [Users: Edit Viewing Access Level](https://docs.joomla.org/Help4.x:Users:_Edit_Viewing_Access_Level/en "Help4.x:Users: Edit Viewing Access Level/en") | Access levels control which users can view which objects on your site. Objects include menu items, modules, categories, and component items (articles, contacts, and so on). Each object in the site is assigned to one access level. User groups are also assigned to each access level.If a user is a member of a group that in turn has permission for an access level, then that user can view all objects assigned to that access level. It is important to understand that user groups can be arranged in a parent-child hierarchy. If so, then a child group has access to all access levels that the parent group has access to. So you don't need to assign a child group access to levels that its parent group already has access to. | +| [Permissions for Group](https://docs.joomla.org/Help4.x:Permissions_for_Group/en "Help4.x:Permissions for Group/en") | The Debug Permissions report maps out the exact permissions for any given user group across all assets on your Joomla! installation. | +| [Permissions for User](https://docs.joomla.org/Help4.x:Permissions_for_User/en "Help4.x:Permissions for User/en") | The Debug Permissions report allows you to map out the exact permissions for any given user across all extensions on your Joomla installation. | +| [Users: Groups](https://docs.joomla.org/Help4.x:Users:_Groups/en "Help4.x:Users: Groups/en") | User Groups control what actions a user may take on the site and which objects a user can view. This screen allows you to create, view, edit, and delete User Groups. | +| [Users: New or Edit Group](https://docs.joomla.org/Help4.x:Users:_New_or_Edit_Group/en "Help4.x:Users: New or Edit Group/en") | User groups play a central role in what a user can do and see on the site. Creating user groups is normally the first step in setting up the security system for your site. | +| [Mass Mail Users](https://docs.joomla.org/Help4.x:Mass_Mail_Users/en "Help4.x:Mass Mail Users/en") | The Mass Mail screen allows Users who are members of the "Super Administrator" group to send an email message to registered users for the site. Users can be selected based on groups. | +| [Users: Edit Profile](https://docs.joomla.org/Help4.x:Users:_Edit_Profile/en "Help4.x:Users: Edit Profile/en") | In this screen, you have the ability to create a new user (if you clicked on the 'New' button in the User Manager), or edit an existing user (if you selected a user and clicked on the 'Edit' button in the User Manager, or clicked on the name of a user). | +| [User Notes: Categories](https://docs.joomla.org/Help4.x:User_Notes:_Categories/en "Help4.x:User Notes: Categories/en") | This screen allows you to look at a list of your user note categories and sort them in different ways. You can also edit and create user note categories and access levels. | +| [User Notes: New or Edit Category](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit_Category/en "Help4.x:User Notes: New or Edit Category/en") | This is where you can add a new Category or edit an existing Category. Categories are used to organize the User Notes. Categories allow you to display related User notes together on a page and to filter User Notes in the User Notes Manager. All User Notes are assigned either to a Category that you create or to the special Category called 'Uncategorized'. | +| [User Notes](https://docs.joomla.org/Help4.x:User_Notes/en "Help4.x:User Notes/en") | User notes are pieces of information which can be assigned to registered users on your Joomla! site. These notes can contain for example comments about 'offending' or 'difficult' users etc. | +| [User Notes:New or Edit](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit/en "Help4.x:User Notes: New or Edit/en") | In this screen you can create an user note or edit an user note. The 'editor' will be the chosen 'editor' for the user editing the note. Examples: TinyMCE - JCE - Codemirror. | +| [Menu Item: Password Reset](https://docs.joomla.org/Help4.x:Menu_Item:_Password_Reset/en "Help4.x:Menu Item: Password Reset/en") | Used to create a form which allows a user to reset their password with an email sent to the user's email associated with the account. | +| [Menu Item: User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_User_Profile/en "Help4.x:Menu Item: User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Edit User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_Edit_User_Profile/en "Help4.x:Menu Item: Edit User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Registration Form](https://docs.joomla.org/Help4.x:Menu_Item:_Registration_Form/en "Help4.x:Menu Item: Registration Form/en") | Used to create a default User Registration form for user registration. Default form contains basic information: Name, Username, Password, and Email Address. | +| [Menu Item: Username Reminder Request](https://docs.joomla.org/Help4.x:Menu_Item:_Username_Reminder_Request/en "Help4.x:Menu Item: Username Reminder Request/en") | Used to create a form which allows a user to request an e-mail with their username. | diff --git a/manuals/help/menu-items/menu-item-logout.md b/manuals/help/menu-items/menu-item-logout.md new file mode 100644 index 0000000..5f89af5 --- /dev/null +++ b/manuals/help/menu-items/menu-item-logout.md @@ -0,0 +1,232 @@ +--- +sidebar_position: 25 +id: menu-item-logout +title: "Help4.x:Menu Item: Logout" +--- +## Description + +The **Logout** menu item type provides a convenient way to logout. + +## How To Access + +To create a new **Logout** menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the New button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Users item to open a list and then + select the **Logout** item. + +To edit an existing Logout menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Options Tab + + + +- **Logout Redirection Page.** Use the default or select a specific page + to redirect to on logout. A user may be viewing a restricted access + page on logout so must be redirected to a public access page. + +### Common Options + +See Menus: Edit/New Item +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **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 + +- The **Login and Logout URL** can be used to send a user to a specific + page('article') created to provide some feedback to the user. For + example, a page titled, 'You are now Logged In' with some general + information. The use of a User Module to show links for Updating User + Profile, Viewing User Profile and other User functions could be shown + on this page enhancing a user's site experience. + +## Related Information + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Users: Options](https://docs.joomla.org/Help4.x:Users:_Options/en "Help4.x:Users: Options/en") | User Options configuration allows setting of parameters used globally for all users. Control the use of Captcha, registration allowed and type of registration, default user group new users, reset password or username counter, and new user registration email notice to administration. | +| [Users](https://docs.joomla.org/Help4.x:Users/en "Help4.x:Users/en") | The Users list is used to find, add, and edit users. | +| [Users: Viewing Access Levels](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en") | In this screen you have the ability to look at a list of your Access Levels and sort them in different ways. You can also edit and create Access Levels. | +| [Users: Edit Viewing Access Level](https://docs.joomla.org/Help4.x:Users:_Edit_Viewing_Access_Level/en "Help4.x:Users: Edit Viewing Access Level/en") | Access levels control which users can view which objects on your site. Objects include menu items, modules, categories, and component items (articles, contacts, and so on). Each object in the site is assigned to one access level. User groups are also assigned to each access level.If a user is a member of a group that in turn has permission for an access level, then that user can view all objects assigned to that access level. It is important to understand that user groups can be arranged in a parent-child hierarchy. If so, then a child group has access to all access levels that the parent group has access to. So you don't need to assign a child group access to levels that its parent group already has access to. | +| [Permissions for Group](https://docs.joomla.org/Help4.x:Permissions_for_Group/en "Help4.x:Permissions for Group/en") | The Debug Permissions report maps out the exact permissions for any given user group across all assets on your Joomla! installation. | +| [Permissions for User](https://docs.joomla.org/Help4.x:Permissions_for_User/en "Help4.x:Permissions for User/en") | The Debug Permissions report allows you to map out the exact permissions for any given user across all extensions on your Joomla installation. | +| [Users: Groups](https://docs.joomla.org/Help4.x:Users:_Groups/en "Help4.x:Users: Groups/en") | User Groups control what actions a user may take on the site and which objects a user can view. This screen allows you to create, view, edit, and delete User Groups. | +| [Users: New or Edit Group](https://docs.joomla.org/Help4.x:Users:_New_or_Edit_Group/en "Help4.x:Users: New or Edit Group/en") | User groups play a central role in what a user can do and see on the site. Creating user groups is normally the first step in setting up the security system for your site. | +| [Mass Mail Users](https://docs.joomla.org/Help4.x:Mass_Mail_Users/en "Help4.x:Mass Mail Users/en") | The Mass Mail screen allows Users who are members of the "Super Administrator" group to send an email message to registered users for the site. Users can be selected based on groups. | +| [Users: Edit Profile](https://docs.joomla.org/Help4.x:Users:_Edit_Profile/en "Help4.x:Users: Edit Profile/en") | In this screen, you have the ability to create a new user (if you clicked on the 'New' button in the User Manager), or edit an existing user (if you selected a user and clicked on the 'Edit' button in the User Manager, or clicked on the name of a user). | +| [User Notes: Categories](https://docs.joomla.org/Help4.x:User_Notes:_Categories/en "Help4.x:User Notes: Categories/en") | This screen allows you to look at a list of your user note categories and sort them in different ways. You can also edit and create user note categories and access levels. | +| [User Notes: New or Edit Category](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit_Category/en "Help4.x:User Notes: New or Edit Category/en") | This is where you can add a new Category or edit an existing Category. Categories are used to organize the User Notes. Categories allow you to display related User notes together on a page and to filter User Notes in the User Notes Manager. All User Notes are assigned either to a Category that you create or to the special Category called 'Uncategorized'. | +| [User Notes](https://docs.joomla.org/Help4.x:User_Notes/en "Help4.x:User Notes/en") | User notes are pieces of information which can be assigned to registered users on your Joomla! site. These notes can contain for example comments about 'offending' or 'difficult' users etc. | +| [User Notes:New or Edit](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit/en "Help4.x:User Notes: New or Edit/en") | In this screen you can create an user note or edit an user note. The 'editor' will be the chosen 'editor' for the user editing the note. Examples: TinyMCE - JCE - Codemirror. | +| [Menu Item: Password Reset](https://docs.joomla.org/Help4.x:Menu_Item:_Password_Reset/en "Help4.x:Menu Item: Password Reset/en") | Used to create a form which allows a user to reset their password with an email sent to the user's email associated with the account. | +| [Menu Item: User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_User_Profile/en "Help4.x:Menu Item: User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Edit User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_Edit_User_Profile/en "Help4.x:Menu Item: Edit User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Registration Form](https://docs.joomla.org/Help4.x:Menu_Item:_Registration_Form/en "Help4.x:Menu Item: Registration Form/en") | Used to create a default User Registration form for user registration. Default form contains basic information: Name, Username, Password, and Email Address. | +| [Menu Item: Username Reminder Request](https://docs.joomla.org/Help4.x:Menu_Item:_Username_Reminder_Request/en "Help4.x:Menu Item: Username Reminder Request/en") | Used to create a form which allows a user to request an e-mail with their username. | diff --git a/manuals/help/menu-items/menu-item-new-item.md b/manuals/help/menu-items/menu-item-new-item.md new file mode 100644 index 0000000..4a6a5ea --- /dev/null +++ b/manuals/help/menu-items/menu-item-new-item.md @@ -0,0 +1,223 @@ +--- +sidebar_position: 26 +id: menu-item-new-item +title: "Help4.x:Menu Item: New Item" +--- +## Description + +Menu Items are the core structure of a Joomla website. Each Menu Item is +a link to a webpage. The Menu Item Type determines the type of page that +will display when this menu choice is selected by the User. + +In this screen, you will select the Menu Item Type for the Menu Item you +are creating and then fill in information about this specific Menu Item. +Some of these fields are common to all Menu Item Types and are +documented in this help screen. + +In addition to these common fields, different Menu Item types may +require different fields unique to that type. These are documented in +the help screen for each type. + +## How To Access + +To add a Menu Item: + +- **Menus **→** \[name of the menu\]** + 1. click the **New** toolbar button. + 2. click the Menu Item Type **Select** button. + +To edit a Menu Item: + +- **Menus **→** \[name of the menu\]** + - select a **Title** from the list + +## Screenshot + + + +## Form Fields + +- **Title**. The title that will display for this menu item. +- **Alias**. The internal name of the menu item. Normally, you can leave + this blank and Joomla will fill in a default value Title in lower case + and with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. +- **Target Window**. Select from the dropdown list. +- **Template Style**. Select from the dropdown list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. +- **Parent Item**. The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. +- **Ordering**. Indicates the order of this menu item in the Menu. The + default Order is to add the menu item to the end of the Menu. This + menu item will moved to the order position just after the menu item + selected from the dropdown list. Note: The Order can also be changed + in [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en"). +- **Status**. The published status of the menu item. +- **Start Publishing**. Date and time to start publishing. Use this + field if you want to enter the menu item 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 the menu item automatically changed to + Unpublished state at a future time (for example, when it is no longer + applicable). +- **Default Page**. If Yes, this menu item is the default page for the + site. There must be exactly one menu item set as the default page. You + can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this menu item. +- **Language**. Menu items language. +- **Note**. This is normally for the site administrator's use and does + not show in the Frontend of the site. + +### Link Type + + + +- **Link Title Attribute**. An optional, custom description for the + title attribute of the menu hyperlink. +- **Link Class**. An optional, custom style to apply to the menu + hyperlink. +- **Link Icon Class**. If an icon class is entered, it takes precedence + over the link image. +- **Link Image**. Select or upload an optional image to be used with the + menu hyperlink. +- **Image Class**. An optional class to apply to the image. +- **Add Menu Title**. If the optional image is added, adds the menu + title next to the image. Default is 'Yes'. +- **Display in Menu**. Select 'No' if you want to exclude this menu item + from displaying in the menu.Note: Any submenu items will also be + hidden. + +### Page Display + + + +Note: Options include "**Use Global**". If this is selected, the setting +from the [Menus: +Options](https://docs.joomla.org/Help4.x:Menus:_Options/en "Special:MyLanguage/Help4.x:Menus: Options/en") +will be used. + +- **Browser Page Title**. Optional text for the 'Browser page title' + element. If blank, a default value is used based on the Menu Item + Title. +- **Show Page Heading**. Show the Browser Page Title in the heading of + the page (If no optional text entered - will default to value based on + the Menu Item Title). The Page heading is usually displayed inside the + HTML-tag 'H1'. +- **Page Heading**. Optional alternative text for the Page heading. +- **Page Class**. Optional CSS class to add to elements in this page. + This allows CSS styling specific to this page. + +### Metadata + + + +- **Meta Description**. An paragraph to be used as the description of + the page. [Learn + more.](https://docs.joomla.org/Using_The_Meta_Description/en "Special:MyLanguage/Using The Meta Description/en") +- **Robots**. The instructions for web 'robots' that browse to this + page. Set 'Use Global' in [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#robots "Special:MyLanguage/Help4.x:Site Global Configuration/en"). + +### Associations + + + +[Multilingual +only.](https://docs.joomla.org/Help4.x:Multilingual_Associations/en "Special:MyLanguage/Help4.x:Multilingual Associations/en") + +### Module Assignment + + + +- **Unassigned Modules**. Show modules unassigned to this menu item +- **Unpublished Modules**. Show modules that are unpublished + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **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. +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. +- **Help**. Opens this help screen. + +Saved menu items have additional buttons: + +- Dropdown 'Save & Close': + - **Save as Copy**. Saves your changes to a copy of the current menu + item. Does not affect the current menu item. +- **Associations**. With a specific language set for an menu item, + allows side by side editing in another language. [Multilingual + only](https://docs.joomla.org/Help4.x:Multilingual_Associations/en "Special:MyLanguage/Help4.x:Multilingual Associations/en"). +- **Close** instead 'Cancel', same function. + +## Quick Tips + +- To add an menu item [Archived + Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Article_Archived/en "Special:MyLanguage/Help4.x:Menu Item: Article Archived/en"). +- The core distribution of Joomla provides 38 different Menu Item types. + If you install third-party extensions, these may add more menu types. + +## Related Information + +- Tutorial: [How to Add a New + Menu](https://docs.joomla.org/J4.x:Adding_a_New_Menu/en "Special:MyLanguage/J4.x:Adding a New Menu/en"). +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Special:MyLanguage/Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. diff --git a/manuals/help/menu-items/menu-item-password-reset.md b/manuals/help/menu-items/menu-item-password-reset.md new file mode 100644 index 0000000..fdbb185 --- /dev/null +++ b/manuals/help/menu-items/menu-item-password-reset.md @@ -0,0 +1,222 @@ +--- +sidebar_position: 27 +id: menu-item-password-reset +title: "Help4.x:Menu Item: Password Reset" +--- +## Description + +The **Password Reset** menu item type is used to create a page +containing a Password Reset form. It asks for the email associated with +the user account and sends an email containing a reset token to the +provided address. + +## How To Access + +To create a new Password Reset menu item: + +- Select **Menus **→** "name of the menu"** from the Administrator menu + (for example, **Menus **→** Main Menu**). Then... + - Select the New button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialogue select the Users item to open a list and then + select the **Password Reset** item. + +To edit an existing User Password Reset menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + +*Example Front End Site images are generic images using Joomla! core +installation supplied free Front End Templates. The actual view can +depend on the installed custom template used and the template's style +for those views on a Joomla! website.* User Password Reset shown: + + + +## Related Information + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Users: Options](https://docs.joomla.org/Help4.x:Users:_Options/en "Help4.x:Users: Options/en") | User Options configuration allows setting of parameters used globally for all users. Control the use of Captcha, registration allowed and type of registration, default user group new users, reset password or username counter, and new user registration email notice to administration. | +| [Users](https://docs.joomla.org/Help4.x:Users/en "Help4.x:Users/en") | The Users list is used to find, add, and edit users. | +| [Users: Viewing Access Levels](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en") | In this screen you have the ability to look at a list of your Access Levels and sort them in different ways. You can also edit and create Access Levels. | +| [Users: Edit Viewing Access Level](https://docs.joomla.org/Help4.x:Users:_Edit_Viewing_Access_Level/en "Help4.x:Users: Edit Viewing Access Level/en") | Access levels control which users can view which objects on your site. Objects include menu items, modules, categories, and component items (articles, contacts, and so on). Each object in the site is assigned to one access level. User groups are also assigned to each access level.If a user is a member of a group that in turn has permission for an access level, then that user can view all objects assigned to that access level. It is important to understand that user groups can be arranged in a parent-child hierarchy. If so, then a child group has access to all access levels that the parent group has access to. So you don't need to assign a child group access to levels that its parent group already has access to. | +| [Permissions for Group](https://docs.joomla.org/Help4.x:Permissions_for_Group/en "Help4.x:Permissions for Group/en") | The Debug Permissions report maps out the exact permissions for any given user group across all assets on your Joomla! installation. | +| [Permissions for User](https://docs.joomla.org/Help4.x:Permissions_for_User/en "Help4.x:Permissions for User/en") | The Debug Permissions report allows you to map out the exact permissions for any given user across all extensions on your Joomla installation. | +| [Users: Groups](https://docs.joomla.org/Help4.x:Users:_Groups/en "Help4.x:Users: Groups/en") | User Groups control what actions a user may take on the site and which objects a user can view. This screen allows you to create, view, edit, and delete User Groups. | +| [Users: New or Edit Group](https://docs.joomla.org/Help4.x:Users:_New_or_Edit_Group/en "Help4.x:Users: New or Edit Group/en") | User groups play a central role in what a user can do and see on the site. Creating user groups is normally the first step in setting up the security system for your site. | +| [Mass Mail Users](https://docs.joomla.org/Help4.x:Mass_Mail_Users/en "Help4.x:Mass Mail Users/en") | The Mass Mail screen allows Users who are members of the "Super Administrator" group to send an email message to registered users for the site. Users can be selected based on groups. | +| [Users: Edit Profile](https://docs.joomla.org/Help4.x:Users:_Edit_Profile/en "Help4.x:Users: Edit Profile/en") | In this screen, you have the ability to create a new user (if you clicked on the 'New' button in the User Manager), or edit an existing user (if you selected a user and clicked on the 'Edit' button in the User Manager, or clicked on the name of a user). | +| [User Notes: Categories](https://docs.joomla.org/Help4.x:User_Notes:_Categories/en "Help4.x:User Notes: Categories/en") | This screen allows you to look at a list of your user note categories and sort them in different ways. You can also edit and create user note categories and access levels. | +| [User Notes: New or Edit Category](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit_Category/en "Help4.x:User Notes: New or Edit Category/en") | This is where you can add a new Category or edit an existing Category. Categories are used to organize the User Notes. Categories allow you to display related User notes together on a page and to filter User Notes in the User Notes Manager. All User Notes are assigned either to a Category that you create or to the special Category called 'Uncategorized'. | +| [User Notes](https://docs.joomla.org/Help4.x:User_Notes/en "Help4.x:User Notes/en") | User notes are pieces of information which can be assigned to registered users on your Joomla! site. These notes can contain for example comments about 'offending' or 'difficult' users etc. | +| [User Notes:New or Edit](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit/en "Help4.x:User Notes: New or Edit/en") | In this screen you can create an user note or edit an user note. The 'editor' will be the chosen 'editor' for the user editing the note. Examples: TinyMCE - JCE - Codemirror. | +| Menu Item: Password Reset | Used to create a form which allows a user to reset their password with an email sent to the user's email associated with the account. | +| [Menu Item: User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_User_Profile/en "Help4.x:Menu Item: User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Edit User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_Edit_User_Profile/en "Help4.x:Menu Item: Edit User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Registration Form](https://docs.joomla.org/Help4.x:Menu_Item:_Registration_Form/en "Help4.x:Menu Item: Registration Form/en") | Used to create a default User Registration form for user registration. Default form contains basic information: Name, Username, Password, and Email Address. | +| [Menu Item: Username Reminder Request](https://docs.joomla.org/Help4.x:Menu_Item:_Username_Reminder_Request/en "Help4.x:Menu Item: Username Reminder Request/en") | Used to create a form which allows a user to request an e-mail with their username. | diff --git a/manuals/help/menu-items/menu-item-registration-form.md b/manuals/help/menu-items/menu-item-registration-form.md new file mode 100644 index 0000000..ca978c9 --- /dev/null +++ b/manuals/help/menu-items/menu-item-registration-form.md @@ -0,0 +1,234 @@ +--- +sidebar_position: 28 +id: menu-item-registration-form +title: "Help4.x:Menu Item: Registration Form" +--- +## Description + +The **Registration Form** menu item type is used to create a User +Registration form page. The default form contains basic information: +Name, Username, Password, and Email Address. + +## How To Access + +To create a new **Registration Form** menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the New button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Users item to open a list and then + select the **Registration Form** item. + +To edit an existing Registration Form menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + +*Example Front End Site images are generic images using Joomla! core +installation supplied free Front End Templates. The actual view can +depend on the installed custom template used and the template's style +for those views on a Joomla! website.* Default User Registration form: + + + +## Quick Tips + +- For extended registration, see the [User Profile + Plugin](https://docs.joomla.org/Help4.x:Plugins:_Name_of_Plugin/en "Help4.x:Plugins: Name of Plugin/en"). + It can be used to add required fields for registration and it provides + a method to force a TOS(Terms of Service) acceptance for registration. + +## Related Information + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Users: Options](https://docs.joomla.org/Help4.x:Users:_Options/en "Help4.x:Users: Options/en") | User Options configuration allows setting of parameters used globally for all users. Control the use of Captcha, registration allowed and type of registration, default user group new users, reset password or username counter, and new user registration email notice to administration. | +| [Users](https://docs.joomla.org/Help4.x:Users/en "Help4.x:Users/en") | The Users list is used to find, add, and edit users. | +| [Users: Viewing Access Levels](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en") | In this screen you have the ability to look at a list of your Access Levels and sort them in different ways. You can also edit and create Access Levels. | +| [Users: Edit Viewing Access Level](https://docs.joomla.org/Help4.x:Users:_Edit_Viewing_Access_Level/en "Help4.x:Users: Edit Viewing Access Level/en") | Access levels control which users can view which objects on your site. Objects include menu items, modules, categories, and component items (articles, contacts, and so on). Each object in the site is assigned to one access level. User groups are also assigned to each access level.If a user is a member of a group that in turn has permission for an access level, then that user can view all objects assigned to that access level. It is important to understand that user groups can be arranged in a parent-child hierarchy. If so, then a child group has access to all access levels that the parent group has access to. So you don't need to assign a child group access to levels that its parent group already has access to. | +| [Permissions for Group](https://docs.joomla.org/Help4.x:Permissions_for_Group/en "Help4.x:Permissions for Group/en") | The Debug Permissions report maps out the exact permissions for any given user group across all assets on your Joomla! installation. | +| [Permissions for User](https://docs.joomla.org/Help4.x:Permissions_for_User/en "Help4.x:Permissions for User/en") | The Debug Permissions report allows you to map out the exact permissions for any given user across all extensions on your Joomla installation. | +| [Users: Groups](https://docs.joomla.org/Help4.x:Users:_Groups/en "Help4.x:Users: Groups/en") | User Groups control what actions a user may take on the site and which objects a user can view. This screen allows you to create, view, edit, and delete User Groups. | +| [Users: New or Edit Group](https://docs.joomla.org/Help4.x:Users:_New_or_Edit_Group/en "Help4.x:Users: New or Edit Group/en") | User groups play a central role in what a user can do and see on the site. Creating user groups is normally the first step in setting up the security system for your site. | +| [Mass Mail Users](https://docs.joomla.org/Help4.x:Mass_Mail_Users/en "Help4.x:Mass Mail Users/en") | The Mass Mail screen allows Users who are members of the "Super Administrator" group to send an email message to registered users for the site. Users can be selected based on groups. | +| [Users: Edit Profile](https://docs.joomla.org/Help4.x:Users:_Edit_Profile/en "Help4.x:Users: Edit Profile/en") | In this screen, you have the ability to create a new user (if you clicked on the 'New' button in the User Manager), or edit an existing user (if you selected a user and clicked on the 'Edit' button in the User Manager, or clicked on the name of a user). | +| [User Notes: Categories](https://docs.joomla.org/Help4.x:User_Notes:_Categories/en "Help4.x:User Notes: Categories/en") | This screen allows you to look at a list of your user note categories and sort them in different ways. You can also edit and create user note categories and access levels. | +| [User Notes: New or Edit Category](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit_Category/en "Help4.x:User Notes: New or Edit Category/en") | This is where you can add a new Category or edit an existing Category. Categories are used to organize the User Notes. Categories allow you to display related User notes together on a page and to filter User Notes in the User Notes Manager. All User Notes are assigned either to a Category that you create or to the special Category called 'Uncategorized'. | +| [User Notes](https://docs.joomla.org/Help4.x:User_Notes/en "Help4.x:User Notes/en") | User notes are pieces of information which can be assigned to registered users on your Joomla! site. These notes can contain for example comments about 'offending' or 'difficult' users etc. | +| [User Notes:New or Edit](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit/en "Help4.x:User Notes: New or Edit/en") | In this screen you can create an user note or edit an user note. The 'editor' will be the chosen 'editor' for the user editing the note. Examples: TinyMCE - JCE - Codemirror. | +| [Menu Item: Password Reset](https://docs.joomla.org/Help4.x:Menu_Item:_Password_Reset/en "Help4.x:Menu Item: Password Reset/en") | Used to create a form which allows a user to reset their password with an email sent to the user's email associated with the account. | +| [Menu Item: User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_User_Profile/en "Help4.x:Menu Item: User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Edit User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_Edit_User_Profile/en "Help4.x:Menu Item: Edit User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| Menu Item: Registration Form | Used to create a default User Registration form for user registration. Default form contains basic information: Name, Username, Password, and Email Address. | +| [Menu Item: Username Reminder Request](https://docs.joomla.org/Help4.x:Menu_Item:_Username_Reminder_Request/en "Help4.x:Menu Item: Username Reminder Request/en") | Used to create a form which allows a user to request an e-mail with their username. | diff --git a/manuals/help/menu-items/menu-item-search.md b/manuals/help/menu-items/menu-item-search.md new file mode 100644 index 0000000..f60a632 --- /dev/null +++ b/manuals/help/menu-items/menu-item-search.md @@ -0,0 +1,388 @@ +--- +sidebar_position: 29 +id: menu-item-search +title: "Help4.x:Menu Item: Search" +--- +## Description + +The **Search** menu item type is used to create a page for Smart Search +Results. It can be used in conjunction with a Smart Search module to +control a Search Results Page layout. + +## How To Access + +To create a new Search menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the **New** button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Smart Search item to open a list and + then select the **Search** item. + +To edit an existing Search menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Search Content Maps**. Optional, used to search in content map + title. + + + +- **Search Filters**. Select from list of \ in drop down + to limit searches to the selected filter. + +*Note: Filters must be created using [Smart Search +Filters](https://docs.joomla.org/Help4.x:Smart_Search:_Search_Filters/en "Help4.x:Smart Search: Search Filters/en") +before they are populated to this drop down list.* + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Options Tab + + + +- **Date Filters**. Show the start and end date filters in Advanced + Search. + + + +- *Show:* Show filter in Advanced Search. +- *Hide:* Hide this filter in Advanced Search. +- *Use Global:* Use the default value from the Smart Search options. + + + +- **Advanced Search**. Users should be able to see the Advanced Search. + + + +- *Show:* Show Advanced Search. +- *Hide:* Hide Advanced Search. +- *Use Global:* Use the default value from the Smart Search options. + + + +- **Expand Advanced Search**. Show Advanced Search in expanded state by + default. + + + +- *Show:* Show Expanded Advanced Search in results by default. +- *Hide:* Hide Expanded Advanced Search in results. +- *Use Global:* Use the default value from the Smart Search options. + + + +- **Result Taxonomy.** ...? + + + +- **Result Description:** Show a description under link in search + results. + - *Show:* Show description in search results. + - *Hide:* Hide description in search results. + - *Use Global:* Use the default value from the Smart Search options. + + + +- **Description Length**. Number of characters of the description in + search results. Enter \ in field, default is 255. +- **Result Date.** ...? + + + +- **Result URL:** Show the result item's URL in search results. The URL + is located under the description. + - *Show:* Show URL in search results. + - *Hide:* Hide the URL in search results. + - *Use Global:* Use the default value from the Smart Search options. + +### Advanced Tab + + + +- **Display Select.** (Use Global/Hide/Show) Whether to hide or show the + Display \# control that allows the user to select the number of items + to show in the list. An example of how it is shown in the Front End + (website) view below. + + + +If there are more items than this number, you can use the page +navigation buttons (Start, Prev, Next, End, and page numbers) to +navigate between pages. Note that if you have a large number of items, +it may be helpful to use the Filter options, located above the column +headings, to limit which items display. + +- **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 listed items will not fit + on one page. An example is shown below. + +Help30-pagination-en.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. + + + +- **Allow Empty Search**. Only if a filter is selected. Allows an empty + search string to initiate a search with the filter constraints. + + + +- **Did You Mean**. Whether to suggest alternative search terms when a + search produces no result. + + + +- **Query Explanation**. Show or hide a detailed explanation of the + search requested. +- **Show Sort Fields**: (*Show*/*Hide*) Show the additional sort fields. +- **Additional Sort Fields**: Choose one or more fields to sort the + search results + - Relevance: Order the results by relevance + - Title: Order the results by title + - Date: Order the results by date + - List price: Order the results by list price + - Sales price: Order the results by sales price + + + +- **Sort Direction**. Direction to sort search results. + + + +- *Descending*. +- *Ascending*. +- *Use Global:* Use the default value from the Smart Search options. + +### Integration Tab + + + +- **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. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made.Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Related Items + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Smart Search: Search Filters](https://docs.joomla.org/Help4.x:Smart_Search:_Search_Filters/en "Help4.x:Smart Search: Search Filters/en") | This screen shows the static search filters currently available for use in Smart Search. | +| [Smart Search: New or Edit Filter](https://docs.joomla.org/Help4.x:Smart_Search:_New_or_Edit_Filter/en "Help4.x:Smart Search: New or Edit Filter/en") | This screen allows you to create a new search filter or amend an existing one. | +| Components + Search | The Search Statistics screen allows you to see how many searches were done for each keyword combination and how many results were returned for each search. | +| Components + Search Manager Options | Details on Component Options and Permissions configuration | +| [Site Modules: Smart Search](https://docs.joomla.org/Help4.x:Site_Modules:_Smart_Search/en "Help4.x:Site Modules: Smart Search/en") | Smart Search is an enhanced site search. | +| Menus + Menu Item Search Results | Used to create a 'Search Form or Search Results' page for users to search site's content. Additional, used to control output look of search results or 'can' the results of a search with a menu link for preset search term or terms. | diff --git a/manuals/help/menu-items/menu-item-separator.md b/manuals/help/menu-items/menu-item-separator.md new file mode 100644 index 0000000..750863c --- /dev/null +++ b/manuals/help/menu-items/menu-item-separator.md @@ -0,0 +1,233 @@ +--- +sidebar_position: 30 +id: menu-item-separator +title: "Help4.x:Menu Item: Separator" +--- +## Description + +The **Separator** menu item type is used to separate links with images +or text in a menu. Some uses might be to give a title to a group of +links or allow a short description before each link or groups of links. +See the [Front End Example](#Front_End_Screenshot) screenshot below. + +## How To Access + +To create a new **Separator** menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the **New** button in the Toolbar. + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + \*\* In the modal dialog select the System Links item to open a list + and then select the **Separator** item. + +To edit an existing Separator menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Link Type Tab + + + +- **Link CSS Style**. An optional, custom style to apply to the menu + hyperlink. + + + +- **Link Image**. Select an image to use with 'Menu Title'. Use 'Add + Menu Title' set to 'No' to show just image. + + + +- **Add Menu Title**. If optional image is selected, shows a 'Menu + Title' next to image. Default is 'Yes'. + + + +- **Display in Menu**. Select 'No' if you want to exclude this menu item + from displaying in the menu. Note any submenu items will also be + hidden. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + + + +*Example Front End Site images are generic images using Joomla! core +installation supplied free Front End Templates. The actual view can +depend on the installed custom template used and the template's style +for those views on a Joomla! website.* + +## Quick Tips + +- It is possible to use an image as a Text Separator. Since a Menu Title + is required, to use only image as a separator, the Menu Title can be a + "space". diff --git a/manuals/help/menu-items/menu-item-single-article.md b/manuals/help/menu-items/menu-item-single-article.md new file mode 100644 index 0000000..37e09bb --- /dev/null +++ b/manuals/help/menu-items/menu-item-single-article.md @@ -0,0 +1,217 @@ +--- +sidebar_position: 31 +id: menu-item-single-article +title: "Help4.x:Menu Item: Single Article" +--- +## Description + +The Single Article menu item type is used to show one article in the +Frontend of the site. + +## How To Access + +**Menus **→** \[name of the menu\]** + +To add a Menu Item: + +1. click the **New** toolbar button. +2. click the Menu Item Type **Select** button. +3. select the **Articles** item. +4. select the **Single Article** item. + +To edit a Menu Item: + +- select a **Title** from the list + +## Screenshot + + + +## Form Fields + +- **Title**. The title that will display for this menu item. +- **Alias**. The internal name of the menu item. Normally, you can leave + this blank and Joomla will fill in a default value Title in lower case + and with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Alias/en") + +### Details + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. +- **Select Article**. This field holds the article to be shown in the + menu item. Press the **Select/Change** button to open the article + selection window.This screen is similar to the + [Articles](https://docs.joomla.org/Help4.x:Articles/en "Help4.x:Articles/en") + page. You can use the Filter fields to find the desired article and + then click on the article's Title to select it. At that point, the + modal window will close and the title will show in the Select Article + field. +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. +- **Target Window**. Select from the dropdown list. +- **Template Style**. Select from the dropdown list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + +### Options + +The Options determine how the article will show on the Frontend Site +layout. + + + +Note: Options include "**Use Global**". If this is selected, the setting +from the [Articles: +Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en") +will be used. + +**Layout** + +- **Title**. Show the Article's Title. +- **Linked Titles**. Show the title as a link to the article. +- **Intro Text**. + - Show: The Intro Text of the article will show when you drill down to + the article. + - Hide: Only the part of the article after the Read More break will + show. +- **Position of Article Info**. + - Above: Puts the article information block above the text. + - Below: Puts the article information block below the text. + - Split: Splits the article information block into 2 separate blocks. + One block is above and the other is below the text. +- **Article Info Title**. Displays 'Details' on top of the article + information block. + +**Category** + +- **Category**. Show the Article's Category Title. +- **Link Category**. Show the title as a link to that Category.Note: You + can set this to be either a blog or list layout with the [Choose a + Layout](https://docs.joomla.org/Help4.x:Articles:_Options/en#choosealayout "Help4.x:Articles: Options/en") + option in the Category Tab. +- **Parent Category**. Show the Article's Parent Category Title. +- **Link Parent Category**. Show the title as a link to that + Category.Note: You can set this to be either a blog or list layout + with the [Choose a + Layout](https://docs.joomla.org/Help4.x:Articles:_Options/en#choosealayout "Help4.x:Articles: Options/en") + option in the Category Tab. + +**Associations** + +- **Associations**. Show the associated flags or Language Code. + [Multilingual + only.](https://docs.joomla.org/Help4.x:Multilingual_Associations/en "Help4.x:Multilingual Associations/en") + +**Author** + +- **Author**. Show the author of the Article. +- **Link to Author's Contact Page**. Show it as a link to a Contact + layout for that author.Note: The author must be set up as a + [Contact](https://docs.joomla.org/Help4.x:Contacts:_Edit/en "Help4.x:Contacts: Edit/en"). + Also, a link will not show if there is an [Author + Alias](https://docs.joomla.org/Help4.x:Articles:_Edit/en#createdbyalias "Help4.x:Articles: Edit/en") + value for the article. + +**Date** + +- **Create Date**. Show the Article's create date. +- **Modify Date**. Show the Article's modify date. +- **Publish Date**. Show the Article's start publishing date. + +**Options** + +- **Navigation**. Show a navigation link 'Prev' or 'Next' when you drill + down to the article. +- **Hits**. Show the number of times the article has been displayed by a + user. +- **Tags**. Show the tags for each article. +- **Unauthorised Links**. + - 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. + - No: Articles that the user is not authorised to view (based on the + viewing access level for the article) will not show. +- **Positioning of the Links**. + - Above: Links are shown above the content. + - Below: Links are shown below the content. + +### Common Options + +See [Menus: New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types, including: + +- [Right + Panel](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#rightpanel "Help4.x:Menu Item: New Item/en") +- [Link + Type](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#linktype "Help4.x:Menu Item: New Item/en") +- [Page + Display](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#pagedisplay "Help4.x:Menu Item: New Item/en") +- [Metadata](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#metadata "Help4.x:Menu Item: New Item/en") +- [Associations](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#associations "Help4.x:Menu Item: New Item/en") +- [Module + Assignment](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en#moduleassignment "Help4.x:Menu Item: New Item/en") + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **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. +- **Cancel**. 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 + +- If you have a Single Article Layout defined for an article, that + layout will show any time a user drills down to that article. For + example, if an article is shown on another menu item type (for + example, in a Category Blog or List Layout or a Featured Articles + Layout), the user will be taken to the Single Article Layout for that + article (if defined). +- Archived articles are no longer published but are still stored on the + site. Articles are Archived using the Articles screen. Note that + Articles assigned to the 'Uncategorised' Section will not show on the + Archived Article List layout. + +## Related Information + +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Articles: Options](https://docs.joomla.org/Help4.x:Articles:_Options/en "Help4.x:Articles: Options/en") | 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. | +| [Articles](https://docs.joomla.org/Help4.x:Articles/en "Help4.x:Articles/en") | The Article list is used to find, mark featured, add and edit articles. | +| [Articles: Edit](https://docs.joomla.org/Help4.x:Articles:_Edit/en "Help4.x:Articles: Edit/en") | This is where you can add and edit Articles. You can also select the Category for an Article and indicate whether or not it is Published and if it is selected to appear on the Front Page. | +| [Articles: Featured](https://docs.joomla.org/Help4.x:Articles:_Featured/en "Help4.x:Articles: Featured/en") | Used to control which 'Featured Articles' are displayed on the Front Page and in what order they are displayed. | +| [Articles: Categories](https://docs.joomla.org/Help4.x:Articles:_Categories/en "Help4.x:Articles: Categories/en") | The Articles Categories list is used to find, add, and edit articles categories. | +| [Menus: Archived Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Article_Archived/en "Help4.x:Menu Item: Article Archived/en") | Shows a customised list of articles ordered by date or title. Archived articles are no longer published but are still stored on the site. | +| [Menus: Category Blog](https://docs.joomla.org/Help4.x:Menu_Item:_Category_Blog/en "Help4.x:Menu Item: Category Blog/en") | Used to show articles belonging to a specific Category in a blog layout. Controls the Leading Articles, Intro Articles and additional links to more Articles. | +| [Menus: Category List](https://docs.joomla.org/Help4.x:Menu_Item:_Category_List/en "Help4.x:Menu Item: Category List/en") | Used to show articles belonging to a specific Category in a list layout. | +| [Menus: Create Article](https://docs.joomla.org/Help4.x:Menu_Item:_Create_Article/en "Help4.x:Menu Item: Create Article/en") | Allows users to submit an article. Normally this is available only to users who have logged in to the Frontend of the site. Users must have permission to create articles. | +| [Menus: Featured Articles](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Articles/en "Help4.x:Menu Item: Featured Articles/en") | Used to show all Articles that have been tagged as Featured. Articles are shown in a Blog Layout. | +| [Menus: List All Categories in an Article Category Tree](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Categories/en "Help4.x:Menu Item: List All Categories/en") | Used to show a hierarchical list of Categories. Depending on the selected options for this layout, you can click on a category Title to show the articles in that category. | +| Menus: Single Article | Used to show one article. | diff --git a/manuals/help/menu-items/menu-item-single-contact.md b/manuals/help/menu-items/menu-item-single-contact.md new file mode 100644 index 0000000..9461b61 --- /dev/null +++ b/manuals/help/menu-items/menu-item-single-contact.md @@ -0,0 +1,416 @@ +--- +sidebar_position: 32 +id: menu-item-single-contact +title: "Help4.x:Menu Item: Single Contact" +--- +## Description + +The **Single Contact** is used to show a menu link for a Single Contact +with optional settings such as Contact Details, Contact Form and Email +subject and message filters. + +## How To Access + +To create a new Single Contact Menu Item: + +- Select **Menus **→** \[name of the menu\]** from Administrator menu + (for example, **Menus **→** Main Menu**). Then... + - Select the **New** button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Contacts item to open a list and then + select the **Single Contact** item. + +To edit an existing Single Contact menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Select Contact**. Select a contact to display for this menu item. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Contact Display Options + +Contact Display Options control the appearance of the list layout. + + + +- **Display Format**. Determines the style used to display sections of + the contact form. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Sliders:* Slider contact view. +- *Tabs:* Tabbed contact view. +- *Plain:* Plain text contact view. + + + +- **Contact Category**. Set to control the Contacts Category display + view. + +The following options are available. + +- *Use Global:* Use the default value from the contacts options screen. +- *Hide:* Do not show the Category name of the contacts. +- *Show Without Link:* Show Category name of contacts as heading styled + text only. +- *Show With Link* Show Category name of contacts as heading styled text + linked to Category. + + + +- **Show Contacts List**. Allow the user to use a drop down list of all + contacts in one contact category. Set one of the following options: + + + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show to allow users to select a contact in a drop down list. +- *Hide:* Do not display the Contact list. + + + +- **Tags**. Whether to hide or show any tags for this item. + + **Common Contact Display Fields** are: + +- **Name**. Display the contact's *Name*. + + + +- **Contact's Position**. Display the contact's *Contact's Position*. + + + +- **Email**. Display the contact's *Email*. + + + +- **Street Address**. Display the contact's *Street Address*. + + + +- **City or Suburb**. Display the contact's *City or Suburb*. + + + +- **State or County**. Display the contact's *State or County*. + + + +- **Postal Code**. Display the contact's *Postal Code*. + + + +- **Country**. Display the contact's *Country*. + + + +- **Telephone**. Display the contact's *Telephone*. + + + +- **Mobile phone**. Display the contact's *Mobile phone*. + + + +- **Fax**. Display the contact's *Fax*. + + + +- **Webpage**. Display the contact's *Webpage*. + + + +- **Misc. Information**. Display the contact's *Misc. Information*. + + + +- **Image**. Display the contact's *Image*. + + + +- **vCard**. Display the contact's *vCard*. + + + +- **Show User Articles**. Display the contact's *Articles*. + + + +- **\# Articles to List**. Display the contact's *Number of articles to + list*. + + + +- **Show Links**. Display the contact's *additional links*. These could + be links to Social Media accounts, such as Twitter, Facebook, Skype... + +All of the **Common Contact Display Fields** have the following options +available: + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Show this field. +- *Hide:* Do not display this field. + + + +- **Link \ Label**. \ Labels (5) to override shown + link's label. + +### Mail Options + +Contact Mail Options control the appearance of a Contact's + **→** *Contact Form* if it is enabled. + + + +- **Show Contact Form**. Display the contact's *contact form*. + +It has the following options available: + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Display this. +- *Hide:* Do not display. + + + +- **Send Copy to Submitter**. Display the a check box to allow a + Submitter to send a copy of email to themselves. + +It has the following options available: + +- *Use Global:* Use the default value from the contacts options screen. +- *Show:* Display this. +- *Hide:* Do not display. + + + +- **Session Check**. Check for the existence of session cookie. Users + without cookies enabled will not be able to send emails. + +It has the following options available: + +- *Use Global:* Use the default value from the contacts options screen. +- *Yes:* Check for session cookie. +- *No:* Do not check for session cookie. + + + +- **Custom Reply**. Turn on or off the custom message reply to contact + form's submitter. + +It has the following options available: + +- *Use Global:* Use the default value from the contacts options screen. +- *Yes:* Send an automated reply email. +- *No:* Do not send an automated reply email. + + + +- **Contact Redirect**. Enter alternative URL to redirect submitter + after a successful contact form email was sent. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **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 + +- The Category List layout is a convenient way to list a compact + directory of contacts in a category that can include filtering and + searching. + +## Related Information + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Contacts: Options](https://docs.joomla.org/Help4.x:Contacts:_Options/en "Help4.x:Contacts: Options/en") | Contact Options configuration allows setting of parameters used globally for all contacts. | +| [Contacts: Categories](https://docs.joomla.org/Help4.x:Contacts:_Categories/en "Help4.x:Contacts: Categories/en") | The Contact Category Manager is where you can edit existing Contact Categories and create new ones. Note that Contact Categories are separate from other Categories, such as for Articles, Banners, News Feeds, and Web Links. From this screen, you can also navigate to the [Contacts](https://docs.joomla.org/Help4.x:Contacts/en "Help4.x:Contacts/en") screen. | +| Contacts: + New or Edit Category | This is where you can add a Contact Category or edit an existing Contact Category. Contact Categories allow you to organize contacts in your web site. Contact Categories are separate from other types of Categories, such as those for Articles, Banners, News Feeds, and so on. | +| [Contacts](https://docs.joomla.org/Help4.x:Contacts/en "Help4.x:Contacts/en") | The Contact Manager screen allows you to add contact information to your Joomla! site. You can enter information such as name, address, phone and e-mail. You can also link contacts to registered users. Afterwards, you can use the [Menu Manager](https://docs.joomla.org/Help4.x:Menus/en "Help4.x:Menus/en") to create front-end links to the the contacts. | +| Contacts: + New or Edit | This is where you can add a Contact or edit an existing Contact. Contacts allow you to list people on your web site. They also allow users to send e-mails to those people. | +| [Menu Item: List Contacts in a Category](https://docs.joomla.org/Help4.x:Menu_Item:_List_Contacts_in_a_Category/en "Help4.x:Menu Item: List Contacts in a Category/en") | Used to show contacts belonging to a specific Category in a list layout. Settings include: Contact Details, Contact Form, presentation(slider, tabs, plain view), and Email subject and message filters. | +| [Menu Item: Featured Contacts](https://docs.joomla.org/Help4.x:Menu_Item:_Featured_Contacts/en "Help4.x:Menu Item: Featured Contacts/en") | Used to show a list of featured contacts. | +| Menu Item: Single Contact | Used to show a Single Contact. Settings include: Contact Details, Contact Form, presentation(slider, tabs, plain view), and Email subject and message filters. | diff --git a/manuals/help/menu-items/menu-item-single-news-feed.md b/manuals/help/menu-items/menu-item-single-news-feed.md new file mode 100644 index 0000000..0e45fd9 --- /dev/null +++ b/manuals/help/menu-items/menu-item-single-news-feed.md @@ -0,0 +1,260 @@ +--- +sidebar_position: 33 +id: menu-item-single-news-feed +title: "Help4.x:Menu Item: Single News Feed" +--- +## Description + +The **Single News Feed** menu item type is used to show a single RSS +News Feed created in the [News +Feeds](https://docs.joomla.org/Help4.x:News_Feeds:_Edit "Help4.x:News Feeds: Edit") +component. + +## How To Access + +To create a new Single News Feed menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the New button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the News Feeds item to open a list and + then select the **Single News Feed** item. + +To edit an existing Single News Feeds menu item: + +- Select its Title in Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Feed.** The News Feed for this page. Select one of the available + News Feeds from the dropdown menu. News Feeds are added using the + [News Feeds: + New](https://docs.joomla.org/Help4.x:News_Feeds:_Edit "Help4.x:News Feeds: Edit") + page. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Feed Display Options Tab + + + +In addition to Yes/No or Hide/Show, these options allow the "Use Global" +setting. This uses the default value from the [News Feeds +Options](https://docs.joomla.org/Help4.x:News_Feed:_Options/en "Help4.x:News Feed: Options/en") +screen. + +- **Feed Image**. (Use Global/Hide/Show) Show or hide the image of News + Feeds. + + + +- **Feed Description.** (Use Global/Hide/Show) Hide or Show the + description text of the News Feed. + + + +- **Feed Content**. (Use Global/Hide/Show) Show or hide the content of + News Feeds. +- **Show Tags**. Show the tags for a news feed. +- **Characters count**. Number of characters to show if Feed Content + from News Feeds is set to show. +- **Feed display order**. (Use Global/Most recent first/Oldest first) + Select the feed display order, most recent first, oldest first, or + Global, the setting in News Feeds Options. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- You can set the News Feed options in two places. + - In [News Feeds + Options](https://docs.joomla.org/Help4.x:News_Feed:_Options "Help4.x:News Feed: Options") + screen you can set the default value for all categories. + - In [News Feeds: New/Edit + Category](https://docs.joomla.org/Help4.x:News_Feeds:_Edit_Category "Help4.x:News Feeds: Edit Category") + you can set a value for a specific category. If this is set, it + overrides the default value. + +## Related Information + +- Categories are created using [News Feeds: New/Edit + Category](https://docs.joomla.org/Help4.x:News_Feeds:_Edit_Category "Help4.x:News Feeds: Edit Category"). + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [News Feeds: Categories](https://docs.joomla.org/Help4.x:News_Feeds:_Categories/en "Help4.x:News Feeds: Categories/en") | News Feed Categories allow you to categorize different website feeds entering your site for better organization. | +| [News Feeds: Edit Category](https://docs.joomla.org/Help4.x:News_Feeds:_Edit_Category/en "Help4.x:News Feeds: Edit Category/en") | 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!* | +| [News Feeds](https://docs.joomla.org/Help4.x:News_Feeds/en "Help4.x:News Feeds/en") | 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 [News Feeds: Edit](https://docs.joomla.org/Help4.x:News_Feeds:_Edit "Help4.x:News Feeds: Edit"). | +| [News Feeds: Edit](https://docs.joomla.org/Help4.x:News_Feeds:_Edit/en "Help4.x:News Feeds: Edit/en") | This is where you add a new News Feed or edit an existing one. Note that you need to create at least one [News Feeds Category](https://docs.joomla.org/Help4.x:News_Feeds:_Categories "Help4.x:News Feeds: Categories") before you can create your first News Feed. | +| [Menu Item: List News Feeds in a Category](https://docs.joomla.org/Help4.x:Menu_Item:_List_News_Feeds_in_a_Category/en "Help4.x:Menu Item: List News Feeds in a Category/en") | 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. | +| Menu Item: Single News Feed | Used to show a single RSS News Feed. The News Feed is selected from the list of News Feeds created in [News Feeds: Edit](https://docs.joomla.org/Help4.x:News_Feeds:_Edit "Help4.x:News Feeds: Edit"). | diff --git a/manuals/help/menu-items/menu-item-site-configuration-options.md b/manuals/help/menu-items/menu-item-site-configuration-options.md new file mode 100644 index 0000000..8a6f78e --- /dev/null +++ b/manuals/help/menu-items/menu-item-site-configuration-options.md @@ -0,0 +1,203 @@ +--- +sidebar_position: 34 +id: menu-item-site-configuration-options +title: "Help4.x:Menu Item: Site Configuration Options" +--- +## Description + +The *Site Configuration Options* menu item type allows a Joomla! +super-user to easily change the site configuration. The page it links to +is a simplified version of the Administrator's Site Global Configuration +page. It provides access to some of the important site configuration +parameters. After a change, the super-user will see the results +immediately. This menu item is intended to help new super-users with +site development. + +## How To Access + +To create a new **Display Site Configuration** menu item type: + +- Select **Menus **→** \[name of the menu\]** from the from the + Administrator menu (for example, **Menus **→** Main Menu**). Then... + - Click the New button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Configuration Manager item to open a + list and then select the **Site Configuration Options** item.. + +To edit an existing Site Configuration Options menu item: Select its +Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + + diff --git a/manuals/help/menu-items/menu-item-tagged-items.md b/manuals/help/menu-items/menu-item-tagged-items.md new file mode 100644 index 0000000..989f5ed --- /dev/null +++ b/manuals/help/menu-items/menu-item-tagged-items.md @@ -0,0 +1,361 @@ +--- +sidebar_position: 35 +id: menu-item-tagged-items +title: "Help4.x:Menu Item: Tagged Items" +--- +## Description + +The **Tagged Items** menu item type is used to create a page to display +content with selected tags. + +## How To Access + +To create a new **Tagged Items** menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the New button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Tags item to open a list and then + select the **Tagged Items** item. + +To edit an existing Tagged Items menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Tag**. Select the tag to use. + + + +- **Content Type.** Only tags of the selected types will be displayed + (optional). + + + +- **Language Filter**. (Use Global (All)/All/Current/English + (en-GB)/...). Optionally filter the list of tags based on language. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Tag Options Tab + + + +- **Show Tag Name.** (Use Global(Hide)/Hide/Show). For a layout with one + tag, show the tag name. + + + +- **Tag Image.** (Use Global(Hide)/Hide/Show). For a layout with one + tag, show the image for the tag. + + + +- **Tag Description.** (Use Global(Hide)/Hide/Show). Show or hide the + description for the tag (only used when a single tag is selected). + + + +- **Image.** Select or upload the image. + + + +- **Description**. The description for the item. Category, Subcategory + and Web Link descriptions may be shown on web pages, depending on the + parameter settings. These descriptions are entered using the same + editor that is used for Articles. + + + +- **Ordering:** (default). The column in which to sort displayed items + in the table. The values are the same as the column heading names. + + + +- **Direction.** Sort order. Descending is highest to lowest. Ascending + is lowest to highest. + +### Item Options Tab + + + +- **Item Image:** Show the image for each item. + + + +- **Item Description:** Show or hide the description for each item in + the list. The lenght may be limited using the Maximum Character + option. + + + +- **Maximum Characters:** The maximum number of characters to display + from the description in each tag. + + + +- **Filter Field:** Show or hide field for the list. + +### Pagination Options Tab + + + +- **Display Select.** (Use Global/Hide/Show) Whether to hide or show the + Display \# control that allows the user to select the number of items + to show in the list. An example of how it is shown in the Front End + (website) view below. + + + +If there are more items than this number, you can use the page +navigation buttons (Start, Prev, Next, End, and page numbers) to +navigate between pages. Note that if you have a large number of items, +it may be helpful to use the Filter options, located above the column +headings, to limit which items display. + +- **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 listed items will not fit + on one page. An example is shown below. + +Help30-pagination-en.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. + +### Item Selection Options Tab + + + +- **Match Type:** All will return items that have all of the tags. Any + will return items that have at least one of the tags. + + + +- **Child Tags:** Include or exclude child tags from the result list for + a tag. + +### Integration Tab + + + +- **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. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. 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. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + +*Example Front End Site images are generic images using Joomla! core +installation supplied free Front End Templates. The actual view can +depend on the installed custom template used and the template's style +for those views on a Joomla! website.* Tags List Layout: + +## Related Information + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Menus Menu Item Tags Items Compact List](https://docs.joomla.org/Help4.x:Menu_Item:_Compact_List_of_Tagged_Items/en "Help4.x:Menu Item: Compact List of Tagged Items/en") | Used to create a 'Compact List of Tagged Items' page per tag(s) selected. | +| [Menus Menu Item Tags Items List All](https://docs.joomla.org/Help4.x:Menu_Item:_List_All_Tags/en "Help4.x:Menu Item: List All Tags/en") | Used to create a 'List of All Tags' page per tag(s) selected. | diff --git a/manuals/help/menu-items/menu-item-url.md b/manuals/help/menu-items/menu-item-url.md new file mode 100644 index 0000000..9820eb6 --- /dev/null +++ b/manuals/help/menu-items/menu-item-url.md @@ -0,0 +1,200 @@ +--- +sidebar_position: 36 +id: menu-item-url +title: "Help4.x:Menu Item: URL" +--- +## Description + +The **URL** menu item type is used to create a link to a separate +website. + +## How To Access + +To create a new **URL** menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu(for example, **Menus **→** Main Menu**). Then... + - Select the **New** button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the System Links item to open a list and + then select the **URL** item. + +To edit an existing External URL menu item: + +- Select its Title in the Menus: Items list. + +## Screenshot + +800px‎ + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. +- **Link**. Enter the URL to which this menu item should point. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. +- **Link Rel Attibute**. The rel Attribute spexifies the relationship + between the page you start on and the page the link directs you to.For + an in-depth explanation of this attribute and what each option means, + please reference the MDN Documentation + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Quick Tips + +Make sure you include the full URL path. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/menu-items/menu-item-user-profile.md b/manuals/help/menu-items/menu-item-user-profile.md new file mode 100644 index 0000000..4feb996 --- /dev/null +++ b/manuals/help/menu-items/menu-item-user-profile.md @@ -0,0 +1,228 @@ +--- +sidebar_position: 37 +id: menu-item-user-profile +title: "Help4.x:Menu Item: User Profile" +--- +## Description + +The **User Profile** menu item type creates a page displaying a user's +own Profile settings. + +## How To Access + +To create a new **User Profile** menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the New button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Users item to open a list and then + select the **User Profile** item. + +To edit an existing User Profile Menu Item: + +- Select its Title in the Menus: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +#### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + +*Example Front End Site images are generic images using Joomla! core +installation supplied free Front End Templates. The actual view can +depend on the installed custom template used and the template's style +for those views on a Joomla! website.* + +User Profile shown: + + + +## Related Information + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Users: Options](https://docs.joomla.org/Help4.x:Users:_Options/en "Help4.x:Users: Options/en") | User Options configuration allows setting of parameters used globally for all users. Control the use of Captcha, registration allowed and type of registration, default user group new users, reset password or username counter, and new user registration email notice to administration. | +| [Users](https://docs.joomla.org/Help4.x:Users/en "Help4.x:Users/en") | The Users list is used to find, add, and edit users. | +| [Users: Viewing Access Levels](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en") | In this screen you have the ability to look at a list of your Access Levels and sort them in different ways. You can also edit and create Access Levels. | +| [Users: Edit Viewing Access Level](https://docs.joomla.org/Help4.x:Users:_Edit_Viewing_Access_Level/en "Help4.x:Users: Edit Viewing Access Level/en") | Access levels control which users can view which objects on your site. Objects include menu items, modules, categories, and component items (articles, contacts, and so on). Each object in the site is assigned to one access level. User groups are also assigned to each access level.If a user is a member of a group that in turn has permission for an access level, then that user can view all objects assigned to that access level. It is important to understand that user groups can be arranged in a parent-child hierarchy. If so, then a child group has access to all access levels that the parent group has access to. So you don't need to assign a child group access to levels that its parent group already has access to. | +| [Permissions for Group](https://docs.joomla.org/Help4.x:Permissions_for_Group/en "Help4.x:Permissions for Group/en") | The Debug Permissions report maps out the exact permissions for any given user group across all assets on your Joomla! installation. | +| [Permissions for User](https://docs.joomla.org/Help4.x:Permissions_for_User/en "Help4.x:Permissions for User/en") | The Debug Permissions report allows you to map out the exact permissions for any given user across all extensions on your Joomla installation. | +| [Users: Groups](https://docs.joomla.org/Help4.x:Users:_Groups/en "Help4.x:Users: Groups/en") | User Groups control what actions a user may take on the site and which objects a user can view. This screen allows you to create, view, edit, and delete User Groups. | +| [Users: New or Edit Group](https://docs.joomla.org/Help4.x:Users:_New_or_Edit_Group/en "Help4.x:Users: New or Edit Group/en") | User groups play a central role in what a user can do and see on the site. Creating user groups is normally the first step in setting up the security system for your site. | +| [Mass Mail Users](https://docs.joomla.org/Help4.x:Mass_Mail_Users/en "Help4.x:Mass Mail Users/en") | The Mass Mail screen allows Users who are members of the "Super Administrator" group to send an email message to registered users for the site. Users can be selected based on groups. | +| [Users: Edit Profile](https://docs.joomla.org/Help4.x:Users:_Edit_Profile/en "Help4.x:Users: Edit Profile/en") | In this screen, you have the ability to create a new user (if you clicked on the 'New' button in the User Manager), or edit an existing user (if you selected a user and clicked on the 'Edit' button in the User Manager, or clicked on the name of a user). | +| [User Notes: Categories](https://docs.joomla.org/Help4.x:User_Notes:_Categories/en "Help4.x:User Notes: Categories/en") | This screen allows you to look at a list of your user note categories and sort them in different ways. You can also edit and create user note categories and access levels. | +| [User Notes: New or Edit Category](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit_Category/en "Help4.x:User Notes: New or Edit Category/en") | This is where you can add a new Category or edit an existing Category. Categories are used to organize the User Notes. Categories allow you to display related User notes together on a page and to filter User Notes in the User Notes Manager. All User Notes are assigned either to a Category that you create or to the special Category called 'Uncategorized'. | +| [User Notes](https://docs.joomla.org/Help4.x:User_Notes/en "Help4.x:User Notes/en") | User notes are pieces of information which can be assigned to registered users on your Joomla! site. These notes can contain for example comments about 'offending' or 'difficult' users etc. | +| [User Notes:New or Edit](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit/en "Help4.x:User Notes: New or Edit/en") | In this screen you can create an user note or edit an user note. The 'editor' will be the chosen 'editor' for the user editing the note. Examples: TinyMCE - JCE - Codemirror. | +| [Menu Item: Password Reset](https://docs.joomla.org/Help4.x:Menu_Item:_Password_Reset/en "Help4.x:Menu Item: Password Reset/en") | Used to create a form which allows a user to reset their password with an email sent to the user's email associated with the account. | +| Menu Item: User Profile | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Edit User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_Edit_User_Profile/en "Help4.x:Menu Item: Edit User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Registration Form](https://docs.joomla.org/Help4.x:Menu_Item:_Registration_Form/en "Help4.x:Menu Item: Registration Form/en") | Used to create a default User Registration form for user registration. Default form contains basic information: Name, Username, Password, and Email Address. | +| [Menu Item: Username Reminder Request](https://docs.joomla.org/Help4.x:Menu_Item:_Username_Reminder_Request/en "Help4.x:Menu Item: Username Reminder Request/en") | Used to create a form which allows a user to request an e-mail with their username. | diff --git a/manuals/help/menu-items/menu-item-username-reminder-request.md b/manuals/help/menu-items/menu-item-username-reminder-request.md new file mode 100644 index 0000000..e23ba4d --- /dev/null +++ b/manuals/help/menu-items/menu-item-username-reminder-request.md @@ -0,0 +1,224 @@ +--- +sidebar_position: 38 +id: menu-item-username-reminder-request +title: "Help4.x:Menu Item: Username Reminder Request" +--- +## Description + +The **Username Reminder Request** menu item type is used to create a +form which allows a user to request an e-mail with their username. + +## How To Access + +To create a new **Username Reminder Request** menu item: + +- Select **Menus **→** \[name of the menu\]** from the Administrator + menu (for example, **Menus **→** Main Menu**). Then... + - Select the **New** button in the Toolbar. Then... + - Select the Menu Item Type Select button. Help-4x-Menu-Item-Type-Select-Button-en.png + - In the modal dialog select the Users item to open a list and then + select the **Username Reminder Request** item. + +To edit an existing Username Reminder Request menu item: + +- Select its Title in the Menu: Items list. + +## Screenshot + + + +## Form Fields + +- **Menu Title:** The title that will display for this menu item. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Details Tab + +**Left Panel** + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Link**. The system-generated link for this menu item. This field + cannot be changed and is for information only. + + + +- **Target Window.** Select from the drop-down list. + + + +- **Template Style.** Select from the drop-down list. + +**Right Panel** + +- **Menu**. Shows which menu the link will appear in. + + + +- **Parent Item.** The parent menu item for this menu item. Used to + determine whether a Menu Item is a top-level item or a submenu item. + Select 'Menu Item Root' (the default value) if this is a top-level + Menu Item. Otherwise, select the Menu Item that is this item's parent. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **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). + + + +- **Default Page**. If Yes, this menu item is the default or home page + for the site. There must be exactly one menu item set as the default + page. You can change the default page in two ways: + 1. Click on the Home column of the desired menu item in the [Menus: + Items](https://docs.joomla.org/Help4.x:Menus:_Items/en "Special:MyLanguage/Help4.x:Menus: Items/en") + screen. + 2. Open the menu item for the new default page and change the Default + Page setting to Yes. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Common Options + +See [Menus: Edit/New +Item](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") +for help on fields common to all Menu Item types located in the +following Tabs: + +- **Link Type** +- **Page Display** +- **Metadata** +- **Associations** +- **Module Assignment** + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or... + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + +*Example Front End Site images are generic images using Joomla! core +installation supplied free Front End Templates. The actual view can +depend on the installed custom template used and the template's style +for those views on a Joomla! website.* User Reminder form: + +## Related Information + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Users: Options](https://docs.joomla.org/Help4.x:Users:_Options/en "Help4.x:Users: Options/en") | User Options configuration allows setting of parameters used globally for all users. Control the use of Captcha, registration allowed and type of registration, default user group new users, reset password or username counter, and new user registration email notice to administration. | +| [Users](https://docs.joomla.org/Help4.x:Users/en "Help4.x:Users/en") | The Users list is used to find, add, and edit users. | +| [Users: Viewing Access Levels](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en") | In this screen you have the ability to look at a list of your Access Levels and sort them in different ways. You can also edit and create Access Levels. | +| [Users: Edit Viewing Access Level](https://docs.joomla.org/Help4.x:Users:_Edit_Viewing_Access_Level/en "Help4.x:Users: Edit Viewing Access Level/en") | Access levels control which users can view which objects on your site. Objects include menu items, modules, categories, and component items (articles, contacts, and so on). Each object in the site is assigned to one access level. User groups are also assigned to each access level.If a user is a member of a group that in turn has permission for an access level, then that user can view all objects assigned to that access level. It is important to understand that user groups can be arranged in a parent-child hierarchy. If so, then a child group has access to all access levels that the parent group has access to. So you don't need to assign a child group access to levels that its parent group already has access to. | +| [Permissions for Group](https://docs.joomla.org/Help4.x:Permissions_for_Group/en "Help4.x:Permissions for Group/en") | The Debug Permissions report maps out the exact permissions for any given user group across all assets on your Joomla! installation. | +| [Permissions for User](https://docs.joomla.org/Help4.x:Permissions_for_User/en "Help4.x:Permissions for User/en") | The Debug Permissions report allows you to map out the exact permissions for any given user across all extensions on your Joomla installation. | +| [Users: Groups](https://docs.joomla.org/Help4.x:Users:_Groups/en "Help4.x:Users: Groups/en") | User Groups control what actions a user may take on the site and which objects a user can view. This screen allows you to create, view, edit, and delete User Groups. | +| [Users: New or Edit Group](https://docs.joomla.org/Help4.x:Users:_New_or_Edit_Group/en "Help4.x:Users: New or Edit Group/en") | User groups play a central role in what a user can do and see on the site. Creating user groups is normally the first step in setting up the security system for your site. | +| [Mass Mail Users](https://docs.joomla.org/Help4.x:Mass_Mail_Users/en "Help4.x:Mass Mail Users/en") | The Mass Mail screen allows Users who are members of the "Super Administrator" group to send an email message to registered users for the site. Users can be selected based on groups. | +| [Users: Edit Profile](https://docs.joomla.org/Help4.x:Users:_Edit_Profile/en "Help4.x:Users: Edit Profile/en") | In this screen, you have the ability to create a new user (if you clicked on the 'New' button in the User Manager), or edit an existing user (if you selected a user and clicked on the 'Edit' button in the User Manager, or clicked on the name of a user). | +| [User Notes: Categories](https://docs.joomla.org/Help4.x:User_Notes:_Categories/en "Help4.x:User Notes: Categories/en") | This screen allows you to look at a list of your user note categories and sort them in different ways. You can also edit and create user note categories and access levels. | +| [User Notes: New or Edit Category](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit_Category/en "Help4.x:User Notes: New or Edit Category/en") | This is where you can add a new Category or edit an existing Category. Categories are used to organize the User Notes. Categories allow you to display related User notes together on a page and to filter User Notes in the User Notes Manager. All User Notes are assigned either to a Category that you create or to the special Category called 'Uncategorized'. | +| [User Notes](https://docs.joomla.org/Help4.x:User_Notes/en "Help4.x:User Notes/en") | User notes are pieces of information which can be assigned to registered users on your Joomla! site. These notes can contain for example comments about 'offending' or 'difficult' users etc. | +| [User Notes:New or Edit](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit/en "Help4.x:User Notes: New or Edit/en") | In this screen you can create an user note or edit an user note. The 'editor' will be the chosen 'editor' for the user editing the note. Examples: TinyMCE - JCE - Codemirror. | +| [Menu Item: Password Reset](https://docs.joomla.org/Help4.x:Menu_Item:_Password_Reset/en "Help4.x:Menu Item: Password Reset/en") | Used to create a form which allows a user to reset their password with an email sent to the user's email associated with the account. | +| [Menu Item: User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_User_Profile/en "Help4.x:Menu Item: User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Edit User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_Edit_User_Profile/en "Help4.x:Menu Item: Edit User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Registration Form](https://docs.joomla.org/Help4.x:Menu_Item:_Registration_Form/en "Help4.x:Menu Item: Registration Form/en") | Used to create a default User Registration form for user registration. Default form contains basic information: Name, Username, Password, and Email Address. | +| Menu Item: Username Reminder Request | Used to create a form which allows a user to request an e-mail with their username. | diff --git a/manuals/help/menus/menus-edit.md b/manuals/help/menus/menus-edit.md new file mode 100644 index 0000000..6e6d7a5 --- /dev/null +++ b/manuals/help/menus/menus-edit.md @@ -0,0 +1,106 @@ +--- +sidebar_position: 2 +id: menus-edit +title: "Help4.x:Menus: Edit" +--- +## Description + +You can add or modify menus in this screen. + +## How to Access + +- Select **Menus **→** Manage** from the Administrator menu. Then... + - Select the **New** button in the Toolbar to create a new menu. Or... + - Select a menu **Title** in the Title column to edit an existing + menu. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the menu to display in the Administrator + Menubar and lists. + +### Menu Details Tab + +- **Unique Name.** The system name of the menu. +- **Description.** A description about the purpose of the menu. + +### Permissions Tab + +You can set permissions for a menu so that only specific groups can +alter the menu. The actions available are: + +- **Access Administration Interface** +- **Create** +- **Delete** +- **Edit** +- **Edit State** + +The available settings for each are: + +- **Inherited** means that the permissions from global configuration, + parent group and category will be used. +- **Allowed** means that the group being edited will be able to take + this action for this item (but if this is in conflict with the global + configuration, parent group or category it will have no impact; a + conflict will be indicated by Not Allowed (Inherited) under Calculated + Settings). +- **Denied** means that no matter what the global configuration, parent + group or category settings are, the group being edited can't take this + action on this item. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Cancel**. 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 + +- If you forgot to create a module for this menu, go to the [Module + Manager](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en"), + found by going to **Home Dashboard → Site → Module**. Click on + **New**, and then on **Menu**. Fill in a title and select the Menu in + the Module Parameters. +- It is a good idea to give a descriptive title for new menus. This is + how the menu will be identified in the *Backend Menus menu*. It is + also a good idea to fill in the *Description* field with information + about the menu. This is how the menu's module will be referred to in + the Module Manager. +- When you create a new menu, use only alphanumeric characters without + spaces in the *Unique Name* field. It is a good idea to use only a-z, + 0-9 and underscore (\_) characters. + +## Related information + +- [Menus](https://docs.joomla.org/Help4.x:Menus/en "Special:MyLanguage/Help4.x:Menus/en") +- Control + Panel diff --git a/manuals/help/menus/menus-items.md b/manuals/help/menus/menus-items.md new file mode 100644 index 0000000..6c446c2 --- /dev/null +++ b/manuals/help/menus/menus-items.md @@ -0,0 +1,243 @@ +--- +sidebar_position: 3 +id: menus-items +title: "Help4.x:Menus: Items" +--- +## Description + +The Menus: Items page lists the menu items contained in a menu created +using the [Menu +Manager](https://docs.joomla.org/Help4.x:Menus/en "Help4.x:Menus/en"). +The Title bar shows the name of the selected menu or *All Menu Items* if +that list is selected. + +## How to access + +- Select **Menus **→** All Menu Items** from the Administrator menu. + Or... +- Select **Menus **→** \[*Menu Name*\]** from the Administrator menu to + select items for a specific menu. + +## Screenshot + + + +## Column Headers + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Status**. The published status of the item. + + + +- **Title**. The name of the item. For a Menu Item, the Title will + display in the Menu. For an Article or Category, the Title may + optionally be displayed on the web page. This entry is required. You + can open the item for editing by clicking on the Title. + + + +- **Menu**. Shows which menu the link will appear in. + + + +- **Home**. The yellow star icon designates which menu item is the + current Home Page. Clicking on an empty Star icon will designate that + menu item as the new Home Page. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Association:** Shows which menu item this item is associated. + + + +- **Language**. Item language. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +Near the top of the page you will see the filter bar shown in the +Screenshot above. The functions are: + +- **Site/Administrator**. The client where the menu is used. +- **Select Menu**. A field to select the menu you want to search. +- **Search**. Enter part of the menu's name and press the Search to find + matching names. Press **x** or Clear to clear the search field and + restore the list of menus. + + + +- **Ordering:** (default). The column in which to sort displayed items + in the table. The values are the same as the column heading names. + +**Filter Options:** + +- **Select Status**. Select from Trashed / Unpublished / Published / + Archived / All. + + + +- **Select Access**. Select from the list of available viewing access + levels. + + + +- **Select Language**. Select from the list of available languages, if + the site manages more than 1 language. + + + +- **Select Max Levels**. Select from the list of available levels. +- **Select Component.** Select from the list of components used by the + menu items + +**Filter by Parent Menu Item**. Lets you show only items of a menu item. + +- **- Select Parent Menu Item -:** Show all menu items. +- **\:** Show items only for this menu item. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new menu item. + + + +- **Actions:** Reveals a list of actions for selected Items. Check one + or more Item checkboxes to activate the list. + + + +- **Publish**. Makes the selected menu items available to visitors to + your website. + + + +- **Unpublish.** Makes the selected menu items unavailable to visitors + to your website. + + + +- **Check-In**. Checks-in the selected menu items. Works with one or + multiple menu items selected. + + + +- **Trash**. Changes the status of the selected menu items to indicate + that they are trashed.Trashed menu items can still be recovered by + selecting 'Trashed' in the 'Select Status' filter and changing the + status of the articles to Published or Unpublished as preferred.To + permanently delete trashed menu items, select 'Trashed' in the 'Select + Status' filter, select the menu items to be permanently deleted, then + click the 'Empty Trash' toolbar icon. + + + +- **Batch**. Batch processes the selected menu items. Works with one or + multiple items selected. + + + +- **Rebuild.** Reconstructs and refreshes the relevant table. Normally, + you do *not* need to rebuild this table. This function is provided in + case the data in the table becomes corrupted. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Batch Process + +The Batch Process allows a change in settings for a group of selected +items. To use: click on the Batch button found on top of the table of +items being viewed to activate the drop down field area. + + + +***\** refers to the page name of items.* + +You can change one value or all four values at one time. + +***Note** - if you copy items to a new category, changes you have +selected from access level and language will be applied to the copies, +not the original.* + +**How to Batch Process** a group of items: + +1. Select one or more items on the list by selecting the desired + checkbox(es). +2. Set one or more of the following values: + - To change the **Access Levels**, select the desired new access + level from the Set Access Level list box. + - To change the **Language**, select the desired language from the + Set Language list box. + - To add a **Tag**, select the desired tag from the Add Tag list + box. + - To change the **Category**, select a category. To leave the + category unchanged, use the default value of "Select". + + 1. To copy the items to a different category, select the desired + category from the category list box and check the Copy option. + In this case, the original items are unchanged and the copies + are assigned to the new category and, if selected, the new + access level and language. + 2. To move the items to a different category, select the desired + category from the category list box and check the Move option. + In this case, the original items will be moved to a new category + and, if selected, be assigned the new access level and language. +3. When all of the settings are entered, click on Process to perform + the changes. A message **"Batch process completed successfully."** + will show. + +Note that nothing will happen if you (a) don't have any items selected +or (b) have not selected an access level, language, or category. + +If you wish to clear your entered selections, click on the Clear button. +This will return all of the Batch controls to their default values. Note +that this does *not* uncheck the check boxes for the items. + +## Quick Tips + +- Select an item and click on the *Home* button to set your Home page. +- Set different filter options to only show some of the menu items. + +## Related information + +- [Menu + Manager](https://docs.joomla.org/Help4.x:Menus/en "Help4.x:Menus/en") diff --git a/manuals/help/menus/menus-menu-item-search-results.md b/manuals/help/menus/menus-menu-item-search-results.md new file mode 100644 index 0000000..9deffd5 --- /dev/null +++ b/manuals/help/menus/menus-menu-item-search-results.md @@ -0,0 +1,299 @@ +--- +sidebar_position: 5 +id: menus-menu-item-search-results +title: "Help4.x:Menus Menu Item Search Results" +--- +This Page Needs Your Help + +*This page is tagged because it* **NEEDS TECHNICAL REVIEW***. You can +help the Joomla! Documentation Wiki by contributing to it. +More pages that need help similar to this one are +[here](https://docs.joomla.org/Category:Needs_technical_review "Category:Needs technical review"). +**NOTE-If you feel the need is satistified, please +remove this notice.*** +**Reason:** There are broken links and missing images + +## How To Access + +To create a new Search Form or Search Results 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 the New Toolbar button to create a new menu item. +- Click the Menu Item Type Select button Help-4x-Menu-Item-Type-Select-Button-en.png and then click + the Search Form or Search Results Menu Item link under Search. + +To edit an existing Search Results Menu Item, click its Title in [Menu +Manager: Menu +Items](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager "Special:MyLanguage/Help4.x:Menus Menu Item Manager"). + +## Description + +Used to create a 'Search Form or Search Results' page for users to +search site's content. Additional, used to control output look of search +results or 'can' the results of a search with a menu link for preset +search term or terms. + +## Screenshot + + + +## Details + +### Details Tab + +For more information please see Menu Item Manager: [Details +Tab](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#New_Menu_Item_Details "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit") + +#### Required Settings + +- **Menu Title:** The title that will display for this menu item. + + + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Menu**. Shows which menu the link will appear in. + +#### Optional Settings + +- **Search Term**. Optional, used to set a 'canned' search word, words + or phrase when Menu Item Search Results is clicked. + +See [Quick +Tips](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Search_Results#Quick_Tips "Special:MyLanguage/Help4.x:Menus Menu Item Search Results") +for more details. + +### Advanced Tab + +- **Show Sort Fields:** *(Show/Hide)* Show the additional sort fields +- **Additional Sort Fields:** Choose one or more fields to sort the + search results + - Relevance: Order the results by relevance + - Title: Order the results by title + - Date: Order the results by date + - List price: Order the results by list price + - Sales price: Order the results by sales price +- **Sort Direction:** *(Global/Ascending/Descending)* + +#### Basic Options + +600px + +- **Use Search Options**. *(Global/Show/Hide)* Show the search options. + + + +- **Use Search Areas**. *(Global/Show/Hide)* Check boxes for search area + types: Articles, Categories, Contacts, Newsfeeds, or Weblinks. + + + +- **Created Date**. Date the item(Article, Category, Weblink, etc.) was + created. + +Default Search Options + +- **Search for**. *(All Words/Any Words/Exact Phrase)* Set the type of + search. Search for All Words, Any Words or Exact Phrase. + + + +- **Results ordering:** Set the search results ordering. + - *Newest:* Show newest item first. + - *Oldest:* Show oldest item first. + - *Popularity:* Show by popularity of item, number of page hits. + - *Alphabetical:* Show in alphabetical order. + - *Category:* Show in category order. + +#### Common Options + +See [Menu Item Manager: Edit/New Menu +Item](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit") +for help on fields common to all Menu Item types, under the **[Advanced +Details +Tab](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Advanced_Details_Tab "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** +which includes: + +- **[Link Type + Options](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Link_Type_Options "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** +- **[Page Display + Options](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Page_Display_Options "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** +- **[Metadata + Options](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Metadata_Options "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** + +### Module Assignments Tab + +See [Menu Item Manager: New Menu +Item](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit") +for help on fields in **[Module +Assignments](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Module_Assignment_Tab "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** +for this Menu Item. + +## Toolbar + +At the top left you will see the toolbar: + + + +The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + +*Example Front End Site images are generic images using Joomla! core +installation supplied free Front End Templates. The actual view can +depend on the installed custom template used and the template's style +for those views on a Joomla! website.* Search form shown: + +File:Help-4x-Menus-Menu-Search-Results-front-end-screenshot-en.png + +Search results shown: + +File:Help-4x-Menus-Menu-Search-Results-front-end-results-screenshot-en.png + +## Quick Tips + +- **Canning Search Results**. To 'can' search results (force a desired + search term), use the [Search + Term](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Search_Results#Optional_Settings "Special:MyLanguage/Help4.x:Menus Menu Item Search Results") + optional setting. This optional field will force a search term or + terms into the search field when a user clicks on a Menu 'Link' to a + 'Search Results' Menu Item. For example, a user clicks a Menu Item + called, 'More Joomla! Articles'. The search term field could contain + the word, Joomla!. The filled optional field would show the search + component page with the word Joomla! pre-filled in the search field + and showing the results of 'Joomla!' searched on the website. + +## Related Information + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Related Help ScreensDescription
Components +Finder Manage Search FiltersThis screen shows the static search filters currently available for +use in Smart Search
Components +Finder Manage Search Filters EditThis screen allows you to create a new search filter or amend an +existing one.
Components +SearchThe Search Statistics screen allows you to see how many searches +were done for each keyword combination and how many results were +returned for each search.
Components +Search Manager OptionsDetails +on Component Options +

Details +on Permissions configuration

Extensions +Module Manager SearchThis Module displays a Search entry field where the user can type in +a phrase and press 'Enter' to search the web site.
Extensions +Module Manager Smart SearchSmart Search is an enhanced site search.
Menus +Menu Item Finder SearchUsed to create a page for Smart Search Results, which can be used in +conjunction with a Smart +Search module to control Search Results Page's layout. Ability to +'can' Smart Search results to specific filters to control a search.
diff --git a/manuals/help/menus/menus-menu-item-weblink-categories.md b/manuals/help/menus/menus-menu-item-weblink-categories.md new file mode 100644 index 0000000..2a0037c --- /dev/null +++ b/manuals/help/menus/menus-menu-item-weblink-categories.md @@ -0,0 +1,339 @@ +--- +sidebar_position: 6 +id: menus-menu-item-weblink-categories +title: "Help4.x:Menus Menu Item Weblink Categories" +--- +## How To Access + +To create a new List All Web Link Categories 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 the New Toolbar button to create a new menu item. +- Click the Menu Item Type Select button Help-4x-Menu-Item-Type-Select-Button-en.png and then click + the List All Web Link Categories Menu Item link under Weblinks link. + +To edit an existing List All Web Link Categories Menu Item, click its +Title in [Menu Manager: Menu +Items](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager "Special:MyLanguage/Help4.x:Menus Menu Item Manager"). + +## Description + +Used to show a list of all Web Link 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 Web Links +in that category. + +## Screenshot + + + +## Details + +### Details Tab + +For more information please see Menu Item Manager: [Details +Tab](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#New_Menu_Item_Details "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit") + +#### Required Settings + +This layout requires a starting top-level category selection. This is +done in the list box shown above in the screenshot. To include all web +link categories, select *Root*. Otherwise, select the desired top-level +category. All child categories of the selected category will show in the +layout. + +- **Menu Title:** The title that will display for this menu item. + + + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Choose a Category**. The Categories that are within this category + will be displayed. + + + +- **Menu**. Shows which menu the link will appear in. + +### Advanced Details Tab + +#### Categories Options + +The Categories Options allow you to control various aspects of this +layout, as shown below. If you select *Use Global* for any option, the +value from the [News Feeds Manager +Options](https://docs.joomla.org/Help4.x:Components_News_Feed_Manager_Options#Options "Special:MyLanguage/Help4.x:Components News Feed Manager Options") +will be used. + + + +- **Top Level Category Description.** (Use Global/Hide/Show) Whether to + hide or show the description of the top-level category. Note that this + description can be overridden for this layout by entering a + Alternative Description below. +- **Alternative Description.** Enter an optional description to + alternatively replace the category description for this layout. If the + Top Level Description option is set to *Show*, this entered + description will show instead of the normal category description. + + + +- **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. + + + +- **Subcategories Descriptions.** (Use Global/Hide/Show) Whether to hide + or show the category description of subcategories. +- **\# Web links**. (Use Global/Hide/Show) Show or hide the number of + 'Web Links' in each category. + +#### Category Options + +Category Options control the appearance of the screen when you click on +a category link. The following options are available. + + + +- **Category Title.** (Use Global/Hide/Show) If Show, the Category Title + will show as a subheading on the page. The subheading is usually + displayed inside the "H2" tag. + + + +- **Category Description**. (Use Global/Hide/Show) Show or hide the + description of the selected Category. + + + +- **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. + + + +- **Subcategories Descriptions.** (Use Global/Hide/Show) Whether to hide + or show the category description of subcategories. +- **\# Web links**. (Use Global/Hide/Show) Show or hide the number of + 'Web Links' in each category. + +#### List Layout Options + +The List Layout Options control the appearance of the category +drill-down page when that is presented as a Category List. The following +options are available: + + + +- **Filter Field:** (Use Global/Hide/Show) Whether to show a Filter + field for the list. Select Hide to hide the filer field + + + +- **Display Select.** (Use Global/Hide/Show) Whether to hide or show the + Display \# control that allows the user to select the number of items + to show in the list. An example of how it is shown in the Front End + (website) view below. + + + +If there are more items than this number, you can use the page +navigation buttons (Start, Prev, Next, End, and page numbers) to +navigate between pages. Note that if you have a large number of items, +it may be helpful to use the Filter options, located above the column +headings, to limit which items display. + +- **Table Headings.** (Use Global/Hide/Show) Table Headings show a + heading above a list, like generic heading image shown below. + +Help30-article-category-list-table-headings-en.png + +If set to *Show*, this heading will show above the list. If set to +*Hide*, the list will show with no headings. + +- **Links Description**. (Use Global/Hide/Show) Show or hide the + description of the list of links. + + + +- **Hits**. (Use Global/Hide/Show) Show or hide the number of hits + (refers to \# of clicks) to a link in the list of links. + + + +- **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 listed items will not fit + on one page. An example is shown below. + +Help30-pagination-en.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. + +#### Common Options + +See [Menu Item Manager: Edit/New Menu +Item](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit") +for help on fields common to all Menu Item types, under the **[Advanced +Details +Tab](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Advanced_Details_Tab "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** +which includes: + +- **[Link Type + Options](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Link_Type_Options "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** +- **[Page Display + Options](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Page_Display_Options "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** +- **[Metadata + Options](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Metadata_Options "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** + +### Module Assignments Tab + +See [Menu Item Manager: New Menu +Item](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit") +for help on fields in **[Module +Assignments](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Module_Assignment_Tab "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** +for this Menu Item. + +## Toolbar + +At the top left you will see the toolbar: + + + +The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Cancel**. 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 + +- Categories can be "nested" into levels, similar to folders on a disk + drive. In theory there is no absolute limit on the number of levels + you can have. However, as a practical matter it is recommended to keep + the levels to a minimum. The Show All Categories layout may not work + correctly if the number of levels shown is greater than five. +- If you set up category titles as linkable, the user can drill down on + the category. If there is a pre-existing menu item for this category + (for example, a Category List menu item), then that menu item will + show in the drill down and the options set for that menu item will + control the page display. Otherwise, the options set for the current + Show All Categories menu item will control the page display. +- You can set the option to drill down to a list in two places. + - In [Web Links Manager + Options](https://docs.joomla.org/Help4.x:Components_Web_Links_Manager_Options#Options "Special:MyLanguage/Help4.x:Components Web Links Manager Options") + you can set the default value for all categories. + - In [Category Manager: Edit A Web Links + Category](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit") + you can set a value for a specific category. If this is set, it + overrides the default value. + +## Related Information + +- Categories are created using [Category Manager: Edit A Web Links + Category](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit"). + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Components Weblinks Categories](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories "Special:MyLanguage/Help4.x:Components Weblinks Categories") | The Web Links Category Manager is where you can [edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit") existing Web Links Categories and [create new ones](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit"). Note that Web Links Categories are separate from other Categories, such as Categories for Articles, Banners, News Feeds, and Contacts. From this screen, you can also navigate to the [Web Links Manager](https://docs.joomla.org/Help4.x:Components_Weblinks_Links "Special:MyLanguage/Help4.x:Components Weblinks Links") screen. | +| [Components Weblinks Categories Edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit") | This is where you can add a new Web Link Category or edit an existing one. Note that you need to create at least one Web Link Category before you can create a Web Link. Also, Web Link Categories are separate from other types of Categories, such as those for Articles, Banners, and News Feeds. | +| [Components Weblinks Links](https://docs.joomla.org/Help4.x:Components_Weblinks_Links "Special:MyLanguage/Help4.x:Components Weblinks Links") | The Weblinks Manager allows you to [add](https://docs.joomla.org/Help4.x:Components_Weblinks_Links_Edit "Special:MyLanguage/Help4.x:Components Weblinks Links Edit"), [edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Links_Edit "Special:MyLanguage/Help4.x:Components Weblinks Links Edit") and remove links to other web sites on your Joomla! web site, and organize them into [categories](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories "Special:MyLanguage/Help4.x:Components Weblinks Categories"). You can then [display these links on your site](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Categories#Displaying_Links_on_your_Site "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Categories"), and optionally [let visitors add new links](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Categories#Letting_Visitors_Submit_Links "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Categories"). | +| [Components Weblinks Links Edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Links_Edit "Special:MyLanguage/Help4.x:Components Weblinks Links Edit") | This is where you add a new Web Link or edit an existing one. Note that you need to create at least one [Web Links Category](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit") before you can create your first Web Link. | +| [Extensions Module Manager Weblinks](https://docs.joomla.org/Help4.x:Extensions_Module_Manager_Weblinks "Special:MyLanguage/Help4.x:Extensions Module Manager Weblinks") | The Weblinks module will display weblinks from within the Weblinks component. | +| [Menus Menu Item Weblink Category](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Category "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Category") | Used to show a list of Web Links in a Category. Categories are shown in a hierarchical list, parent with child (sub) categories. Depending on the selected layout options, click on a category Title to show the Web Links in that category or sub categories. | +| [Menus Menu Item Weblink Submit](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Submit "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Submit") | Used to show a Web Link submission form in [Front End (website)](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Submit#Front_End_Screenshot "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Submit") allowing users with permission to submit Web Links. | diff --git a/manuals/help/menus/menus-menu-item-weblink-category.md b/manuals/help/menus/menus-menu-item-weblink-category.md new file mode 100644 index 0000000..7b4761a --- /dev/null +++ b/manuals/help/menus/menus-menu-item-weblink-category.md @@ -0,0 +1,298 @@ +--- +sidebar_position: 7 +id: menus-menu-item-weblink-category +title: "Help4.x:Menus Menu Item Weblink Category" +--- +## How To Access + +To create a new List Web Links in a Category 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 the New Toolbar button to create a new menu item. +- Click the Menu Item Type Select button Help-4x-Menu-Item-Type-Select-Button-en.png and then click + the List Web Links in a Category Menu Item link under Weblinks link. + +To edit an existing List Web Links in a Category Menu Item, click its +Title in [Menu Manager: Menu +Items](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager "Special:MyLanguage/Help4.x:Menus Menu Item Manager"). + +## Description + +Used to show a list of Web Links in a Category. Categories are shown in +a hierarchical list, parent with child (sub) categories. Depending on +the selected layout options, click on a category Title to show the Web +Links in that category or sub categories. + +## Screenshot + + + +## Details + +### Details Tab + +For more information please see Menu Item Manager: [Details +Tab](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#New_Menu_Item_Details "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit") + +#### Required Settings + +This layout requires a category selection. This is done in the list box +shown above in the screenshot. All child categories of the selected +category will show in the layout if sub categories are shown. + +- **Menu Title:** The title that will display for this menu item. + + + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Choose a Category**. The Categories that are within this category + will be displayed. + + + +- **Menu**. Shows which menu the link will appear in. + +### Advanced Details Tab + +#### Category Options + +Category Options control the appearance of the screen when you click on +a category link. The following options are available. + + + +- **Category Title.** (Use Global/Hide/Show) If Show, the Category Title + will show as a subheading on the page. The subheading is usually + displayed inside the "H2" tag. + + + +- **Category Description**. (Use Global/Hide/Show) Show or hide the + description of the selected Category. + + + +- **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. + + + +- **Subcategories Descriptions.** (Use Global/Hide/Show) Whether to hide + or show the category description of subcategories. + + + +- **\# Web links**. (Use Global/Hide/Show) Show or hide the number of + 'Web Links' in each category. + +#### List Layout Options + +The List Layout Options control the appearance of the category +drill-down page when that is presented as a Category List. The following +options are available: + + + +- **Filter Field:** (Use Global/Hide/Show) Whether to show a Filter + field for the list. Select Hide to hide the filer field + + + +- **Display Select.** (Use Global/Hide/Show) Whether to hide or show the + Display \# control that allows the user to select the number of items + to show in the list. An example of how it is shown in the Front End + (website) view below. + + + +If there are more items than this number, you can use the page +navigation buttons (Start, Prev, Next, End, and page numbers) to +navigate between pages. Note that if you have a large number of items, +it may be helpful to use the Filter options, located above the column +headings, to limit which items display. + +- **Table Headings.** (Use Global/Hide/Show) Table Headings show a + heading above a list, like generic heading image shown below. + +Help30-article-category-list-table-headings-en.png + +If set to *Show*, this heading will show above the list. If set to +*Hide*, the list will show with no headings. + +- **Links Description**. (Use Global/Hide/Show) Show or hide the + description of the list of links. + + + +- **Hits**. (Use Global/Hide/Show) Show or hide the number of hits + (refers to \# of clicks) to a link in the list of links. + + + +- **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 listed items will not fit + on one page. An example is shown below. + +Help30-pagination-en.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. + +#### Common Options + +See [Menu Item Manager: Edit/New Menu +Item](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit") +for help on fields common to all Menu Item types, under the **[Advanced +Details +Tab](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Advanced_Details_Tab "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** +which includes: + +- **[Link Type + Options](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Link_Type_Options "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** +- **[Page Display + Options](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Page_Display_Options "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** +- **[Metadata + Options](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Metadata_Options "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** + +### Module Assignments Tab + +See [Menu Item Manager: New Menu +Item](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit") +for help on fields in **[Module +Assignments](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Module_Assignment_Tab "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** +for this Menu Item. + +## Toolbar + +At the top left you will see the toolbar: + + + +The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Cancel**. 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 + +- Categories can be "nested" into levels, similar to folders on a disk + drive. In theory there is no absolute limit on the number of levels + you can have. However, as a practical matter it is recommended to keep + the levels to a minimum. The Show All Categories layout may not work + correctly if the number of levels shown is greater than five. +- If you set up category titles as linkable, the user can drill down on + the category. If there is a pre-existing menu item for this category + (for example, a Category List menu item), then that menu item will + show in the drill down and the options set for that menu item will + control the page display. Otherwise, the options set for the current + Show All Categories menu item will control the page display. +- You can set the option to drill down to a list in two places. + - In [Web Links Manager + Options](https://docs.joomla.org/Help4.x:Components_Web_Links_Manager_Options#Options "Special:MyLanguage/Help4.x:Components Web Links Manager Options") + you can set the default value for all categories. + - In [Category Manager: Edit A Web Links + Category](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit") + you can set a value for a specific category. If this is set, it + overrides the default value. + +## Related Information + +- Categories are created using [Category Manager: Edit A Web Links + Category](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit"). + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Components Weblinks Categories](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories "Special:MyLanguage/Help4.x:Components Weblinks Categories") | The Web Links Category Manager is where you can [edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit") existing Web Links Categories and [create new ones](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit"). Note that Web Links Categories are separate from other Categories, such as Categories for Articles, Banners, News Feeds, and Contacts. From this screen, you can also navigate to the [Web Links Manager](https://docs.joomla.org/Help4.x:Components_Weblinks_Links "Special:MyLanguage/Help4.x:Components Weblinks Links") screen. | +| [Components Weblinks Categories Edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit") | This is where you can add a new Web Link Category or edit an existing one. Note that you need to create at least one Web Link Category before you can create a Web Link. Also, Web Link Categories are separate from other types of Categories, such as those for Articles, Banners, and News Feeds. | +| [Components Weblinks Links](https://docs.joomla.org/Help4.x:Components_Weblinks_Links "Special:MyLanguage/Help4.x:Components Weblinks Links") | The Weblinks Manager allows you to [add](https://docs.joomla.org/Help4.x:Components_Weblinks_Links_Edit "Special:MyLanguage/Help4.x:Components Weblinks Links Edit"), [edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Links_Edit "Special:MyLanguage/Help4.x:Components Weblinks Links Edit") and remove links to other web sites on your Joomla! web site, and organize them into [categories](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories "Special:MyLanguage/Help4.x:Components Weblinks Categories"). You can then [display these links on your site](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Category#Displaying_Links_on_your_Site "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Category"), and optionally [let visitors add new links](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Category#Letting_Visitors_Submit_Links "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Category"). | +| [Components Weblinks Links Edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Links_Edit "Special:MyLanguage/Help4.x:Components Weblinks Links Edit") | This is where you add a new Web Link or edit an existing one. Note that you need to create at least one [Web Links Category](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit") before you can create your first Web Link. | +| [Extensions Module Manager Weblinks](https://docs.joomla.org/Help4.x:Extensions_Module_Manager_Weblinks "Special:MyLanguage/Help4.x:Extensions Module Manager Weblinks") | The Weblinks module will display weblinks from within the Weblinks component. | +| [Menus Menu Item Weblink Categories](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Categories "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Categories") | Used to show a list of all Web Link 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 Web Links in that category. | +| [Menus Menu Item Weblink Submit](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Submit "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Submit") | Used to show a Web Link submission form in [Front End (website)](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Submit#Front_End_Screenshot "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Submit") allowing users with permission to submit Web Links. | diff --git a/manuals/help/menus/menus-menu-item-weblink-submit.md b/manuals/help/menus/menus-menu-item-weblink-submit.md new file mode 100644 index 0000000..4963abd --- /dev/null +++ b/manuals/help/menus/menus-menu-item-weblink-submit.md @@ -0,0 +1,217 @@ +--- +sidebar_position: 8 +id: menus-menu-item-weblink-submit +title: "Help4.x:Menus Menu Item Weblink Submit" +--- +## How To Access + +To create a new Submit a Web Link 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 the New Toolbar button to create a new menu item. +- Click the Menu Item Type Select button Help-4x-Menu-Item-Type-Select-Button-en.png and then click + the Submit a Web Link Menu Item link under Weblinks link. + +To edit an existing Submit a Web Link Menu Item, click its Title in +[Menu Manager: Menu +Items](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager "Special:MyLanguage/Help4.x:Menus Menu Item Manager"). + +## Description + +Used to show a Web Link submission form in [Front End +(website)](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Submit#Front_End_Screenshot "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Submit") +allowing users with permission to submit Web Links. + +## Screenshot + + + +## Details + +### Details Tab + +For more information please see Menu Item Manager: [Details +Tab](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#New_Menu_Item_Details "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit") + +#### Required Settings + +- **Menu Title:** The title that will display for this menu item. + + + +- **Menu Item Type**. The Menu Item Type selected when this menu item + was created. This can be one of the core menu item types or a menu + item type provided by an installed extension. + + + +- **Menu**. Shows which menu the link will appear in. + +### Advanced Details Tab + +#### Common Options + +See [Menu Item Manager: Edit/New Menu +Item](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit") +for help on fields common to all Menu Item types, under the **[Advanced +Details +Tab](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Advanced_Details_Tab "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** +which includes: + +- **[Link Type + Options](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Link_Type_Options "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** +- **[Page Display + Options](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Page_Display_Options "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** +- **[Metadata + Options](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Metadata_Options "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** + +### Module Assignments Tab + +See [Menu Item Manager: New Menu +Item](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit") +for help on fields in **[Module +Assignments](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Manager_Edit#Module_Assignment_Tab "Special:MyLanguage/Help4.x:Menus Menu Item Manager Edit")** +for this Menu Item. + +## Toolbar + +At the top left you will see the toolbar: + + + +The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + +*Example Front End Site images are generic images using Joomla! core +installation supplied free Front End Templates. The actual view can +depend on the installed custom template used and the template's style +for those views on a Joomla! website.* + + + +### Form Fields + +The following are available form fields when submitting a Web Link on +the Front End. Title, Category and URL are required fields. + +- **Title**. The name of the item. For a Menu Item, the Title will + display in the Menu. For an Article or Category, the Title may + optionally be displayed on the web page. This entry is required. You + can open the item for editing by clicking on the Title. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + + + +- **Category.** The Category this item belongs to. + + + +- **URL**. Field to enter a URL (web page address. + + + +- **Tags**. Enter one or more optional tags for this item. You can + select existing tags by entering in the first few letters. You may + also create new tags by entering them here. Tags allow you to see + lists of related items across content types (for example, articles, + contacts, and categories). + + + +- **Status**. The published status of the item. ***\*Note:** Trashed is + not an available option because the Web Link does not exist yet. The + only options are Published or Unpublished when submitting a new Web + Link.* + + + +- **Language**. Item language. + + + +- **Description**. The description for the item. Category, Subcategory + and Web Link descriptions may be shown on web pages, depending on the + parameter settings. These descriptions are entered using the same + editor that is used for Articles. +- For use of the Toggle editor button, see [Editor + Buttons](https://docs.joomla.org/Help4.x:Content_Article_Manager_Edit#Editor_Buttons "Special:MyLanguage/Help4.x:Content Article Manager Edit"). + +## Quick Tips + +- You can set the Web Link options in two places. + - In [Web Links Manager + Options](https://docs.joomla.org/Help4.x:Components_Web_Links_Manager_Options#Options "Special:MyLanguage/Help4.x:Components Web Links Manager Options") + you can set the default values for all categories. + - In [Category Manager: Edit A Web Links + Category](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit") + you can set a values for a specific category. If this is set, it + overrides the default value. + +## Related Information + +- Categories are created using [Category Manager: Edit A Web Links + Category](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit"). + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Components Weblinks Categories](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories "Special:MyLanguage/Help4.x:Components Weblinks Categories") | The Web Links Category Manager is where you can [edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit") existing Web Links Categories and [create new ones](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit"). Note that Web Links Categories are separate from other Categories, such as Categories for Articles, Banners, News Feeds, and Contacts. From this screen, you can also navigate to the [Web Links Manager](https://docs.joomla.org/Help4.x:Components_Weblinks_Links "Special:MyLanguage/Help4.x:Components Weblinks Links") screen. | +| [Components Weblinks Categories Edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit") | This is where you can add a new Web Link Category or edit an existing one. Note that you need to create at least one Web Link Category before you can create a Web Link. Also, Web Link Categories are separate from other types of Categories, such as those for Articles, Banners, and News Feeds. | +| [Components Weblinks Links](https://docs.joomla.org/Help4.x:Components_Weblinks_Links "Special:MyLanguage/Help4.x:Components Weblinks Links") | The Weblinks Manager allows you to [add](https://docs.joomla.org/Help4.x:Components_Weblinks_Links_Edit "Special:MyLanguage/Help4.x:Components Weblinks Links Edit"), [edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Links_Edit "Special:MyLanguage/Help4.x:Components Weblinks Links Edit") and remove links to other web sites on your Joomla! web site, and organize them into [categories](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories "Special:MyLanguage/Help4.x:Components Weblinks Categories"). You can then [display these links on your site](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Submit#Displaying_Links_on_your_Site "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Submit"), and optionally [let visitors add new links](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Submit#Letting_Visitors_Submit_Links "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Submit"). | +| [Components Weblinks Links Edit](https://docs.joomla.org/Help4.x:Components_Weblinks_Links_Edit "Special:MyLanguage/Help4.x:Components Weblinks Links Edit") | This is where you add a new Web Link or edit an existing one. Note that you need to create at least one [Web Links Category](https://docs.joomla.org/Help4.x:Components_Weblinks_Categories_Edit "Special:MyLanguage/Help4.x:Components Weblinks Categories Edit") before you can create your first Web Link. | +| [Extensions Module Manager Weblinks](https://docs.joomla.org/Help4.x:Extensions_Module_Manager_Weblinks "Special:MyLanguage/Help4.x:Extensions Module Manager Weblinks") | The Weblinks module will display weblinks from within the Weblinks component. | +| [Menus Menu Item Weblink Categories](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Categories "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Categories") | Used to show a list of all Web Link 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 Web Links in that category. | +| [Menus Menu Item Weblink Category](https://docs.joomla.org/Help4.x:Menus_Menu_Item_Weblink_Category "Special:MyLanguage/Help4.x:Menus Menu Item Weblink Category") | Used to show a list of Web Links in a Category. Categories are shown in a hierarchical list, parent with child (sub) categories. Depending on the selected layout options, click on a category Title to show the Web Links in that category or sub categories. | diff --git a/manuals/help/menus/menus-menu-manager-options.md b/manuals/help/menus/menus-menu-manager-options.md new file mode 100644 index 0000000..60be385 --- /dev/null +++ b/manuals/help/menus/menus-menu-manager-options.md @@ -0,0 +1,121 @@ +--- +sidebar_position: 9 +id: menus-menu-manager-options +title: "Help4.x:Menus Menu Manager Options" +--- +This Page is a Candidate for Deletion + +**This page is a candidate for deletion.** The given reason is: ***No +links here.*** + + This notice should remain for a **minimum** +of 1 week after it was placed on the page. If discussion is still +ongoing, it should remain until a consensus is reached, after which the +page will either be deleted or this notice removed. If you disagree with +its deletion, please discuss your reasons on its associated talk +page, as applicable. + +Remember to check [if anything links +here](https://docs.joomla.org/Special:WhatLinksHere/Help4.x:Menus_Menu_Manager_Options "Special:WhatLinksHere/Help4.x:Menus Menu Manager Options") +and the page +history before deleting. + +Last edit by +[Franz.wohlkoenig](https://docs.joomla.org/User:Franz.wohlkoenig "User:Franz.wohlkoenig") +([talk](https://docs.joomla.org/User_talk:Franz.wohlkoenig "User talk:Franz.wohlkoenig") +· +[contrib](https://docs.joomla.org/Special:Contributions/Franz.wohlkoenig "Special:Contributions/Franz.wohlkoenig")) +· Last edited on Wed, 31 Aug 2022 03:11:40 +0000 + +## How to access + +Go to the Menu Manager by clicking on the Menu Manager icon in the +Control Panel, or by clicking on 'Menu Manager' in the 'Menus' menu. +After that, click on the 'New' button in the toolbar, or select a menu +and click on the 'Options' button. + +## Description + +You can set options of your menus in this screen. + +## Screenshot + +## Column Headers + +- **Title**. The name of the item. For a Menu Item, the Title will + display in the Menu. For an Article, Section, or Category, the Title + may optionally be displayed on the web page. This entry is required. + You can open the item for editing by clicking on the Title. + +**Show Page Heading:** Show the page heading. **Page Heading:** Optional +alternative text for the Page heading. **Page Class:** Optional css +class to add elements in this page. This allows css styling specific to +this page. + +## Toolbar + +At the top you will see the toolbar: + + + +The functions are: + +- **Save:** Saves the menu and stays in the current screen. + + + +- **Save & Close**. Saves the menu and closes the current screen. + + + +- **Save & New**. Saves the menu and keeps the editing screen open and + ready to create another menu. + + + +- **Cancel**. 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 + +- Hover your mouse over the '\*' next to the input box, and extra + information will be shown. +- If you forgot to create a module for this menu, you can do so by using + the + Module + Manager, found by going to Extensions -\> Module Manager. Click on + 'New', and then on 'Menu'. Fill in a title and select the Menu in the + Module Parameters. +- It is a good idea to give a descriptive title for new menus. This is + how the menu will be identified in the *Backend Menus menu*. It is + also a good idea to fill in the *Description* field with information + about the menu. This is how the menu's module will be referred to in + the Module Manager. +- When you create a new menu, use only alphanumeric characters without + spaces in the *Unique Name* field. It is a good idea to use only a-z, + 0-9 and underscore (\_) characters. Please read the tooltips as well. + +## Related information + +- [Menus](https://docs.joomla.org/Help4.x:Menus "Special:MyLanguage/Help4.x:Menus") +- [Control + Panel](https://docs.joomla.org/Help4.x:Site_Control_Panel "Special:MyLanguage/Help4.x:Site Control Panel") diff --git a/manuals/help/menus/menus-options.md b/manuals/help/menus/menus-options.md new file mode 100644 index 0000000..648ace5 --- /dev/null +++ b/manuals/help/menus/menus-options.md @@ -0,0 +1,105 @@ +--- +sidebar_position: 4 +id: menus-options +title: "Help4.x:Menus: Options" +--- +## Description + +Menu Options allow the setting of parameters used globally on all menus +such as, Title, CSS Class and Permissions. + +## How to Access + +- Select **Menus **→** Manage** in the Administrator menu. Then... + - Select the **Options** button in the Toolbar. + +## Screenshot + + + +## Form Fields + +### Page Display Tab + +- **Browser Page Title:** Optional text for the "Browser page title" + element. If blank, the Menu Item Title is used. +- **Show Page Heading:** Whether or not to show the Browser Page Title + in the heading of the page. The page heading is normally displayed + inside an h1 HTML element. +- **Page Heading:** Optional alternative text for the Page Heading. +- **Page Class:** Optional CSS class to add to elements in this page. + This allows CSS styling specific to this page. + +### Permissions Tab + + + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Options**. Users can edit the options and + permissions of this extension. + - **Configure Options Only**. Users can edit the options exept the + permissions of this extension. + - **Access Administration Interface**. Users can access user + administration interface of this extension. + - **Create:** Users can create content of this extension. + - **Delete:** Users can delete content of this extension. + - **Edit:** Users can edit content of this extension. + - **Edit State:** User can change the published state and related + information for content of this extension. + - **Edit Own:** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited:*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- Remember, these choices are applied globally. + +## Related Information + +- To add new Menus: [Menu Manager + New/Edit](https://docs.joomla.org/Help4.x:Menus:_Edit/en "Help4.x:Menus: Edit/en") +- To add or edit Menu Items: [Menu Item + Manager](https://docs.joomla.org/Help4.x:Menus:_Items/en "Help4.x:Menus: Items/en") +- To add or edit Menu Modules: [Module + Manager](https://docs.joomla.org/Help4.x:Extensions_Module_Manager_Edit/en "Help4.x:Extensions Module Manager Edit/en") diff --git a/manuals/help/menus/menus.md b/manuals/help/menus/menus.md new file mode 100644 index 0000000..f5e9a9c --- /dev/null +++ b/manuals/help/menus/menus.md @@ -0,0 +1,147 @@ +--- +sidebar_position: 1 +id: menus +title: "Help4.x:Menus" +--- +## Description + +Menus allow a user to navigate through the site. A menu is an object +which contains one or more menu items. Each menu item points to a +logical page on the site. A menu module is required to place the menu on +the page. One menu can have more than one module. For example, one +module might show only the first level menu items and a second module +might show the level 2 menu items. + +The Menus list provides an overview of the menus available on a Joomla +site. This includes the details of each individual menu's number of +items published, unpublished and trashed, and the names of linked +modules. + +The process for adding a menu to the site is normally as follows: + +1. Create a new menu (using this screen). +2. Create one or more new menu items for the menu. Each menu item will + have a specific menu item type. +3. Create one or more menu modules to display the menu on the site. + When you create the modules, you will select which menu items + (pages) the modules will show on. + +## How to Access + +- Select **Menus **→** Manage** from the Administrator menu. + +## Screenshot + + + +## Column Headers + +Clicking on the title of a column will sort the table view by the +column. A down arrow next to the column title means ascending order and +an up arrow means descending order. The default sort is by **ID#** in +ascending order. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. +- **Title**. The name of the menu. +- **\# Published**. Number of published menu items in this menu. +- **\# Unpublished**. Number of unpublished menu items in this menu. +- **\# Trashed**. Number of trashed menu items in this menu. +- **Linked Modules**. Lists any menu modules associated with the menu. + The column shows the module's name, access level, and position on + template. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new menu. + + + +- **Edit**. Opens the editing screen for the selected menu. If more than + one menu is selected (where applicable), only the first menu will be + opened. The editing screen can also be opened by clicking on the Name + of the menu. + + + +- **Delete:** Deletes the selected menus. Works with one or multiple + menus selected. Deleting a menu also deletes all the menu items it + contains and any associated menu modules. On clicking Delete you will + be asked to confirm that you want to delete the selected menus. + Clicking OK button will delete the menus. Click Cancel to abort the + deletion. + + + +- **Rebuild.** Reconstructs and refreshes the menu table. Normally, you + do *not* need to rebuild this table. This function is provided in case + the data in the table becomes corrupted. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. See [Menus + Configuration](https://docs.joomla.org/Help4.x:Components_Menus_Configuration "Special:MyLanguage/Help4.x:Components Menus Configuration"). + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- It is expedient to give a descriptive title for new menus because, + later, you will see it in the *Backend Menus* menu. It is a good idea + to fill in the *Description* field with information about the menu. If + you enter a short title in the *Module title* field, you can identify + the menu's module using that title in the Module Manager. +- Though you can create a copy of a selected menu by clicking the *Copy* + toolbar button, you can make another instance in the Module Manager as + well. +- When you create a new menu, use only English alphanumeric characters + without space in the Unique Name field. It is a good idea using only + a-z, 0-9 and underscore (\_) characters. +- If you don't enter a *Module title*, no module will be created and the + menu cannot be displayed in the front end. However you can use the + Module Manager later to create a new mod_mainmenu module, and assign + it to the menu. +- If you delete an existing menu, do not forget that all the menu items + of the respective menu will be also deleted. +- The Main Menu has your default menu item, so it **should not be + deleted**. The default menu item is defines the page that is displayed + when you visit www.*yoursite*.com, and your site will not function if + it is deleted. It is usually your Home menu item but it can be set to + any menu item including a menu item in a hidden menu. If you change + the default menu item, make sure that you don't delete that menu item + either! The menu with the default menu item is marked with an asterisk + (\*) in the *Menus* menu. + +## Related Information + +- To add new Menus: [Menu Manager + New/Edit](https://docs.joomla.org/Help4.x:Menus:_Edit/en "Help4.x:Menus: Edit/en") +- To set action permissions for menus: [Menus + Configuration](https://docs.joomla.org/Help4.x:Menus:_Options/en "Help4.x:Menus: Options/en") +- To add or edit Menu Items: [Menu Item + Manager](https://docs.joomla.org/Help4.x:Menus:_Items/en "Help4.x:Menus: Items/en") +- To add or edit Menu Modules: [Module + Manager](https://docs.joomla.org/Help4.x:Menu_Item:_New_Item/en "Help4.x:Menu Item: New Item/en") diff --git a/manuals/help/messages/messages-options.md b/manuals/help/messages/messages-options.md new file mode 100644 index 0000000..cca47ef --- /dev/null +++ b/manuals/help/messages/messages-options.md @@ -0,0 +1,75 @@ +--- +sidebar_position: 1 +id: messages-options +title: "Help4.x:Messages: Options" +--- +## Description + +Messaging Options configuration allows setting of parameters used +globally for Messaging. + +## How to Access + +- Select **Users **→** Messaging **→** Private Messages** from the + Administrator menu. Then... + - Select the **Options** button in the Toolbar. + +## Screenshot + + + +## Form Fields + +### Permissions Tab + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Optons**. Users can edit the options and + persimissions of this extension. + - **Configure Optons Only**. Users can edit the options exept the + persimissions of this extension. + - **Access Administration Interface**. Users can access user + administration interface of this extension. + - **Create:** Users can create content of this extension. + - **Delete:** Users can delete content of this extension. + - **Edit:** Users can edit content of this extension. + - **Edit State:** User can change the published state and related + information for content of this extension. + - **Edit Own:** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited:*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/modules/module-options.md b/manuals/help/modules/module-options.md new file mode 100644 index 0000000..e525caf --- /dev/null +++ b/manuals/help/modules/module-options.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 1 +id: module-options +title: "Help4.x:Module: Options" +--- +Redirect to: + +- [Help4.x:Modules: + Options](https://docs.joomla.org/Help4.x:Modules:_Options "Help4.x:Modules: Options") diff --git a/manuals/help/modules/modules.md b/manuals/help/modules/modules.md new file mode 100644 index 0000000..369d7f2 --- /dev/null +++ b/manuals/help/modules/modules.md @@ -0,0 +1,209 @@ +--- +sidebar_position: 2 +id: modules +title: "Help4.x:Modules" +--- +## Description + +The Modules list is used to find, add, and edit modules. + +Modules are used to display content and/or media around the main +content. + +## How to Access + +**Home Dashboard **→** Site **→** Modules** + +To add a Module: + +- click the **New** toolbar button + +To edit a Module: + +- select a **Title** from the list + +## Screenshot + + + +## Column Headers + +- **Checkbox**. Check this box to select modules. To select all modules, + check the box in the column heading. After boxes are checked the + toolbar button 'Actions' get active. +- **Ordering**. You can change the order of an module within a list as + follows: + - Select the Ordering icon Ordering icon in the List heading to make it active. + - Select one of the Three dots icons Three dots icon and drag it up or down to change the + position of that row in the list. + - In the Filter Options you may limit the list to modules that are + assigned for example to a Language. +- **Status**. Status of module. Hover icon for informations. +- **Title**. The title of the module. Edit the module by clicking on the + Title. +- **Position**. The position on the page where this module is displayed. + [Learn + more.](https://docs.joomla.org/J4.x:How_to_Show_a_Calendar_Month_List_of_Archived_Articles_Using_a_Module/en "J4.x:How to Show a Calendar Month List of Archived Articles Using a Module/en") +- **Type**. The system name of the Module. +- **Pages**. The Menu Items where this Module will be displayed. + - On all pages + - No pages + - Only on the pages selected + - On all pages except those selected +- **Access**. The viewing [Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en") + for this module. +- **Language**. Modules language, default is 'All'. +- **ID**. A unique identification number for this module, you cannot + change this number. + +## List Filters + +**Site and Administrator filter**. Selects either Site or Administrator +modules. + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of modules in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +### Filter Options + +Near the top of the page you will see the filter bar shown in the +[Screenshot](#screenshot) above. + +- **Select Status**. Select from Trashed / Unpublished / Published / + All. +- **Select Position**. Select from the list of available module + positions. +- **Select Type**. Select from the list of available module types. +- **Select Menu Item**. Select from the list of available menu items. +- **Select Access**. Select from the list of available viewing access + levels. +- **Select Language**. Select from the list of available languages. + +### Pagination + +**Page Controls**. When the number of modules is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **New**. Opens the editing screen to create a new module. +- **Actions**. Reveals a list of actions for selected modules. Check one + or more modules checkboxes to activate the list. + - **Publish**. Makes the selected modules available to visitors to + your website. + - **Unpublish**. Makes the selected modules unavailable to visitors to + your website. + - **Check-in**. Checks-in the selected modules. + - **Trash**. Changes the status of the selected modules to indicate + that they are trashed. [Learn + more.](https://docs.joomla.org/J4.x:Deleting_an_Article/en "J4.x:Deleting an Article/en") + - **Batch**. Batch processes the selected modules. + - **Duplicate**. Makes a copy of the selected modules. The copy is + created immediately and is given the same name as the original but + suffixed with a number (for example "(2)") so that it can be + distinguished from the original and any other copies. +- **Options**. Opens [Module: + Options](https://docs.joomla.org/Help4.x:Modules:_Options/en "Help4.x:Modules: Options/en"). +- **Help**. Opens this help screen. + +## Batch Process + +The Batch Process allows a change in settings for a group of selected +modules. + + + +**How to Batch Process** a group of modules: + +1. Select one or more modules on the list by checking the desired + checkboxes. +2. Click the Batch Toolbar button. +3. Set one or more of the following values: + - To change the **Language**, select the desired new language from + the Set Language list box. + - To change the **Access Levels**, select the desired new access + level from the Set Access Level list box. + - To change the **Position**, select the desired new Position from + the Set Position list box. +4. When all of the settings are entered, click on Process to perform + the changes. A message **"Batch process completed successfully."** + will show. + +## Quick Tips + +- Joomla websites require at least 1 [Menu + Module](https://docs.joomla.org/Help4.x:Site_Modules:_Menu/en "Help4.x:Site Modules: Menu/en"). +- Other Module Types (for example + [Banners](https://docs.joomla.org/Help4.x:Site_Modules:_Banners/en "Help4.x:Site Modules: Banners/en")) + are optional. +- Some Modules are linked to components. For example, each Menu Module + is related to one + [Menu](https://docs.joomla.org/Help4.x:Menus/en "Help4.x:Menus/en"). +- Other Modules (for example + [Breadcrumbs](https://docs.joomla.org/Help4.x:Site_Modules:_Breadcrumbs/en "Help4.x:Site Modules: Breadcrumbs/en")) + do not depend on any other content. +- Multiple occurrences of similar Module Types are allowed and common. + +## Related Information + +- The Joomla installation has over 40 module types. Additional 3rd party + modules can be obtained from the + Joomla Extensions + Directory. +- [Home + Dashboard](https://docs.joomla.org/Help4.x:Home_Dashboard/en "Help4.x:Home Dashboard/en"): + Access to many default Joomla functions. +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. diff --git a/manuals/help/multilingual-associations/multilingual-associations-edit.md b/manuals/help/multilingual-associations/multilingual-associations-edit.md new file mode 100644 index 0000000..7c6b7ca --- /dev/null +++ b/manuals/help/multilingual-associations/multilingual-associations-edit.md @@ -0,0 +1,151 @@ +--- +sidebar_position: 2 +id: multilingual-associations-edit +title: "Help4.x:Multilingual Associations: Edit" +--- +## Description + +Used to add or edit associations between languages displayed on a +multilingual website. + +## How to Access + +To add a Association: + +- **Components **→** Multilingual Associations** + 1. select **Item Type**. + 2. select **Language**. + 3. Select a target language in the **Not Associated** column. + +To edit a Association: + +- **Components **→** Multilingual Associations** + 1. select **Item Type**. + 2. select **Language**. + 3. Select a target language in the **Associated** column. + +## Screenshot + + + +The Multilingual Associations edit screen shows the item content in +source and destination side by side. Each is a scrollable window with +the item options beneath the text edit area. + +## Form Fields + +The screens depends on the selected item so go to: + +### Content + +- [Articles](https://docs.joomla.org/Help4.x:Articles:_Edit/en#content "Help4.x:Articles: Edit/en") +- [Articles + Categories](https://docs.joomla.org/Help4.x:Articles:_Edit_Category/en#content "Help4.x:Articles: Edit Category/en") +- [Contacts](https://docs.joomla.org/Help4.x:Contacts:_Edit/en#content "Help4.x:Contacts: Edit/en") +- [Contacts + Categories](https://docs.joomla.org/Help4.x:Contacts:_Edit_Category/en#content "Help4.x:Contacts: Edit Category/en") +- [Menus](https://docs.joomla.org/Help4.x:Menus:_Items/en "Help4.x:Menus: Items/en") +- [News + Feeds](https://docs.joomla.org/Help4.x:News_Feeds:_Edit/en#content "Help4.x:News Feeds: Edit/en") +- [News Feeds + Categories](https://docs.joomla.org/Help4.x:News_Feeds:_Edit_Category/en#content "Help4.x:News Feeds: Edit Category/en") + +### Images and Links + +- [Articles](https://docs.joomla.org/Help4.x:Articles:_Edit/en#imagesandlinks "Help4.x:Articles: Edit/en") + +### Options + +- [Articles](https://docs.joomla.org/Help4.x:Articles:_Edit/en#options "Help4.x:Articles: Edit/en") +- [Articles + Categories](https://docs.joomla.org/Help4.x:Articles:_Edit_Category/en#options "Help4.x:Articles: Edit Category/en") +- [Contacts + Categories](https://docs.joomla.org/Help4.x:Contacts:_Edit_Category/en#options "Help4.x:Contacts: Edit Category/en") +- [News + Feeds](https://docs.joomla.org/Help4.x:News_Feeds:_Edit/en#options "Help4.x:News Feeds: Edit/en") +- [News Feeds + Categories](https://docs.joomla.org/Help4.x:News_Feeds:_Edit_Category/en#options "Help4.x:News Feeds: Edit Category/en") + +### Publishing + +- [Articles](https://docs.joomla.org/Help4.x:Articles:_Edit/en#publishing "Help4.x:Articles: Edit/en") +- [Articles + Categories](https://docs.joomla.org/Help4.x:Articles:_Edit_Category/en#publishing "Help4.x:Articles: Edit Category/en") +- [Contacts](https://docs.joomla.org/Help4.x:Contacts:_Edit/en#publishing "Help4.x:Contacts: Edit/en") +- [Contacts + Categories](https://docs.joomla.org/Help4.x:Contacts:_Edit_Category/en#publishing "Help4.x:Contacts: Edit Category/en") +- [News + Feeds](https://docs.joomla.org/Help4.x:News_Feeds:_Edit/en#publishing "Help4.x:News Feeds: Edit/en") +- [News Feeds + Categories](https://docs.joomla.org/Help4.x:News_Feeds:_Edit_Category/en#publishing "Help4.x:News Feeds: Edit Category/en") + +### Associations + +- [Articles](https://docs.joomla.org/Help4.x:Articles:_Edit/en#associations "Help4.x:Articles: Edit/en") +- [Articles + Categories](https://docs.joomla.org/Help4.x:Articles:_Edit_Category/en#associations "Help4.x:Articles: Edit Category/en") +- [Contacts](https://docs.joomla.org/Help4.x:Contacts:_Edit/en#associations "Help4.x:Contacts: Edit/en") +- [Contacts + Categories](https://docs.joomla.org/Help4.x:Contacts:_Edit_Category/en#associations "Help4.x:Contacts: Edit Category/en") +- [News + Feeds](https://docs.joomla.org/Help4.x:News_Feeds:_Edit/en#associations "Help4.x:News Feeds: Edit/en") +- [News Feeds + Categories](https://docs.joomla.org/Help4.x:News_Feeds:_Edit_Category/en#associations "Help4.x:News Feeds: Edit Category/en") + +### Configure Edit Screen + +- [Articles](https://docs.joomla.org/Help4.x:Articles:_Edit/en#configureeditscreen "Help4.x:Articles: Edit/en") + +### Permissions + +- [Articles](https://docs.joomla.org/Help4.x:Articles:_Edit/en#permissions "Help4.x:Articles: Edit/en") +- [Articles + Categories](https://docs.joomla.org/Help4.x:Articles:_Edit_Category/en#permissions "Help4.x:Articles: Edit Category/en") +- [Contacts + Categories](https://docs.joomla.org/Help4.x:Contacts:_Edit_Category/en#permissions "Help4.x:Contacts: Edit Category/en") +- [News Feeds + Categories](https://docs.joomla.org/Help4.x:News_Feeds:_Edit_Category/en#permissions "Help4.x:News Feeds: Edit Category/en") + +### Miscellaneous Information + +- [Contacts](https://docs.joomla.org/Help4.x:Contacts:_Edit/en#miscellaneousinformation "Help4.x:Contacts: Edit/en") + +### Display + +- [Contacts](https://docs.joomla.org/Help4.x:Contacts:_Edit/en#display "Help4.x:Contacts: Edit/en") + +### Form + +- [Contacts](https://docs.joomla.org/Help4.x:Contacts:_Edit/en#form "Help4.x:Contacts: Edit/en") + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **Save Reference**. Saves the Reference and stays in the current + screen. +- **Save Target**. Saves the Target and stays in the current screen. +- **Copy Reference to Target**. Copies all the fields to the target + fields. +- **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 + +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Multilingual Associations: Options](https://docs.joomla.org/Help4.x:Multilingual_Associations:_Options/en "Help4.x:Multilingual Associations: Options/en") | Default permissions used for all content in the Multilingual Associations Component. | +| [Multilingual Associations](https://docs.joomla.org/Help4.x:Multilingual_Associations/en "Help4.x:Multilingual Associations/en") | This screen is used to set up an Association between an item and installed site languages. | +| Multilingual Associations: Edit | Used to add or edit associations between languages displayed on a multilingual website. | diff --git a/manuals/help/multilingual-associations/multilingual-associations-options.md b/manuals/help/multilingual-associations/multilingual-associations-options.md new file mode 100644 index 0000000..8ba00a5 --- /dev/null +++ b/manuals/help/multilingual-associations/multilingual-associations-options.md @@ -0,0 +1,73 @@ +--- +sidebar_position: 3 +id: multilingual-associations-options +title: "Help4.x:Multilingual Associations: Options" +--- +## Description + +Default permissions used for all content in the Multilingual +Associations Component. + +## How to Access + +- **Components **→** Multilingual Associations** + - click the **Options** toolbar button + +## Screenshot + + + +## Form Fields + +### Permissions + +To change the permissions for associations, do the following. + +1. Select the **Group** by clicking its title located on the left. +2. Find the desired **Action**. + - **Configure ACL & Options**. Users can edit the options and + permissions. + - **Configure Options Only**. Users can edit the options exept the + permissions. + - **Access Administration Interface**. Users can access user + administration interface. +3. Select the desired permission for the action you wish to change. + - **Inherited**. Inherited for users in this Group from the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#permissions "Help4.x:Site Global Configuration/en") + permissions. + - **Allowed**. Allowed for users in this Group.Note: 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 + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **Save**. Saves the association and stays in the current screen. +- **Save & Close**. Saves the association and closes the current screen. +- **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 + +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. + +| | | +|----------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| Multilingual Associations: Options | Default permissions used for all content in the Multilingual Associations Component. | +| [Multilingual Associations](https://docs.joomla.org/Help4.x:Multilingual_Associations/en "Help4.x:Multilingual Associations/en") | This screen is used to set up an Association between an item and installed site languages. | +| [Multilingual Associations: Edit](https://docs.joomla.org/Help4.x:Multilingual_Associations:_Edit/en "Help4.x:Multilingual Associations: Edit/en") | Used to add or edit associations between languages displayed on a multilingual website. | diff --git a/manuals/help/multilingual-associations/multilingual-associations.md b/manuals/help/multilingual-associations/multilingual-associations.md new file mode 100644 index 0000000..13d9211 --- /dev/null +++ b/manuals/help/multilingual-associations/multilingual-associations.md @@ -0,0 +1,131 @@ +--- +sidebar_position: 1 +id: multilingual-associations +title: "Help4.x:Multilingual Associations" +--- +## Description + +The Multilingual Associations Component is a tool that allows editing of +associated items side-by-side without the need to go back and forth. + +This screen is used to set up an Association between an item and +installed site languages. + +## How to Access + +- **Components **→** Multilingual Associations** + 1. select **Item Type**. + 2. select **Language**. + +## Screenshot + + + +## Column Headers + +- **Status**. The published status of the menu item. +- **Title**. The title of the menu item. Edit the menu item by clicking + on the Title. +- **Language**. Menu items language. +- **Associations**. Shows which language this menu item is associated. +- **Not Associated**. Shows for which languages this menu item is not + associated. +- **Menu**. Shows which menu the menu item belongs to. +- **Access**. The viewing [Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en") + for this menu item. +- **ID**. A unique identification number for this menu item, you cannot + change this number. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of menu items in a list. + Select from the dropdown list to change the number displayed.The + default for a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +### Filter Options + +Near the top of the page you will see the filter bar shown in the +[Screenshot](#screenshot) above. + +- **Select Status**. Select from Trashed / Unpublished / Published / + Archived / All. +- **Select Category**. Select from the list of available categories. +- **Select Menu**. Select from the list of available menus. +- **Select Access**. Select from the list of available viewing access + levels. +- **Select Max Levels**. Select from the list of available levels. + +### Pagination + +**Page Controls**. When the number of menu items is more than one page, +you will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +Prior to selection of an Item Type and Language the toolbar at the top +has 4 buttons. The first 2 disappear after selection. + +- **Delete All Associations**. Lets you delete all associations. After a + question to confirm, all associations will be deleted. +- **Delete Orphans**. Lets you delete all orphans. +- **Options**. Opens the help screen [Multilingual Associations: + Options](https://docs.joomla.org/Help4.x:Multilingual_Associations:_Options/en "Help4.x:Multilingual Associations: Options/en"). +- **Help**. Opens this help screen. + +## Quick Tips + +- An menu-item in English can be more easily translated into French with + the original and translation side by side. And then select Persian to + translate from English to Persian too. [Learn + more.](https://docs.joomla.org/Help4.x:Multilingual_Associations:_Edit/en "Help4.x:Multilingual Associations: Edit/en") +- This screen use menu-items as example. You will see all Item Types + shown in the [Screenshot](#screenshot) above. + +## Related Information + +- This + [Portal](https://docs.joomla.org/Portal:Joomla_4/en "Portal:Joomla 4/en") + brings together information related specifically to Joomla 4. + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Multilingual Associations: Options](https://docs.joomla.org/Help4.x:Multilingual_Associations:_Options/en "Help4.x:Multilingual Associations: Options/en") | Default permissions used for all content in the Multilingual Associations Component. | +| Multilingual Associations | This screen is used to set up an Association between an item and installed site languages. | +| [Multilingual Associations: Edit](https://docs.joomla.org/Help4.x:Multilingual_Associations:_Edit/en "Help4.x:Multilingual Associations: Edit/en") | Used to add or edit associations between languages displayed on a multilingual website. | diff --git a/manuals/help/my-profile/my-profile.md b/manuals/help/my-profile/my-profile.md new file mode 100644 index 0000000..f5a71ca --- /dev/null +++ b/manuals/help/my-profile/my-profile.md @@ -0,0 +1,183 @@ +--- +sidebar_position: 1 +id: my-profile +title: "Help4.x:My Profile" +--- +## Description + +Available to users with Administrator access to a Joomla! installation, +the **My Profile** page allows a user to edit some personal information. +These include **Name**, **Password** and **Email**, and personal +preferences: Administrator template, Language settings, Editor and Time +zone. + +## How to access + +- At the top right, click on the **User Menu**  **→**  **Edit Account** + + + +## Screenshot + + + +## Form Fields + +### Account Details + +- **Name:** The (full) name of the user. + + + +- **Login Name**. The user name that will be entered during login. + + + +- **Password**. The password that will be entered during login. + + + +- **Confirm Password**. The same password again (to make sure the + password is entered correctly). + + + +- **Email**. Email address for this user. + + + +- **Registration Date:** The date this user was registered. + + + +- **Last Visit Date**. The date this user last logged into the site. + + + +- **Last Reset Date**. Date and time of last password reset. + + + +- **Password Reset Count**. Number of password resets since starting the + last reset time. + + + +- **Receive System Emails**. (*Yes*/*No*) If set to yes, the user will + receive system emails. + + + +- **User Status**. (*Blocked*/*Enabled*) Enable or block this user. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +#### Basic Settings + +Help-4x-Site-My-Profile-basic-en.png + +- **Backend Template Style**. The template style to use for this user in + the administrative backend. + + + +- **Back-end Language**. Here you can select the back-end language of + the user. All installed languages for the back-end will be displayed + in the drop-down box. Default is the language set in Language Manager. + + + +- **Front-end Language**. Here you can select the front-end language of + the user. All installed languages for the front-end will be displayed + in the drop-down box. Default is the language set in Language Manager. + + + +- **Editor**. The editor to use for this user. + + + +- **Time Zone**. Set the time zone of the user. Default is the Time Zone + set in the Global Configuration. + +#### Accessibility Settings + + + +- **Monochrome**. Yes/No +- **High Contrast**. Yes/No +- **Highlight Links**. Yes/No +- **Increase Font Size**. Yes/No + +#### User Actions Log Options *(tab available for Super Users only)* + + + +- **Send notifications for User Actions Log**. (*Yes/No*) If set to yes, + the User will receive user actions log notification by email +- **Select events to be notified for**. Select the user actions log + notifications to be sent by email. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the user and stays in the current screen. + + + +- **Save & Close**. Saves the user and closes the current screen. + + + +- **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 + +- Your login name, password, and email are automatically populated from + your initial installation. If desired, you can change or edit these + settings by using this interface. If you change your password remember + that it is case sensitive. +- You can also access and edit your administrator account from the + [Users: Edit + Profile](https://docs.joomla.org/Help4.x:Users:_Edit_Profile/en "Help4.x:Users: Edit Profile/en") + screen which is available through the + [Users](https://docs.joomla.org/Help4.x:Users/en "Help4.x:Users/en"). + +## Related Information + +- See [Users: Edit + Profile](https://docs.joomla.org/Help4.x:Users:_Edit_Profile/en "Help4.x:Users: Edit Profile/en") diff --git a/manuals/help/news-feed/news-feed-options.md b/manuals/help/news-feed/news-feed-options.md new file mode 100644 index 0000000..1b451a2 --- /dev/null +++ b/manuals/help/news-feed/news-feed-options.md @@ -0,0 +1,289 @@ +--- +sidebar_position: 1 +id: news-feed-options +title: "Help4.x:News Feed: Options" +--- +## Description + +News Feed Options configuration allows setting of parameters used +globally for all news feeds. + +## How to Access + +- Select **Components **→** News Feeds **→** Feeds** from the + Administrator menu. Or... +- Select **Components **→** News Feeds **→** Categories** from the + Administrator menu. Then... + - Click the *Options* button on the Toolbar. + +## Screenshot + + + +## Form Fields + +### News Feed Tab + +These settings apply for all News Feeds unless they are changed for a +specific menu item or News Feed + +- **Choose a layout.** Default layout to use for articles. +- **Enable Versions.** (Yes/No). Whether or not to save version history + for this component. If No, version history will not be saved for + component items or for this component's categories. +- **Maximum Versions.** The maximum number of versions to store for an + item. If an item is saved and the maximum number of versions has been + reached, the oldest version will be deleted automatically. If set to + 0, then versions will never be deleted automatically. Also, specific + versions may be flagged as "Keep Forever" and will not be deleted + automatically. Note that versions may be deleted manually using the + Delete button in the [Version + History](https://docs.joomla.org/Help310:Components_Version_History/en "Help310:Components Version History/en") + screen. +- **Feed Image.** (Show/Hide). Show or hide the feed image. +- **Feed Description.** (Show/Hide). Show or hide the feed description. +- **Feed Content.** (Show/Hide). Show or hide the feed content. +- **Characters Count.** The maximum number of characters to display for + each feed. This is a way to limit the size of the feed. +- **Feed Display Order.** (Most recent first/oldest first). The order in + which to show the feeds. +- **First Image Float.** (Right/Left/None). Where to display the image + on the page. +- **Second Image Float.** (Right/Left/None). Where to display the image + on the page. +- **Show Tags.** (Show/Hide). Show or hide the feed's tags. + +### Category Tab + +Category Options control how feeds will show when you drill down to a +Category to view its feeds. + + + +- **Choose a layout.** (Blog/List/user defined). This lets you select + the default layout to show when you click on a Category link. If you + create an alternative layout for a category layout, you may select + that as the default. +- **Category Title.** (Show/Hide). Show or hide the title of the + category. +- **Category Description.** (Show/Hide). Show or hide the description + for the category. +- **Category Image.** (Show/Hide). Show or hide the category image. +- **Subcategory Levels.** (None/All/1-5). Categories in Joomla can be + created in a hierarchy. This lets you control how many levels of + subcategories to show when showing a category view. +- **Empty Categories.** (Show/Hide). Show or hide categories that don't + contain any items or subcategories. +- **Subcategories Descriptions.** (Hide/Show). Show or hide the + descriptions for subcategories that are shown. +- **\# Feeds in Category.** (Show/Hide). Show or hide the number of news + feeds in category. +- **Show Tags.** (Show/Hide). Show or hide the tags for a single + category. + +### Categories Tab + +These settings apply for News Feed Categories Options unless they are +changed for a specific menu item. + + + +- **Top Level Category Description.** (Show/Hide). Show or hide the + description of the top-level category. +- **Subcategory Levels.** (All/1-5). How many levels in the hierarchy to + show. +- **Empty Categories.** (Show/Hide). Show or hide categories that + contain no items and no subcategories. +- **Subcategories Descriptions.** (Hide/Show). Show or hide the + description of each subcategory. +- **\# Feeds in Category.** (Show/Hide). Show or hide the number of news + feeds in category. + +### List Layouts Tab + +These settings apply for Feed List Options unless they are changed for a +specific menu item. + + + +- **Filter Field.** The Filter Field creates a text field where a user + can enter a field to be used to filter the articles shown in the list. + An example of how this looks in the front-end layout is shown below. + +Help-4x-article-category-list-filter-field-en.png + +The possible options for this (in the back-end menu item edit) are shown +below. + +- *Hide:* Don't show a filter field. +- *Title:* Filter on article title. +- *Author:* Filter on the author's name. +- *Hits:* Filter on the number of article hits. + + + +- **Display Select.** (Show/Hide) Whether to show or hide the Display \# + control that allows the user to select the number of items to show in + the list. An example is shown below. + + + +If there are more items than this number, you can use the page +navigation buttons (Start, Prev, Next, End, and page numbers) to +navigate between pages. Note that if you have a large number of items, +it may be helpful to use the Filter options, located above the column +headings, to limit which items display. + +- **Table Headings.** (Hide/Show) Table Headings show a heading above + the article list, as shown below. + + + +If set to *Show*, this heading will show about the list. Otherwise the +list will show with no headings. + +- **\# Articles.** (Show/Hide). Whether to show or hide the number or + articles in each feed. +- **Feed Links.** (Show/Hide). Whether to show or hide the feed links + URL. + + + +- **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 listed items will not fit + on one page. An example is shown below. + +Help30-pagination-en.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. + +### Integration Tab + +These options control the display of news feeds. + + + +- **Remove IDs from URLs.** (Yes or No) Whether or not to show the + database id of a newsfeed in a link. + +### Permissions Tab + +This section shows permissions for feeds. The screen shows as follows. + + + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Optons**. Users can edit the options and + persimissions of this extension. + - **Configure Optons Only**. Users can edit the options exept the + persimissions of this extension. + - **Access Administration Interface**. Users can access user + administration interface of this extension. + - **Create:** Users can create content of this extension. + - **Delete:** Users can delete content of this extension. + - **Edit:** Users can edit content of this extension. + - **Edit State:** User can change the published state and related + information for content of this extension. + - **Edit Own:** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited:*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **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 + +- If you are a beginning user, you can just keep the default values here + until you learn more about using global options. +- If you are an advanced user, you can save time by creating good + default values here. When you set up menu items and create news feed + menu items, you will be able to accept the default values for most + options. +- All values set here can be overridden at the menu item, category, or + news feed level. + +## Related Information + +- To create and edit news feeds and news feed categories: [News Feed + Manager](https://docs.joomla.org/Help4.x:News_Feeds/en "Help4.x:News Feeds/en") +- For more information about Joomla's ACL system: [Joomla 3 ACL + Tutorial](https://docs.joomla.org/J3.x:Access_Control_List_Tutorial/en "J3.x:Access Control List Tutorial/en") diff --git a/manuals/help/news-feed/news-feeds-categories.md b/manuals/help/news-feed/news-feeds-categories.md new file mode 100644 index 0000000..dfc8a3c --- /dev/null +++ b/manuals/help/news-feed/news-feeds-categories.md @@ -0,0 +1,218 @@ +--- +sidebar_position: 3 +id: news-feeds-categories +title: "Help4.x:News Feeds: Categories" +--- +## Description + +News Feed Categories allow you to categorise different website feeds +entering your site for better organisation. + +## How to Access + +- Select **Components **→** News Feeds **→** Categories** from the + Administrator menu. + +## Screenshot + + + +## Column Headers + +Click on the column heading to sort the list by that column's value. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **Title**. The name or title of the feed. Make it as descriptive as + possible. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Associations:** Shows which language this item is associated. + + + +- **Language**. Item language. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Special:MyLanguage/Help4.x:Site Global Configuration/en"). + +**Filter Options** + +- **Select Status.** Use the drop-down list box to select the published + state: Published, Unpublished, Trashed, or All. For Articles, you may + also select Archived. **Important:** With the default setting of + -Select Status-, the screen only shows Published and Unpublished + items. If you have the filter set to -Select Status- and you change + items to Trashed, the Trashed items will disappear from the screen. + However, they have not been permanently deleted. To do that you need + to: + +1. Change the filter to Trashed. The Delete icon will now show in the + toolbar. +2. Select the items you want to permanently delete. +3. Click on the Delete icon. + +You can see all items, regardless of their published state, by selecting +All for this filter. You can also re-publish Trashed items by selecting +them and clicking on the Publish icon in the toolbar. + +- **Select Access**. Select from the list of available viewing access + levels. + + + +- **Select Language**. Select from the list of available languages, if + the site manages more than 1 language. + + + +- **Select Tag**. Select from the list of available tags. + + + +- **Select Max Levels**. Select from the list of available levels. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new category. + + + +- **Edit**. Opens the editing screen for the selected category. If more + than one category is selected (where applicable), only the first + category will be opened. The editing screen can also be opened by + clicking on the Name of the category. + + + +- **Publish**. Makes the selected category available to visitors to your + website. + + + +- **Unpublish.** Makes the selected category unavailable to visitors to + your website. + + + +- **Archive**. Changes the status of the selected category to indicate + that they are archived. Archived category can be moved back to the + published or unpublished state by selecting 'Archived' in the 'Select + Status' filter and changing the status of the category. + + + +- **Check-In**. Checks-in the selected category. Works with one or + multiple category selected. + + + +- **Batch**. Batch processes the selected category. Works with one or + multiple items selected. + + + +- **Rebuild.** Reconstructs and refreshes the category table. Normally, + you do *not* need to rebuild this table. This function is provided in + case the data in the table becomes corrupted. + + + +- **Trash**. Changes the status of the selected category to indicate + that they are trashed.Trashed category can still be recovered by + selecting 'Trashed' in the 'Select Status' filter and changing the + status of the articles to Published or Unpublished as preferred.To + permanently delete trashed category, select 'Trashed' in the 'Select + Status' filter, select the category to be permanently deleted, then + click the 'Empty Trash' toolbar icon. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Related Information + +- To work with News Feeds: [News + Feeds](https://docs.joomla.org/Help4.x:News_Feeds "Help4.x:News Feeds") +- To add new News Feeds Categories: [News Feeds: Edit + Category](https://docs.joomla.org/Help4.x:News_Feeds:_Edit_Category "Help4.x:News Feeds: Edit Category") diff --git a/manuals/help/news-feed/news-feeds-new-or-edit-category.md b/manuals/help/news-feed/news-feeds-new-or-edit-category.md new file mode 100644 index 0000000..87add00 --- /dev/null +++ b/manuals/help/news-feed/news-feeds-new-or-edit-category.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 5 +id: news-feeds-new-or-edit-category +title: "Help4.x:News Feeds: New or Edit Category" +--- +Redirect to: + +- [Help4.x:News Feeds: Edit + Category](https://docs.joomla.org/Help4.x:News_Feeds:_Edit_Category "Help4.x:News Feeds: Edit Category") diff --git a/manuals/help/news-feed/news-feeds-new-or-edit.md b/manuals/help/news-feed/news-feeds-new-or-edit.md new file mode 100644 index 0000000..a36427b --- /dev/null +++ b/manuals/help/news-feed/news-feeds-new-or-edit.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 4 +id: news-feeds-new-or-edit +title: "Help4.x:News Feeds: New or Edit" +--- +Redirect to: + +- [Help4.x:News Feeds: + Edit](https://docs.joomla.org/Help4.x:News_Feeds:_Edit "Help4.x:News Feeds: Edit") diff --git a/manuals/help/news-feed/news-feeds.md b/manuals/help/news-feed/news-feeds.md new file mode 100644 index 0000000..9229f41 --- /dev/null +++ b/manuals/help/news-feed/news-feeds.md @@ -0,0 +1,236 @@ +--- +sidebar_position: 2 +id: news-feeds +title: "Help4.x:News Feeds" +--- +## Description + +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. + +## How to Access + +- Select **Components **→** News Feeds **→** Feeds** from the + Administrator menu. +- Or select the **Feeds** link from the [News Feeds Manager - + Categories](https://docs.joomla.org/Help4.x:News_Feeds:_Categories "Help4.x:News Feeds: Categories"). + +## Screenshot + + + +## Column Headers + +Click on the column heading to sort the list by that column's value. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **Title**. The name or title of the feed. Make it as descriptive as + possible. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. +- **\# Articles** The number of articles included in the feed. + + + +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. + + + +- **Association:** Shows which menu item this item is associated. + + + +- **Language**. Item language. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +**Filter Options** + +- **Select Status.** Use the drop-down list box to select the published + state: Published, Unpublished, Trashed, or All. For Articles, you may + also select Archived. **Important:** With the default setting of + -Select Status-, the screen only shows Published and Unpublished + items. If you have the filter set to -Select Status- and you change + items to Trashed, the Trashed items will disappear from the screen. + However, they have not been permanently deleted. To do that you need + to: + +1. Change the filter to Trashed. The Delete icon will now show in the + toolbar. +2. Select the items you want to permanently delete. +3. Click on the Delete icon. + +You can see all items, regardless of their published state, by selecting +All for this filter. You can also re-publish Trashed items by selecting +them and clicking on the Publish icon in the toolbar. + +- **Select Category**. Select from the list of available categories. + + + +- **Select Access**. Select from the list of available viewing access + levels. + + + +- **Select Language**. Select from the list of available languages, if + the site manages more than 1 language. + + + +- **Select Tag**. Select from the list of available tags. + + + +- **Select Max Levels**. Select from the list of available levels. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new news feed. + + + +- **Actions:** Reveals a list of actions for selected Items. Check one + or more Item checkboxes to activate the list. + + + +- **Publish**. Makes the selected news feeds available to visitors to + your website. + + + +- **Unpublish.** Makes the selected news feeds unavailable to visitors + to your website. + + + +- **Archive**. Changes the status of the selected news feeds to indicate + that they are archived. Archived news feeds can be moved back to the + published or unpublished state by selecting 'Archived' in the 'Select + Status' filter and changing the status of the news feeds. + + + +- **Check-In**. Checks-in the selected news feeds. Works with one or + multiple news feeds selected. + + + +- **Trash**. Changes the status of the selected news feeds to indicate + that they are trashed.Trashed news feeds can still be recovered by + selecting 'Trashed' in the 'Select Status' filter and changing the + status of the articles to Published or Unpublished as preferred.To + permanently delete trashed news feeds, select 'Trashed' in the 'Select + Status' filter, select the news feeds to be permanently deleted, then + click the 'Empty Trash' toolbar icon. + + + +- **Batch**. Batch processes the selected news feeds. Works with one or + multiple items selected. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- You need to add at least one Category for news feeds *before* you add + the first feed. Categories are added by clicking on 'News Feeds', and + then on 'Categories' in the 'Components' menu. + +## Related Information + +- To set News Feed Options: [News Feed + Options](https://docs.joomla.org/Help4.x:News_Feed:_Options "Help4.x:News Feed: Options") +- To create or Edit News Feeds: + News Feeds + Manager - New/Edit +- To work with News Feed Categories: [Category Manager (News + Feeds)](https://docs.joomla.org/Help4.x:News_Feeds:_Categories "Help4.x:News Feeds: Categories") diff --git a/manuals/help/permissions/permissions-for-group.md b/manuals/help/permissions/permissions-for-group.md new file mode 100644 index 0000000..7140ef3 --- /dev/null +++ b/manuals/help/permissions/permissions-for-group.md @@ -0,0 +1,128 @@ +--- +sidebar_position: 1 +id: permissions-for-group +title: "Help4.x:Permissions for Group" +--- +## Description + +The Advanced Permissions Report maps out the exact permissions for any +given user group across all assets on your Joomla! installation. It is +useful for debugging user access problems. + +## How to access + +- Select **Users → Groups** from the Administrator menu. Then... + - Select the **Permissions** icon for a specific group from the user + groups list. + +## Screenshot + +Help-4x-debug groups-screen-en.png + +## Column Headers + +In the table containing the assets from your Joomla! site, you will see +different columns. For each asset the permission for this group is +shown, color coded as per legend. + +- **Asset Title.** The asset as we know it. +- **Asset Name.** The asset as known internally. +- **Site Login.** Allows users in the group to login to the Frontend + site. +- **Administrator Login.** Allows users in the group to login to the + Backend Administrator site. +- **Web Services Login.** Allows utilization of the Joomla Web Services + API via a Super User API Token. +- **Offline Access.** Allows users in the group to access the Frontend + site when site is offline. +- **Super User.** Allows users in the group to perform any action over + the whole site regardless of any other permission settings. +- **Configure Options Only.** Allows users in the group to edit the + options (except permissions) of any extension. +- **Access Administration Interface.** Allows users in the group to + access all of the administration interface except Global + Configuration. +- **Create.** Allows users in the group to create any content in any + extension. +- **Delete.** Allows users in the group to delete any content in any + extension. +- **Edit.** Allows users in the group to edit any content in any + extension. +- **Edit State.** Allows users in the group to edit the state of any + content in any extension. +- **Edit Own.** Allows users in the group to edit any content they own + in any extension. +- **Edit Custom Field Value.** Allows users in the group to edit any + value of custom fields submitted in any extension. +- **LFT.** The left and right values in the hierarchy. See [Using nested + sets](https://docs.joomla.org/Using_nested_sets "Using nested sets") + in English. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +Near the top of the page you will see the filter bar shown in the +Screenshot above. The functions are: + +- **Search**. Enter part of the asset name and press the Search icon to + find matching assets. Press **x** or Clear to clear the search field + and restore the list of assets. +- **Component**. Filter by any installed component in Joomla. +- **Start Level**. Start level of the item. +- **End Level**. End level of the item. + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Legend + +At the bottom you will see the legend: + +Help31-Help-Permissions-Report-Legend-en.png + +- **Not Allowed**. Action not allowed. +- **Allowed**. Action allowed. +- **Forbidden**. Action forbidden. + +## Related Information + +- [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en "Help4.x:Site Global Configuration/en") diff --git a/manuals/help/permissions/permissions-for-user.md b/manuals/help/permissions/permissions-for-user.md new file mode 100644 index 0000000..e13a522 --- /dev/null +++ b/manuals/help/permissions/permissions-for-user.md @@ -0,0 +1,120 @@ +--- +sidebar_position: 2 +id: permissions-for-user +title: "Help4.x:Permissions for User" +--- +## Description + +The User Permissions report shows a map of the exact permissions for any +given user across all extensions on your Joomla installation. + +## How to access + +- Select **Users **→** Manage** from the Administrator menu. Then... + - Select the icon in the **Permissions** column for a specific user. + +## Screenshot + + + +## Column Headers + +In the table containing the users from your Joomla! site, you will see +different columns. Here you can read what they mean and what is +displayed in that column. + +- **Asset Title.** The asset as we know it. +- **Asset Name.** The asset as known internally. +- **Site Login.** Allows users in the group to login to the Frontend + site. +- **Administrator Login.** Allows users in the group to login to the + Backend Administrator site. +- **Offline Access.** Allows users in the group to access the Frontend + site when site is offline. +- **Super User.** Allows users in the group to perform any action over + the whole site regardless of any other perrmission settings. +- **Configure Options Only.** Allows users in the group to edit the + options (except permissions) of any extension. +- **Access Administration Interface.** Allows users in the group to + access all of the administration interface except Global + Configuration. +- **Create.** Allows users in the group to create any content in any + extension. +- **Delete.** Allows users in the group to delete any content in any + extension. +- **Edit.** Allows users in the group to edit any content in any + extension. +- **Edit State.** Allows users in the group to edit the state of any + content in any extension. +- **Edit Own.** Allows users in the group to edit any content they own + in any extension. +- **Edit Custom Field Value.** Allows users in the group to edit any + value of custom fields submitted in any extension. +- **LFT.** The left and right values in the hierarchy. See [Using nested + sets](https://docs.joomla.org/Using_nested_sets "Using nested sets") + in English. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +Near the top of the page you will see the filter bar shown in the +Screenshot above. The functions are: + +- **Search**. Enter part of the asset name and press the Search icon to + find matching assets. Press Clear to clear the search field and + restore the list of assets. +- **Component**. Filter by any installed component in Joomla. +- **Start Level**. Start level of the item. +- **End Level**. End level of the item. + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Legend + +At the bottom you will see the legend: + +Help31-Help-Permissions-Report-Legend-en.png + +- **Not Allowed**. Action not allowed. +- **Allowed**. Action allowed. +- **Forbidden**. Action forbidden. + +## Related Information + +- [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration "Help4.x:Site Global Configuration") diff --git a/manuals/help/plugins/plugin-options.md b/manuals/help/plugins/plugin-options.md new file mode 100644 index 0000000..b16a1d2 --- /dev/null +++ b/manuals/help/plugins/plugin-options.md @@ -0,0 +1,75 @@ +--- +sidebar_position: 1 +id: plugin-options +title: "Help4.x:Plugin: Options" +--- +## Description + +Plugins Options configuration allows setting of parameters used globally +for Plugins. + +## How to Access + +- Select **System **→** Plugins (in the Manage panel)** from the + Administrator menu. Then... + - Select the **Options** button on the Toolbar. + +## Screenshot + + + +## Form Fields + +### Permissions Tab + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Optons**. Users can edit the options and + persimissions of this extension. + - **Configure Optons Only**. Users can edit the options exept the + persimissions of this extension. + - **Access Administration Interface**. Users can access user + administration interface of this extension. + - **Create:** Users can create content of this extension. + - **Delete:** Users can delete content of this extension. + - **Edit:** Users can edit content of this extension. + - **Edit State:** User can change the published state and related + information for content of this extension. + - **Edit Own:** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited:*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/plugins/plugins-name-of-plugin.md b/manuals/help/plugins/plugins-name-of-plugin.md new file mode 100644 index 0000000..6b0ca7d --- /dev/null +++ b/manuals/help/plugins/plugins-name-of-plugin.md @@ -0,0 +1,218 @@ +--- +sidebar_position: 3 +id: plugins-name-of-plugin +title: "Help4.x:Plugins: Name of Plugin" +--- +## Description + +The Plugin screen allows you to edit the details and options of a +plugin. Common options for all plugins are located in the right hand +part of the Plugin Tab and described below. + +Plugins by Group: + +- [**Action Log Group.** (1 + Plugin)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Action_Log_Group/en "Chunk4x:Extensions Plugin Manager Edit Action Log Group/en") + + + +- [**API Authentication Group.** (2 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_API_Authentication_Group/en "Chunk4x:Extensions Plugin Manager Edit API Authentication Group/en") + + + +- [**Authentication Group.** (3 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Authentication_Group/en "Chunk4x:Extensions Plugin Manager Edit Authentication Group/en") + + + +- [**Behaviour Group.** (2 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Behaviour_Group/en "Chunk4x:Extensions Plugin Manager Edit Behaviour Group/en") + + + +- [**CAPTCHA Group**. (2 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_CAPTCHA_Group/en "Chunk4x:Extensions Plugin Manager Edit CAPTCHA Group/en") + + + +- [**Content Group.** (1 + Plugin)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Content_Group/en "Chunk4x:Extensions Plugin Manager Edit Content Group/en") + + + +- [**Editors Group.** (3 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Editor_Group/en "Chunk4x:Extensions Plugin Manager Edit Editor Group/en") + + + +- [**Editor Button Group.** (8 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Button_Group/en "Chunk4x:Extensions Plugin Manager Edit Button Group/en") + + + +- [**Extensions Group.** (3 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Extension_Group/en "Chunk4x:Extensions Plugin Manager Edit Extension Group/en") + + + +- [**Fields Group.** (6 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Fields_Group/en "Chunk4x:Extensions Plugin Manager Edit Fields Group/en") + + + +- [**FileSystem Group.** (1 + Plugin)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_FileSystem_Group/en "Chunk4x:Extensions Plugin Manager Edit FileSystem Group/en") + + + +- [**Finder Group.** (5 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Smart_Search_Group/en "Chunk4x:Extensions Plugin Manager Edit Smart Search Group/en") + + + +- [**Installer Group.** (5 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Installer_Group/en "Chunk4x:Extensions Plugin Manager Edit Installer Group/en") + + + +- [**Media Action Group.** (3 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Media_Action_Group/en "Chunk4x:Extensions Plugin Manager Edit Media Action Group/en") + + + +- [**Privacy Group.** (6 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Privacy_Group/en "Chunk4x:Extensions Plugin Manager Edit Privacy Group/en") + + + +- [**Quick Icon Group.** (6 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Quick_Icon_Group/en "Chunk4x:Extensions Plugin Manager Edit Quick Icon Group/en") + + + +- [**Sample Data Group.** (2 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Sample_Data_Group/en "Chunk4x:Extensions Plugin Manager Edit Sample Data Group/en") + + + +- [**System Group.** (22 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_System_Group/en "Chunk4x:Extensions Plugin Manager Edit System Group/en") + + + +- [**Two Factor Authentication Group.** (2 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Two_Factor_Authentication_Group/en "Chunk4x:Extensions Plugin Manager Edit Two Factor Authentication Group/en") + + + +- [**User Group.** (5 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_User_Group/en "Chunk4x:Extensions Plugin Manager Edit User Group/en") + + + +- [**Web Services Group.** (5 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Web_Services_Group/en "Chunk4x:Extensions Plugin Manager Edit Web Services Group/en") + + + +- [**Workflow Group.** (3 + Plugins)](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Workflow_Group/en "Chunk4x:Extensions Plugin Manager Edit Workflow Group/en") + +The complete list of plugin groups above is available in one long +document: [**List of +Plugins**.](https://docs.joomla.org/Chunk4x:List_of_Plugins/en "Chunk4x:List of Plugins/en") + +## How to Access + +Starting from the Administrator menu: + +- Select **Home Dashboard **→** Plugins**. Or.. +- Select **System **→** Manage panel **→** Plugins**. Then... + - Select the Plugin's Name in the list of plugins. + +## Screenshot + + + +## Form Fields + +### Plugin Tab + +**Left Panel** + +If the plugin has configurable options they will appear here. The +example shown in the Screenshot is the *Content - Confirm Consent* +plugin which has several configurable parameters which change as options +are selected. + +**Right Panel** + +The right panel is the same for all plugins and has the following +fields: + +- **Status.** Whether or not the item is enabled. +- **Access.** Which user 'access levels' have access to this item. You + can change an item's Access Level by clicking on its name to open it + up for editing. The default user 'access levels' which come + preconfigured with Joomla! are: + - Public: Everyone has access including website visitors who have not + logged in + - Registered: Only users with registered status or higher will have + access + - Special: Only users with author status or higher have access +- **Ordering.** A drop-down list of plugins of the same Type. The list + of plugins is arranged by their current order. You can change this + plugin's order in relation to the other plugins by selecting the + plugin in the drop-down list that you want this plugin to be ordered + below. +- **Plugin Type.** The Type of the Plugin. This value cannot be changed. +- **Plugin File.** The name of the Plugin file. Each Plugin has two + files with this name. One has the file extension '.php' and the other + has the file extension '.xml'. +- **Description.** The description of what this Plugin does. This cannot + be changed. The developer of the plugin specifies this. This may be + blank if the developer did not specify a description for the plugin. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- If you are using the TinyMCE editor, you can control which options + appear on the editor's toolbar by setting the parameters in the + "Editor - TinyMCE" plugin. +- Configurable plug-in settings are referred to as 'options'. In + previous versions of Joomla! these configurable settings were referred + to as 'parameters'. You may see the terms 'options' and 'parameters' + used interchangeably in help documentation and tutorials you + encounter. + +## Related Information + +- To install new Plugin Extensions: [Extension Manager - Install + Screen](https://docs.joomla.org/Help4.x:Extensions:_Install/en "Help4.x:Extensions: Install/en") +- To uninstall third-party Plugins: [Extension Manager - + Manage](https://docs.joomla.org/Help4.x:Extensions:_Manage/en "Help4.x:Extensions: Manage/en") diff --git a/manuals/help/plugins/plugins.md b/manuals/help/plugins/plugins.md new file mode 100644 index 0000000..df55495 --- /dev/null +++ b/manuals/help/plugins/plugins.md @@ -0,0 +1,182 @@ +--- +sidebar_position: 2 +id: plugins +title: "Help4.x:Plugins" +--- +## Description + +The Plugin Manager allows you to enable and disable Joomla! plugins and +to edit a plugin's details and options. It is also useful for quickly +enabling/disabling multiple plugins at once. + +## How to Access + +- Select **System **→** Manage panel **→** Plugins** from the + Administrator menu. or... +- Select **Home Dashboard **→** Site panel **→** Plugins** from the + Administrator menu. + +## Screenshot + + + +## Column Headers + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status.** A green tick or a red X showing whether the use of the + component is enabled/disabled. Click the icon to toggle the item + between enabled and disabled. + + + +- **Plugin Name.** The name of the plugin. +- **Type.** The Type of the plug-in. Some possible types are: + authentication, content, editors, editors-xtd, search, system, and + user. These are also the names of the website sub-directories where + the plugin files are located. For example, plugins with a type of + 'authentication' are located in the website directory + 'plugins/authentication'. +- **Element.** The plug-in directory name which contains the plugin's + files. This directory will be located in the directory which + corresponds to its type. For example, the 'Authentication - Joomla' + plugin is of type 'Authentication' and element 'joomla'. So the + website directory it is located in is 'plugins/authentication/joomla' +- **Access.** Which user 'access levels' have access to this item. You + can change an item's Access Level by clicking on its name to open it + up for editing. The default user 'access levels' which come + preconfigured with Joomla! are: + - Public: Everyone has access including website visitors who have not + logged in + - Registered: Only users with registered status or higher will have + access + - Special: Only users with author status or higher have access + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Special:MyLanguage/Help4.x:Site Global Configuration/en"). + +The list of plugins which appears on this screen may be very large. You +can use one of the available filters or any combination of them to limit +the number of plug-ins displayed to just the plug-ins which match your +filter parameters. + +**Filter Options** + +- **Select Status.** Select a status (Enabled or Disabled) from the + drop-down list box to show only plugins with the selected status. +- **Select Type.** Select a Type from the drop-down list box to show + only plugins of the selected Type. +- **Select Element.** A long list of elements, allowing a precise + selection. +- **Select Access.** Select the 'Access Level' from the drop-down list + box to only show plugins accessible by uses of the selected 'Access + Level' + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Enable**. Makes the selected item available for use on your website. + You may also toggle between Enabled and Disabled by clicking on the + icon in the 'Status' column. + + + +- **Disable**. Makes the selected plugins unavailable for use on your + website. You may also toggle between Enabled and Disabled by clicking + on the icon in the 'Status' column. + + + +- **Check-In**. Checks-in the selected plugins. Works with one or + multiple plugins selected. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- To enable or disable a group of Plugins, check the check box for each + desired Plugin and then click the Enable or Disable toolbar button. +- Starting with Joomla! 1.6, configurable plugin settings are referred + to as 'options'. In previous versions of Joomla! these configurable + settings were referred to as 'parameters'. You may see the terms + 'options' and 'parameters' used interchangeably in help documentation + and tutorials you encounter. + +## Related Information + +- To change the Details or Options for a Plugin: [Plugin Manager - + Edit](https://docs.joomla.org/Help4.x:Plugins:_Name_of_Plugin/en "Help4.x:Plugins: Name of Plugin/en") +- To install Plugins: [Extension Manager - + Install](https://docs.joomla.org/Help4.x:Extensions:_Install/en "Help4.x:Extensions: Install/en") +- To uninstall Plugins: [Extension Manager - + Manage](https://docs.joomla.org/Help4.x:Extensions:_Manage/en "Help4.x:Extensions: Manage/en") diff --git a/manuals/help/post-install-messages/post-installation-messages-for-joomla-cms.md b/manuals/help/post-install-messages/post-installation-messages-for-joomla-cms.md new file mode 100644 index 0000000..311dc0f --- /dev/null +++ b/manuals/help/post-install-messages/post-installation-messages-for-joomla-cms.md @@ -0,0 +1,62 @@ +--- +sidebar_position: 2 +id: post-installation-messages-for-joomla-cms +title: "Help4.x:Post-installation Messages for Joomla CMS" +--- +## Description + +The Post-installation Messages shows a variety of messages useful to the +site Administrator. + +## How to Access + +- Select the **Post-installation Messages** icon in any Administrator + list screen Title bar. The icon is disabled in Edit screens. + +## Screenshot + + + +## Form Fields + +- **Showing messages for.** Joomla CMS is the only option at the moment. + +## Messages + +There are a number of message panels, each with a ***Hide this +message*** button to select when you no longer wish to see a message. A +hidden message can be restored - see the Toolbar section below. + +- **Stats Collection in Joomla.** Information on how Statistics on your + site are used. +- **Welcome to Joomla!** Some resources you may find helpful. +- **Two Factor Authentication is Available.** Information on enhanced + security. + +## Release News + +- **Release News.** A list of Stable and Beta releases. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Hide All Messages.** Select this button to hide the messages in the + left panel. The messages are replaced by a box that says ***You have + read all the messages***. There is a ***Reset Messages*** button that + restores the unread messages, including the individually hidden + messages. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/post-install-messages/post-installation-messages-options.md b/manuals/help/post-install-messages/post-installation-messages-options.md new file mode 100644 index 0000000..f4d77cd --- /dev/null +++ b/manuals/help/post-install-messages/post-installation-messages-options.md @@ -0,0 +1,62 @@ +--- +sidebar_position: 1 +id: post-installation-messages-options +title: "Help4.x:Post-installation Messages: Options" +--- +## Description + +Post-installation Messages Configuration allows setting of parameters +used globally for all post-installation messages. + +## How to Access + +- Select the **Post-installation Messages** icon in any Administrator + list screen Title bar. The icon is disabled in Edit screens. Then... + - Select the **Options** button in the Toolbar. + +## Screenshot + + + +## Form Fields + +### Permissions Tab + +Default permissions used for all content in this component. + +- **Access Administration Interface:** (*Inherited*/*Allowed*/*Denied*). + Allow or deny Access Administration Interface for users in the Public + group. Access Administration Interface Allows users in the group to + access the administration interface for this extension. +- **Edit State:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Edit + State for users in the Public group. Edit State Allows users in the + group to change the state of any content in this extension. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **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 + +See [Post-installation Messages for Joomla +CMS](https://docs.joomla.org/Help4.x:Post-installation_Messages_for_Joomla_CMS/en "Help4.x:Post-installation Messages for Joomla CMS/en") diff --git a/manuals/help/privacy/privacy-consents.md b/manuals/help/privacy/privacy-consents.md new file mode 100644 index 0000000..6ce242c --- /dev/null +++ b/manuals/help/privacy/privacy-consents.md @@ -0,0 +1,78 @@ +--- +sidebar_position: 1 +id: privacy-consents +title: "Help4.x:Privacy: Consents" +--- +## Description + +This screen provides a sortable list of privacy policy consents. + +## How to access + +- Select **Users **→** Privacy **→** Consents** from the Administrator + menu. + +## Screenshot + + + +## Column Headers + +1. **Username.** +2. **User ID.** The ID of the user who consented to the Privacy Policy +3. **Subject.** Consent to the Privacy Policy +4. **Body.** Displays information about the user information stored and + consented (User's IP, browser used ...) +5. **Created.** Indicates when the consent has been given by the user +6. **ID.** This is a unique identification number for the privacy + consent assigned automatically by Joomla. It is used to identify the + item internally, and you cannot change this number. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Invalid Consent.** Activated when an item is selected. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Related Information + +- [The Privacy Tool + Suite](https://docs.joomla.org/J3.x:Privacy/en "J3.x:Privacy/en") diff --git a/manuals/help/privacy/privacy-dashboard.md b/manuals/help/privacy/privacy-dashboard.md new file mode 100644 index 0000000..d6481f6 --- /dev/null +++ b/manuals/help/privacy/privacy-dashboard.md @@ -0,0 +1,80 @@ +--- +sidebar_position: 7 +id: privacy-dashboard +title: "Help4.x:Privacy Dashboard" +--- +## Description + +This screen lists User Privacy Request Type, Status and Number of +requests. + +**Tutorials** + +- [Privacy Outline - Content and + Workflow](https://docs.joomla.org/Help4.x:Components_Privacy_Outline/en "Help4.x:Components Privacy Outline/en") +- [The Privacy Tool + Suite](https://docs.joomla.org/J3.x:Privacy/en "J3.x:Privacy/en") + +(Detailed Tutorial from Joomla 3) + +- [Information Request + Workflow](https://docs.joomla.org/J3.x:Information_Request_Workflow_in_Privacy_Component/en "J3.x:Information Request Workflow in Privacy Component/en") + +(Detailed Tutorial from Joomla 3) + +## How to access + +- Select **Users **→** Privacy Dashboard icon** from the Administrator + menu. + +## Screenshot + + + +## Dashboard Panels + +### Privacy Requests + +- *Request Type.* Displays the two different types of request + - Export: when a user has sent a request for an export of their data + - Remove: when a user has sent a request to be removed. +- *Status.* Displays the status of the request + - Invalid: a Super user has invalidated the request + - Pending: when a user has sent a request but hasn't confirmed their + request yet. Users have 2 ways to confirm: by visiting the URL + mentioned in the email sent to the user or by copying the token from + the email and paste it into the form in the given URL. The token is + valid for 24 hours. + - Confirmed: the user has confirmed their request. + - Completed: a Super user has completed the request +- *\# of requests.* Displays the number of requests for each typeThis + block displays also the total number of requests and the number of + active requests + +### Privacy Status + +- *Privacy Policy Published.*(Published/Unpublished) Whether the Privacy + Policy is published or unpublished. Navigate to Plugins **→** System - + Privacy Consent, and select your Privacy Article. Once published, you + can edit your Privacy Policy article from this screen. +- *Request Form Menu Item Published.* (Published/Unpublished) Whether + the Menu Item (which allows users to send requests) is published or + unpublished. To create it, navigate to your Menu **→** Add New Menu + Item **→** Menu Item Type: Create Request. Once published, you can + edit your menu item from this screen. +- *Outstanding Urgent Requests.* Number of urgent requests which are + older than the number of days set in the Component Options (from 10 to + 29 days). + +## Quick Tips + +- Click on a Request Type to view the requests. + +## Related Information + +- [The Privacy Tool + Suite](https://docs.joomla.org/J3.x:Privacy/en "J3.x:Privacy/en") diff --git a/manuals/help/privacy/privacy-extension-capabilities.md b/manuals/help/privacy/privacy-extension-capabilities.md new file mode 100644 index 0000000..acf92d8 --- /dev/null +++ b/manuals/help/privacy/privacy-extension-capabilities.md @@ -0,0 +1,41 @@ +--- +sidebar_position: 2 +id: privacy-extension-capabilities +title: "Help4.x:Privacy: Extension Capabilities" +--- +## Description + +This screen displays the information collected from extensions which +report their privacy related capabilities. + +## How to access + +Select **Users **→** Privacy **→** Capabilities** from the Administrator +menu. + +## Screenshot + + + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Related Information + +- [The Privacy Tool + Suite](https://docs.joomla.org/J3.x:Privacy/en "J3.x:Privacy/en") +- [Report Extension + Capabilities](https://docs.joomla.org/J3.x:Report_Extension_Capabilities_in_Privacy_Component/en "J3.x:Report Extension Capabilities in Privacy Component/en") diff --git a/manuals/help/privacy/privacy-information-requests.md b/manuals/help/privacy/privacy-information-requests.md new file mode 100644 index 0000000..b471ee7 --- /dev/null +++ b/manuals/help/privacy/privacy-information-requests.md @@ -0,0 +1,109 @@ +--- +sidebar_position: 3 +id: privacy-information-requests +title: "Help4.x:Privacy: Information Requests" +--- +## Description + +This screen lists Privacy Information Requests received, selectable for +viewing. It can be used also to create new requests. + +**Tutorials** + +- [Privacy Outline - Content and + Workflow](https://docs.joomla.org/Help4.x:Components_Privacy_Outline/en "Help4.x:Components Privacy Outline/en") +- [The Privacy Tool + Suite](https://docs.joomla.org/J3.x:Privacy/en "J3.x:Privacy/en") + (Detailed Tutorial from Joomla 3) +- [Information Request + Workflow](https://docs.joomla.org/J3.x:Information_Request_Workflow_in_Privacy_Component/en "J3.x:Information Request Workflow in Privacy Component/en") + (Detailed Tutorial from Joomla 3) + +## How to access + +- Select **Users **→** Privacy **→** Requests** in the Administrator + menu. + +## Screenshot + + + +## Column Headers + +In the table containing the Privacy Information Requests from your +Joomla! site, you will see different columns. + +- **Actions.** + - For Export Requests: send automatically by email the export data or + download them + - For Removal Requests: click on the cross to remove the user. Their + data will be anonymised +- **Status.** + - **Invalid.** The information request has been invalidated by a Super + User + - **Pending.** The user hasn't yet confirmed their information request + - **Confirmed.** The user has confirmed their information request + - **Completed.** The information request has been completed by a Super + User +- **Email.** Email of the user who sent the information request +- **Request Type.** 2 types of information requests: asking for a Data + Export or to be removed +- **Requested.** When the information request has been sent +- **ID.** This is a unique identification number for the information + request assigned automatically by Joomla. It is used to identify the + item internally, and you cannot change this number. + +## List Filters + +Near the top of the page you will see the filter bar shown in the +Screenshot above. The functions are: + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). +- **Select Status**. Select the desired status (*Invalid*, *Pending*, + *Confirmed* or *Completed*) to limit the list based on the status of + the requests +- **Select Request Type**. Select the desired request type (*Remove* or + *Export*) to limit the list based on the request type + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new item. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- Click on the Email address to view the information request diff --git a/manuals/help/privacy/privacy-new-information-request.md b/manuals/help/privacy/privacy-new-information-request.md new file mode 100644 index 0000000..27f5c8e --- /dev/null +++ b/manuals/help/privacy/privacy-new-information-request.md @@ -0,0 +1,51 @@ +--- +sidebar_position: 4 +id: privacy-new-information-request +title: "Help4.x:Privacy: New Information Request" +--- +## Description + +In this screen you have the ability to create a new information request. + +## How to access + +- Select **Users **→** Privacy **→** Requests** from the Administrator + menu. Then... + - Select the **New** button in the Toolbar. + +## Screenshot + + + +## Form Fields + +- **Email.** Enter the email address of the individual owning the + information being requested +- **Request Status.** The status of the information request +- **Request Type.** (*Export*/*Remove*) The type of the information + request. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Cancel**. 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 + +- [The Privacy Tool + Suite](https://docs.joomla.org/J3.x:Privacy/en "J3.x:Privacy/en") diff --git a/manuals/help/privacy/privacy-options.md b/manuals/help/privacy/privacy-options.md new file mode 100644 index 0000000..7c5f336 --- /dev/null +++ b/manuals/help/privacy/privacy-options.md @@ -0,0 +1,64 @@ +--- +sidebar_position: 5 +id: privacy-options +title: "Help4.x:Privacy: Options" +--- +## Description + +Default options to set up the number of days (from 1 to 29 days) to +consider a request as urgent. It shows a notification in the Privacy +Dashboard screen when there are requests older than the specified number +of days. The default setting is 14 days. + +## How To Access + +- Select **Users **→** Privacy **→** Requests** from the Administrator + menu. Or... +- Select **Users **→** Privacy **→** Capabilities** from the + Administrator menu. Or... +- Select **Users **→** Privacy **→** Consents** from the Administrator + menu. Then... + - Select the **Options** button on the Toolbar. + +## Screenshot + + + +## Form Fields + +### Options Tab + +- **Days To Consider Request Urgent.** (*1 day to 29 days*). This allows + you to set up the number of days to consider a request as urgent. It + will show a notification on the Privacy Dashboard when there are + requests older than the specified number of days. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **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 + +- [The Privacy Tool + Suite](https://docs.joomla.org/J3.x:Privacy/en "J3.x:Privacy/en") +- diff --git a/manuals/help/privacy/privacy-review-information-request.md b/manuals/help/privacy/privacy-review-information-request.md new file mode 100644 index 0000000..2ff784b --- /dev/null +++ b/manuals/help/privacy/privacy-review-information-request.md @@ -0,0 +1,85 @@ +--- +sidebar_position: 6 +id: privacy-review-information-request +title: "Help4.x:Privacy: Review Information Request" +--- +## Description + +In this screen you have the ability to review an information request and +the related action log. + +**Tutorials** + +- [Privacy Outline - Content and + Workflow](https://docs.joomla.org/Help4.x:Components_Privacy_Outline/en "Help4.x:Components Privacy Outline/en") +- [The Privacy Tool + Suite](https://docs.joomla.org/J3.x:Privacy/en "J3.x:Privacy/en") + (Detailed Tutorial from Joomla 3) +- [Information Request + Workflow](https://docs.joomla.org/J3.x:Information_Request_Workflow_in_Privacy_Component/en "J3.x:Information Request Workflow in Privacy Component/en") + (Detailed Tutorial from Joomla 3) + +## How to access + +- Select **Users **→** Privacy **→** Requests** from the Administrator + menu. Then... + - Select the email address of the request you want to review to open + it. + +## Screenshot + + + +## Details + +- **Request Information.** + - *Email.* The email address of the individual owning the information + being requested + - *Status.* The status of the information request + - Invalid. The information request has been invalidated by a Super + User + - Pending. The user hasn't yet confirmed their information request + - Confirmed. The user has confirmed their information request + - Completed. The information request has been completed by a Super + User + - *Request Type.* Export or Remove + - *Date Requested.* Date and time when the information request has + been created +- **Action Log.** (*Action/Date/Name*) All actions performed related to + the individual owning the information being requested. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Complete.** Marks the request as Complete and removes Action buttons + from the item in the Requests list. +- **Invalidate.** Allows a Super user to mark an information request as + **Invalid**. *Note: This button is displayed only for information + requests with the status Pending* +- **Delete Data** For Remove requests only. Anonymises personal data in + compatible components. +- **Export Data.** For Export requests only. Downloads the data in XML + format for your inspections. +- **Email Export Data.** For Export requests only. Sends export data to + the data Subject in XML format. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Related Information + +- [The Privacy Tool + Suite](https://docs.joomla.org/J3.x:Privacy/en "J3.x:Privacy/en") diff --git a/manuals/help/privacy/private-messages.md b/manuals/help/privacy/private-messages.md new file mode 100644 index 0000000..12c61c3 --- /dev/null +++ b/manuals/help/privacy/private-messages.md @@ -0,0 +1,127 @@ +--- +sidebar_position: 8 +id: private-messages +title: "Help4.x:Private Messages" +--- +## Description + +The Private Messaging screen allows you to send messages to other +Back-end Joomla! users who have permission to send and receive messages. +You may read, write, send, and delete messages here. In addition, you +may also manage message settings and grouping options. + +## How to Access + +- Select **Users **→** Messaging **→** Private Messages** from the + Administrator menu. + +## Screenshot + + + +## Column Headers + +- **Checkbox.** The item selection checkbox. Check this box to select + one or more items. To select all items, check the box in the column + heading. After one or more boxes are checked, click a toolbar button + to take an action on the selected item or items. Many toolbar actions, + such as Mark As Read, Mark As Unread and Trash, can work with multiple + items. +- **Subject.** The subject line of the message. Click this to open the + message for viewing. This takes you to the [View + Message](https://docs.joomla.org/Help4.x:Private_Messages:_Read/en "Help4.x:Private Messages: Read/en") + screen where you view, reply to, or delete the message. +- **Read.** A green tick indicates that the message has been read. A red + donut indicates that it has not been read. +- **From.** The user who sent the message. +- **Date.** The date and time the message was sent. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +**Filter Options** + +- **Select State.** Use the drop-down list box to select: Read, Unread + or Trashed. Only messages with this state will show on the list. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new message. + + + +- **Actions:** Reveals a list of actions for selected Items. Check one + or more Item checkboxes to activate the list. + - **Mark As Read**. Marks the selected messages as Read. Select + messages by checking the message's checkbox. + - **Mark As Unread**. Marks the selected messages as Unread. Select + messages by checking the message's checkbox. +- +- **Trash**. Changes the status of the selected items to indicate that + they are trashed.Trashed items can still be recovered by selecting + 'Trashed' in the 'Select Status' filter and changing the status of the + articles to Published or Unpublished as preferred.To permanently + delete trashed items, select 'Trashed' in the 'Select Status' filter, + select the items to be permanently deleted, then click the 'Empty + Trash' toolbar icon. +- **My Settings**. Opens a new window that allows you to change + messaging settings. + + + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- Only users who are members of the "Super Users" and "Administrator" + groups have access to this screen, unless + User Group + permissions have been altered for this component via Options on the + toolbar. +- You are able to restore Messages previously sent to the Trash by + finding the Select State filter drop-down and selecting "Trash" from + the list. Finally, to restore the message, simply select the messages + you want to restore using the checkbox next to the particular message + you require and click the "Mark As Unread" button in the toolbar. + +## Related Information + +- Further information about writing messages: [Private messages - + Write](https://docs.joomla.org/Help4.x:Private_Messages:_Write/en "Help4.x:Private Messages: Write/en") +- Further information about reading messages: [Private messages - + Read](https://docs.joomla.org/Help4.x:Private_Messages:_Read/en "Help4.x:Private Messages: Read/en") diff --git a/manuals/help/private-messages/private-messages-read.md b/manuals/help/private-messages/private-messages-read.md new file mode 100644 index 0000000..eca34ce --- /dev/null +++ b/manuals/help/private-messages/private-messages-read.md @@ -0,0 +1,76 @@ +--- +sidebar_position: 1 +id: private-messages-read +title: "Help4.x:Private Messages: Read" +--- +## Description + +This screen allows you to view and reply to a single private message +only. + +## How to Access + +- Select **Users **→** Messaging **→** Private Messages** from the + Administrator menu. + + + +- Or select the icon in the title bar of the Administrator pages. + + + +- Next, click on a Message Subject link to open the **Private Messages: + View** screen. + +## Screenshot + + + +## Details + +- **From.** The sender of the message. +- **Posted.** The date and time the message was sent. +- **Subject.** The subject of the message. +- **Message.** The body of the message. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Reply**. Creates a new message as a reply to the current message. + + + +- **Cancel**. 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 + +- Only users who are members of the "Super Users" and "Administrator" + groups have access to this screen, unless + User Group + permissions have been altered for this component via Options at the + [Private Messages - + Inbox](https://docs.joomla.org/Help4.x:Private_Messages/en "Help4.x:Private Messages/en") + screen. + +## Related Information + +- Further information about Inbox messages: [Private Messages - + Inbox](https://docs.joomla.org/Help4.x:Private_Messages/en "Help4.x:Private Messages/en") +- Further information about writing messages: [Private Messages - + Write](https://docs.joomla.org/Help4.x:Private_Messages:_Write/en "Help4.x:Private Messages: Write/en") diff --git a/manuals/help/private-messages/private-messages-write.md b/manuals/help/private-messages/private-messages-write.md new file mode 100644 index 0000000..6b4144a --- /dev/null +++ b/manuals/help/private-messages/private-messages-write.md @@ -0,0 +1,61 @@ +--- +sidebar_position: 2 +id: private-messages-write +title: "Help4.x:Private Messages: Write" +--- +## Description + +This screen lets you write and send private messages to others with the +correct [User +Group](https://docs.joomla.org/Help4.x:Users:_Groups/en "Help4.x:Users: Groups/en") +permissions. + +## How to Access + +- Select **Users **→** Messaging **→** Private Messages **→** +** from + the Administrator menu. +- Select **Users **→** Messaging **→** Private Messages** and click the + "New" icon in the Private Messages screen. + +## Screenshot + + + +## Details + +- **Recipient.** The recipient of the message. Click on the "Select + User" button to open the pop-up, and then, from the list of names, + select the user to whom you wish to send the message. +- **Subject.** The subject of the message. Just like the subject of an + email, it helps if this is a short description of the message body. +- **Message.** The body text of the message. Just like the body text of + an email, it helps if the message is meaningful and kept relatively + short. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Send:** Sends the message. Note that the Recipient, Subject and + Message fields cannot be blank. + + + +- **Cancel**. 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 + +- Further information about Inbox messages: [Private messages - + Inbox](https://docs.joomla.org/Help4.x:Private_Messages/en "Help4.x:Private Messages/en") +- Further information about Reading messages: [Private messages - + Read](https://docs.joomla.org/Help4.x:Private_Messages:_Read/en "Help4.x:Private Messages: Read/en") diff --git a/manuals/help/redirect/redirect-options.md b/manuals/help/redirect/redirect-options.md new file mode 100644 index 0000000..10d0ec1 --- /dev/null +++ b/manuals/help/redirect/redirect-options.md @@ -0,0 +1,108 @@ +--- +sidebar_position: 1 +id: redirect-options +title: "Help4.x:Redirect: Options" +--- +## Description + +Redirect Options configuration allows setting of parameters used +globally for Redirects. + +## How to Access + +- Select **System **→** Redirects in the Manage Panel** from the + Administrator menu. Then... + - Select the **Options** button in the Toolbar. + +If you see this error message: + + + +Go to **System **→** Plugins** and enable the System Redirect plugin. +Then come back here. + +## Screenshot + + + +## Form Fields + +### Advanced Tab + +- **Activate Advanced Mode.** (Yes/No) Enable more advanced + functionality for the component. When enabled the Redirects Edit form + has a required **Redirect Status Code** field that allows you to + change the default value from 301 to 302 or 303. Only enable Advanced + Mode if you know how to use Redirect Status codes. +- **Bulk Import Separator.** The separator used for bulk import, by + default it is '\|' but it can be ',' for a copy/paste from a CSV file + for instance. +- **Import State.** (Enable/Disable) When batch importing redirects, + enable or disable by default. + +### Permissions Tab + + + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Optons**. Users can edit the options and + persimissions of this extension. + - **Configure Optons Only**. Users can edit the options exept the + persimissions of this extension. + - **Access Administration Interface**. Users can access user + administration interface of this extension. + - **Create:** Users can create content of this extension. + - **Delete:** Users can delete content of this extension. + - **Edit:** Users can edit content of this extension. + - **Edit State:** User can change the published state and related + information for content of this extension. + - **Edit Own:** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited:*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Save.** Saves the Redirects options and stays in the current screen. + + + +- **Save & Close**. Saves the Redirects options and closes the current + screen. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/redirect/redirects-links.md b/manuals/help/redirect/redirects-links.md new file mode 100644 index 0000000..f9da648 --- /dev/null +++ b/manuals/help/redirect/redirects-links.md @@ -0,0 +1,213 @@ +--- +sidebar_position: 2 +id: redirects-links +title: "Help4.x:Redirects: Links" +--- +## Description + +This component is used for redirecting URLs for web pages that no longer +exist on your website to web pages that are working. The URL you want to +redirect from must not be a working one on your website which actually +loads a web page. It can be the URL to a web page which you have +disabled. The *Expired URL* you specify when you create the redirect +should be the full URL as you would type it in your web browser. The +component will only display the last portion of the source URL in the +redirect listing. The *New URL* you specify when you create a redirect +must be the full URL as well. You must have the *Use URL Rewriting* +option enabled in your Joomla! installation *Global Configuration* +options in order for the redirects you create to function. + +## How to access + +- Select **System **→** Manage panel **→** Redirects** from the + Administrator menu. + +## Screenshot + + + +## Column Headers + +Click on the column heading to sort the list by that column's value. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Status**: Published status of the item. Possible values are: + - *Published*: The item is published. This is the only state that will + allow regular website users to view this item. + - *Unpublished*: The item is unpublished. + - *Archived*: The item has been archived. + - *Trashed*: The item has been sent to the Trash. +- **Expired URL.** The URL which is being redirected on your website. + Only the web page portion of the URL is displayed in this listing. +- **New URL.** The destination URL for the redirect. +- **Referring Page.** The referring web page for the redirect. + + + +- **Created Date**. Date the item(Article, Category, Weblink, etc.) was + created. + + + +- **404 Hits.** Number of 404 Hits there has been on this URL. + + + +- **Status Code.** The Status Code of the page. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +**Filter Options** + +- Status +- HTTP Status code + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Batch Processing + +Below the listing of redirects, is a section named 'Batch update new +URL(s)'. This function allows you to change the 'New URL' for the +selected redirects. + + + +- **New URL.** The destination URL to set for the selected redirects. +- **Comment.** The comment to set for the selected redirects. +- **Update Links.** Updates all selected redirects with the specified + *New URL* and *Comment*. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new item. + + + +- **Actions:** Reveals a list of actions for selected Items. Check one + or more Item checkboxes to activate the list. + + + +- **Enable**. Makes the selected item available for use on your website. + + + +- **Disable**. Makes the selected items unavailable for use on your + website. + + + +- **Archive**. Changes the status of the selected items to indicate that + they are archived. Archived items can be moved back to the published + or unpublished state by selecting 'Archived' in the 'Select Status' + filter and changing the status of the items. + + + +- **Trash**. Changes the status of the selected items to indicate that + they are trashed.Trashed items can still be recovered by selecting + 'Trashed' in the 'Select Status' filter and changing the status of the + articles to Published or Unpublished as preferred.To permanently + delete trashed items, select 'Trashed' in the 'Select Status' filter, + select the items to be permanently deleted, then click the 'Empty + Trash' toolbar icon. + + + +- **Empty Trash.** Select one or more Articles and click on this button + to permanently delete them. + + + +- **Bulk Import**. Bulk process to add new URLs. + + + +- **Purge Disabled**. Deletes all disabled links. URL's that are still + enabled will not be deleted. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Options + +Click the +[Options](https://docs.joomla.org/Help4.x:Redirect:_Options/en "Help4.x:Redirect: Options/en") +button screen to configure this component. + +## Quick Tips + +- In order for your redirects to work, you must enable the option **Use + URL Rewriting** in the **Global Configuration** options of your + Joomla! installation. Note also that just enabling the 'Use URL + Rewriting' option is not enough. You must take the additional step of + renaming the *htaccess.txt* file in the web site directory where you + installed Joomla! to *.htaccess* or to whatever file name your Apache + web server requires for additional configuration directives. In the + Apache configuration file this setting is named 'AccessFileName' and + by default this is set to '.htaccess'. diff --git a/manuals/help/redirect/redirects-new-or-edit.md b/manuals/help/redirect/redirects-new-or-edit.md new file mode 100644 index 0000000..7ab3e97 --- /dev/null +++ b/manuals/help/redirect/redirects-new-or-edit.md @@ -0,0 +1,131 @@ +--- +sidebar_position: 3 +id: redirects-new-or-edit +title: "Help4.x:Redirects: New or Edit" +--- +## Description + +This is where you can add a new redirect or edit an existing one. The +URL you want to redirect from must not be a working one on your website +which actually loads a web page. It can be the URL to a web page which +you have disabled in the Joomla! back-end administrator interface. The +Source URL you specify when you create the redirect should be the full +URL as you would type it in your web browser. The Destination URL you +specify when you create a redirect must be the full URL as well. + +## How to access + +- Select **System **→** Redirects** from the Administrator menu. Then... + - To create a new redirect click the **New** button in the Toolbar. + - To edit an existing redirect click its link in the **Expired URL** + column. + +## Screenshot + + + +## Form Fields + +**Edit/New Link \#1** + +- **Expired URL.** The URL to be redirected. + + + +- **New URL.** The URL to redirect to. + + + +- **Status**: Published status of the item. Possible values are: + - *Published*: The item is published. This is the only state that will + allow regular website users to view this item. + - *Unpublished*: The item is unpublished. + - *Archived*: The item has been archived. + - *Trashed*: The item has been sent to the Trash. + + + +- **Comment.** A comment that is only viewable in the administrator + back-end. It is primarily intended for administrator reference only. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + + + +- **Created Date**. Date the item(Article, Category, Weblink, etc.) was + created. + + + +- **Last Updated Date.** Shows the last date the item was modified. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Function + +### How to Create a Redirect + +1. First ensure that you have enabled the option *Use URL Rewriting* in + the Global Configuration options of your Joomla! installation. Note + that just enabling the *Use URL Rewriting* option is not enough. You + must also take the additional step of renaming the htaccess.txt file + in the web server directory where you installed Joomla! to .htaccess + or to whatever file name your Apache web server requires for + additional configuration directives. In the Apache configuration + file this setting is named 'AccessFileName' and by default this is + set to '.htaccess' +2. Next open the + Redirect: Links + screen and click the 'New' toolbar button. +3. In the screen that appears, enter the redirect information. When + entering URLs into the *Expired URL* and *New URL* fields, enter the + complete URL as you would type it into your web browser to view it. + The *Expired URL* should be a URL that does not resolve to any valid + web page on your website. You can specify a source URL for a Joomla! + web page that you have put into a disabled state in the + administrator back-end. Ensure the *State* option is set to + **Enabled**. +4. Press the **Save & Close** toolbar button to save your new redirect + and put it into effect. + +## Quick Tips + +- When entering URLs into the *Expired/Source URL* and *New/Destination + URL* fields, enter the complete URL as you would type it into your web + browser to view the web page. diff --git a/manuals/help/site-modules/site-modules-articles---archived.md b/manuals/help/site-modules/site-modules-articles---archived.md new file mode 100644 index 0000000..b68a627 --- /dev/null +++ b/manuals/help/site-modules/site-modules-articles---archived.md @@ -0,0 +1,222 @@ +--- +sidebar_position: 1 +id: site-modules-articles---archived +title: "Help4.x:Site Modules: Articles - Archived" +--- +## Description + +The **Articles - Archived** module type 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 generated automatically. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** Enter a name for this module. + +### Module Tab + +**Left Panel** Module type, location and description. + +- **\# of Months:** The number of months to display (the default is 10) + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **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**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +- **Delete:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Delete for + users in the group. Delete Allows users in the group to delete any + content in this extension. +- **Edit:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Edit for + users in the group. Edit Allows users in the group to edit any content + in this extension. +- **Edit State:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Edit + State for users in the group. Edit State Allows users in the group to + change the state of any content in this extension. +- **Frontend Editing:** (*Inherited*/*Allowed*/*Denied*). Allow or deny + Edit from the frontend of the site for users in the group. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + +*Example Front End Site images are generic images using Joomla! core +installation supplied free Front End Templates. The actual view can +depend on the installed custom template used and the template's style +for those views on a Joomla! website.* Archived Articles module shown: + + + +The Module Type name for this Module is "mod_articles_archive". It is +related to the content component. diff --git a/manuals/help/site-modules/site-modules-articles---categories.md b/manuals/help/site-modules/site-modules-articles---categories.md new file mode 100644 index 0000000..c74f19b --- /dev/null +++ b/manuals/help/site-modules/site-modules-articles---categories.md @@ -0,0 +1,246 @@ +--- +sidebar_position: 2 +id: site-modules-articles---categories +title: "Help4.x:Site Modules: Articles - Categories" +--- +## Description + +The **Articles - Categories** module type displays a list of categories +from one parent category. **Important:** If the parent category has no +sub-categories the module does not display. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title:** Module must have a title + +### Module Tab + +**Left Panel** + +- **Parent Category:** (*Sample + Data-Articles*/*Joomla!*/*Extensions*/*Components*/*Modules*/*Content + Modules*/*User Modules*/...). Choose 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. + +**Right Panel** + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + + + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + +*Example Front End Site images are generic images using Joomla! core +installation supplied free Front End Templates. The actual view can +depend on the installed custom template used and the template's style +for those views on a Joomla! website.* Articles Categories module shown: + + + +The Module Type name for this Module is "mod_articles_categories". It is +related to the content component. diff --git a/manuals/help/site-modules/site-modules-articles---category.md b/manuals/help/site-modules/site-modules-articles---category.md new file mode 100644 index 0000000..2cdfc81 --- /dev/null +++ b/manuals/help/site-modules/site-modules-articles---category.md @@ -0,0 +1,353 @@ +--- +sidebar_position: 3 +id: site-modules-articles---category +title: "Help4.x:Site Modules: Articles - Category" +--- +## Description + +The **Articles - Category** module type displays a list of published +articles from one or more categories. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Mode:** (*Normal*/*Dynamic*). Please select the mode you would like + to use. If Normal Mode is chosen, then simply configure the module and + it will display a static list of Articles on the menu items you assign + the module to. If Dynamic Mode is chosen, then you can still configure + the module normally, however now the Category option will no longer be + used. Instead, the module will dynamically detect whether or not you + are on a Category view and will display the list of articles within + that Category accordingly. When Dynamic Mode is chosen, it is best to + leave the module set to display on all pages, as it will decide + whether or not to display anything dynamically. +- **Show on Article Page:** (*Show*/*Hide*). Select to Show or Hide + Article List from Article Pages. This means that the module will only + display itself dynamically on Category Pages. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Filtering Options Tab + + + +- **Featured Articles:** (*Show*/*Hide*/*Only*). Select to Show, Hide, + or Only display Featured Articles. +- **Count:** The number of items to display. The default value of 0 will + display all articles. +- **Category Filtering Type:** (*Inclusive*/*Exclusive*). Select + Inclusive to Include the Selected Categories, Exclusive to Exclude the + Selected Categories. +- **Category:** Please select one or more categories. +- **Child Category Articles:** (*Include*/*Exclude*). Include or Exclude + Articles from Child Categories. +- **Category Depth:** The number of child category levels to return. +- **Author Filtering Type:** (*Inclusive*/*Exclusive*). Select Inclusive + to Include the Selected Authors, Exclusive to Exclude the Selected + Authors. +- **Authors:** Select one or more authors from the list below. +- **Author Alias Filtering Type:** (*Inclusive*/*Exclusive*). Select + Inclusive to Include the Selected Author Aliases, Exclusive to Exclude + the Selected Author Aliases. +- **Author Aliases:** Select one or more author aliases from the list + below. +- **Article IDs to Exclude:** Please enter each Article ID on a new + line. +- **Date Filtering:** (*Off*/*Date Range*/*Relative Date*). Select Date + Filtering Type. +- **Date Range Field:** (*Created Date*/*Modified Date*/*Start + Publishing Date*). Select which date field you want the date range to + be applied to. +- **Start Date Range:** If Date Range is selected above, please enter a + Starting Date. +- **To Date:** If Date Range is selected above, please enter an End + Date. +- **Relative Date:** If Relative Date is selected above, please enter in + a numeric day value. Results will be retrieved relative to the current + date and the value you enter. + +### Ordering Options Tab + + + +- **Article Field to Order By:** (*Article Manager Order*/*Featured + Articles Order*/*Hits*/*Title*/*ID*/*Alias*/*Created Date*/...). + Select which field you would like Articles to be ordered by. Featured + Ordering should only be used when Filtering Option for Featured + Articles is set to 'Only'. +- **Ordering Direction:** (*Descending*/*Ascending*). Select the + direction you would like Articles to be ordered by. + +### Grouping Options Tab + + + +- **Article Grouping:** (*None*/*Year*/*Month and + Year*/*Author*/*Category*). Select how you would like the articles to + be grouped. +- **Grouping Direction:** (*Descending*/*Ascending*). Select the + direction you would like the Article Groupings to be ordered by. +- **Month and Year Display Format:** Please enter in a valid date + format. See: + http://php.net/date for + formatting information. + +### Display Options Tab + + + +- **Linked Titles:** (*Yes*/*No*). +- **Date:** (*Show*/*Hide*). Select Show if you would like the date + displayed. +- **Date Field:** (*Created Date*/*Modified Date*/*Start Publishing + Date*). Select which date field you want to display. +- **Date Format:** Please enter in a valid date format. See: + http://php.net/date for + formatting information. +- **Category:** (*Show*/*Hide*). Select Show if you would like the + category name displayed. +- **Hits:** (*Show*/*Hide*). Select Show if you would like the hits for + each article to be displayed. +- **Author:** (*Show*/*Hide*). Select Show if you would like the author + (or author alias instead, if available) to be displayed. +- **Introtext:** (*Show*/*Hide*). Select Show if you would like the + introtext to be displayed. +- **Introtext Limit:** Please enter in a numeric character limit value. + The introtext will be trimmed to the number of characters you enter. +- **Show "Read More":** (*Show*/*Hide*). If set to Show, the Read + more... Link will show if Main text has been provided for the Article. +- **Show Title with Read More:** (*Show*/*Hide*). If set to show the + Title of the Article will be shown on the Read More button. +- **Read More Limit:** Set a limit of number of characters in Article + Title to show in Read More button. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Module Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + +*Example Front End Site images are generic images using Joomla! core +installation supplied free Front End Templates. The actual view can +depend on the installed custom template used and the template's style +for those views on a Joomla! website.* Articles Category module shown: + + + +The Module Type name for this Module is "mod_articles_category". It is +related to the content component. diff --git a/manuals/help/site-modules/site-modules-articles---latest.md b/manuals/help/site-modules/site-modules-articles---latest.md new file mode 100644 index 0000000..d7aa21a --- /dev/null +++ b/manuals/help/site-modules/site-modules-articles---latest.md @@ -0,0 +1,239 @@ +--- +sidebar_position: 4 +id: site-modules-articles---latest +title: "Help4.x:Site Modules: Articles - Latest" +--- +## Description + +The **Articles - Latest** module type shows a list of the most recently +published Articles. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Category:** Selects Articles from one or more Categories. If no + selection will show all categories as default. +- **Count:** The number of Articles to display (the default is 5). +- **Featured Articles:** (*Show*/*Hide*/*Only show Featured Articles*). + Show/Hide Articles designated as Featured. +- **Order:** (*Recently Added First*/*Recently Modified First*/*Recently + Published First*/*Recently Touched First*/*Random Articles*). Recently + Added First: order the articles using their creation dateRecently + Modified First: order the articles using their modification + dateRecently Published First: order the articles using their + publication date.Recently Touched First: order the articles using + their modification or creation dates. +- **Authors:** (*Anyone*/*Added or modified by me*/*Not added or + modified by me*). Filter by author. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Site View + +An example is shown below: + + + +The Module Type name for this is "mod_articles_latest". It is not +related to any other component. diff --git a/manuals/help/site-modules/site-modules-articles---most-read.md b/manuals/help/site-modules/site-modules-articles---most-read.md new file mode 100644 index 0000000..5b3b88c --- /dev/null +++ b/manuals/help/site-modules/site-modules-articles---most-read.md @@ -0,0 +1,230 @@ +--- +sidebar_position: 5 +id: site-modules-articles---most-read +title: "Help4.x:Site Modules: Articles - Most Read" +--- +## Description + +The **Articles - Most Read** module type shows a list of the currently +published Articles that have the highest number of page views. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Category:** Select Articles from a specific Category or a set of + Categories. If no selection will show all categories as default. +- **Count:** The number of Articles to display (the default is 5). +- **Featured Articles:** (*Show*/*Hide*). Show/Hide Articles designated + as Featured. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Front end View + +An example is shown below: + + + +The Module Type name for this is "mod_mostread". This Module is not +related to any other component. diff --git a/manuals/help/site-modules/site-modules-articles---newsflash.md b/manuals/help/site-modules/site-modules-articles---newsflash.md new file mode 100644 index 0000000..a619eb6 --- /dev/null +++ b/manuals/help/site-modules/site-modules-articles---newsflash.md @@ -0,0 +1,256 @@ +--- +sidebar_position: 6 +id: site-modules-articles---newsflash +title: "Help4.x:Site Modules: Articles - Newsflash" +--- +## Description + +The **Article Newsflash** module type will display a fixed number of +Articles from a specific Category or a set of Categories. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title:** Module must have a title + +### Module Tab + +**Left Panel** + +- **Category:** Select Articles from a specific Category or a set of + Categories. If no selection will show all categories as default. +- **Show Images:** (*Yes*/*No*). Display Article images. +- **Show Article title:** (*Yes*/*No*). Show/hide Article title. +- **Linked Titles:** (*Use Global*/*No*/*Yes*). Link the Article titles + to Articles. +- **Header Level:** (*h1*/*h2*/*h3*/*h4*/*h5*). Select the desired HTML + header level for the Article titles. +- **Show last separator:** (*Yes*/*No*). Show separator after last + Article. +- '**Read more...' Link:** (*Show*/*Hide*). If set to Show, the 'Read + more...' link will show if Main text has been provided for an Article. +- **Number of Articles:** The number of Articles to display within this + module. +- **Featured Articles:** (Show/Hide/Only show Featured Articles). + Show/Hide Articles designated as Featured. +- **Order Results:** (*Published Date*/*Created + Date*/*Ordering*/*Random*). Select the order in which you want query + results presented. +- **Direction:** (*Descending*/*Ascending*). The order the result will + be displayed. + +**Right Panel** + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + + + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permission Tabs + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Front End Screenshot + +*Example Front End Site images are generic images using Joomla! core +installation supplied free Front End Templates. The actual view can +depend on the installed custom template used and the template's style +for those views on a Joomla! website.* + +Articles Newsflash module shown: + + + +The Module Type name for this Module is "mod_articles_newsflash". It is +related to the content component. diff --git a/manuals/help/site-modules/site-modules-articles---related.md b/manuals/help/site-modules/site-modules-articles---related.md new file mode 100644 index 0000000..9513ca3 --- /dev/null +++ b/manuals/help/site-modules/site-modules-articles---related.md @@ -0,0 +1,244 @@ +--- +sidebar_position: 7 +id: site-modules-articles---related +title: "Help4.x:Site Modules: Articles - Related" +--- +## Description + +The **Articles - Related** module type 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 +[Articles: New or +Edit](https://docs.joomla.org/Help4.x:Articles:_Edit/en#Publishing_Tab "Help4.x:Articles: Edit/en") +screen. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +This Module displays other Articles that are related to the one +currently being viewed. These relations are established by the Meta +Keywords. All the keywords of the current Article are searched against +all the keywords of all other published... + +- **Date:** (*Show*/*Hide*). Show/Hide Date +- **Maximum articles:** The maximum number of related articles to + display (default is 5) + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Description Tab + +- **Explanatory Text.** This module displays other Articles that are + related to the one being viewed. These relations are established by + the Keywords. All the keywords of the current Article are searched + against all the keywords of all other published Articles. For example, + you may have an Article on "Breeding Parrots" and another on "Hand + Raising Black Cockatoos". If you include the keyword "parrot" in both + Articles, then the Related Items Module will list the "Breeding + Parrots" Article when viewing "Hand Raising Black Cockatoos" and + vice-versa. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +No tips have been added at the time. diff --git a/manuals/help/site-modules/site-modules-banners.md b/manuals/help/site-modules/site-modules-banners.md new file mode 100644 index 0000000..d080af8 --- /dev/null +++ b/manuals/help/site-modules/site-modules-banners.md @@ -0,0 +1,227 @@ +--- +sidebar_position: 8 +id: site-modules-banners +title: "Help4.x:Site Modules: Banners" +--- +## Description + +The **Banners** module type displays the active Banners from the +Component. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Target:** (*Open in parent window*/*Open in new window*/*Open in + popup*). Target window when the link is clicked. +- **Count:** (*1*/*2*/*3*/*4*/*5*/*6*/*7*/...). The number of banners to + display (default 5). +- **Client:** (*No client*/*Bookstore*/*Joomla!*/*Shop*). Select banners + only from a single client. +- **Category:** Select banners from a specific Category or a set of + Categories. If no selection then it will show all categories as + default. +- **Search by Meta Keyword:** (*Yes*/*No*). Banner is selected by + matching the banner tags to the current document meta keywords. +- **Randomise:** (*Sticky, Ordering*/*Sticky, Randomise*). Randomise the + ordering of the banners. +- **Header Text:** Text or HTML to display before the group of banners. +- **Footer Text:** Text or HTML to display after the group of banners. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/site-modules/site-modules-breadcrumbs.md b/manuals/help/site-modules/site-modules-breadcrumbs.md new file mode 100644 index 0000000..a2251ae --- /dev/null +++ b/manuals/help/site-modules/site-modules-breadcrumbs.md @@ -0,0 +1,221 @@ +--- +sidebar_position: 9 +id: site-modules-breadcrumbs +title: "Help4.x:Site Modules: Breadcrumbs" +--- +## Description + +The **Breadcrumbs** module type shows a set of navigation links that +illustrate location in the site and allow back navigation. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **You are here.** (*Show*/*Hide*). Show or hide "You are here" text in + the Pathway. +- **Show Home.** (*Show*/*Hide*). Show or hide the Home element in the + Pathway. +- **Text for Home Entry** This text will be shown as Home entry. If the + field is left empty, it will use the default value from the + mod_breadcrumbs.ini language file. +- **Show Last.** (*Show*/*Hide*). Show or hide the last element in the + Pathway. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/site-modules/site-modules-custom.md b/manuals/help/site-modules/site-modules-custom.md new file mode 100644 index 0000000..be4ad34 --- /dev/null +++ b/manuals/help/site-modules/site-modules-custom.md @@ -0,0 +1,244 @@ +--- +sidebar_position: 10 +id: site-modules-custom +title: "Help4.x:Site Modules: Custom" +--- +## Description + +The **Custom** module type allows you to create a self-contained HTML +unit and then put it in any valid location on a page. + +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. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Editor.** The 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. Another possibility is (if the + editor has this option) to switch to the HTML mode, enter the code, + save and switch back to normal view. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Options Tab + +- **Prepare Content.** (*Yes*/*No*). Optionally prepare the content with + the Joomla Content Plug-ins. +- **Select a Background-Image.** If you select an image here it will be + inserted automatically as an inline style for the wrapping div element + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Front End View + +An example of a Custom HTML message is shown below. + + + +In this example the custom module would be *Unpublished* after the +software update. diff --git a/manuals/help/site-modules/site-modules-feed-display.md b/manuals/help/site-modules/site-modules-feed-display.md new file mode 100644 index 0000000..b29da02 --- /dev/null +++ b/manuals/help/site-modules/site-modules-feed-display.md @@ -0,0 +1,238 @@ +--- +sidebar_position: 11 +id: site-modules-feed-display +title: "Help4.x:Site Modules: Feed Display" +--- +## Description + +The **Feed Display** module type shows an RSS News Feed from a website. +This Module is not related to the News Feeds Component or the News Feeds +Layouts and is an alternative that allows a feed to display in a Module +position. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Feed URL:** Enter the URL of the RSS/RDF/ATOM feed. +- **RTL Feed:** (*Yes*/*No*). Display feed in RTL direction. +- **Feed Title:** (*Show*/*Hide*). Display news feed title. +- **Feed Description:** (*Show*/*Hide*). Show the description text for + the entire feed. +- **Feed Image:** (*Show*/*Hide*). Show the image associated with the + entire feed. +- **Feed Items:** Enter number of RSS items to display. +- **Item Description:** (*Show*/*Hide*). Show the description or intro + text of individual RSS items. +- **Word Count:** Allows you to limit the amount of visible Item + description text. 0 will show all the text + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Front End View + +An example is shown below: + + + +The Module Type name for this Module is "mod_feed". diff --git a/manuals/help/site-modules/site-modules-footer.md b/manuals/help/site-modules/site-modules-footer.md new file mode 100644 index 0000000..954c3ba --- /dev/null +++ b/manuals/help/site-modules/site-modules-footer.md @@ -0,0 +1,228 @@ +--- +sidebar_position: 12 +id: site-modules-footer +title: "Help4.x:Site Modules: Footer" +--- +## Description + +The **Footer** module type typically displays the web site copyright and +Joomla! license information. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Footer.** Site indicator and text: *This module shows the Joomla! + copyright information*. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Front End View + +Shown in the example below: + + + +The Module Type name for this Module is "mod_footer". It is not related +to any other component. **Note**: the last line is from the template +(index.php), not from the Footer Module. diff --git a/manuals/help/site-modules/site-modules-language-switcher.md b/manuals/help/site-modules/site-modules-language-switcher.md new file mode 100644 index 0000000..97f5aab --- /dev/null +++ b/manuals/help/site-modules/site-modules-language-switcher.md @@ -0,0 +1,235 @@ +--- +sidebar_position: 13 +id: site-modules-language-switcher +title: "Help4.x:Site Modules: Language Switcher" +--- +## Description + +The **Language Switcher** module type allows you to switch between +available Content languages. Selecting a language will take you to the +home page for that language. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Pre-text:** This is the text or HTML that is displayed above the + language switcher. +- **Post-text:** This is the text or HTML that is displayed below the + language switcher. +- **Use Dropdown:** (*Yes*/*No*). If set to 'Yes', the display + parameters below will be ignored. The content languages native names + will display in a dropdown. +- **Use Image Flags:** (*Yes*/*No*). If set to 'Yes', will display + language choice as image flags. Otherwise will use the content + language native names. +- **Horizontal Display:** (*Yes*/*No*). Default is set to 'Yes', i.e. to + horizontal display. +- **Active Language:** (*Yes*/*No*). Display or not the active language. + If displayed, the class 'lang-active' will be added to the element. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Site View + + diff --git a/manuals/help/site-modules/site-modules-latest-users.md b/manuals/help/site-modules/site-modules-latest-users.md new file mode 100644 index 0000000..77dbb77 --- /dev/null +++ b/manuals/help/site-modules/site-modules-latest-users.md @@ -0,0 +1,217 @@ +--- +sidebar_position: 14 +id: site-modules-latest-users +title: "Help4.x:Site Modules: Latest Users" +--- +## Description + +The **Latest Users** module type displays the latest users to register +with the website. It displays the username so access is likely to be +restricted to Super Users. The module should not be confused with Who's +Online, which is more suitable for Public display. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Number of Users:** Number of latest registered users to display. +- **Filter groups:** (*Yes*/*No*). Choose to filter by groups of the + connected user, + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/site-modules/site-modules-login.md b/manuals/help/site-modules/site-modules-login.md new file mode 100644 index 0000000..b35fd62 --- /dev/null +++ b/manuals/help/site-modules/site-modules-login.md @@ -0,0 +1,242 @@ +--- +sidebar_position: 15 +id: site-modules-login +title: "Help4.x:Site Modules: Login" +--- +## Description + +The **Login** module type displays a username and password Login form. +It also displays a link to retrieve a forgotten password. If User +registration is enabled in the User Settings of the Global Configuration +screen, then the link "Create an Account" will be shown to invite Users +to self-register. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Pre-text:** This is the text or HTML that is displayed above the + login form. +- **Post-text:** This is the text or HTML that is displayed below the + login form. +- **Login Redirection Page:** (*Default*/*Getting Started*/*Using + Joomla!*/*Using Extensions*/*Components*/*Content Component*/...). + Select the page the user will be redirected to after a successful + login. Select from all the pages listed in the dropdown menu. Choosing + "Default" will return to the same page. +- **Logout Redirection Page:** (*Default*/*Getting Started*/*Using + Joomla!*/*Using Extensions*/*Components*/*Content Component*/...). + Select the page the user will be redirected to after successfully + ending their current session by logging out. Select from all the pages + listed in the dropdown menu. Choosing "Default" will return to the + same page. +- **Show Greeting:** (*Show*/*Hide*). Show/Hide the simple greeting + text. +- **Show Name/Username:** (*Name*/*User Name*). Displays name or + username after logging. +- **Profile link:** (*Show*/*Hide*). Show or hide a link to the profile + of the User. +- **Display Labels:** Choose text or icons to display the fields labels. + Default is icons. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **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 + +No tips have been added at this time. diff --git a/manuals/help/site-modules/site-modules-menu.md b/manuals/help/site-modules/site-modules-menu.md new file mode 100644 index 0000000..55ab8bd --- /dev/null +++ b/manuals/help/site-modules/site-modules-menu.md @@ -0,0 +1,236 @@ +--- +sidebar_position: 16 +id: site-modules-menu +title: "Help4.x:Site Modules: Menu" +--- +## Description + +This **Menu** module type allows you to place a Menu at the desired +position and on the desired web pages. A web site may have more than one +menu on a single page and different menus on different web pages. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Select Menu:** (*About Joomla*/*Australian Parks*/*Fruit Shop*/*Main + Menu*/*Top*/*User Menu*). Select a menu in the list. +- **Base Item:** (*Current*/*Getting Started*/*Using Joomla!*/*Using + Extensions*/*Components*/*Content Component*/...). Select a menu item + to always be used as the base for the menu display. You must set the + Start Level to the same level or higher than the level of the base + item. This will cause the module to be displayed on all assigned + pages. If Current is selected the currently active item is used as the + base. This causes the module to only display when the parent menu item + is active. +- **Start Level:** (*1*/*2*/*3*/*4*/*5*/*6*/*7*/...). Level to start + rendering the menu at. Setting the start and end levels to the same \# + and setting 'Show Sub-menu Items' to yes will only display that single + level. +- **End Level:** (*All*/*1*/*2*/*3*/*4*/*5*/*6*/...). Level to stop + rendering the menu at. If you choose 'All', all levels will be shown + depending on 'Show Sub-menu Items' setting. +- **Show Sub-menu Items:** (*Show*/*Hide*). Expand the menu and make its + sub-menu items always visible. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **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 + +No tips have been added at this time. diff --git a/manuals/help/site-modules/site-modules-random-image.md b/manuals/help/site-modules/site-modules-random-image.md new file mode 100644 index 0000000..765dc05 --- /dev/null +++ b/manuals/help/site-modules/site-modules-random-image.md @@ -0,0 +1,227 @@ +--- +sidebar_position: 17 +id: site-modules-random-image +title: "Help4.x:Site Modules: Random Image" +--- +## Description + +The **Random Image** module type displays a random image from a +directory. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Image Type:** Type of image PNG\|GIF\|JPG etc. (the default is JPG). +- **Image Folder:** Path to the image folder relative to the site URL + (e.g. images). +- **Link:** A URL to redirect to if the image is clicked upon (e.g. + http://www.joomla.org). +- **Width (px):** Image Width forces all images to be displayed with + this width in pixels. +- **Height (px):** Image Height forces all images to be displayed with + the height in pixels. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +No tips have been added for the Random Image module. diff --git a/manuals/help/site-modules/site-modules-smart-search.md b/manuals/help/site-modules/site-modules-smart-search.md new file mode 100644 index 0000000..95ee5d9 --- /dev/null +++ b/manuals/help/site-modules/site-modules-smart-search.md @@ -0,0 +1,230 @@ +--- +sidebar_position: 18 +id: site-modules-smart-search +title: "Help4.x:Site Modules: Smart Search" +--- +## Description + +The **Smart Search** module type is an enhanced site search form. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Search Filter:** (*No Filter*). Selecting a Search Filter will limit + any searches submitted through this module to use the selected filter. +- **Search Suggestions:** (*Show*/*Hide*). Toggle whether automatic + search suggestions should be displayed. +- **Advanced Search:** (*Link to Component*/*Show*/*Hide*). Toggle + whether users should be able to see advanced search options. If set to + Link to Component option creates an Smart Search link which redirects + to the smart search view. If set to show, the advanced search options + will be displayed inline. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +## Frontend View + +An example site search form is shown below: + + diff --git a/manuals/help/site-modules/site-modules-statistics.md b/manuals/help/site-modules/site-modules-statistics.md new file mode 100644 index 0000000..06b2494 --- /dev/null +++ b/manuals/help/site-modules/site-modules-statistics.md @@ -0,0 +1,233 @@ +--- +sidebar_position: 19 +id: site-modules-statistics +title: "Help4.x:Site Modules: Statistics" +--- +## Description + +The **Statistics Module** type shows information about your server +installation together with statistics on the Web site users, number of +Articles in your database and the number of Web links you provide. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Server Information:** (*Show*/*Hide*). Display Server Information. +- **Site Information:** (*Show*/*Hide*). Display Site Information. +- **Hit Counter:** (*Show*/*Hide*). Display Hit Counter. +- **Increase Counter:** Enter the amount of hits to increase the counter + by. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **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 + +Just because you *could* display your server information, doesn't mean +you should, or that it's a good idea! + +## Frontend View + +An example Statistics module is shown below: + + diff --git a/manuals/help/site-modules/site-modules-syndication-feeds.md b/manuals/help/site-modules/site-modules-syndication-feeds.md new file mode 100644 index 0000000..c80e37e --- /dev/null +++ b/manuals/help/site-modules/site-modules-syndication-feeds.md @@ -0,0 +1,237 @@ +--- +sidebar_position: 20 +id: site-modules-syndication-feeds +title: "Help4.x:Site Modules: Syndication Feeds" +--- +## Description + +The Smart **Syndication Feeds** module type creates a Syndicated Feed +for the page where the Module is displayed. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Label:** If 'Display Label' is activated, the text entered here will + be displayed next to the icon along with the RSS Link. If this field + is left empty, the default text displayed will be picked from the site + language ini file. +- **Display Label:** (*Yes*/*No*). If set to 'Yes', Label will be + displayed next to the icon. +- **Feed Format:** (*RSS 2.0*/*Atom 1.0*). Select the format for the + Syndication Feed. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **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 + +Not all menu items types actually provide for an RSS feed. This will be +displayed on types of Category Blog and on Featured Articles menu types +(probably others). On pages for which no feed is available this module +will not display. + +## Frontend View + +An example Syndication module is shown below: + + diff --git a/manuals/help/site-modules/site-modules-tags---popular.md b/manuals/help/site-modules/site-modules-tags---popular.md new file mode 100644 index 0000000..ed89d25 --- /dev/null +++ b/manuals/help/site-modules/site-modules-tags---popular.md @@ -0,0 +1,242 @@ +--- +sidebar_position: 21 +id: site-modules-tags---popular +title: "Help4.x:Site Modules: Tags - Popular" +--- +## Description + +The **Tags - Popular** module type displays tags used on the site in a +list or a cloud layout. Tags can be ordered by title or by the number of +tagged items and limited to a specific time period. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Parent Tag.** Limit tags shown to the children of this Parent Tag. +- **Maximum tags.** (*1*/*2*/*3*/*4*/*5*/*6*/*7*/...). Sets the maximum + number of tags to display in the module. +- **Time Period.** (*All time*/*Last hour*/*Last day*/*Last week*/*Last + month*/*Last year*). Sets the time period for which to calculate + popularity. +- **Order.** (*Title*/*Number of Items*/*Random*). The order that tags + will show in. +- **Direction.** (*Ascending*/*Descending*). Sort order. Descending is + highest to lowest. Ascending is lowest to highest. +- **Display number of items.** (*Yes*/*No*). Choose if the number of + tagged items should be displayed next to each tag. +- **Show "No results" text.** (*Yes*/*No*). Will show a message if no + matching tags are found instead of hiding the module. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Cloud Layout Tab + + + +- **Minimum font size:** The minimum font size used for the tags, + proportional to the site's default font size (e.g. "2" means 200% of + the default size). +- **Maximum font size:** The maximum font size used for the tags, + proportional to the site's default font size (e.g. "2" means 200% of + the default size). + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/site-modules/site-modules-tags---similar.md b/manuals/help/site-modules/site-modules-tags---similar.md new file mode 100644 index 0000000..bb88aec --- /dev/null +++ b/manuals/help/site-modules/site-modules-tags---similar.md @@ -0,0 +1,219 @@ +--- +sidebar_position: 22 +id: site-modules-tags---similar +title: "Help4.x:Site Modules: Tags - Similar" +--- +## Description + +The **Tags - Similar** module type displays links to other items with +similar tags. The closeness of the match can be specified. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Maximum items:** (*1*/*2*/*3*/*4*/*5*/*6*/*7*/...). Maximum number + of items to display. +- **Match type:** (*All*/*Any*/*Half*). How closely an item's tags need + to match. All - requires that all tags in the displayed item be + matched. Any - requires that at least one tag match. Half - requires + that at least half of the tags match (rounded up in the case of + decimals). + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/site-modules/site-modules-who%27s-online.md b/manuals/help/site-modules/site-modules-who%27s-online.md new file mode 100644 index 0000000..748db20 --- /dev/null +++ b/manuals/help/site-modules/site-modules-who%27s-online.md @@ -0,0 +1,224 @@ +--- +sidebar_position: 23 +id: site-modules-who%27s-online +title: "Help4.x:Site Modules: Who's Online" +--- +## Description + +The **Who's Online** module type displays the number of Anonymous and +Registered Users who are currently accessing the Web site. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **Display:** (*\# of Guests / Users*/*User names*/*Both*). Select what + shall be shown. +- **Filter Groups.** (Yes/No) Choose to filter by groups of the + connected user. + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **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 + +- Most people prefer not to use the "Who's Online" module when they have + few visitors. +- If you set the cache time for this module too long, the number of + visitors shown will be incorrect as the module takes users into + account that visited your site x minutes ago. diff --git a/manuals/help/site-modules/site-modules-wrapper.md b/manuals/help/site-modules/site-modules-wrapper.md new file mode 100644 index 0000000..359f180 --- /dev/null +++ b/manuals/help/site-modules/site-modules-wrapper.md @@ -0,0 +1,235 @@ +--- +sidebar_position: 24 +id: site-modules-wrapper +title: "Help4.x:Site Modules: Wrapper" +--- +## Description + +The **Wrapper** module type allows you to display an external website in +a module. The functionality is the same to that of the 'iFrame Wrapper' +you can add as a menu item. If the page to which the wrapper is linked +is too big, bars will be shown below and to the right of the wrapper, +allowing you to "navigate" the page. + +## How to Access + +- Select **System **→** Manage Panel **→** Site Modules** from the + Administrator menu. Then... + - To create a new module: select the **New** button from the Toolbar. + Then... + - Select the required module type. + - To edit an existing module: + - Find the module in the list of installed modules and select the + title link in the **Title** column. + +## Screenshot + + + +## Form Fields + +- **Title.** The title of the module. This is also the title displayed + for the module depending on the *Show Title* Form Field + +### Module Tab + +**Left Panel** + +- **URL:** URL to site/file you wish to display within the iframe. +- **Auto Add:** (*Yes*/*No*). By default, http:// will be added unless + it detects http:// or https:// in the URL you provide. This allows you + to switch this ability off. +- **Scroll Bars:** (*Auto*/*No*/*Yes*). Show/Hide Horizontal & Vertical + Scroll Bars. +- **Width:** Width of the iFrame window. You can enter an absolute + figure in pixels or a relative figure by adding a %. +- **Height:** Height of the iFrame window. +- **Auto Height:** (*Yes*/*No*). The height will automatically be set to + the size of the external page. This will only work for pages on your + own domain. +- **Frame border:** (*Yes*/*No*). Show frame border which wraps the + iframe. +- **Target Name:** Name of the iFrame when used as Target + +**Right Panel** + +- **Show Title.** (Show/Hide) Choose whether to show or hide the modules + title in the front end. The title will be the one in the Form Field + above. + + + +- **Position.** Choose the [module + position](https://docs.joomla.org/Module_Position/en "Module Position/en") + you wish this module to be displayed in. A custom module position can + be entered for use with the [load position + plugin](https://docs.joomla.org/How_do_you_put_a_module_inside_an_article%3F/en "How do you put a module inside an article?/en") + or the position button can be pressed to select a module position from + the template. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Module Ordering.** This shows a drop down 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 front end as well as + in the + [Modules](https://docs.joomla.org/Help4.x:Modules/en "Help4.x:Modules/en") + page. + + + +- **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). + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + +### Menu Assignment Tab + + + +- **Module Assignment.** Select **On All Pages**, **No Pages**, **Only + on the pages selected** or **On all pages except those selected** from + the List. + + + +- **Menu Selection.** If the latter two options are selected a list will + show all of the menu items. This allows you to assign modules to some + but not all pages, and by selecting the menu links that you want the + module associated with you can customize on what pages modules + appear/don't appear. See [How do you assign a module to specific + pages?](https://docs.joomla.org/How_do_you_assign_a_module_to_specific_pages%3F/en "How do you assign a module to specific pages?/en") + for more information. + +### Advanced Tab + + + +- **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. +- **Module Class.** 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 "user.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. A setting of "Use Global" will use the Cache + Settings from the Global Configuration screen. +- **Cache Time.** The number of seconds for which to cache the item + locally. It can safely be left at the default. +- **Module Style.** You can use this option to override the templates + style for its position. +- **Module Tag.** The HTML tag for the module to be placed in. By + default this is a div tag but other HTML5 elements can also be used. +- **Bootstrap Size.** (Values 0 to 12) This allows you to choose the + width of the module via the span element built into bootstrap. +- **Header Tag.** The HTML tag to use for the modules header or title. + This can be an h1, h2, h3, h4, h5, h6 or a p tag. Note that you must + use a module style (chrome) of html5 or add your custom module styles + in \/html/modules.php. +- **Header Class.** Here you can add optional CSS classes to add to the + modules header or title element. + +### Permissions Tab + + + +To change the permissions, do the following. + +- Select the **Group** by clicking its title located on right. +- Find the desired **Action**. Possible Actions are: + - **Delete**. Users can delete the module. + - **Edit**. Users can edit the module. + - **Edit State**. User can change the published state and related + information for the module. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration, Article Manager Options, or Category permissions. + - ***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. +- Select **Save** in the **Toolbar**. When the screen refreshes, the + Calculated Setting column will show the effective permission for this + Group and Action. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **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 + +No tips have been added for the Wrapper module. The module type is +**mod_wrapper**. diff --git a/manuals/help/site/site-control-panel.md b/manuals/help/site/site-control-panel.md new file mode 100644 index 0000000..8b480cc --- /dev/null +++ b/manuals/help/site/site-control-panel.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 1 +id: site-control-panel +title: "Help4.x:Site Control Panel" +--- +Redirect to: + +- [Help4.x:Home + Dashboard](https://docs.joomla.org/Help4.x:Home_Dashboard "Help4.x:Home Dashboard") diff --git a/manuals/help/site/site-global-configuration-logging.md b/manuals/help/site/site-global-configuration-logging.md new file mode 100644 index 0000000..2cf6fca --- /dev/null +++ b/manuals/help/site/site-global-configuration-logging.md @@ -0,0 +1,17 @@ +--- +sidebar_position: 3 +id: site-global-configuration-logging +title: "Help4.x:Site Global Configuration Logging" +--- + **←**  [Global +Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#logging "Help4.x:Site Global Configuration/en") + + + + **←**  [Global +Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#logging "Help4.x:Site Global Configuration/en") diff --git a/manuals/help/site/site-global-configuration-permissions.md b/manuals/help/site/site-global-configuration-permissions.md new file mode 100644 index 0000000..c5eae83 --- /dev/null +++ b/manuals/help/site/site-global-configuration-permissions.md @@ -0,0 +1,24 @@ +--- +sidebar_position: 4 +id: site-global-configuration-permissions +title: "Help4.x:Site Global Configuration Permissions" +--- + **←**  [Global +Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#permissions "Help4.x:Site Global Configuration/en") + + + + + + **←**  [Global +Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#permissions "Help4.x:Site Global Configuration/en") diff --git a/manuals/help/site/site-global-configuration-server.md b/manuals/help/site/site-global-configuration-server.md new file mode 100644 index 0000000..1dc912d --- /dev/null +++ b/manuals/help/site/site-global-configuration-server.md @@ -0,0 +1,52 @@ +--- +sidebar_position: 5 +id: site-global-configuration-server +title: "Help4.x:Site Global Configuration Server" +--- + **←**  [Global +Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#server "Help4.x:Site Global Configuration/en") + + + + + + + + + + + + + + **←**  [Global +Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#server "Help4.x:Site Global Configuration/en") diff --git a/manuals/help/site/site-global-configuration-site.md b/manuals/help/site/site-global-configuration-site.md new file mode 100644 index 0000000..80228a6 --- /dev/null +++ b/manuals/help/site/site-global-configuration-site.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 6 +id: site-global-configuration-site +title: "Help4.x:Site Global Configuration Site" +--- + **←**  [Global +Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#site "Help4.x:Site Global Configuration/en") + + + + + + + + + + **←**  [Global +Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#site "Help4.x:Site Global Configuration/en") diff --git a/manuals/help/site/site-global-configuration-system.md b/manuals/help/site/site-global-configuration-system.md new file mode 100644 index 0000000..5c97828 --- /dev/null +++ b/manuals/help/site/site-global-configuration-system.md @@ -0,0 +1,31 @@ +--- +sidebar_position: 7 +id: site-global-configuration-system +title: "Help4.x:Site Global Configuration System" +--- + **←**  [Global +Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#system "Help4.x:Site Global Configuration/en") + + + + + + + + **←**  [Global +Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#system "Help4.x:Site Global Configuration/en") diff --git a/manuals/help/site/site-global-configuration-text-filters.md b/manuals/help/site/site-global-configuration-text-filters.md new file mode 100644 index 0000000..bafc59d --- /dev/null +++ b/manuals/help/site/site-global-configuration-text-filters.md @@ -0,0 +1,17 @@ +--- +sidebar_position: 8 +id: site-global-configuration-text-filters +title: "Help4.x:Site Global Configuration Text Filters" +--- + **←**  [Global +Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#textfilters "Help4.x:Site Global Configuration/en") + + + + **←**  [Global +Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#textfilters "Help4.x:Site Global Configuration/en") diff --git a/manuals/help/site/site-global-configuration.md b/manuals/help/site/site-global-configuration.md new file mode 100644 index 0000000..198928b --- /dev/null +++ b/manuals/help/site/site-global-configuration.md @@ -0,0 +1,440 @@ +--- +sidebar_position: 2 +id: site-global-configuration +title: "Help4.x:Site Global Configuration" +--- +## Description + +The Global Configuration screen allows you to configure the Joomla site +with your personal settings. Settings made in this screen apply to the +whole site. + +## How to access + +- **System **→** Setup Panel **→** Global Configuration** + +## Screenshot + + + +## Form Fields + +### Site + +[Complete +screenshot.](https://docs.joomla.org/Help4.x:Site_Global_Configuration_Site/en "Help4.x:Site Global Configuration Site/en") + +#### Site + +- **Site Name**. Enter the name of the website. This will be used in + various locations (for example the Backend browser title bar and Site + Offline pages). +- **Site Offline**. Select whether access to the Frontend is available. + [Learn + more.](https://docs.joomla.org/J3.x:Taking_the_website_temporarily_offline/en "J3.x:Taking the website temporarily offline/en") + - **Offline Message**. + - Use Custom Message: The message uses the value defined in the + 'Custom Message' field. + - Use Site Language Default Message: The message uses the value + defined in the site language ini file. + - **Offline Image**. Select an image to be displayed on the offline + page. Make sure the image is less than 400px wide. +- **Frontend Editing**. Select editing for modules and menu items. +- **Default Editor**. Select the default text editor. Registered Users + will be able to change their preference in their personal details. +- **Default Captcha**. Select the default captcha for your site. You may + need to enter required information in the [captcha + plugin](https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_CAPTCHA_Group/en "Chunk4x:Extensions Plugin Manager Edit CAPTCHA Group/en"). +- **Default Access Level**. Select the default access level for new + items. +- **Default List Limit**. Sets the default length of lists in the + Backend for all users. +- **Default Feed Limit**. Select the number of content items to show in + the feeds. +- **Feed Email Address**. The RSS and Atom newsfeeds include the + author's email address. + - Author Email: Use each author's email from + [Users](https://docs.joomla.org/Help4.x:Users/en "Help4.x:Users/en") + in the news feed. + - Site Email: Include the site [From Email](#fromemail) address for + each article. + +#### Metadata + +- **Site Meta Description**. Enter a description of the overall website + that is to be used by search engines. +- **Robots**. Robots instructions. + - index, follow: Index this page and follow the links on this page. + - noindex, follow: Do not index this page, but still follow the links + on the page. For example, you might do this for a site map page + where you want the links to be indexed but you don't want this page + to show in search engines. + - index, nofollow: Index this page, but do not follow any links on the + page. For example, you might want to do this for an events calendar, + where you want the page to show in search engines but you do not + want to index each event. + - noindex, nofollow: Do not index this page or follow any links on the + page. +- **Content Rights**. Describe what rights others have to use this + content. This is conveyed to search engines using the 'rights' meta + tag in the HTML head. +- **Author Meta Tag**. Show the author meta tag when viewing articles. +- **Joomla Version**. Controls whether the 'generator' meta tag in the + HTML document's header in the Frontend and in Atom feeds includes the + exact version of the Joomla site. It is recommended to hide it for + security reasons. + +#### SEO + +- **Search Engine Friendly URLs**. Select if the URLs are optimised for + Search Engines. +- **Use URL Rewriting**. + - Apache and Litespeed: Rename 'htaccess.txt' to '.htaccess' + Learn more. + - IIS: Rename 'web.config.txt' to 'web.config' + - NginX: you must [configure your + server](https://docs.joomla.org/Nginx/en "Nginx/en") + - Other servers or if unsure: please consult your hosting company +- **Add Suffix to URL**. If yes, the system will add a suffix to the URL + based on the document type. +- **Unicode Aliases**. Choose between transliteration and unicode + aliases. Transliteration is the default. +- **Site Name in Page Titles**. Begin or end all Page Titles with the + site name (for example, "My Site Name - My Article Name"). + +#### Cookie + +- **Cookie Domain**. Domain to use when setting session cookies. Precede + domain with '.' if cookie should be valid for all subdomains. +- **Cookie Path**. Path the cookie should be valid for. + +### System + +[Complete +screenshot.](https://docs.joomla.org/Help4.x:Site_Global_Configuration_System/en "Help4.x:Site Global Configuration System/en") + +#### Debug + +- **Debug System**. If enabled, diagnostic information, language + translation, and SQL errors (if present) will be displayed. The + information will be displayed at the foot of every page you view + within the Joomla Backend and Frontend. It is not advisable to leave + the debug mode activated when running a live website. +- **Debug Language**. Select if the debugging indicators \*\*...\*\* + or ??...?? for the Joomla Language files will be displayed. Debug + Language will work without Debug System being activated, but you will + not get the additional detailed references that will help you correct + any errors. + - **Language Display**. Select if you should display the language + constant or the language value when debugging the language strings. + +#### Cache + +- **System Cache**. Enable caching and set caching level. [Learn + more.](https://docs.joomla.org/Cache/en "Cache/en") + - Conservative level: smaller system cache. + - Progressive level: faster, bigger system cache, includes module + renderers cache. Not appropriate for extremely large sites. + - **Cache Handler**. + - File: Native caching mechanism is file-based. Please make sure the + cache folders are writable. + - **Platform Specific Caching**. Enable when HTML output on mobile + differs from other devices. + - **Cache Time (minutes)**. The maximum length of time in minutes for + a cache file to be stored before it is refreshed. + - **Path to Cache Folder**. Specify a writable folder to store cache + files if you do not wish to use the default folder. + +#### Session + +- **Session Handler**. The mechanism by which Joomla identifies a User + once they are connected to the website using non-persistent cookies. + - Database: The database session handler is the default handler + because it is the only one that Joomla can fully configure and + control on its own. + - Filesystem: The filesystem handler will be slightly more performant + than the database handler, but it requires PHP to be configured + properly otherwise it will crash and Joomla will be totally + unusable. + - **Session Save Path**. Enter a full filesystem path. Ensure the + path has appropriate permissions for PHP to read and write files, + and if 'session garbage collection' is enabled to delete files + from it.If this path is not set, Joomla will rely on the PHP + session.save_path INI configuration or fallback to the system + temporary directory (as defined by the sys_get_temp_dir() PHP + function).If neither of those paths are configured or the + permissions are wrong then it's game over. To recover, edit the + configuration.php file and set \$session_handler = 'database'. + - Other handlers (APCu, Memcached, Redis, and WinCache) all rely on + optional PHP extensions and may be available if your system supports + them. APCu or WinCache may be no better than the "plain" filesystem + option. The Memcached and Redis handlers are overkill for Joomla in + a typical shared hosting environment. Those types of handlers + succeed if you are deploying Joomla in a load balanced environment + where multiple servers are involved and you need the session data + for the application to be available across all servers. +- **Session Lifetime (minutes)**. Auto log out a User after they have + been inactive for the entered number of minutes. Do not set too high. +- **Shared Sessions**. When enabled, a user's session is shared between + the Frontend and Backend sections of the site. Note that changing this + value will invalidate all existing sessions on the site.This is not + available when the [Force HTTPS](#forcehttps) option is set to + 'Administrator Only'. +- **Track Session Metadata**. + - Yes: Additional metadata about a user's session (including their + username, user ID, and which application they are logged into) will + be logged to the session database table. + - No: Features dependent on this data will be unavailable. + +### Server + +[Complete +screenshot.](https://docs.joomla.org/Help4.x:Site_Global_Configuration_Server/en "Help4.x:Site Global Configuration Server/en") + +#### Server + +- **Path to Temp Folder**. Please specify a writable folder to store + temporary files. +- **Gzip Page Compression**. + - Yes: Automatically compress the generated HTML pages with Gzip, + making them smaller and increasing your site's speed score. + - No: If your server is already doing that for you or if it conflicts + with third party extensions. +- **Error Reporting**. This parameter sets the level of error reporting + to be used by PHP on the Joomla site. + - System Default: Leaves the level of error reporting to that set up + in the server. + - None: Switches off error reporting. + - Simple: Override the server setting to give a basic level of + reporting. + - Maximum: Override the server setting to reporting of all + errors.Should your Joomla site fail to the extent that it is not + possible to use the administrator page to activate error reporting, + you can switch on full error reporting by editing the + 'configuration.php' file. Changing the '\$error_reporting' parameter + in that file to a value of 'maximum' is the equivalent to setting + Error Reporting to 'Maximum'. +- **Force HTTPS**. Force site access in the selected areas to occur only + with HTTPS (encrypted HTTP connections with the https:// protocol + prefix) and also force the use of secure cookies. Note, you must have + HTTPS enabled on your server to utilise this option. + +#### Location + +- **Website Time Zone**. Choose a city in the list to configure the date + and time for display. + +#### Web Services + +- **Enable CORS**. Cross-Origin Resource Sharing + (CORS) enables scripts running + in a browser to interact with resources from a different origin. + - **Access-Control-Allow-Origin**. Specifies the origin allowed to + access Web services on this site, sent back in response to a + preflight request. Default: \* (=all). + - **Access-Control-Allow-Headers**. Specifies the header(s) sent back + in response to a preflight request. Default: + Content-Type,X-Joomla-Token. + - **Access-Control-Allow-Methods**. Specifies the Web service + method(s) allowed to access on this site, sent back in response to a + preflight request. Default: all methods available for the requested + route. + +#### Proxy + +- **Behind Load Balancer**. If your site is behind a load balancer or + reverse proxy, enable this setting so that IP addresses and other + configurations within Joomla automatically take this into account. +- **Enable Outbound Proxy**. Some hosts do not allow any network access + from your site to the outside world by default and require you to + manually configure an outbound proxy. + - **Outbound Proxy Host**. Host (domain) name or IP address. + - **Outbound Proxy Port**. + - **Outbound Proxy Username**. Leave blank if your outbound proxy does + not require authentication. + - **Outbound Proxy Password**. + +#### Database + +- **Database Type**. The type of database in use, selected during the + installation process.Do not edit this field unless absolutely + necessary (for example the transfer of the database to a new hosting + provider). +- **Host**. The hostname for your database entered during the + installation process.Do not edit this field unless absolutely + necessary (for example the transfer of the database to a new hosting + provider). +- **Database Username**. The username for access to your database + entered during the installation process.Do not edit this field unless + absolutely necessary (for example the transfer of the database to a + new hosting provider). +- **Database Password**. The password to be used to access the + database.Do not edit this field unless absolutely necessary (for + example the transfer of the database to a new hosting provider). +- **Database Name**. The name for your database entered during the + installation process.Do not edit this field unless absolutely + necessary (for example the transfer of the database to a new hosting + provider). +- **Database Tables Prefix**. The prefix used for your database tables, + created during the installation process.Do not edit this field unless + absolutely necessary (for example the transfer of the database to a + new hosting provider). +- **Connection Encryption**. + - Default (server controlled) + - One-way authentication + - **Verify Server Certificate**. + - **Path to CA File**. File system path. + - Two-way authentication + - **Path to Private Key File**. File system location. + - **Path to Certificate File**. File system location. + - **Verify Server Certificate**. + - **Path to CA File**. File system path. + - **Supported Cipher Suite (optional)**. No entry required (only + recommended for experienced users) – for more details, see the + documentation of your database. + +#### Mail + +- **Send Mail**. + - Yes: Turn on mail sending. + - No: Turn off mail sending. It is recommended to put the site offline + when disabling the mail function. +- **Disable Mass Mail**. + - Yes: Disable the Mass Mail Users function. + - No: Make the Mass Mail Users function active. +- **From Email**. The email address that will be used to send site + email. +- **From Name**. Text displayed in the header "From:" field when sending + a site email. Usually the site name. +- **Reply To Email**. The email address that will be used to receive end + user(s) reply. +- **Reply To Name**. Text displayed in the header "To:" field when end + user(s) replying to received email. +- **Mailer**. Select which mailer for the delivery of site email. + +### Logging + +[Complete +screenshot.](https://docs.joomla.org/Help4.x:Site_Global_Configuration_Logging/en "Help4.x:Site Global Configuration Logging/en") + +#### Logging + +- **Path to Log Folder**. Joomla can optionally keep a log file of its + own and third party extensions' operations. Provide the absolute path + to a folder that is writeable by PHP; if it's missing or is not + writeable Joomla will not load at all. For security reasons you must + not use a folder with system–wide access such as '/tmp'. +- **Log Almost Everything**. Logs everything, except deprecated APIs. +- **Log Deprecated API**. Logs deprecated APIs. + +#### Custom logging + +- **Log Priorities**. Can be used to manage custom logging. Select the + events you want to see in the log file. Default is 'All'. The item(s) + can be selected/deselected by clicking the dropdown list. +- **Log Categories**. A comma separated list of log categories to + include or exclude. Common log categories include but are not limited + to: 'database', 'databasequery', 'database-error', 'deprecated' and + 'jerror'. If empty, custom logging is disabled. +- **Log Category Mode**. Sets the mode for the list of log categories + above. + +### Text Filters + +[Complete +screenshot.](https://docs.joomla.org/Help4.x:Site_Global_Configuration_Text_Filters/en "Help4.x:Site Global Configuration Text Filters/en") + +These text filter settings will be applied to all text editor fields +submitted by users in the selected groups. + +These filtering options give more control over the HTML your content +providers submit. You can be as strict or as liberal as you require to +suit your site's needs. The filtering is opt-in and the default settings +provide good protection against markup commonly associated with website +attacks. + +### Permissions + +[Complete +screenshot.](https://docs.joomla.org/Help4.x:Site_Global_Configuration_Permissions/en "Help4.x:Site Global Configuration Permissions/en") + +Manage the permission settings for user groups. + +- **Site Login**. Site Login for users in the selected group. +- **Administrator Login**. Administrator Login for users in the selected + group. +- **Web Services Login**. Web Services Login for users in the selected + group. +- **Offline Access**. Allows users in the selected group to access to + the Frontend site when site is offline. +- **Super User**. Allows users in the selected selected group to perform + any action over the whole site regardless of any other permission + settings. +- **Configure Options Only**. Allows users in the group to edit the + options except the permissions of any extension. +- **Access Administration Interface**. Allows users in the selected + group to access all of the administration interface except Global + Configuration. +- **Create**. Allows users in the selected group to create any content + in any extension. +- **Delete**. Allows users in the selected group to delete any content + in any extension. +- **Edit**. Allows users in the selected group to edit any content in + any extension. +- **Edit State**. Allows users in the selected group to edit the state + of any content in any extension. +- **Edit Own**. Allows users in the selected group to edit any content + they own in any extension. +- **Edit Custom Field Value**. Allows users in the selected group to + edit any value of custom fields submitted in any extension. + +If you change the setting, it will apply to this and all child groups, +components and content. + +- Note that **Denied** will overrule any inherited setting and also the + setting in any child group, component or content. In the case of a + setting conflict, **Deny** will take precedence. +- **Not Set** is equivalent to **Denied** but can be changed in child + groups, components and content. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **Save**. Saves the global configuration options and stays in the + current screen. +- **Save & Close**. Saves the global configuration options and closes + the current screen. +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. +- **Toggle Inline Help**. Show help text below some options. +- **Help**. Opens this help screen. + +## Quick Tips + +- Most of these settings can be set once and then left alone. +- If major modifications need to be made, then consider taking the site + offline to test it and to make sure everything is in working order. +- The settings are saved in '\[Joomla\]/configuration.php'. You have to + either activate the FTP-layer or make the 'configuration.php' file + writable to save your changes. + +## Related Information + +- [Backup + Basics](https://docs.joomla.org/Backup_Basics_for_a_Joomla!_Web_Site/en "Backup Basics for a Joomla! Web Site/en") +- [Security + Checklist](https://docs.joomla.org/Security_Checklist/en "Security Checklist/en") +- Joomla 3.x diff --git a/manuals/help/site/site-system-information.md b/manuals/help/site/site-system-information.md new file mode 100644 index 0000000..2f45646 --- /dev/null +++ b/manuals/help/site/site-system-information.md @@ -0,0 +1,193 @@ +--- +sidebar_position: 10 +id: site-system-information +title: "Help4.x:Site System Information" +--- +## Description + +This page provides information about your host server environment, +including operating system, database and PHP settings, and directory +information. There are five different tab panels: System Information, +PHP Settings, Configuration File, Folder Permissions, and PHP +Information. Each screen provides detailed information about that aspect +of your Joomla! website. This information is very helpful when you are +troubleshooting setup problems. + +- Note that none of these settings can be changed from these screens. + This must be done in different locations throughout your Joomla! + installation, depending on the specific setting. +- Many settings in the Configuration File screen can be changed from the + [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en "Help4.x:Site Global Configuration/en") + screen. Some settings shown here depend on your host server + configuration and cannot be changed from inside Joomla!. + +## How to access + +- Select **System **→** Information Panel **→** System Information** + from the Administrator menu. + +## Screenshot + + + +## Details + +- System Information +- PHP Settings +- Configuration File +- Folder Permissions +- PHP Information. + +### System Information Tab + +This screen shows information about the operating environment for your +Joomla! site. + +- **PHP Built on:** Provides details of the principle operating system + which the webserver that Joomla is running on. +- **Database Type:** Provides the type of the database being used by the + installation of Joomla. +- **Database Version:** Provides the current version of the MySQL + database being used by the installation of Joomla. +- **Database Collation:** How the MySQL database is structured for the + information used by Joomla!. +- **Database Connection Collation:** The character set and collation of + the database. +- **PHP Version:** Provides the current version of PHP server side + script that is being used for this installation of Joomla. +- **Web Server:** Provides the current type and version of webserver + which the installation of Joomla! is running on. +- **Web Server to PHP Interface:** The script that permits interaction + between the web server (in most cases, Apache) and the PHP scripting + language. +- **Joomla! Version:** Provides the current version of Joomla!. It is + recommended that it is always up-to-date and using the current stable + release. +- **User Agent:**The summary of the current user's local machine's + operating system and browser information which is used to create an + unique session ID for access and functionality within the Joomla! + website. + +### PHP Settings Tab + +Help-4x-system-php-settings-en.png + +This screen shows the relevant PHP Settings information. If any of these +is highlighted as incorrect should be taken care of to rectify the +situation. + +- **Safe Mode:** Recommended setting: OFF +- **Open basedir:** Recommended setting: Site dependent +- **Display Errors:** Recommended setting: OFF +- **Short Open Tags:** Recommended setting: ON +- **File Uploads:** Recommended setting: ON +- **Magic Quotes:** Recommended setting: OFF +- **Register Globals:** Recommended setting: OFF +- **Output Buffering:** Recommended setting: OFF +- **Session Save Path:** Recommended setting: Site dependent +- **Session Auto Start:** Recommended setting: 0 +- **XML Enabled:** Recommended setting: YES +- **Zlib Enabled:** Recommended setting: YES +- **Native ZIP Enabled:** Recommended setting: YES +- **Disabled Functions:** Recommended setting: Site dependent +- **Multibyte String (mbstring) Enabled:** Recommended setting: YES +- **Iconv Available:** Recommended setting: YES +- **Maximum Input Variables:** Recommended setting: 2500 + +### Configuration File Tab + + + +This screen shows the contents of the current Joomla! +*configuration.php* file which is stored under the main **\/joomla_root/** directory. This file is created for you +automatically when you first install Joomla! and where most changes of +the Global Configuration section of Joomla! are recorded. Please note +that none of the settings can be changed from this page. Use [Global +Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en "Help4.x:Site Global Configuration/en") +to see more information about these settings and to make changes. + +### Folder Permissions Tab + + + +This screen shows a list of the directories that the webserver should +have write access to. Please note that all directories listed on this +page should say **Writable**. If not, you may need to change the +permissions to be able to install and use Joomla! successfully. + +### PHP Information Tab + +Help-4x-system-php-information-en.png + +This screen displays the full configuration of the PHP server side +scripting language that Joomla! runs on, together with all the +associated system information that goes towards the creation of the web +server. It is the output of an integrated php.info script built into +Joomla!. + +PHP is installed, and runs on the server (hence the server side above), +and therefore all the settings are made on the server. The visitor to +the web site does not need to have anything special running on their +local machine in order to view or use any of the extra functionality +that PHP gives to the web site. + +All the settings that are ever likely to be needed are displayed here. +Any changes that are required would be made within the *php.ini* and +other configuration files on the web server. + +How much control a web site owner has over this information depends on +whether they own the server or if the server host is flexible in their +customer approach. + +It is a good practice to know the limitations of a particular server +installation. This screens output is used to find detailed information +about how PHP is implemented on the server. + +For full details on the information contained within the PHP Info screen +visit: +http://php.net/phpinfo. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Download as text.** Downloads the System Information in a text file. +- **Download as JSON.** Downloads the System Information in a JSON file. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- If you are having problems installing extensions, uploading files, or + changing configuration options, check the Directory Permissions screen + to make sure you have permission to write to files on your web server. + The "Status" of the directories should be "Writable". If not, you may + be unable to upload or edit files in these directories. +- When you are seeking help with setup problems, for example in a + Joomla! web forum, it is very helpful to post specific information + about your Joomla! installation. This screen is an easy way to find + all of this information in one place. diff --git a/manuals/help/smart-search/smart-search-content-maps.md b/manuals/help/smart-search/smart-search-content-maps.md new file mode 100644 index 0000000..862ef70 --- /dev/null +++ b/manuals/help/smart-search/smart-search-content-maps.md @@ -0,0 +1,194 @@ +--- +sidebar_position: 1 +id: smart-search-content-maps +title: "Help4.x:Smart Search: Content Maps" +--- +## Description + +This screen shows the content maps currently in the Smart Search index. +Content maps allow you to cross-reference your indexed content +(articles, etc) to related meta information such as the category in +which it resides. Each content item that is indexed by Smart Search is +added to one or more content maps that can be used as filters when +searching the index. + +Content maps are split into two parts: + +- Map Group: These are super-containers for a particular type of + information. For example, a Map Group could be "Type", "Category", + "Event", "Language" or "Author". +- Content Map: Content maps are the actual values for the meta + information in a particular Map Group. The Content Maps are, for + example, the names of the categories or authors. + +These Map Groups and Content Maps are what make up the advanced search +panel available on the front-end. For each Map Group there can be a +drop-down select list and the Content Maps are added as values to the +respective list. More advanced site builders can override the default +layouts and use multi-select lists or checkboxes instead. + +It's important to note that Map Groups and Content Maps from different +content types are merged into the one list. A Joomla article in a +category called "News" and a news feed or contact in a category named +the same are mapped to the same Content Map in the same Map Group. This +is a little like tagging different types of content with the same label. +The effect is that your site visitor does not have to know how your +content is classified in order to set the correct filters to find it. + +The content maps screen shows all the Map Groups within the Smart Search +index together with a number indicating the number of Content Maps +within that Map Group and the items within a Contrent Map. Clicking on a +Map Groups number allows you to see the Content Map within that Map +Group together with the number of content items that belong to that +Content Map. A content item can belong to multiple Content Maps within a +Map Group as well as to multiple Map Groups. + +## How to access + +- Select **Components **→** Smart Search **→** Content Maps** from the + Administrator menu. + +## Screenshot + + + +## Column Headers + +In the table containing the indexed content for your Joomla! site you +will see different columns. Here you can read what they mean and what is +displayed in each column. + + + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Status**. The status of the content item within Smart Search. + Published items are shown with a green tick; unpublished items by a + red circle. You can change the status of an item by clicking on the + icon. Changing the status on this screen only affects whether the + content item is available in search results and does not affect the + content item itself. +- **Title**. The title of the Map Group or Content Map. +- **Maps**. The number of maps inside the Map Group. Selecting the + number wil show the maps inside the Map Group. +- **Published Indexed Content**. The number of published content items + in the Map Group. Selecting the number will show the published content + items inside the Map Group. +- **Unpublished Indexed Content**. The number of unpublished content + items in the Map Group. Selecting the number will show the unpublished + content items inside the Map Group. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +**Filter Options** + +- **Filter by published status.** Choose whether to show only published + or unpublished maps by selecting the appropriate item from the + drop-down list. The published state of the maps in Smart Search is + independent of their published state elsewhere. +- **Filter by Map Group**. Select the Map Group from the drop-down list. + - Authors + - Categories + - Languages + - Types +- **Filter by Max Levels (Category Level).** Lets you show only items + whose category is at or above the specified level in the category + hierarchy. + - ***- Select Max Levels -:*** Show all items regardless of level of + their assigned category. + - ***1:*** Only show items whose category is at the top level in the + category hierarchy (in other words, with categories whose parent + category is "- No Parent -".) + - ***2-10:*** Only show items whose category is in the top 2-10 levels + in the category hierarchy. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Actions:** Reveals a list of actions for selected Items. Check one + or more Item checkboxes to activate the list. + + + +- **Publish**. Makes the selected Map Groups or Content Maps available + to visitors to your website. + + + +- **Unpublish.** Makes the selected Map Groups or Content Maps + unavailable to visitors to your website. An unpublished Map Group will + not be displayed as a select list in the front-end. An unpublished + Content Map will not appear in the select list for the Map Group in + which it occurs. Re-indexing does not change the published state of + Map Groups or Content Maps. + + + +- **Statistics:** Shows some basic statistics on Smart Search. + + + +- **Delete:** Deletes the selected Map Groups or Content Maps. Works + with one or multiple Map Groups or Content Maps selected. You can + recover deleted Map Groups or Content Maps by running the Smart Search + indexer again. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. See [Smart Search: + Options](https://docs.joomla.org/Help4.x:Smart_Search:_Options/en "Help4.x:Smart Search: Options/en") + for further details. + +## Quick Tips + +- Smart Search was introduced in Joomla 3.0 but is not enabled by + default in that version. +- If you are new to Smart Search then you should read the [Smart Search + Quickstart + Guide](https://docs.joomla.org/Smart_Search_quickstart_guide "Smart Search quickstart guide"). + +## Related information diff --git a/manuals/help/smart-search/smart-search-indexed-content.md b/manuals/help/smart-search/smart-search-indexed-content.md new file mode 100644 index 0000000..738f2ac --- /dev/null +++ b/manuals/help/smart-search/smart-search-indexed-content.md @@ -0,0 +1,183 @@ +--- +sidebar_position: 2 +id: smart-search-indexed-content +title: "Help4.x:Smart Search: Indexed Content" +--- +## Description + +This screen shows a list of all the content items that have been indexed +in Smart Search. If the list is empty then + +- Make sure that the Smart Search plug-in has been enabled. + - To check if the Smart Search plug-in has been enabled: + - Select **System** from the Administrator menu and then **Plugins** + from the Manage panel. + - Select "content" from the Filter Options **-Select Type-** list. + - Find "Smart Search" in the list of plug-ins shown. + - If there is a green tick in the Status column for Smart Search + then the Smart Search plug-in has been enabled. If there is red + cross then the Smart Search plug-in is currently disabled. + - To enable the Smart Search plug-in: + - Click on the red cross. This should change to a green tick + indicating that the Smart Search plug-in is now enabled. + +## How to access + +- Select **Components **→** Smart Search **→** Index** from the + Administrator menu. + +## Screenshot + + + +## Create an Index + +Click on the Index toolbar icon. This will open a window to show the +progress of the indexing operation. The indexing operation may take some +time depending on the number of content items on your site and the +number of search words and phrases contained in each content item. A +progress bar will indicate how much of the indexing process has been +completed so far. Do not close this window until indexing has been +completed. On sites with a large amount of content this may take a long +time (tens of minutes). + +## Column Headers + +In the table containing the indexed content for your Joomla! site you +will see different columns. Here you can read what they mean and what is +displayed in each column. + + + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Status**. The status of the content item within Smart Search. + Published items are shown with a green tick; unpublished items by a + red circle. You can change the status of an item by clicking on the + icon. Changing the status on this screen only affects whether the + content item is available in search results and does not affect the + content item itself. +- **Title**. The title of the content item. +- **Type**. The type of the content item. +- **Last Updated**. The date on which the content item was last + re-indexed. Any change to the indexable fields of a content item will + automatically cause that content item to be re-indexed. +- **Details**. The details of the content item (Published Start, + Published End, Content Start, Content End). +- **Raw URL**. The raw (non-SEF) URL that will be used to retrieve the + content item in search results. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +**Filter Options** + +- **Filter by published status**. Choose whether to show only published + or unpublished content items by selecting the appropriate item from + the drop-down list. The published state of the items in Smart Search + is independent of their published state elsewhere. +- **Filter by type of content**. Select the content item type from the + drop-down list. + + + +- **Search Content Maps**. Optional, used to search in content map + title. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Index**. Runs the Smart Search indexer. A small popup window will + appear with a progress bar which advances as the indexing process + works through the content on your site. Do not close this popup window + until the process is finished. On sites with a large amount of content + this may take a long time (tens of minutes). You should run the + indexer after new content has been introduced to your website that the + Smart Search function is not automatically aware of. For example, + batch importing new content where the importer does not automatically + trigger Smart Search to index each new content item. NOTE: The Smart + Search indexer can also be run from the command-line interface (CLI) + if required. See [Setting up automatic Smart Search + indexing](https://docs.joomla.org/Setting_up_automatic_Smart_Search_indexing "Setting up automatic Smart Search indexing"). +- **Publish**. Makes the selected items available to visitors to your + website. +- **Unpublish.** Makes the selected items unavailable to visitors to + your website. + + + +- **Statistics:** Shows some basic statistics on Smart Search. + + + +- **Delete:** Deletes the selected content items. Works with one or + multiple content items selected. Deleting a content item from Smart + Search only deletes it from the index and does not affect the content + item itself. +- **Clear Index**. Purges the Smart Search index by emptying all index + tables. To continue using Smart Search you must click on the Index + toolbar icon after purging. WARNING: Purging the index also empties + the content filters. You must manually re-enter the content filter + settings after a Purge-Index cycle. +- **Help**. Opens this help screen. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. See [Smart Search: + Options](https://docs.joomla.org/Help4.x:Smart_Search:_Options/en "Help4.x:Smart Search: Options/en") + for further details. + +## Quick Tips + +- Smart Search was introduced in Joomla 3.0 but is not enabled by + default in that version. +- If you are new to Smart Search then you should read the [Smart Search + quickstart + guide](https://docs.joomla.org/Smart_Search_quickstart_guide "Smart Search quickstart guide"). +- If you run the indexer and get an "undefined null" error, then check + the permissions on the Joomla `/logs` directory. The web server needs + to have write permission to that directory for the indexer to work. + +## Related information + +- [Setting up automatic Smart Search + indexing](https://docs.joomla.org/Setting_up_automatic_Smart_Search_indexing "Setting up automatic Smart Search indexing") diff --git a/manuals/help/smart-search/smart-search-new-or-edit-filter.md b/manuals/help/smart-search/smart-search-new-or-edit-filter.md new file mode 100644 index 0000000..7ee5b13 --- /dev/null +++ b/manuals/help/smart-search/smart-search-new-or-edit-filter.md @@ -0,0 +1,119 @@ +--- +sidebar_position: 3 +id: smart-search-new-or-edit-filter +title: "Help4.x:Smart Search: New or Edit Filter" +--- +## Description + +This screen allows you to create a new search filter or amend an +existing one. + +## How to access + +- Select **Components **→** Smart Search **→** Filters** from the + Administrator menu. Then... + - Select the **New** Toolbar button to create a new filter. + - Select a title link in the **Title** column to edit an existing + filter. + +## Screenshot + + + +## Form Fields + +- **Title**. The Title for this item. This may or may not display on the + page, depending on the parameter values you choose. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +## Edit Filter Tab + +- **Map Count.** The number of maps included in the filter. + + + +- **Toggle Selection.** The Toggle Selection button will change all the + selections in the opposite way. So selected will change into + unselected and unselected will change into selected. +- **Expand all.** The Expand all button will open all the maps and show + the items inside. + +## Options Tab + + + +**Publishing panel** + +- **Created Date**. Date the item(Article, Category, Weblink, etc.) was + created. +- **Created By**. Name of the Joomla! User who created this item. This + will default to the currently logged-in user. If you want to change + this to a different user, click the Select User button to select a + different user. +- **Alias.** This optional field allows you to enter an alias for the + Author of the filter. +- **Modified Date:** *(Informative only)* Date of last modification. +- **Modified By:** *(Informative only)* Username who performed the last + modification. + +**Filter Timeline panel** + +- **When (Start Date).** When to search relative to the start date + (before, after or exactly). +- **Start Date.** Format YYYY-MM-DD. +- **When (End Date).** When to search relative to the end date (before, + after or exactly). +- **End Date.** Format YYYY-MM-DD. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- Smart Search was introduced in Joomla 3.0 but is not enabled by + default in that version. +- If you are new to Smart Search then you should read the [Smart Search + quickstart + guide](https://docs.joomla.org/Smart_Search_quickstart_guide "Smart Search quickstart guide"). diff --git a/manuals/help/smart-search/smart-search-options.md b/manuals/help/smart-search/smart-search-options.md new file mode 100644 index 0000000..ed0e300 --- /dev/null +++ b/manuals/help/smart-search/smart-search-options.md @@ -0,0 +1,186 @@ +--- +sidebar_position: 4 +id: smart-search-options +title: "Help4.x:Smart Search: Options" +--- +## Description + +Smart Search Options configuration allows setting of parameters used +globally for Smart Search. + +## How to Access + +- Select **Components **→** Smart Search **→** Index** from the + Administrator menu. Then... + - Select the Options button from the Toolbar. + +## Screenshot + + + +## Form Fields + +### Smart Search Tab + +- **Result Taxonomy.** (Yes/No) ... +- **Result Description.** (Show/Hide) Toggle if the description should + be displayed with search results. + + + +- **Description Length**. Number of characters of the description in + search results. Enter \ in field, default is 255. +- **Result Date.** (Show/Hide) Show the start and end date filters in + the advanced search. +- **Result URL.** (Show/Hide) Show the result item's URL in search + results. The URL is located under the description. +- **Gather Search Statistics.** (Yes/No) Record the search phrases + submitted by visitors. + + + +- **Allow Empty Search**. Only if a filter is selected. Allows an empty + search string to initiate a search with the filter constraints. +- **Search Suggestions.** (Show/Hide) Toggle if automatic search + suggestions should be displayed. + + + +- **Did You Mean**. Whether to suggest alternative search terms when a + search produces no result. + + + +- **Query Explanation**. Show or hide a detailed explanation of the + search requested. +- **Advanced Search.** (Show/Hide) Toggle if users should be able to see + advanced search options. +- **Advanced Tips.** (Show/Hide) Toggle if users should be able to see + advanced search tips. +- **Expand Advanced Search.** (Show/Hide) Toggle if the advanced search + options should be expanded by default. +- **Sort Field.** (Relevance/Date/List price) Field to sort the search + results. +- **Sort Direction.** (Descending/Ascending) Direction to sort search + results. +- **Highlight Search Terms.** (Yes/No) Toggle if search terms should be + highlighted in search results. +- **Enable OpenSearch.** (Yes/No) +- **OpenSearch Name.** Name displayed for this site as a search + provider. +- **OpenSearch Description.** Description displayed for this site as a + search provider. + +### Index Tab + + + +- **Search for Phrases.** (Disabled/Enabled) Performance versus quality + of results. +- **Indexer Batch Size.** The batch size controls how many items are + processed per batch. Large batch sizes require lots of memory whereas + small batch sizes require less memory but execute more requests which + tends to take longer. +- **Memory Table Limit.** The memory table limit should not be changed + unless you are getting errors indicating that the finder_tokens or + finder_tokens_aggregate tables are full. The default is 30,000. +- **Title Text Weight Multiplier.** The multiplier is used to control + how much influence matching text has on the overall relevance score of + a search result. A multiplier is considered in relationship to the + other multipliers. The title text comes from the title of the content +- **Body Text Weight Multiplier.** The multiplier is used to control how + much influence matching text has on the overall relevance score of a + search result. A multiplier is considered in relationship to the other + multipliers. The body title text comes from the summary and/or body of + the content. +- **Metadata Weight Multiplier.** The multiplier is used to control how + much influence matching text has on the overall relevance score of a + search result. A multiplier is considered in relationship to the other + multipliers. The metadata comes from a number of sources including the + meta keywords and meta description, author names, etc. +- **Path Text Weight Multiplier.** The multiplier is used to control how + much influence matching text has on the overall relevance score of a + search result. A multiplier is considered in relationship to the other + multipliers. The path text comes from the SEF URL of the content. +- **Misc. Text Weight Multiplier.** The multiplier is used to control + how much influence matching text has on the overall relevance score of + a search result. A multiplier is considered in relationship to the + other multipliers. The miscellaneous text comes from a number of + sources including comments and other associated data. +- **Enable Logging.** Enable this option to create a log file in your + site's logs folder during the index process. This file is useful for + troubleshooting issues with the index process. It is recommended that + logging be disabled unless necessary. +- **Default Language.** (Default Site Language/None/English (United + Kingdom)) +- **Filter Common Words.** (Yes/No) +- **Filter Numeric Terms.** (Yes/No) + +### Permissions Tab + +This section shows permissions for Smart Search. The screen shows as +follows. + + + + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Options.** Users can edit the options and + permissions of this extension. + - **Configure Options Only.** Users can edit the options except the + permissions of this extension. + - **Access Administration Interface.** Users can access user + administration interface of this extension. + - **Create.** Users can create content of this extension. + - **Delete.** Users can delete content of this extension. + - **Edit.** Users can edit content of this extension. + - **Edit State.** User can change the published state and related + information for content of this extension. + - **Edit Own.** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/smart-search/smart-search-search-filters.md b/manuals/help/smart-search/smart-search-search-filters.md new file mode 100644 index 0000000..bc3f763 --- /dev/null +++ b/manuals/help/smart-search/smart-search-search-filters.md @@ -0,0 +1,138 @@ +--- +sidebar_position: 5 +id: smart-search-search-filters +title: "Help4.x:Smart Search: Search Filters" +--- +## Description + +This screen shows the search filters currently available for use in +Smart Search. For example, you could define a filter to list Articles by +a specific Author. You can then select that filter in a Menu item or +Module to search for words or phrases only in Articlaes by that Author. + +## How to access + +- Select **Components **→** Smart Search **→** Filters** from the + Administrator menu. + +## Screenshot + + + +## Column Headers + +In the table containing the indexed content for your Joomla! site you +will see different columns. Here you can read what they mean and what is +displayed in each column. + + + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. +- **Status**. The status of the search filter. Published filters are + shown with a green tick; unpublished filters by a red circle. You can + change the status of a search filter by clicking on the icon. +- **Title**. The title of the search filter. +- **Created by**. The name of the user who created the search filter. +- **Created on**. The date on which the search filter was created. +- **Map Count**. The number of content maps included in the search + filter. +- **ID**. The unique id associated with the search filter. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +**Filter Options** + +- **Filter by published status**. Choose whether to show only published + or unpublished search filters by selecting the appropriate item from + the drop-down list. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new search filter. + + + +- **Actions:** Reveals a list of actions for selected Items. Check one + or more Item checkboxes to activate the list. + + + +- **Publish**. Makes the selected search filters available to visitors + to your website. + + + +- **Unpublish.** Makes the selected search filters unavailable to + visitors to your website. + + + +- **Check-In**. Checks-in the selected search filters. Works with one or + multiple search filters selected. + + + +- **Statistics:** Shows some basic statistics on Smart Search. + + + +- **Delete:** Deletes the selected search filters. Works with one or + multiple search filters selected. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- If you are new to Smart Search then you should read the [Smart Search + quickstart + guide](https://docs.joomla.org/Smart_Search_quickstart_guide "Smart Search quickstart guide"). + +## Related information + +[Components Finder Manage +Searches](https://docs.joomla.org/Help4.x:Smart_Search:_Search_Term_Analysis/en "Help4.x:Smart Search: Search Term Analysis/en") diff --git a/manuals/help/smart-search/smart-search-search-term-analysis.md b/manuals/help/smart-search/smart-search-search-term-analysis.md new file mode 100644 index 0000000..367f8ec --- /dev/null +++ b/manuals/help/smart-search/smart-search-search-term-analysis.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 6 +id: smart-search-search-term-analysis +title: "Help4.x:Smart Search: Search Term Analysis" +--- +## Description + +Displays a list of phrases used by site visitors for site searching. The +Smart Search component Option - **Gather Search Statistics** needs to be +set to **Yes** to allow statistics to be collected. + +## How to Access + +- Select **Components **→** SmartSearch **→** Statistics** from the + Administrator menu. + +## Screenshot + + + +## Columns + +- **Search Phrase.** The search term entered by the site user. +- **Hits.** The number of times this term has been used. +- **Results.** The number of items resulting from the search. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Reset**. Resets the search log to its initial, empty state. + *Warning: This will erase all prior search statistics information.* diff --git a/manuals/help/tags/tags-new-or-edit.md b/manuals/help/tags/tags-new-or-edit.md new file mode 100644 index 0000000..4df0c51 --- /dev/null +++ b/manuals/help/tags/tags-new-or-edit.md @@ -0,0 +1,255 @@ +--- +sidebar_position: 2 +id: tags-new-or-edit +title: "Help4.x:Tags: New or Edit" +--- +## Description + +Used to add or edit tags which can be used to display content by tag +name on your Joomla! website. + +## How to Access + +- Select **Components **→** Tags** in the Administrator menu. Then + - Select the '**New'** button in the Toolbar to create a new Tag. + - Select a Tags's Title from the **Title** column of the list to edit + an existing tag. + +## Screenshot + + + +## Form Fields + +- **Title.** The Name of this item. This field is required. + + + +- **Alias**. The internal name of the item. Normally, you can leave this + blank and Joomla will fill in a default value Title in lower case and + with dashes instead of spaces. [Learn + more.](https://docs.joomla.org/Alias/en "Special:MyLanguage/Alias/en") + +### Tag Details Tab + +- **Description.** State the purpose of this tag. + +### Tag Details Sidebar + +- **Parent**. The item (category, menu item, and so on) that is the + parent of the item being edited. + + + +- **Status**. The published status of the item. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **Note**. This is normally for the site administrator's use (for + example, to document information about this item) and does not show in + the Frontend of the site. + + + +- **Version Note**. Optional field to identify this version of the item + in the item's [Version + History](https://docs.joomla.org/Help40:Components_Version_History/en "Special:MyLanguage/Help40:Components Version History/en") + window. + +### Options Tab + + + +**Options Panel** + +- **Layout**. Use a layout from the supplied component view or overrides + in the templates. + + + +- **CSS Class for tag link**. Add specific CSS classes for the tag link. + If empty 'label label-info' will be added by the default tag layout. + +**Images Panels** + +- **Teaser Image.** The image that will be displayed as part of the + list. + + + +- **Float.** Float attribute for the image. + + + +- **Alt.** Alt text for the image. + + + +- **Caption.** The caption for the image. + + + +- **Full Image.** An image that will be displayed in the single tag + view. + +### Publishing Tab + + + +- **Created Date**. Date the item(Article, Category, Weblink, etc.) was + created. + + + +- **Created By**. Name of the Joomla User who created this item. This + will default to the currently logged-in user. If you want to change + this to a different user, click the Select User button to select a + different user. + + + +- **Created by Alias**. This optional field allows you to enter in an + alias for this Author for this Article. This allows you to display a + different Author name for this Article. + + + +- **Modified Date**. Date of last modification. + + + +- **Modified By**. Username who performed the last modification. + + + +- **Hits**. The number of times an item has been viewed. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + + + +- **Meta Description**. An optional paragraph to be used as the + description of the page in the HTML output. This will generally + display in the results of search engines. If entered, this creates an + HTML meta element with a name attribute of 'description' and a content + attribute equal to the entered text. + + + +- **Keywords**. Optional entry for keywords. Must be entered separated + by commas (for example, "cats, dogs, pets") and may be entered in + upper or lower case. (For example, "CATS" will match "cats" or + "Cats"). Keywords can be used in several ways: + 1. To help Search Engines and other systems classify the content of + the Article. + 2. In combination with Banner tags, to display specific Banners based + on the Article content. For example, say you have one Banner with + an ad for dog products and another Banner for cat products. You + can have your dog Banner display when a User is viewing a + dog-related Article and your cat Banner display for a cat-related + Article. To do this, you would: + - Add the keywords "dog" and "cat" to the appropriate Articles. + - Add the Tags "dog" and "cat" to the appropriate Banners in + [Banners: + Edit](https://docs.joomla.org/Help40:Banners:_Edit/en "Special:MyLanguage/Help40:Banners: Edit/en"). + - Set the Banner module Parameter 'Search By Tags' to "Yes" in + [Site Modules: + Banners](https://docs.joomla.org/Help40:Site_Modules:_Banners/en "Special:MyLanguage/Help40:Site Modules: Banners/en"). + 3. For articles only, in combination with the ['Articles - Related' + module](https://docs.joomla.org/Help40:Site_Modules:_Articles_-_Related/en "Special:MyLanguage/Help40:Site Modules: Articles - Related/en"), + to display Articles that share at least one keyword in common. For + example, if the current Article displayed has the keywords "cats, + dogs, monkeys", any other Articles with at least one of these + keywords will show in the 'Articles - Related' module. + + + +- **Author**. Optional entry for an Author name within the metadata. If + entered, this creates an HTML meta element with the name attribute of + 'author' and the content attribute as entered here. + + + +- **Robots**. The instructions for web 'robots' that browse to this + page. + - *index, follow:* Index this page and follow the links on this page. + - *noindex, follow:* Do not index this page, but still follow the + links on the page. For example, you might do this for a site map + page where you want the links to be indexed but you don't want this + page to show in search engines. + - *index, nofollow:* Index this page, but do not follow any links on + the page. For example, you might want to do this for an events + calendar, where you want the page to show in search engines but you + do not want to index each event. + - *noindex, nofollow:* Do not index this page or follow any links on + the page. + - *Use Global:* Set in [Global Configuration: Metadata + Settings](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#Metadata_Settings "Special:MyLanguage/Help4.x:Site Global Configuration/en"). + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Versions**. Opens the Item Version History window to show any prior + versions of this item. This allows you to view older versions of this + item and, if desired, restore from an older version. See [Version + History](https://docs.joomla.org/Help40:Components_Version_History/en "Special:MyLanguage/Help40:Components Version History/en") + for more information. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/tags/tags-options.md b/manuals/help/tags/tags-options.md new file mode 100644 index 0000000..db60e93 --- /dev/null +++ b/manuals/help/tags/tags-options.md @@ -0,0 +1,214 @@ +--- +sidebar_position: 3 +id: tags-options +title: "Help4.x:Tags: Options" +--- +## Description + +Used to set global defaults for menu items that display tags. These +default values will be used when "Use Global" is selected for an option +in a Tags menu item. For example, to show the 'Tag Name' for a Tagged +Items List in your Tags 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. + +## How to Access + +- Select **Components **→** Tags** from the Administrator menu. Then... + - Select the **Options** button in the Toolbar. + +## Screenshot + + + +## Form Fields + +### Tagged Items Tab + +- **Default Tagged Items Layout**. Choose a default layout to for tagged + items. This layout will be used when a user clicks on a tag that + doesn't have a menu item defined. +- **Enable Versions.** (Yes/No). Whether or not to save version history + for this component. If No, version history will not be saved for + component items or for this component's categories. +- **Maximum Versions.** The maximum number of versions to store for an + item. If an item is saved and the maximum number of versions has been + reached, the oldest version will be deleted automatically. If set to + 0, then versions will never be deleted automatically. Also, specific + versions may be flagged as "Keep Forever" and will not be deleted + automatically. Note that versions may be deleted manually using the + Delete button in the [Version + History](https://docs.joomla.org/Help310:Components_Version_History/en "Help310:Components Version History/en") + screen. +- **Show Tag Name**. For a layout with one tag, show the tag name. +- **Tag Image**. For a layout with one tag, show the image for the tag. +- **Tag Description**. Show or hide a description for the tag (only used + when a single tag is selected). +- **Image**. Show the tag image (full image). +- **Order**. Order items will be displayed in. +- **Direction**. Sort order. Descending is highest to lowest. Ascending + is lowest to highest. +- **Table Headings**. Show or hide the headings in list layouts. +- **Show Date**. Whether to show a date column in the list of articles. + Select Hide to hide the date, or select which date you wish to show. +- **Item Images**. Shows the first image for each item in the list. +- **Item Description**. Whether to show or hide the description for each + item in the list. The length may be limited using the Maximum + Characters option. +- **Maximum Characters**. The maximum number of characters to display + from the description in each tag. + +### Item Selection Tab + + + +- **Minimum Search Length**. This setting controls the minimum character + length for the search and adding tags using the tags field Ajax mode. +- **Match Type**. All will return items that have all of the tags. Any + will return items that have at least one of the tags. +- **Child Tags**. Include or exclude child tags from the result list for + a tag. +- **Maximum Items**. The maximum number of results to return. +- **Language Filter**. Optionally filter the list of tags based on + language. + +### List All Tags Tab + + + +- **Default List All Tags Layout**. Choose a default layout for List of + all tags. +- **Order**. Order items will be displayed in. +- **Direction**. Sort order. Descending is highest to lowest. Ascending + is lowest to highest. +- **Item Images**. Shows the first image for each item in the list. +- **Tag Description**. Shows or hides the description for each tag + listed. +- **Maximum Characters**. The maximum number of characters to display + from the description in each tag. +- **Hits**. Display the number of hits. + +### Shared Layout Tab + + + +- **Filter Field**. Whether to show a Filter field for the list. Select + Hide to hide the filter field. +- **Display Select**. Whether to show or hide the Display Select + dropdown listbox. +- **Pagination**. Show or hide 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 Information will not fit + on the page. +- **Pagination Results**. Show or hide pagination results information, + for example, "Page 1 of 4". + +### Data Entry Tab + + + +- **Tag Entry Mode**. Ajax mode searches tag while typing and allows you + on the fly tag creation. Nested tags show you a nested view with all + the available tags. + +### Integration Tab + + + +- **Show Feed Link**. Show or hide an RSS Feed Link. (A Feed Link will + show up as a feed icon in the address bar of most modern browsers). + +### Permissions Tab + +This section lets you set up the default ACL permissions for all tags. +These permissions may be overridden for specific tags. + + + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Optons**. Users can edit the options and + persimissions of this extension. + - **Configure Optons Only**. Users can edit the options exept the + persimissions of this extension. + - **Access Administration Interface**. Users can access user + administration interface of this extension. + - **Create:** Users can create content of this extension. + - **Delete:** Users can delete content of this extension. + - **Edit:** Users can edit content of this extension. + - **Edit State:** User can change the published state and related + information for content of this extension. + - **Edit Own:** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited:*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Save.** Saves the Tags Options settings and stays in the current + screen. + + + +- **Save & Close**. Saves the Tags Options settings and closes the + current screen. + + + +- **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 + +- If you are a beginning user, you can just keep the default values here + until you learn more about using global options. +- If you are an advanced user, you can save time by creating good + default values here. When you set up menu items and create tags, you + will be able to accept the default values for most options. diff --git a/manuals/help/tags/tags.md b/manuals/help/tags/tags.md new file mode 100644 index 0000000..cb4c049 --- /dev/null +++ b/manuals/help/tags/tags.md @@ -0,0 +1,212 @@ +--- +sidebar_position: 1 +id: tags +title: "Help4.x:Tags" +--- +## Description + +Used to view a list of existing Tags, edit current and create new Tags. + +## How to Access + +Select **Components **→** Tags** from the Administrator menu. + +## Screenshot + + + +## Column Headers + +In the table containing Tags, these are the different columns shown +below. Click on the column heading on the Tags manager screen to sort +the list by that column's value. Help31-Tags-Manager-columns-en.png + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **Title**. The name of the item. For a Menu Item, the Title will + display in the Menu. For an Article or Category, the Title may + optionally be displayed on the web page. This entry is required. You + can open the item for editing by clicking on the Title. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. +- **Tagged Items.** The number of items with this tag. Click the number + to go to a list of items. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +**Filter Options** + +- **Select Status**. Select from Trashed / Unpublished / Published / + Archived / All. + + + +- **Select Access**. Select from the list of available viewing access + levels. + + + +- **Select Language**. Select from the list of available languages, if + the site manages more than 1 language. + + + +- **Select Max Levels**. Select from the list of available levels. + +**Filter by Tag Type.** Select the Tag Type from the drop-down list box +of available Tag Types. Available tags are components in which tags are +defined. + +### Automatic Pagination + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new tag. + + + +- **Edit**. Opens the editing screen for the selected tag. If more than + one tag is selected (where applicable), only the first tag will be + opened. The editing screen can also be opened by clicking on the Name + of the tag. + + + +- **Publish**. Makes the selected tag available to visitors to your + website. + + + +- **Unpublish.** Makes the selected tag unavailable to visitors to your + website. + + + +- **Archive**. Changes the status of the selected tag to indicate that + they are archived. Archived tag can be moved back to the published or + unpublished state by selecting 'Archived' in the 'Select Status' + filter and changing the status of the tag. + + + +- **Check-In**. Checks-in the selected tag. Works with one or multiple + tag selected. + + + +- **Batch**. Batch processes the selected tag. Works with one or + multiple items selected. + + + +- **Trash**. Changes the status of the selected tag to indicate that + they are trashed.Trashed tag can still be recovered by selecting + 'Trashed' in the 'Select Status' filter and changing the status of the + articles to Published or Unpublished as preferred.To permanently + delete trashed tag, select 'Trashed' in the 'Select Status' filter, + select the tag to be permanently deleted, then click the 'Empty Trash' + toolbar icon. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/templates/template-options.md b/manuals/help/templates/template-options.md new file mode 100644 index 0000000..6eca8ce --- /dev/null +++ b/manuals/help/templates/template-options.md @@ -0,0 +1,102 @@ +--- +sidebar_position: 1 +id: template-options +title: "Help4.x:Template: Options" +--- +## Description + +Template Options configuration allows setting of parameters used +globally for Templates. + +## How to Access + +- Select **System **→** Site Templates in the Templates Panel** from the + Administrator menu. Or... +- Select **System **→** Site Templates Styles in the Templates Panel** + from the Administrator menu. Or... +- Select **System **→** Administrator Templates in the Templates Panel** + from the Administrator menu. Or... +- Select **System **→** Administrator Templates Styles in the Templates + Panel** from the Administrator menu. Then... + - Select the **Options** button in the Toolbar. + +## Screenshot + + + +## Form Fields + +### Templates Tab + +- **Preview Module Positions.** (Enable/Disable) Enable the preview of + the module positions in the template by appending tp=1 to the web + adress. Also enable the Preview button in the list of templates. +- **Upload Size (MB).** The maximum upload size for files inside + Template Manager. +- **Valid Image Formats.** These file types will be available for + cropping and resizing. +- **Valid Source Formats.** These file types will be available for + editing. +- **Valid Font Formats.** These file types will be available for font + preview. + +### Permissions Tab + + + +To change the permissions for this extension, do the following. + +- Select the **Group** by clicking its title located on the left. +- Find the desired **Action**. Possible Actions are: + - **Configure ACL & Options.** Users can edit the options and + permissions of this extension. + - **Configure Options Only.** Users can edit the options except the + permissions of this extension. + - **Access Administration Interface.** Users can access user + administration interface of this extension. + - **Create.** Users can create content of this extension. + - **Delete.** Users can delete content of this extension. + - **Edit.** Users can edit content of this extension. + - **Edit State.** User can change the published state and related + information for content of this extension. + - **Edit Own.** Users can edit own created content of this extension. +- Select the desired permission for the action you wish to change. + Possible settings are: + - ***Inherited.*** Inherited for users in this Group from the Global + Configuration permissions of this extension. + - ***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. +- 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 + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the Templates options and stays in the current screen. + + + +- **Save & Close**. Saves the Templates options and closes the current + screen. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/templates/templates-customise-source.md b/manuals/help/templates/templates-customise-source.md new file mode 100644 index 0000000..5ce019c --- /dev/null +++ b/manuals/help/templates/templates-customise-source.md @@ -0,0 +1,123 @@ +--- +sidebar_position: 3 +id: templates-customise-source +title: "Help4.x:Templates: Customise Source" +--- +## Description + +This screen is where the source code of template files is edited. It +provides a plain text interface to edit the template files. HTML and PHP +programming syntax is highlighted to make the source code files easier +to read. + +## How to Access + +- Select **System **→** Templates Panel **→** Site Templates** from the + Administrator menu. Or... +- Select **System **→** Templates Panel **→** Administrator Templates** + from the Administrator menu. Then... + - Select a template name from the **Templates** column. Then... + - Select a file to edit from the Editor tab. + +## Screenshot + + + +## Form Fields + +### Editor Tab + +- Select a file to edit. The edit area shows syntax highlighted text for + most types of file. + +### Create Overrides Tab + +- Select an item to override. This is done immediately with no prompt + for confirmation. The override is placed in the appropriate location. + There is a confirmation message, example: Override created in + /templates/cassiopeia/html/mod_whosonline + +### Updated Files Tab + +If there have been no updates to the template since overrides were +created this tab will contain a simple message: + +- **Notice.** Overridden files are up to date. Nothing has been changed + in the last extension or Joomla update. + +If there have been updates, a table will show a list of overrides that +need to be reviewed. + +### Template Description Tab + +- **Thumbnail and Description.** Information on this template. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +The Toolbar icons change with the action being taken. You may see: + +- **Save.** Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Copy Template.** Copies the current template. A dialog box prompts + for a new name. + + + +- **Template Preview.** Select to open the Site in a new browser tab. + + + +- **Manage Folders.** Allows creation and deletion of template folders + using a dialog box. + + + +- **New File.** Allows upload of a file from your computer to the + template file hierarchy using a dialog box. + + + +- **Rename File.** Select a file to edit. Select the Rename button to + prompt for a new name. + + + +- **Delete File.** You will be prompted to Confirm or Cancel. + + + +- **Close File.** Closes the open file and returns to the Editor Tab. + + + +- **Help**. Opens this help screen. + +The Toolbar icons change with the action being taken. Some of the above +are absent on some screens. + +## Quick Tips + +- Important: Do not delete the default template files using FTP because + it generates an error in both the front-end and back-end. +- Before editing the HTML and the CSS file of the template, it is a good + idea to make a backup of the file you are editing. Also, you can edit + these files outside of Joomla! using the HTML or CSS editor of your + choice. + +## Related Information + +- To install templates: [Extension Manager: + Install](https://docs.joomla.org/Help4.x:Extensions:_Install/en "Help4.x:Extensions: Install/en") diff --git a/manuals/help/templates/templates-customise.md b/manuals/help/templates/templates-customise.md new file mode 100644 index 0000000..0317c98 --- /dev/null +++ b/manuals/help/templates/templates-customise.md @@ -0,0 +1,152 @@ +--- +sidebar_position: 2 +id: templates-customise +title: "Help4.x:Templates: Customise" +--- +## Description + +This is where you edit a template's source code. You can edit the +template's master files and stylesheets from this screen. + +## How to Access + +- Select **System **→** Templates Panel **→** Site Templates** from the + Administrator menu. Or... +- Select **System **→** Templates Panel **→** Administrator Templates** + from the Administrator menu. Then... + - Select a template name from the **Templates** column. + +## Screenshot + +The Administrator and Site Templates screens use the same layout. The +Site Template screen is illustrated here. + + + +## Form Fields + +### Editor Tab + +- Select a file to edit. The edit area shows syntax highlighted text for + most types of file. + +### Create Overrides Tab + +- Select an item to override. This is done immediately with no prompt + for confirmation. The override is placed in the appropriate location. + There is a confirmation message, example: Override created in + /templates/cassiopeia/html/mod_whosonline + +### Updated Files Tab + +If there have been no updates to the template since overrides were +created this tab will contain a simple message: + +- **Notice.** Overridden files are up to date. Nothing has been changed + in the last extension or Joomla update. + +If there have been updates, a table will show a list of overrides that +need to be reviewed. + +### Template Description Tab + +- **Thumbnail and Description.** Information on this template. + +## Toolbar + +Note that the Toolbar buttons change when a file is selected for +editing. + +### No file selected + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Create Child Template.** Select to make a complete a new child + template. You will be prompted for a new child template name. There is + also an opportunity to Close without creating a new child template. To + remove the new child template: select the **Close** button, select the + Styles button in the Templates list Toolbar, check the template check + box for the new child template and select Delete in the toolbar. +- **Template Preview.** Select to open the Site default view using this + template. +- **Manage Folders.** Select to create a new folder within the template + hierarchy. A popup window appears: + + + +- **New File.** Select to create a new file or to upload a file from + your computer to your Joomla! template hierarchy. A popup window + appears: + + + +- **Check Overrides.** Activated when an Override is selected in the + **Overrides** tab. The options are: + - Mark Checked + - Mark Unchecked + - Remove Record + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. + + + +- **Help**. Opens this help screen. + +### File selected + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Rename File.** Select a file to edit. Select the Rename button to + prompt for a new name. + + + +- **Delete File.** You will be prompted to Confirm or Cancel. +- **Check Overrides.** Activated when an Override is selected in the + **Overrides** tab. + + + +- **Close File.** Closes the open file and returns to the Editor Tab. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- Before editing the HTML and the CSS file of the template, it is a good + idea to make a backup of the file you are editing. Also, you can edit + these files outside of Joomla! using the HTML or CSS editor of your + choice. + +## Related Information + +- To install templates: [Extensions: + Install](https://docs.joomla.org/Help4.x:Extensions:_Install/en "Help4.x:Extensions: Install/en") diff --git a/manuals/help/templates/templates-edit-style.md b/manuals/help/templates/templates-edit-style.md new file mode 100644 index 0000000..f2108e7 --- /dev/null +++ b/manuals/help/templates/templates-edit-style.md @@ -0,0 +1,118 @@ +--- +sidebar_position: 4 +id: templates-edit-style +title: "Help4.x:Templates: Edit Style" +--- +## Description + +This is where you edit template styles. When a template is first +installed, a default style is created for it. The default style for the +template will have the same name as the template with a *- Default* +suffix. To make a different variation of the default template style, +check the default style's checkbox and press the *Duplicate* icon in the +toolbar. Then edit the duplicate. + +## How to Access + +- Select **System **→** Templates Panel **→** Site Templates Styles** + from the Administrator menu. Or... +- Select **System **→** Templates Panel **→** Administrator Templates + Styles** from the Administrator menu. Then... + - Select the name of the Template Style to edit in the Style column. + +## Screenshot + + + +## Form Fields + +- **Style Name.** The name of the style. This is the name that will + display in the Style column of the *Template: Styles* screen. + +### Details Tab + +- **Template Name.** The name of the template, Site or Administrator + indicator and a brief description. +- **Default.** Whether or not the style is the default for the location. +- **Template.** The name of the template the style is derived from. + +### Advanced Tab + +This section may not be present for all styles. If a template from which +a style is derived from has configurable options they will be present +here. It is these additional configurable options which allow you to +have multiple different styles of templates with variations of these +options. The options available will vary based on what options the +template developer made available. + +### Atum Colour Settings + +The default Administrator template allows you to experiment with colour +variations. Save and see! + +### Atum Image Settings + +You may select an image to replace the **Login Logo** in the +Administrator login form, and the **Brand Logo** in the Administrator +Title bar in expanded mode and in compacted mode. The defaults are the +Joomla Brand logos. In the Title Bar, the word Joomla! is present in the +**Brand Large** version and omitted in the **Brand Small** version. +Select **Toggle Menu** to see the change. + +If you provide your own Brand Small you also need to provide a width +style override. To do so, create a user.css file in the template root +and insert the following, but replace 3rem with a suitable width for +your image: + + .header .logo.small { + width: 3rem; + } + +### Menu Assignment Tab + +This section contains all the menu items configured in your Joomla! +website. To apply the current style to a menu item's corresponding web +page, check the box next to the menu item. You can press the *Toggle +Selection* button to invert the menu item selections. + +**Note**: If a checkbox is grayed out and cannot be checked then it +could be because the menu item is in use by another user. You can see if +this is the case by going to the [menu manager screen for the +menu](https://docs.joomla.org/Help4.x:Menus:_Items/en "Help4.x:Menus: Items/en") +concerned. If there is a padlock symbol next to the menu item then it is +currently in use by another user. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save as Copy**. Saves your changes to a copy of the current item. + Does not affect the current item. This toolbar icon is not shown if + you are creating a new item. + + + +- **Cancel**. 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 + +- To install templates: [Extension Manager: + Install](https://docs.joomla.org/Help4.x:Extensions:_Install/en "Help4.x:Extensions: Install/en") diff --git a/manuals/help/templates/templates-styles.md b/manuals/help/templates/templates-styles.md new file mode 100644 index 0000000..a8e4be9 --- /dev/null +++ b/manuals/help/templates/templates-styles.md @@ -0,0 +1,139 @@ +--- +sidebar_position: 5 +id: templates-styles +title: "Help4.x:Templates: Styles" +--- +## Description + +The Template Styles screen is used to manage both Site and Administrator +templates. Use it to set the default template for all pages or assign a +specific template to an individual page. + +## How to Access + +- Select **System **→** Templates Panel **→** Site Templates Styles** + from the Administrator menu. Or... +- Select **System **→** Templates Panel **→** Administrator Templates + Styles** from the Administrator menu. + +## Screenshot + + + +## Column Headers + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. +- **Style.** The name of the style. Select the link to edit the Style. +- **Preview.** Select to see a preview of the style if one is available. + Has to be activated in *Global Configuration*. +- **Default.** The icon indicates which template is the default for all + pages. Select a greyed icon to change the default template style. +- **Pages**. The Menu Items where this style will be displayed. Options + are "All" for all Menu Items, "None" for no Menu Items, and "Varies" + for selected Menu Items. A style will only display on Menu Items where + it is selected. +- **Template.** The name of the template. Select a link to edit the + templates files. Do not edit Joomla default templates - your changes + may be lost if there is an update. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Special:MyLanguage/Help4.x:Site Global Configuration/en"). + +**Filter Options** + +- **Select Menu Item.** Use the drop-down list box to select pages to + which the style has been assigned. +- **Select Template.** Use the drop-down list box to select a template + from those available. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Default:** Makes the selected item the default item. The default + star symbol + (Icon-16-default.png) will show in the Default + column, indicating that this is now the default item. + + + +- **Duplicate:** Makes a copy of the selected item. The copy is created + immediately and is given the same name as the original but prefixed + with "Copy of" and/or suffixed with a number (eg. "(2)") so that it + can be distinguished from the original and any other copies. + + + +- **Delete:** Deletes the selected items. Works with one or multiple + items selected. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/templates/templates-templates.md b/manuals/help/templates/templates-templates.md new file mode 100644 index 0000000..2de3dac --- /dev/null +++ b/manuals/help/templates/templates-templates.md @@ -0,0 +1,85 @@ +--- +sidebar_position: 6 +id: templates-templates +title: "Help4.x:Templates: Templates" +--- +## Description + +The **Templates: Templates** screen allows you to preview and edit +templates which are installed in your Joomla! site. + +## How to access + +- Select **System **→** Templates Panel **→** Site Templates** from the + Administrator menu. Or... +- Select **System **→** Templates Panel **→** Administrator Templates** + from the Administrator menu. + +## Screenshot + +The Administrator and Site Templates screens use the same layout. The +Site Template screen is illustrated here. + + + +## Column Headers + +Click on the column heading to sort the list by that column's value. + +- **Image.** A thumbnail of the template appearance. +- **Template.** The name of the template. Select the linked name to edit + a templates files. +- **Version.** The version number of the item. +- **Date.** The date the item was created by the developer. +- **Author.** The developer of the template. +- **Override Files.** If the original template has not been updated + since any overrides were created this column will display a green **Up + to date** message. If the original template has been updated it will + display a yellow **Change found** message. + +## List Filters + +- **Site or Administrator.** Whether the template is a for Site or + Administrator use. + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Related Information + +- To edit templates styles: [Template Manager: + Styles](https://docs.joomla.org/Help4.x:Templates:_Styles/en "Help4.x:Templates: Styles/en") diff --git a/manuals/help/update-sites/edit-update-site.md b/manuals/help/update-sites/edit-update-site.md new file mode 100644 index 0000000..42f7ca2 --- /dev/null +++ b/manuals/help/update-sites/edit-update-site.md @@ -0,0 +1,50 @@ +--- +sidebar_position: 1 +id: edit-update-site +title: "Help4.x:Edit Update Site" +--- +## Description + +The Edit Update Site screen shows some information about the update +site. The Joomla! sources cannot be edited but other sources may allow +editing. + +## How to access + +- Select **System **→** Update panel **→** Update Sites** from the + Administrator menu. Then... + - Select a Title link in the Update Site column. + +## Screenshot + + + +## Form Fields + +- **Name.** The name of the site. +- **Type.** The type of site. +- **Location.** The URL of the XML file controlling the update. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the user and stays in the current screen. + + + +- **Save & Close**. Saves the user and closes the current screen. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/update-sites/extensions-update-sites.md b/manuals/help/update-sites/extensions-update-sites.md new file mode 100644 index 0000000..5318f3e --- /dev/null +++ b/manuals/help/update-sites/extensions-update-sites.md @@ -0,0 +1,149 @@ +--- +sidebar_position: 2 +id: extensions-update-sites +title: "Help4.x:Extensions: Update Sites" +--- +## Description + +A list of sites from which Joomla! Extensions can be updated on-line. + +## How to Access + +- Select **System **→** Update panel **→** Update Sites** from the + Administrator menu. + +## Screenshot + + + +## Column Headers + +Click on the title of a column header to sort by that column. The +purpose of each column is as follows: + +- **Checkbox.** Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. +- **Status.** The status of this item (Enabled or Disabled). +- **Update Site.** The URL of the update source site. +- **Name.** The name of the Extension. +- **Location.** Site or Administrator Extension +- **Type.** Package, Component, File... +- **Folder.** ... +- **ID.** This is a unique identification number for this action + assigned automatically by Joomla. It is used to identify the item + internally, and you cannot change this number. + +## List Filters + +**Search bar.** This is a common feature of most Lists. The layout is as +shown below. + +Help-4x-colheader-filter-field-en.png + +- **Search by Text.** Enter part of the search term and click the Search + icon. The search may be of one or more fields. *Hover* to see a + *Tooltip* indicating which fields will be searched. In some cases a + different format is required. For Example, to **Search by ID** enter + "id:xx", where "xx" is the item ID number (for example, "id:9"). +- **Filter Options.** Click to display or hide the additional filters. +- **Clear.** Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering.** Shows the current table ordering field. Select from the + drop down list to change the order or click a column heading. Ordering + may be in ascending or descending order. The column heading toggles + between ascending and descending order. +- **Number to Display.** Shows the number of items in a list. The + default for a site is 20 but this may be changed in the global + configuration. Select from the drop-down list to change the number + displayed. If you select too many complex items they will be slow to + deliver and display. + +**Filter Options** + +- ***- Select Status -*** Shows items that are Published and + Unpublished. Does *not* show items that are Trashed or Archived. + - ***Trashed:*** Shows only items that are Trashed. **Important + Note:** To permanently delete items: Change the status of the items + to Trashed. Change the Status filter to Trashed. At this point the + trashed items will show and an icon called "Empty trash" will show + in the toolbar. Select the desired trashed items and click on "Empty + Trash" in the toolbar. The items will be permanently deleted. + - ***Unpublished:*** Shows only items that are Unpublished. + - ***Published:*** Shows only items that are Published. + - ***Archived:*** Shows only items that are Archived. + - ***All:*** Shows all items regardless of published status. +- **Location.** The intended destination of the extension: Site, + Administrator or API. +- **Type.** Select from the list: Component, File, etc. +- **Folder.** Select from the list: actionlog, api-authentication, etc. +- **Download Key.** Used by commercial extensions to allow download + access. + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Edit**. Opens the editing screen for the selected item. If more than + one item is selected (where applicable), only the first item will be + opened. The editing screen can also be opened by clicking on the Name + of the item. + + + +- **Actions:** Reveals a list of actions for selected Items. Check one + or more Item checkboxes to activate the list. + + + +- **Enable**. Makes the selected item available for use on your website. + + + +- **Disable**. Makes the selected items unavailable for use on your + website. + + + +- **Delete:** Deletes the selected items. Works with one or multiple + items selected. + + + +- **Check-In**. Checks-in the selected items. Works with one or multiple + items selected. + + + +- **Rebuild.** Reconstructs and refreshes the relevant table. Normally, + you do *not* need to rebuild this table. This function is provided in + case the data in the table becomes corrupted. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/users/user-actions-log-options.md b/manuals/help/users/user-actions-log-options.md new file mode 100644 index 0000000..b781033 --- /dev/null +++ b/manuals/help/users/user-actions-log-options.md @@ -0,0 +1,66 @@ +--- +sidebar_position: 2 +id: user-actions-log-options +title: "Help4.x:User Actions Log: Options" +--- +## Description + +The User Actions Log Options screen allows setting of parameters used +globally for User Actions Log component. Control if you want to enable +or not the IP logging, the CVS delimiter you would like, what events +should be logged and define the permissions for each user group. + +## How To Access + +To access this screen: + +- Select **Users **→** Users Actions Log** from the Administrator menu. + Then... + - Select the **Options** button in the Toolbar. + +## Screenshot + + + +## Form Fields + +### Options Tab + +- **IP logging.** (*Yes/No*) This allows you to choose if you want the + users' IP to be logged in the site and displayed in the User Actions + log screen. +- **CSV delimiter.** (*Coma*/*Semicolon*). This allows to choose if you + want the actions log to be exported in CSV using coma or semicolon +- **Select events to be logged.** This allows to choose which events of + your site should be logged. +- **Log API Requests.** Default is **No**. If set to Yes for testing... +- **Verbs To Log.** The options are GET, POST, DELETE, PUT and PATCH. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Save.** Saves the user and stays in the current screen. + + + +- **Save & Close**. Saves the user and closes the current screen. + + + +- **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 + +- [User Action + Logs](https://docs.joomla.org/J3.x:User_Action_Logs/en "J3.x:User Action Logs/en") diff --git a/manuals/help/users/user-actions-log.md b/manuals/help/users/user-actions-log.md new file mode 100644 index 0000000..4ea4786 --- /dev/null +++ b/manuals/help/users/user-actions-log.md @@ -0,0 +1,112 @@ +--- +sidebar_position: 1 +id: user-actions-log +title: "Help4.x:User Actions Log" +--- +## Description + +The User Actions Log provides a global overview of selected +Administrator activities on your site. From this screen you may Select, +Export, Delete or Purge entries. The Events to log are set via the +Options button in the Toolbar. + +## How to Access + +Select **Users **→** User Actions Log** from the Administrator menu. + +## Screenshot + +Help-4x-user-actions-log-en.png + +## Column Headers + +Click on the title of a column header to sort by that column. The +purpose of each column is as follows: + +- **Checkbox.** Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. +- **Action.** The action performed by the user on your site (who did + what) +- **Extensions.** The extension used to perform this action +- **Date.** Date and time when the action was performed +- **Name.** Name of the user who performed the action +- **IP Address.** The IP Address of the user who performed the action. + *Note: This column is displayed only when the option **IP logging** is + set to **Yes** in the component options* +- **ID.** This is a unique identification number for this action + assigned automatically by Joomla. It is used to identify the item + internally, and you cannot change this number. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + +**Filter Options** + +- **Select Extension**. Select the desired extension to limit the list + based on a specific extension +- **Select Date**. Select the desired timeframe to limit the list based + on this timeframe (from *Today* to *In the last year*) +- **Select User**. Select the desired name to limit the list based on + the actions on a specific user. + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Export Selected as CSV.** Allows you to export as CSV the User + Action Logs you have selected. +- **Export All as CSV.** Allows you to export as CSV all the User Action + Logs. +- **Delete.** Deletes one or more selected records. +- **Purge.** Allows you to delete all User Action Logs at once. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Related Information + +- [Joomla 3 Tutorial: User Action + Logs](https://docs.joomla.org/J3.x:User_Action_Logs/en "J3.x:User Action Logs/en") diff --git a/manuals/help/users/user-notes-categories.md b/manuals/help/users/user-notes-categories.md new file mode 100644 index 0000000..2185f79 --- /dev/null +++ b/manuals/help/users/user-notes-categories.md @@ -0,0 +1,255 @@ +--- +sidebar_position: 4 +id: user-notes-categories +title: "Help4.x:User Notes: Categories" +--- +## Description + +This screen shows a list of user note categories. + +## How to access + +- Select **Users **→** User Note Categories** from the Administrator + menu. + +## Screenshot + + + +## Column Headers + +In the table containing the user note categories from your Joomla! site, +you will see different columns. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **Title**. The name of the item. For a Menu Item, the Title will + display in the Menu. For an Article or Category, the Title may + optionally be displayed on the web page. This entry is required. You + can open the item for editing by clicking on the Title. + + + +- **Access**. The [viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Special:MyLanguage/Help4.x:Users: Viewing Access Levels/en") + for this item. + + + +- **Language**. Item language. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +Near the top of the page you will see the filter bar shown in the +Screenshot above. The functions are: + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of items in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Help4.x:Site Global Configuration/en"). + + + +- **Select Status**. Select from Trashed / Unpublished / Published / + Archived / All. + + + +- **Select Access**. Select from the list of available viewing access + levels. + + + +- **Select Language**. Select from the list of available languages, if + the site manages more than 1 language. + + + +- **Select Tag**. Select from the list of available tags. + + + +- **Select Max Levels**. Select from the list of available levels. + +**Page Controls**. When the number of items is more than one page, you +will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **New**. Opens the editing screen to create a new category. +- **Publish.** Makes the selected user notes category available to + administrators of your website. +- **Unpublish.** Makes the selected user notes category not available to + administrators of your website. + + + +- **Archive.** Changes the status of the selected category to indicate + that they are archived. Archived category can be moved back to the + published or unpublished state by selecting "Archived" in the Select + Status filter and changing the status of the category to Published or + Unpublished as preferred. + + + +- **Check-In**. Checks-in the selected category. Works with one or + multiple category selected. + + + +- **Trash**. Changes the status of the selected category to indicate + that they are trashed. Trashed category can still be recovered by + selecting "Trashed" in the Select Status filter and changing the + status of the category to Published or Unpublished as preferred. To + permanently delete trashed category, select "Trashed" in the Select + Status filter, select the category to be permanently deleted, then + click the Empty Trash toolbar icon. + + + +- **Batch**. Batch processes the selected category. Works with one or + multiple items selected. + + + +- **Help**. Opens this help screen. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + +## Batch Process + +The Batch Process allows a change in settings for a group of selected +items. To use: click on the Batch button found on top of the table of +items being viewed to activate the drop down field area. + + + +***\** refers to the page name of items.* + +You can change one value or all four values at one time. + +***Note** - if you copy items to a new category, changes you have +selected from access level and language will be applied to the copies, +not the original.* + +**How to Batch Process** a group of items: + +1. Select one or more items on the list by selecting the desired + checkbox(es). +2. Set one or more of the following values: + - To change the **Access Levels**, select the desired new access + level from the Set Access Level list box. + - To change the **Language**, select the desired language from the + Set Language list box. + - To add a **Tag**, select the desired tag from the Add Tag list + box. + - To change the **Category**, select a category. To leave the + category unchanged, use the default value of "Select". + + 1. To copy the items to a different category, select the desired + category from the category list box and check the Copy option. + In this case, the original items are unchanged and the copies + are assigned to the new category and, if selected, the new + access level and language. + 2. To move the items to a different category, select the desired + category from the category list box and check the Move option. + In this case, the original items will be moved to a new category + and, if selected, be assigned the new access level and language. +3. When all of the settings are entered, click on Process to perform + the changes. A message **"Batch process completed successfully."** + will show. + +Note that nothing will happen if you (a) don't have any items selected +or (b) have not selected an access level, language, or category. + +If you wish to clear your entered selections, click on the Clear button. +This will return all of the Batch controls to their default values. Note +that this does *not* uncheck the check boxes for the items. + +## Related Information + +- [User Notes: New or + Edit](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit/en "Help4.x:User Notes: New or Edit/en") +- [User + Notes](https://docs.joomla.org/Help4.x:User_Notes/en "Help4.x:User Notes/en") +- [User Notes: New or Edit + Category](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit_Category/en "Help4.x:User Notes: New or Edit Category/en") diff --git a/manuals/help/users/user-notes-new-or-edit-category.md b/manuals/help/users/user-notes-new-or-edit-category.md new file mode 100644 index 0000000..a59b51d --- /dev/null +++ b/manuals/help/users/user-notes-new-or-edit-category.md @@ -0,0 +1,207 @@ +--- +sidebar_position: 6 +id: user-notes-new-or-edit-category +title: "Help4.x:User Notes: New or Edit Category" +--- +## Description + +Categories are used to organize User Notes allowing display of related +notes together on a page. All User Notes are assigned either to a +Category that you create or to the special Category named +'Uncategorised'. + +This screen has a form to add a new Category or edit an existing +Category. + +## How to access + +- Select **Users **→** User Note Categories** from the Administrator + menu. Then... + - Select the **New** button in the Toolbar to create a new category. + Or... + - Select a category title in the **Title** column to edit an existing + category. + +## Screenshot + + + +## Details + +- **Title:** Title of the Category. +- **Alias:** The Alias will be used in the SEF URL. Leave this blank and + Joomla will fill in a default value from the title. This value will + depend on the SEO settings (**System **→** Global + Configuration **→** Site**). Using Unicode will produce UTF-8 aliases. + You may also enter manually any UTF-8 character. Spaces and some + forbidden characters will be changed to hyphens.When using default + transliteration it will produce an alias in lower case and with dashes + instead of spaces. You may enter the Alias manually. Use lowercase + letters and hyphens (-). No spaces or underscores are allowed. Default + value will be a date and time if the title is typed in non-latin + letters . + +### Category + +- **Description:** Enter an optional category description in the + text-area. +- **Parent:** (*No parent*/*Uncategorised*). Select a Parent Category. +- **Status:** (*Published*/*Unpublished*/*Archived*/*Trashed*). Set + publication status. +- **Access:** (*Guest*/*Public*/*Registered*/*Special*/*Customer Access + Level (Example)*). The access level group that is allowed to view this + item. +- **Language:** (*All*/*English (UK)*). Assign a language to this + category. +- **Tags:** Assign tags to content items. Tag names must be unique. +- **Note:** Enter an optional note to display in the category list. +- **Version Note:** Enter an optional note for this version of the item. + +### Options + + + +**Layout:** (*Use Global*). Use a layout from the supplied component +view or overrides in the templates. + +- **Image:** Choose an image for this category. +- **Alt Text:** Alternative text used for visitors without access to + images. + +### Publishing + + + +- **Created Date:** The date and time this item was first created. This + is entered by the system automatically. +- **Created By:** The user who created this item. +- **Modified Date:** The date and time this item was last modified. This + is entered by the system automatically. +- **Modified By:** The user who did the last modification +- **Hits:** Number of hits for this category +- **ID:** Record number in the database +- **Meta Description:** An optional paragraph to be used as the + description of the page in the HTML output. This will generally + display in the results of search engines. +- **Meta Keywords:** An optional comma-separated list of keywords and/or + phrases to be used in the HTML output. +- **Author:** The author of this content. +- **Robots:** (*Use Global*/*Index, Follow*/*No index, follow*/*Index, + No follow*/*No index, no follow*). Robots Instructions. + +### Permissions + + + +Manage the permission settings for the user groups below. See notes at +the bottom. + +- **Create:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Create for + users in the Public group. Create New setting for **create actions** + in this category and the calculated setting based on the parent + category and group permissions. +- **Delete:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Delete for + users in the Public group. Delete New setting for **delete actions** + on this category and the calculated setting based on the parent + category and group permissions. +- **Edit:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Edit for + users in the Public group. Edit New setting for **edit actions** on + this category and the calculated setting based on the parent category + and group permissions. +- **Edit State:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Edit + State for users in the Public group. Edit State New setting for **edit + state actions** on this category and the calculated setting based on + the parent category and group permissions. +- **Edit Own:** (*Inherited*/*Allowed*/*Denied*). Allow or deny Edit Own + for users in the Public group. Edit Own New setting for **edit own + actions** on this category and the calculated setting based on the + parent category and group permissions. + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +**User Notes: New Category**: The functions are: + +- **Save.** Saves the category and stays in the current screen. + + + +- **Save & Close**. Saves the category and closes the current screen. + + + +- **Save & New**. Saves the category and keeps the editing screen open + and ready to create another category. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Help**. Opens this help screen. + +**User Notes: Edit Category**: The functions are: + +- **Save.** Saves the category and stays in the current screen. + + + +- **Save & Close**. Saves the category and closes the current screen. + + + +- **Save & New**. Saves the category and keeps the editing screen open + and ready to create another category. + + + +- **Save as Copy**. Saves your changes to a copy of the current + category. Does not affect the current category. This toolbar icon is + not shown if you are creating a new category. + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. + + + +- **Associations**. With a specific language set for an article, allows + side by side editing in another language. + + + +- **Help**. Opens this help screen. + +## Related Information + +- [User Notes: New or + Edit](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit/en "Help4.x:User Notes: New or Edit/en") +- [User Notes: Users + Notes](https://docs.joomla.org/Help4.x:User_Notes/en "Help4.x:User Notes/en") +- [User Notes: + Categories](https://docs.joomla.org/Help4.x:User_Notes:_Categories/en "Help4.x:User Notes: Categories/en") +- To work with existing Categories: [Articles: + Categories](https://docs.joomla.org/Help4.x:Articles:_Categories/en "Help4.x:Articles: Categories/en") +- To work with Articles: + [Articles](https://docs.joomla.org/Help4.x:Articles/en "Help4.x:Articles/en") diff --git a/manuals/help/users/user-notes-new-or-edit.md b/manuals/help/users/user-notes-new-or-edit.md new file mode 100644 index 0000000..a3dab8b --- /dev/null +++ b/manuals/help/users/user-notes-new-or-edit.md @@ -0,0 +1,80 @@ +--- +sidebar_position: 5 +id: user-notes-new-or-edit +title: "Help4.x:User Notes: New or Edit" +--- +## Description + +User notes are pieces of information which can be assigned to registered +users on your Joomla! site. For example, user notes can contain comments +about 'offending' or 'difficult' users etc. + +In this screen you can create a new user note or edit an existing user +note. The 'editor' will be the chosen 'editor' for the user editing the +note. Examples: TinyMCE, JCE or Codemirror + +## How to access + +- Select **Users **→** User Notes** from the Administrator menu. Then... + - Select **New** from the Toolbar to create a new note. Or... + - Select a link from the **Subjects** column to edit an existing note. +- Or Select **Users **→** Manage** from the Administrator menu. Then... + - Search for a user by Username or Email. Then... + - Select **Add a Note** to create a new note. Or... + - Select **Show Notes List** from the drop-down list, only shown if + notes exist for this user. Or... + - Select **Display Note** from the drop-down list to show notes in a + popup window. + +## Screenshot + +Help-4x-users-notes-en.png + +## Details + +- **Subject:** The subject line for the note. +- **User:** The user for the note. You can select an existing user +- **Category:** (*Uncategorised*). The category that this item is + assigned to. +- **Status:** (*Published*/*Unpublished*/*Archived*/*Trashed*). Set + publication status. +- **Review Date:** Review date is a manually entered date you can use as + fits in your workflow. Examples would be to put in a date that you + want to review a user or the last date you reviewed the user. +- **Version Note:** Enter an optional note for this version of the item. +- **Note:** Enter the note. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save:** Saves the user note and stays in the current screen. +- **Save & Close**. Saves the user note and closes the current screen. +- **Save & New**. Saves the user note and keeps the editing screen open + and ready to create another user note. +- **Save as Copy**. Saves your changes to a copy of the current user + note. Does not affect the current user note. This toolbar icon is not + shown if you are creating a new user note. +- **Versions:** Opens the Item Version History window to show any prior + versions of this item. This allows you to view older versions of this + item and, if desired, restore from an older version. See [Version + History](https://docs.joomla.org/Help4.x:Components_Version_History/en "Help4.x:Components Version History/en") + for more information. +- **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 + +- [TinyMCE - the default WYSIWYG + Editor](https://docs.joomla.org/Help4.x:TinyMCE/en "Help4.x:TinyMCE/en") +- [User + Notes](https://docs.joomla.org/Help4.x:User_Notes/en "Help4.x:User Notes/en") +- [User Notes: New or Edit + Category](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit_Category/en "Help4.x:User Notes: New or Edit Category/en") +- [User Notes: + Categories](https://docs.joomla.org/Help4.x:User_Notes:_Categories/en "Help4.x:User Notes: Categories/en") diff --git a/manuals/help/users/user-notes.md b/manuals/help/users/user-notes.md new file mode 100644 index 0000000..4c90fe0 --- /dev/null +++ b/manuals/help/users/user-notes.md @@ -0,0 +1,130 @@ +--- +sidebar_position: 3 +id: user-notes +title: "Help4.x:User Notes" +--- +## Description + +User notes are pieces of information which can be assigned to registered +users on your Joomla! site. For example, user notes can contain comments +about 'offending' or 'difficult' users, etc. + +The User Notes screen presents a list of existing notes. + +## How to Access + +- Select **Users **→** User Notes** from the Administrator menu. +- Or Select the **Users Dashboard Icon** from the Administrator menu. + Then ... + - Select **User Notes** from the Miscellaneous panel. + +## Screenshot + +Help-4x-users-user-notes-en.png + +## Column Headers + +In the table containing the user notes assigned to users registered on +your Joomla! site, you will see different columns. Here you can read +what they mean and what is displayed in that column. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. +- **Status**. (Published/Unpublished/Archived/Trashed) The published + status of the item. +- **Subject**. The subject of the user note. +- **User**. The name of the user. +- **Review date**. The date when the user note was created. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +Near the top of the page you will see the filter bar shown in the +Screenshot above. The functions are: + +- **Select Status**. Select the desired status (Published, Unpublished, + Archived, Trashed or All) to limit the list based on note status. + Select "- Select State -" to list all notes regardless of its status. +- **Select Category**. Select a "Category" to list only notes in the + category. Select "- Select Category -" to list all notes in any + "Category". +- **Select Max Levels**. Select the maximum deep of the levels in a + category to list notes. Select "- Select Max Levels -" to list all + notes with any level. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new user note. + + + +- **Actions:** Reveals a list of actions for selected Items. Check one + or more Item checkboxes to activate the list. +- **Publish.** Makes the selected user notes available to administrators + of your website. +- **Unpublish.** Makes the selected user notes not available to + administrators of your website. + + + +- **Archive**. Changes the status of the selected user notes to indicate + that they are archived. Archived user notes can be moved back to the + published or unpublished state by selecting 'Archived' in the 'Select + Status' filter and changing the status of the user notes. + + + +- **Check-In**. Checks-in the selected user notes. Works with one or + multiple user notes selected. + + + +- **Trash**. Changes the status of the selected user notes to indicate + that they are trashed.Trashed user notes can still be recovered by + selecting 'Trashed' in the 'Select Status' filter and changing the + status of the articles to Published or Unpublished as preferred.To + permanently delete trashed user notes, select 'Trashed' in the 'Select + Status' filter, select the user notes to be permanently deleted, then + click the 'Empty Trash' toolbar icon. + + + +- **Help**. Opens this help screen. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + +## Quick Tips + +- Click on the subject to edit the user note properties. + +## Related information + +- [User Notes: New or + Edit](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit/en "Help4.x:User Notes: New or Edit/en") +- [User Notes: New or Edit + Category](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit_Category/en "Help4.x:User Notes: New or Edit Category/en") +- [User Notes: + Categories](https://docs.joomla.org/Help4.x:User_Notes:_Categories/en "Help4.x:User Notes: Categories/en") +- [Users: + Options](https://docs.joomla.org/Help4.x:Users:_Options/en "Help4.x:Users: Options/en") diff --git a/manuals/help/users/users-edit-profile.md b/manuals/help/users/users-edit-profile.md new file mode 100644 index 0000000..d11bb16 --- /dev/null +++ b/manuals/help/users/users-edit-profile.md @@ -0,0 +1,229 @@ +--- +sidebar_position: 8 +id: users-edit-profile +title: "Help4.x:Users: Edit Profile" +--- +## Description + +The User Edit screen is used to create a new user or edit an existing +user. + +## How to access + +To edit an existing user: + +- Select **Users **→** Manage** from the Administrator menu. Then... + - Search for the required user and select the name link in the + **Name** column. + +To create a new user: + +- Select **Users **→** Manage** from the Administrator menu. Then... + - Select the **New** button in the Toolbar. +- Or... Select **Users **→** Manage **→** Plus icon** from the + Administrator menu. +- Or... Select **Users **→** Dashboard icon** from the Administrator + menu. Then... + - Select the **Plus** icon from the Users panel. +- Or... Select **Home Dashboard **→** Site Panel **→** Users Plus icon** + starting from the Administrator menu. + +## Screenshot + + + +## Form Fields + +### Account Details + +- **Name**. Enter the name of the user. +- **Login Name**. Enter the login name (Username) for the user. +- **Password**. Fill in a (new) password. Although this field is not + required, the user will not be able to log in when no password is set. +- **Confirm Password**. Fill in the password from the field above again, + to verify it. This field is required when you filled in the New + password field. +- **Email**. Enter an email address for the user. +- **Registration Date**. Registration Date of the user. +- **Last Visit Date**. Date the user visited the site last time. +- **Last Reset Date**. Date and time of last password reset. +- **Password Reset Count**. Number of password resets since starting the + last reset time. +- **Receive System Emails**. (*Yes*/*No*) If set to yes, the user will + receive system emails. +- **User Status**. (*Blocked*/*Enabled*) Enable or block this user. +- **Require Password Reset**. (*Yes*/*No*) If set to yes, the user will + have to reset their password the next time they log into the site. +- **ID**. Record number in the database. + +### Assigned User Groups + + + +### Basic Settings + + + +- **Backend Template Style**. (*Use Default*/*Hathor - Default*/*isis - + Default*) Select the template style for the Administrator Backend + interface. This will only affect this User. +- **Backend Language**. (*Use Default*/*English (United Kingdom)*) + Select the Language for the Administrator Backend interface. This will + only affect this User. +- **Frontend Language**. (*Use Default*/*English (United Kingdom)*) + Select the Language for the frontend interface. This will only affect + this User. +- **Editor**. (*Use Default*/*Editor - CodeMirror*/*Editor - + None*/*Editor - TinyMCE*) Editor for this user. +- **Time Zone**. (*Use Default*/*Abidjan*/*Accra*/*Addis + Ababa*/*Algiers*/*Asmara*/...) Time zone for this user. + +### Accessibility Settings + + + +- **Monochrome**. Yes/No +- **High Contrast**. Yes/No +- **Highlight Links**. Yes/No +- **Increase Font Size**. Yes/No + +### User Actions Log Options *(tab available for Super Users only)* + + + +- **Send notifications for User Actions Log**. (*Yes/No*) If set to yes, + the User will receive user actions log notification by email +- **Select events to be notified for**. Select the user actions log + notifications to be sent by email. + +### W3C Web Authentication (WebAuthn) Login + +This tab is only present when the site is accessed using https. To set +up passwordless login you need a hardware device, available from Amazon +and similar outlets for about £15, or a device with fingerprint or face +recognition or similar biometric software. You may add more than one +authenticator. Once set up, you can login by clicking the Web +Authentication button in the Login form and then pressing the button on +the device when prompted. + +This tab is present but cannot be used in the User edit form because +passwordless login can only be set up by the individual user via the +Edit Profile form. + +### Joomla API Token + +This tab is used to manage the security tokens used for authenticating +to the Joomla API application (remote access to your site). If you are +not sure what this does chances are you don't need it and can safely +ignore these settings. + +The token is only visible for your own account. + +### Multi-factor Authentication + +This tab allows you to set one or more methods to allow access to your +account after login with Username and Password. It is only present when +editing your own profile. There are several methods available. If you +lose access to one method for any reason you can choose another method +from the post-login verification screen. The alternative mthods must +have been set up in advance! + +#### Backup Codes + +This method generates a set of numbers that you can save or print. Each +number can be used only once, so remember to amend your list after use. + +#### Verification code + +An extra form to fill out with alternative methods of setting up the +code. Have a look and click the Cancel button if you decide not to +proceed. + +#### Yubi Key + +This is for another type of hardware key that provides a code on a +screen display. Have a look and select Cancel if you decide not to +proceed. + +#### Web Authentication + +For a hardware device with a button to press. Have a look and select +Cancel if you decide not to proceed. Note that this method will be +bypassed if you use the separate WebAuthn Login method. + +#### Code by Email + +With this method a code is sent to your email address. You will be +prompted to enter that code to gain site access. It is a one-time code. +A new one is sent for every login. Have a look and select Cancel if you +decide not to proceed. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Cancel**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. Or + + + +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. This + toolbar icon is not shown if you are creating a new item. +- **Activate & Send Email.** Activate the user and send an email + notifying that their account has been activated. -OR- +- **Send Activation Reminder.** An email will be sent to the user + notifying that their account has been activated + + + +- **Help**. Opens this help screen. + +## Quick tips + +- Name, Login Name, and Email are required. +- If you did not fill in a particular language, editor, help site and/or + time zone, the default settings from the Global Configuration, + Language Manager and/or Template Manager are set. + +## Related information + +- [Users](https://docs.joomla.org/Help4.x:Users/en "Help4.x:Users/en") +- [Users: + Groups](https://docs.joomla.org/Help4.x:Users:_Groups/en "Help4.x:Users: Groups/en") +- [ACL Tutorial for Joomla! + 3.x](https://docs.joomla.org/J3.x:Access_Control_List_Tutorial/en "J3.x:Access Control List Tutorial/en") diff --git a/manuals/help/users/users-edit-viewing-access-level.md b/manuals/help/users/users-edit-viewing-access-level.md new file mode 100644 index 0000000..65e54f5 --- /dev/null +++ b/manuals/help/users/users-edit-viewing-access-level.md @@ -0,0 +1,87 @@ +--- +sidebar_position: 9 +id: users-edit-viewing-access-level +title: "Help4.x:Users: Edit Viewing Access Level" +--- +## Description + +Access levels control which users can view which objects on your site. +Objects include menu items, modules, categories, and component items +(articles, contacts, and so on). Each object in the site is assigned to +one access level. User groups are also assigned to each access level. + +If a user is a member of a group that in turn has permission for an +access level, then that user can view all objects assigned to that +access level. It is important to understand that user groups can be +arranged in a parent-child hierarchy. If so, then a child group has +access to all access levels that the parent group has access to. So you +don't need to assign a child group access to levels that its parent +group already has access to. + +## How to access + +- Select **Users **→** Access Levels** from the Administrator menu. + Then... + - Select a link from the **Level Name** column to edit an existing + level. Or... + - Select the New button to create a new access level. + +## Screenshot + + + +## Level Details + +- **Level Title:** Enter a Title for this Access level. +- **User Groups With Viewing Access** Check any Group to have this + Access Level. + +## User Groups With Viewing Access + +Select a check box to add a user group to a viewing level. In the +example shown all Groups are childs of Public so it not necessary to +check any of the child groups. They inherit the Public access +permissions. This feature should only be used for custom groups! + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Cancel**. 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 + +- If you add a new group, you may need to edit any access levels that + this group should have access to. + +## Related information + +- [Users: Viewing Access + Levels](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en") +- [User Manager: User: + Groups](https://docs.joomla.org/Help4.x:Users:_Groups/en "Help4.x:Users: Groups/en") +- [ACL Tutorial for Joomla! + 3.x](https://docs.joomla.org/J3.x:Access_Control_List_Tutorial/en "J3.x:Access Control List Tutorial/en") diff --git a/manuals/help/users/users-groups.md b/manuals/help/users/users-groups.md new file mode 100644 index 0000000..2d7bad7 --- /dev/null +++ b/manuals/help/users/users-groups.md @@ -0,0 +1,99 @@ +--- +sidebar_position: 10 +id: users-groups +title: "Help4.x:Users: Groups" +--- +## Description + +User Groups control what actions a user may take on the site and which +objects a user can view. This screen allows you to create, view, edit, +and delete User Groups. + +## How to access + +- Select **Users **→** Groups** from the Administrator menu. + +## Screenshot + + + +## Column Headers + +In the table containing the users from your Joomla! site, you will see +different columns. Here you can read what they mean and what is +displayed in that column. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. +- **Group Title**. The name of the group. +- **Permissions**. Link to The Advanced Permissions Report which maps + out the exact permissions for any given user group across all assets + on your Joomla! installation. +- **Enabled users**. (Tick) The number of enabled users in this group. +- **Disabled users**. (X) The number of disabled users in this group. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +At the top you will see the search bar shown in the Screenshot above. +The functions are: + +- **Search**. Filter by Partial Group Name or Group ID. Enter part of + the group's name and press the Search icon to find matching names. + Press Clear to clear the search field and restore the list of groups. + +## Toolbar + +At the top you will see the toolbar shown in the Screenshot above. The +functions are: + +- **New**. Opens the editing screen to create a new user group. + + + +- **Delete:** Deletes the selected user groups. Works with one or + multiple user groups selected. If you delete a group that has users + assigned to it, those users will lose the permissions they had from + that group. It is recommended to remove all users from a group before + you delete the group. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- Click on the name of a group to edit the group's properties. + +## Related information + +- [Users: New or Edit + Group](https://docs.joomla.org/Help4.x:Users:_New_or_Edit_Group/en "Help4.x:Users: New or Edit Group/en") +- [Users: + Options](https://docs.joomla.org/Help4.x:Users:_Options/en "Help4.x:Users: Options/en") +- [Users](https://docs.joomla.org/Help4.x:Users/en "Help4.x:Users/en") +- [Users: Viewing Access + Levels](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en") +- [ACL Tutorial for Joomla! + 3.x](https://docs.joomla.org/J3.x:Access_Control_List_Tutorial/en "J3.x:Access Control List Tutorial/en") diff --git a/manuals/help/users/users-new-or-edit-group.md b/manuals/help/users/users-new-or-edit-group.md new file mode 100644 index 0000000..4d9d8fa --- /dev/null +++ b/manuals/help/users/users-new-or-edit-group.md @@ -0,0 +1,95 @@ +--- +sidebar_position: 11 +id: users-new-or-edit-group +title: "Help4.x:Users: New or Edit Group" +--- +## Description + +Joomla! is installed with set of User Groups suitable for management of +standard sites. The default groups should not be edited! New groups can +be created for special purposes. For example, you may wish to create a +group allowed access to one component only. + +## How to access + +- Select **Users **→** Groups** from the Administrator menu. Then... + - Select the **New** button from the Toolbar. Or... + - Select a link from the **Group Title** column to edit an existing + group. + +## Screenshot + + + +## User Group Details + +- **Group Title:** Enter a Title for the Group. +- **Group Parent:** + (*Public*/*Guest*/*Manager*/*Administrator*/*Registered*/*Author*/*Editor*/...). + Choose a Parent for this Group. + +User Groups control what actions a user can take on the site. Actions +include things like creating a new article, changing options for a +component, or logging in. The site administrator assigns permissions for +various actions to each group. Permissions for actions can be assigned +at different levels in the component hierarchy (Global Configuration, +component options, categories, and articles). If a user does not have +permission for a given action, the user cannot perform that action. + +User groups also control which objects a user can view on the site. +Objects include categories, articles, modules, menu items, and others. +When you create an access level, one or more user groups are assigned to +it. Then, when you create an object (such as a menu item or module), the +object is assigned an access level. If a user is a member of a group +that is assigned to an access level, this user can view any object +assigned to that access level. If not, then that user cannot view that +object. + +User groups can be arranged in a hierarchy. If so, then all child groups +inherit the action permissions and access levels of a parent group. If +used wisely, this feature can save a lot of time setting up your +security system, since it means that you don't have to enter duplicate +setup information. + +## Toolbar + +At the top you will see the toolbar shown in the Screenshot above. The +functions are: + +- **Save**. Saves the item and stays in the current screen. + + + +- **Save & Close**. Saves the item and closes the current screen. + + + +- **Save & New**. Saves the item and keeps the editing screen open and + ready to create another item. + + + +- **Cancel**. 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 + +- If a new group will have similar permissions to an existing group, you + can save work by making the new group a child of the existing group. + That way, you only need to change the permissions that are different + for the new group. + +## Related information + +- [Users: + Groups](https://docs.joomla.org/Help4.x:Users:_Groups/en "Help4.x:Users: Groups/en") +- [ACL Tutorial for Joomla! + 3.x](https://docs.joomla.org/J3.x:Access_Control_List_Tutorial/en "J3.x:Access Control List Tutorial/en") diff --git a/manuals/help/users/users-options.md b/manuals/help/users/users-options.md new file mode 100644 index 0000000..8df2c34 --- /dev/null +++ b/manuals/help/users/users-options.md @@ -0,0 +1,292 @@ +--- +sidebar_position: 12 +id: users-options +title: "Help4.x:Users: Options" +--- +## Description + +User Options set globally for all users include + +- Captcha, +- registration allowed and type of registration, +- default user group for new users, +- reset password or username counter, +- new user registration email notice to administration and more. + +## How to Access + +**Users **→** Manage** + +- click the **Options** toolbar button + +## Screenshot + + + +## Form Fields + +### User Options + +- **Allow User Registration**. + - Yes: Users can register from the Frontend of the site using the + 'Create an Account' link provided on the [Login + module](https://docs.joomla.org/Help4.x:Site_Modules:_Login/en "Special:MyLanguage/Help4.x:Site Modules: Login/en"). + - No: The 'Create an Account' link will not show. +- **New User Registration Group**. The + [group](https://docs.joomla.org/Help4.x:Users:_Groups/en "Special:MyLanguage/Help4.x:Users: Groups/en") + that users are assigned to by default when they register on the site. + Defaults to 'Registered'. +- **Guest User Group**. The group that guests are assigned to (Guests + are visitors to the site who are not logged in). It is possible to + create content on the site that is visible to guests but not visible + to logged in users. Learn + more. +- **Send Password**. If set to 'Yes' the user's first password will be + emailed to the user as part of the registration mail. +- **New User Account Activation**. + - None: User account will be active immediately with no action + required. + - Self: User will receive an email with an activation link. The + account will be activated when the user clicks the activation link. + - Administrator: User will receive an email with an activation link. + When the user clicks this link, the Site Admin will be notified via + email and the Site Admin needs to activate the user's account. +- **Send Mail to Administrators**. Send email notification to + administrators with 'New User Account Activation' set to 'None' or + 'Self'. +- **Captcha**. Use + [Captcha](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#captcha "Special:MyLanguage/Help4.x:Site Global Configuration/en") + for User Account Registration, User Password reminder and Username + reminder. +- **Frontend User Parameters**. + - Show: Users will be able to modify their [Basic + Settings](https://docs.joomla.org/Help4.x:Users:_Edit_Profile/en#basicssettings "Special:MyLanguage/Help4.x:Users: Edit Profile/en") + from the Frontend of the site. + - Hide: User will not be able to change these settings. + - Frontend Language. Default site language. +- **Change Username**. Allow user to change Username. + +### Email Domain Options + + + +- **Domain Name**. Enter a list of allowed and disallowed email domains. + By default, all domains are allowed.Wildcards (\*) are supported. For + example: + - \* (Asterisk): Allows or disallows all domains + - \*.com: Allows or disallows all '.com' domains + - \*.joomla.org: Allows or disallows all 'joomla.org' subdomains. +- **Rule** Select whether to allow or disallow the domain. + +### Password Options + + + +- **Maximum Reset Count**. The maximum number of password resets allowed + within the time period. Zero indicates no limit. +- **Reset Time**. The time period, in hours, for the reset counter. +- **Minimum Lenght**. Set the minimum lenght for a password. +- **Minimum Integers**. Set the minimum number of integers that must be + included in a password. +- **Minimum Symbols**. Set the minimum number of symbols (such as !@#\$) + required in a password. +- **Minimum Upper Case**. Set the minimum number of upper case + alphabetical characters required for a password. +- **Minimum Lower Case**. Set the minimum number of lower case + alphabetical characters required for a password. + +### Multi-factor Authentication + + + +- **Allowed frontend module positions**. When displaying the frontend + Multi-factor Authentication page all modules will be hidden except + those in the positions selected here. +- **Show title in frontend**. Display a title in the frontend + Multi-factor Authentication verification page? Please note that the + title is always displayed in the backend. If you need to change the + title please override the language key 'COM_USERS_HEADING_MFA' using + [Languages: + Overrides](https://docs.joomla.org/Help4.x:Languages:_Overrides/en "Special:MyLanguage/Help4.x:Languages: Overrides/en"). +- **Allowed backend module positions**. When displaying the backend + Multi-factor Authentication page all modules will be hidden except + those in the positions selected here. Please note that modules in the + 'title' position are always shown: this is required to show the + backend page icon and title. +- **Disable Multi-factor Authentication**. Any user who belongs in *any* + of the selected user groups will be exempt from Multi-factor + Authentication. Even if they have set up Multi-factor Authentication + methods they will not be asked to use them when they are logging in, + nor will they be able to view them, remove them, or change their + configuration. +- **Enforce Multi-factor Authentication**. Any user who belongs in *any* + of the selected user groups will be required to enable Multi-factor + Authentication before being able to use the site. +- **Frontend template style**. Choose the frontend template style to use + in the Multi-factor Authentication page. Select 'Use Default" to use + the default site template style. +- **Multi-factor Authentication after silent login**. Should the user + have to go through Multi-factor Authentication after a silent user + login? Silent logins are those which do not require a username and + password for example the Remember Me feature, WebAuthn etc. +- **Silent login authentication response types (for experts)**. For + experts. A comma–separated list of Joomla authentication response + types which are considered silent logins. The default is 'cookie' (the + Remember Me feature) and 'passwordless' (WebAuthn). +- **Onboard new users**. If the user has not yet set up Multi-factor + Authentication and this option is enabled they will be redirected to + the Multi-factor Authentication setup page or the custom URL you set + up below. This is meant to be a simple way to to let your users know + that Multi-factor Authentication is an option on your site. +- **Custom redirection URL**. If it's not empty redirects to this URL + instead of the Multi-factor Authentication setup page when the option + above is enabled.Warning: This must be a URL inside your site. You + cannot log in to an external link or to a different subdomain. + +### User Notes History + + + +- **Enable Versions**. Save version history for User Notes. +- **Maximum Versions**. The maximum number of versions to store for a + User Note. If a User Note is saved and the maximum number of versions + has been reached, the oldest version will be deleted automatically. If + set to 0, then versions will never be deleted automatically. [Learn + more.](https://docs.joomla.org/Help4.x:Components_Version_History/en "Special:MyLanguage/Help4.x:Components Version History/en") + +### Mass Mail Users + + + +- **Subject Prefix**. Enter optional text to be inserted automatically + before the subject of the mass email. +- **Mailbody Suffix**. Enter optional text to be inserted automatically + after the body of the email (for example, a signature). + +### Integration + + + +- **Enable Custom Fields**. Enable the creation of custom fields. + +### Permissions + +This section lets you set up the default [Access Control +List](https://docs.joomla.org/Access_Control_List/en "Special:MyLanguage/Access Control List/en") +permissions for all users. + + + +To change the permissions for users, do the following. + +1. Select the **Group** by clicking its title located on the left. +2. Find the desired **Action**. + - **Configure ACL & Options**. Users can edit the options and + permissions. + - **Configure Options Only**. Users can edit the options exept the + permissions. + - **Access Administration Interface**. Users can access user + administration interface. + - **Create**. Users can create users. + - **Delete**. Users can delete users. + - **Edit**. Users can edit users. + - **Edit State**. User can change the published state and related + information. + - **Edit Custom Field Value**. Users can edit any value of custom + fields submitted in users. +3. Select the desired permission for the action you wish to change. + - **Inherited**. Inherited for users in this Group from the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#permissions "Special:MyLanguage/Help4.x:Site Global Configuration/en") + permissions. + - **Allowed**. Allowed for users in this Group.Note: 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 + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **Save**. Saves the users options and stays in the current screen. +- **Save & Close**. Saves the users options and closes the current + screen. +- **Close**. Closes the current screen and returns to the previous + screen without saving any modifications you may have made. +- **Toggle Inline Help**. Show help text below some options. +- **Help**. Opens this help screen. + +## Quick Tips + +If you are a beginning user, you can just keep the default values here +until you learn more about using global options. + +## Related Information + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| Users: Options | User Options configuration allows setting of parameters used globally for all users. Control the use of Captcha, registration allowed and type of registration, default user group new users, reset password or username counter, and new user registration email notice to administration. | +| [Users](https://docs.joomla.org/Help4.x:Users/en "Help4.x:Users/en") | The Users list is used to find, add, and edit users. | +| [Users: Viewing Access Levels](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en") | In this screen you have the ability to look at a list of your Access Levels and sort them in different ways. You can also edit and create Access Levels. | +| [Users: Edit Viewing Access Level](https://docs.joomla.org/Help4.x:Users:_Edit_Viewing_Access_Level/en "Help4.x:Users: Edit Viewing Access Level/en") | Access levels control which users can view which objects on your site. Objects include menu items, modules, categories, and component items (articles, contacts, and so on). Each object in the site is assigned to one access level. User groups are also assigned to each access level.If a user is a member of a group that in turn has permission for an access level, then that user can view all objects assigned to that access level. It is important to understand that user groups can be arranged in a parent-child hierarchy. If so, then a child group has access to all access levels that the parent group has access to. So you don't need to assign a child group access to levels that its parent group already has access to. | +| [Permissions for Group](https://docs.joomla.org/Help4.x:Permissions_for_Group/en "Help4.x:Permissions for Group/en") | The Debug Permissions report maps out the exact permissions for any given user group across all assets on your Joomla! installation. | +| [Permissions for User](https://docs.joomla.org/Help4.x:Permissions_for_User/en "Help4.x:Permissions for User/en") | The Debug Permissions report allows you to map out the exact permissions for any given user across all extensions on your Joomla installation. | +| [Users: Groups](https://docs.joomla.org/Help4.x:Users:_Groups/en "Help4.x:Users: Groups/en") | User Groups control what actions a user may take on the site and which objects a user can view. This screen allows you to create, view, edit, and delete User Groups. | +| [Users: New or Edit Group](https://docs.joomla.org/Help4.x:Users:_New_or_Edit_Group/en "Help4.x:Users: New or Edit Group/en") | User groups play a central role in what a user can do and see on the site. Creating user groups is normally the first step in setting up the security system for your site. | +| [Mass Mail Users](https://docs.joomla.org/Help4.x:Mass_Mail_Users/en "Help4.x:Mass Mail Users/en") | The Mass Mail screen allows Users who are members of the "Super Administrator" group to send an email message to registered users for the site. Users can be selected based on groups. | +| [Users: Edit Profile](https://docs.joomla.org/Help4.x:Users:_Edit_Profile/en "Help4.x:Users: Edit Profile/en") | In this screen, you have the ability to create a new user (if you clicked on the 'New' button in the User Manager), or edit an existing user (if you selected a user and clicked on the 'Edit' button in the User Manager, or clicked on the name of a user). | +| [User Notes: Categories](https://docs.joomla.org/Help4.x:User_Notes:_Categories/en "Help4.x:User Notes: Categories/en") | This screen allows you to look at a list of your user note categories and sort them in different ways. You can also edit and create user note categories and access levels. | +| [User Notes: New or Edit Category](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit_Category/en "Help4.x:User Notes: New or Edit Category/en") | This is where you can add a new Category or edit an existing Category. Categories are used to organize the User Notes. Categories allow you to display related User notes together on a page and to filter User Notes in the User Notes Manager. All User Notes are assigned either to a Category that you create or to the special Category called 'Uncategorized'. | +| [User Notes](https://docs.joomla.org/Help4.x:User_Notes/en "Help4.x:User Notes/en") | User notes are pieces of information which can be assigned to registered users on your Joomla! site. These notes can contain for example comments about 'offending' or 'difficult' users etc. | +| [User Notes:New or Edit](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit/en "Help4.x:User Notes: New or Edit/en") | In this screen you can create an user note or edit an user note. The 'editor' will be the chosen 'editor' for the user editing the note. Examples: TinyMCE - JCE - Codemirror. | +| [Menu Item: Password Reset](https://docs.joomla.org/Help4.x:Menu_Item:_Password_Reset/en "Help4.x:Menu Item: Password Reset/en") | Used to create a form which allows a user to reset their password with an email sent to the user's email associated with the account. | +| [Menu Item: User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_User_Profile/en "Help4.x:Menu Item: User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Edit User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_Edit_User_Profile/en "Help4.x:Menu Item: Edit User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Registration Form](https://docs.joomla.org/Help4.x:Menu_Item:_Registration_Form/en "Help4.x:Menu Item: Registration Form/en") | Used to create a default User Registration form for user registration. Default form contains basic information: Name, Username, Password, and Email Address. | +| [Menu Item: Username Reminder Request](https://docs.joomla.org/Help4.x:Menu_Item:_Username_Reminder_Request/en "Help4.x:Menu Item: Username Reminder Request/en") | Used to create a form which allows a user to request an e-mail with their username. | diff --git a/manuals/help/users/users-viewing-access-levels.md b/manuals/help/users/users-viewing-access-levels.md new file mode 100644 index 0000000..c62d237 --- /dev/null +++ b/manuals/help/users/users-viewing-access-levels.md @@ -0,0 +1,109 @@ +--- +sidebar_position: 13 +id: users-viewing-access-levels +title: "Help4.x:Users: Viewing Access Levels" +--- +## Description + +This screen shows a list of User Access Levels. + +## How to access + +Select **Users **→** Access Levels** from the Administrator menu. + +## Screenshot + + + +## Column Headers + +In the table containing the Access Levels from your Joomla! site, you +will see different columns. Here you can read what they mean and what is +displayed in that column. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Ordering:** (default). The column in which to sort displayed items + in the table. The values are the same as the column heading names. +- **Level Name**. The name of the access level. +- **User Groups Having Viewing Access**. The groups that have viewing + access. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +At the top you will see the filter bar shown in the Screenshot above. +The functions are: + +- **Search**. Enter part of the level's name and press the Search icon + to find matching names. Press 'Clear' to clear the search field and + restore the list of levels. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#Screenshot) above. The functions are: + +- **New**. Opens the editing screen to create a new access level. + + + +- **Edit**. Opens the editing screen for the selected access level. If + more than one access level is selected (where applicable), only the + first access level will be opened. The editing screen can also be + opened by clicking on the Name of the access level. + + + +- **Delete:** Deletes the selected access levels. Works with one or + multiple access levels selected. Note that you cannot delete an access + level that is currently being used. If you try to delete an access + level that is assigned, a message showing where it is assigned will be + displayed. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. + +## Quick Tips + +- Click on the name of an access level to edit it. +- Click on the Column Headers to sort the users by that column, + ascending or descending. + +## Related information + +- [Users: Edit Viewing Access + Level](https://docs.joomla.org/Help4.x:Users:_Edit_Viewing_Access_Level/en "Help4.x:Users: Edit Viewing Access Level/en") +- [Users: + Options](https://docs.joomla.org/Help4.x:Users:_Options/en "Help4.x:Users: Options/en") +- [Users](https://docs.joomla.org/Help4.x:Users/en "Help4.x:Users/en") +- [Users: + Groups](https://docs.joomla.org/Help4.x:Users:_Groups/en "Help4.x:Users: Groups/en") +- [ACL Tutorial for Joomla! + 3.x](https://docs.joomla.org/J3.x:Access_Control_List_Tutorial/en "J3.x:Access Control List Tutorial/en") diff --git a/manuals/help/users/users.md b/manuals/help/users/users.md new file mode 100644 index 0000000..e768505 --- /dev/null +++ b/manuals/help/users/users.md @@ -0,0 +1,197 @@ +--- +sidebar_position: 7 +id: users +title: "Help4.x:Users" +--- +## Description + +The Users list is used to find, add, and edit users. + +## How to access + +**Home Dashboard **→** Site **→** Users** + +To add a User: + +- click the **New** toolbar button + +To edit a User: + +- select a **Name** from the list + +## Screenshot + + + +## Column Headers + +- **Checkbox**. Check this box to select users. To select all users, + check the box in the column heading. After boxes are checked the + toolbar button 'Actions' get active. +- **Name**. The full name of the user. + - **Add a Note**. Create a Note for the user. + - **Show notes list**. Show the [User + Notes](https://docs.joomla.org/Help4.x:User_Notes/en "Special:MyLanguage/Help4.x:User Notes/en") + for the user as a list. + - **Display note**. Show the User Notes for the user in a window and + stays in the current screen. +- **Username**. The name the user will log in as. +- **Enabled**. Whether or not the user is enabled. +- **Activated**. Whether or not the user is activated. Normally when a + user registers from the Frontend, some type of activation is required. + This is controlled by the 'New User Account Activation' parameter in + the [Users: + Options](https://docs.joomla.org/Help4.x:Users:_Options/en#newuseraccountactivation "Special:MyLanguage/Help4.x:Users: Options/en"). +- **User Groups**. The list of groups that the user belongs to. Note + that a user may belong to more than one group. +- **Email**. The email address from the user is displayed here. +- **Last visit**. Here you can see the date on which the user last + logged in. +- **Registered**. The date the user was registered. +- **ID**. A unique identification number for this user, you cannot + change this number. + +## List Filters + +**Search bar**. Near the top of the page you will see the search bar +shown in the [Screenshot](#screenshot) above. + +- **Search by Text**. Enter part of the search term and click the Search + icon. *Hover* to see a *Tooltip* indicating which fields will be + searched.To 'Search by ID' enter "id:x", where "x" is the ID number + (for example, "id:19"). +- **Filter Options**. Click to display the additional filters. +- **Clear**. Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering**. Shows the current list ordering field. 2 ways to change + the order: + - Select from the dropdown list. Ordering may be in ascending or + descending order. + - Click a column heading. The column heading toggles between ascending + and descending order. +- **Number to Display**. Shows the number of users in a list. Select + from the dropdown list to change the number displayed.The default for + a site is '20' but this may be changed in the [Global + Configuration](https://docs.joomla.org/Help4.x:Site_Global_Configuration/en#defaultlistlimit "Special:MyLanguage/Help4.x:Site Global Configuration/en"). + +### Filter Options + +Near the top of the page you will see the filter bar shown in the +[Screenshot](#screenshot) above. + +- **Select State**. Select from Enabled / Disabled. +- **Select Active State**. Select from Activated / Unactivated. +- **Select Group**. Select from the list box to list only users who are + members of that group. +- **Select Last Vist Date**. Select from a list to show only users who + visited in a selected time frame. +- **Select Registration Date**. Select from a list to show only users + who registered in a selected time frame. + +### Pagination + +**Page Controls**. When the number of articles is more than one page, +you will see a page control bar near the bottom of the page shown in the +[Screenshot](#screenshot) above. The current page number being viewed +has a dark colour background. + +- **Start**. Click to go to the first page. +- **Prev**. Click to go to the previous page. +- **Page numbers**. Click to go to the desired page. +- **Next**. Click to go to the next page. +- **End**. Click to go to the last page. + +## Toolbar + +At the top of the page you will see the toolbar shown in the +[Screenshot](#screenshot) above. + +- **New**. Opens the editing screen to create a new user. +- **Actions**. Reveals a list of actions for selected users. Check one + or more users checkboxes to activate the list. + - **Activate**. Activates multiple users. Select all the users + required using their checkboxes then click this button. An email + will be sent to the user notifying that their account has been + activated + - **Block**. Blocks one or more users. Select the users to be blocked + using their checkboxes then click this button. + - **Unblock**. Unblocks one or more users. Select the users to be + unblocked using their checkboxes then click this button. + - **Batch**. Batch processes the selected users. + - **Delete**. Deletes the selected users. +- **Options**. Opens [Users: + Options](https://docs.joomla.org/Help4.x:Users:_Options/en "Special:MyLanguage/Help4.x:Users: Options/en"). +- **Help**. Opens this help screen. + +## Batch Process + +The Batch Process allows a change in settings for a group of selected +users. + + + +**How to Batch Process** a group of users: + +1. Select one or more users on the list by checking the desired + checkboxes. +2. Click the Batch Toolbar button. +3. Set one or more of the following values: + - To change the **User Group**, select the desired new user group + from the Select Group list box. + - Choose to do the desired action. + - Add To Group + - Delete From Group + - Move To Group + - Decide if a **Password Reset** is wanted. +4. When all of the settings are entered, click on Process to perform + the changes. A message **"Batch process completed successfully."** + will show. + +## Quick Tips + +- Click on the name of a user to edit the user's properties. +- Click on the icon in the Enabled column to toggle between Enabled and + Disabled status. +- To understand user and group permissions, read: + Joomla 3.x + +## Related information + +- [Home + Dashboard](https://docs.joomla.org/Help4.x:Home_Dashboard/en "Special:MyLanguage/Help4.x:Home Dashboard/en"): + Access to many default Joomla functions. + +| | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Related Help Screens | Description | +| [Users: Options](https://docs.joomla.org/Help4.x:Users:_Options/en "Help4.x:Users: Options/en") | User Options configuration allows setting of parameters used globally for all users. Control the use of Captcha, registration allowed and type of registration, default user group new users, reset password or username counter, and new user registration email notice to administration. | +| Users | The Users list is used to find, add, and edit users. | +| [Users: Viewing Access Levels](https://docs.joomla.org/Help4.x:Users:_Viewing_Access_Levels/en "Help4.x:Users: Viewing Access Levels/en") | In this screen you have the ability to look at a list of your Access Levels and sort them in different ways. You can also edit and create Access Levels. | +| [Users: Edit Viewing Access Level](https://docs.joomla.org/Help4.x:Users:_Edit_Viewing_Access_Level/en "Help4.x:Users: Edit Viewing Access Level/en") | Access levels control which users can view which objects on your site. Objects include menu items, modules, categories, and component items (articles, contacts, and so on). Each object in the site is assigned to one access level. User groups are also assigned to each access level.If a user is a member of a group that in turn has permission for an access level, then that user can view all objects assigned to that access level. It is important to understand that user groups can be arranged in a parent-child hierarchy. If so, then a child group has access to all access levels that the parent group has access to. So you don't need to assign a child group access to levels that its parent group already has access to. | +| [Permissions for Group](https://docs.joomla.org/Help4.x:Permissions_for_Group/en "Help4.x:Permissions for Group/en") | The Debug Permissions report maps out the exact permissions for any given user group across all assets on your Joomla! installation. | +| [Permissions for User](https://docs.joomla.org/Help4.x:Permissions_for_User/en "Help4.x:Permissions for User/en") | The Debug Permissions report allows you to map out the exact permissions for any given user across all extensions on your Joomla installation. | +| [Users: Groups](https://docs.joomla.org/Help4.x:Users:_Groups/en "Help4.x:Users: Groups/en") | User Groups control what actions a user may take on the site and which objects a user can view. This screen allows you to create, view, edit, and delete User Groups. | +| [Users: New or Edit Group](https://docs.joomla.org/Help4.x:Users:_New_or_Edit_Group/en "Help4.x:Users: New or Edit Group/en") | User groups play a central role in what a user can do and see on the site. Creating user groups is normally the first step in setting up the security system for your site. | +| [Mass Mail Users](https://docs.joomla.org/Help4.x:Mass_Mail_Users/en "Help4.x:Mass Mail Users/en") | The Mass Mail screen allows Users who are members of the "Super Administrator" group to send an email message to registered users for the site. Users can be selected based on groups. | +| [Users: Edit Profile](https://docs.joomla.org/Help4.x:Users:_Edit_Profile/en "Help4.x:Users: Edit Profile/en") | In this screen, you have the ability to create a new user (if you clicked on the 'New' button in the User Manager), or edit an existing user (if you selected a user and clicked on the 'Edit' button in the User Manager, or clicked on the name of a user). | +| [User Notes: Categories](https://docs.joomla.org/Help4.x:User_Notes:_Categories/en "Help4.x:User Notes: Categories/en") | This screen allows you to look at a list of your user note categories and sort them in different ways. You can also edit and create user note categories and access levels. | +| [User Notes: New or Edit Category](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit_Category/en "Help4.x:User Notes: New or Edit Category/en") | This is where you can add a new Category or edit an existing Category. Categories are used to organize the User Notes. Categories allow you to display related User notes together on a page and to filter User Notes in the User Notes Manager. All User Notes are assigned either to a Category that you create or to the special Category called 'Uncategorized'. | +| [User Notes](https://docs.joomla.org/Help4.x:User_Notes/en "Help4.x:User Notes/en") | User notes are pieces of information which can be assigned to registered users on your Joomla! site. These notes can contain for example comments about 'offending' or 'difficult' users etc. | +| [User Notes:New or Edit](https://docs.joomla.org/Help4.x:User_Notes:_New_or_Edit/en "Help4.x:User Notes: New or Edit/en") | In this screen you can create an user note or edit an user note. The 'editor' will be the chosen 'editor' for the user editing the note. Examples: TinyMCE - JCE - Codemirror. | +| [Menu Item: Password Reset](https://docs.joomla.org/Help4.x:Menu_Item:_Password_Reset/en "Help4.x:Menu Item: Password Reset/en") | Used to create a form which allows a user to reset their password with an email sent to the user's email associated with the account. | +| [Menu Item: User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_User_Profile/en "Help4.x:Menu Item: User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Edit User Profile](https://docs.joomla.org/Help4.x:Menu_Item:_Edit_User_Profile/en "Help4.x:Menu Item: Edit User Profile/en") | Used to create a form which allows a user to edit their profile settings. | +| [Menu Item: Registration Form](https://docs.joomla.org/Help4.x:Menu_Item:_Registration_Form/en "Help4.x:Menu Item: Registration Form/en") | Used to create a default User Registration form for user registration. Default form contains basic information: Name, Username, Password, and Email Address. | +| [Menu Item: Username Reminder Request](https://docs.joomla.org/Help4.x:Menu_Item:_Username_Reminder_Request/en "Help4.x:Menu Item: Username Reminder Request/en") | Used to create a form which allows a user to request an e-mail with their username. | diff --git a/manuals/help/workflow/stages-list-basic-workflow.md b/manuals/help/workflow/stages-list-basic-workflow.md new file mode 100644 index 0000000..5c97c19 --- /dev/null +++ b/manuals/help/workflow/stages-list-basic-workflow.md @@ -0,0 +1,174 @@ +--- +sidebar_position: 1 +id: stages-list-basic-workflow +title: "Help4.x:Stages List: Basic Workflow" +--- +## Description + +The Publishing Workflow component is used to replace static states +(unpublished, published, trashed and archived) with a more generic +approach. This way you can easily create a customized workflow to manage +your articles within a component. + +For more information see the [Workflow +Tutorial](https://docs.joomla.org/J4.x:Workflow/en "J4.x:Workflow/en"). + +## How To Access + +- Enable Workflows in + **Content **→** Articles **→** Options **→** Integration Tab** from + the Administrator menu. Then... + - Select **Content **→** Workflows** in the Administrator menu. Then + ... + - Select the numbered Stage button. Then... + - Select the New button to create a new stage. Or... + - Select an item in the Name column to edit an existing stage. + +## Screenshot + + + +## Column Headings + +Click on the column heading to sort the list by that column's value. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. +- **Default.** If there is more than one workflow. Select to set the + default. + + + +- **Name:** The (full) name of the user. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +**Search bar.** This is a common feature of most Lists. The layout is as +shown below. + +Help-4x-colheader-filter-field-en.png + +- **Search by Text.** Enter part of the search term and click the Search + icon. The search may be of one or more fields. *Hover* to see a + *Tooltip* indicating which fields will be searched. In some cases a + different format is required. For Example, to **Search by ID** enter + "id:xx", where "xx" is the item ID number (for example, "id:9"). +- **Filter Options.** Click to display or hide the additional filters. +- **Clear.** Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering.** Shows the current table ordering field. Select from the + drop down list to change the order or click a column heading. Ordering + may be in ascending or descending order. The column heading toggles + between ascending and descending order. +- **Number to Display.** Shows the number of items in a list. The + default for a site is 20 but this may be changed in the global + configuration. Select from the drop-down list to change the number + displayed. If you select too many complex items they will be slow to + deliver and display. + +**Filter Options** + +- **Filter by published status.** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Back.** Go back to the previous page. + + + +- **New**. Opens the editing screen to create a new item. + + + +- **Actions:** Reveals a list of actions for selected Items. Check one + or more Item checkboxes to activate the list. + + + +- **Enable**. Makes the selected item available for use on your website. + + + +- **Disable**. Makes the selected items unavailable for use on your + website. + + + +- **Default:** Makes the selected item the default item. The default + star symbol + (Icon-16-default.png) will show in the Default + column, indicating that this is now the default item. + + + +- **Check-In**. Checks-in the selected items. Works with one or multiple + items selected. + + + +- **Trash**. Changes the status of the selected items to indicate that + they are trashed. Trashed items can still be recovered by selecting + "Trashed" in the Select Status filter and changing the status of the + items to Published or Unpublished as preferred. To permanently delete + trashed items, select "Trashed" in the Select Status filter, select + the items to be permanently deleted, then click the Empty Trash + toolbar icon. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/workflow/transitions-list-basic-workflow.md b/manuals/help/workflow/transitions-list-basic-workflow.md new file mode 100644 index 0000000..7ecfa68 --- /dev/null +++ b/manuals/help/workflow/transitions-list-basic-workflow.md @@ -0,0 +1,174 @@ +--- +sidebar_position: 2 +id: transitions-list-basic-workflow +title: "Help4.x:Transitions List: Basic Workflow" +--- +## Description + +The Publishing Workflow component is used to replace static states +(unpublished, published, trashed and archived) with a more generic +approach. This way you can easily create a customized workflow to manage +your articles within a component. + +For more information see the [Workflow +Tutorial](https://docs.joomla.org/J4.x:Workflow/en "J4.x:Workflow/en"). + +## How To Access + +- Enable Workflows in + **Content **→** Articles **→** Options **→** Integration Tab** from + the Administrator menu. Then... + - Select **Content **→** Workflows** in the Administrator menu. Then + ... + - Select the numbered button in the **Transitions** columns. + +## Screenshot + + + +## Column Headings + +Click on the column heading to sort the list by that column's value. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **Name:** The (full) name of the user. +- **Current Stage.** Default is All. +- **Target Stage.** Default is Basic Stage. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +**Search bar.** This is a common feature of most Lists. The layout is as +shown below. + +Help-4x-colheader-filter-field-en.png + +- **Search by Text.** Enter part of the search term and click the Search + icon. The search may be of one or more fields. *Hover* to see a + *Tooltip* indicating which fields will be searched. In some cases a + different format is required. For Example, to **Search by ID** enter + "id:xx", where "xx" is the item ID number (for example, "id:9"). +- **Filter Options.** Click to display or hide the additional filters. +- **Clear.** Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering.** Shows the current table ordering field. Select from the + drop down list to change the order or click a column heading. Ordering + may be in ascending or descending order. The column heading toggles + between ascending and descending order. +- **Number to Display.** Shows the number of items in a list. The + default for a site is 20 but this may be changed in the global + configuration. Select from the drop-down list to change the number + displayed. If you select too many complex items they will be slow to + deliver and display. + +**Filter Options** + +- **Filter by Status.** +- **Filter by Current Stage.** +- **Filter by Target Stage.** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Back.** Go back to the previous page. + + + +- **New**. Opens the editing screen to create a new item. + + + +- **Actions:** Reveals a list of actions for selected Items. Check one + or more Item checkboxes to activate the list. + + + +- **Enable**. Makes the selected item available for use on your website. + + + +- **Disable**. Makes the selected items unavailable for use on your + website. + + + +- **Default:** Makes the selected item the default item. The default + star symbol + (Icon-16-default.png) will show in the Default + column, indicating that this is now the default item. + + + +- **Check-In**. Checks-in the selected items. Works with one or multiple + items selected. + + + +- **Trash**. Changes the status of the selected items to indicate that + they are trashed. Trashed items can still be recovered by selecting + "Trashed" in the Select Status filter and changing the status of the + items to Published or Unpublished as preferred. To permanently delete + trashed items, select "Trashed" in the Select Status filter, select + the items to be permanently deleted, then click the Empty Trash + toolbar icon. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen. diff --git a/manuals/help/workflow/workflows-list.md b/manuals/help/workflow/workflows-list.md new file mode 100644 index 0000000..6f5b3b5 --- /dev/null +++ b/manuals/help/workflow/workflows-list.md @@ -0,0 +1,166 @@ +--- +sidebar_position: 3 +id: workflows-list +title: "Help4.x:Workflows List" +--- +## Description + +The Publishing Workflow component is used to replace static states +(unpublished, published, trashed and archived) with a more generic +approach. This way you can easily create a customized workflow to manage +your articles within a component. + +For more information see the [Workflow +Tutorial](https://docs.joomla.org/J4.x:Workflow/en "J4.x:Workflow/en"). + +## How To Access + +- Enable Workflows in + **Content **→** Articles **→** Options **→** Integration Tab** from + the Administrator menu. Then... + - Select **Content **→** Workflows** in the Administrator menu. + +## Screenshot + + + +## Column Headings + +Click on the column heading to sort the list by that column's value. + +- **Checkbox**. Check this box to select one or more items. To select + all items, check the box in the column heading. After one or more + boxes are checked, click a toolbar button to take an action on the + selected item or items. Many toolbar actions, such as Publish and + Unpublish, can work with multiple items. Others, such as Edit, only + work on one item at a time. If multiple items are checked and you + press Edit, the first item will be opened for editing. + + + +- **Ordering.** You can change the order of an item within a list as + follows: + - If the list Filter Options include a Position filter select the + desired Position. This will limit the list to items that are + assigned to that Position. + - Select the Ordering icon Help30-Ordering-colheader-icon.png in the Table + heading to make it the active ordering item. The ordering icons in + each row will change from light grey to dark grey and the pointer + will change to a drag arrow on hover. + - Select one of the Ordering icons Help30-Ordering-colheader-grab-bar-icon.png and + drag it up or down to change the position of that row in the list. + The items will display in the new order within the Position. + + + +- **Status**. The published status of the item. + + + +- **Name:** The (full) name of the user. +- **Default.** If there is more than one workflow. Select to set the + default. +- **Stages.** The number of stages in the workflow. Select to view the + stages list. +- **Transition.** The number of transitions. Select to view the + transitions list. + + + +- **ID**. This is a unique identification number for this item assigned + automatically by Joomla. It is used to identify the item internally, + and you cannot change this number. When creating a new item, this + field displays "0" until you save the new entry, at which point a new + ID is assigned to it. + +## List Filters + +**Search bar.** This is a common feature of most Lists. The layout is as +shown below. + +Help-4x-colheader-filter-field-en.png + +- **Search by Text.** Enter part of the search term and click the Search + icon. The search may be of one or more fields. *Hover* to see a + *Tooltip* indicating which fields will be searched. In some cases a + different format is required. For Example, to **Search by ID** enter + "id:xx", where "xx" is the item ID number (for example, "id:9"). +- **Filter Options.** Click to display or hide the additional filters. +- **Clear.** Click to clear the Filter field and restore the list to its + unfiltered state. +- **Ordering.** Shows the current table ordering field. Select from the + drop down list to change the order or click a column heading. Ordering + may be in ascending or descending order. The column heading toggles + between ascending and descending order. +- **Number to Display.** Shows the number of items in a list. The + default for a site is 20 but this may be changed in the global + configuration. Select from the drop-down list to change the number + displayed. If you select too many complex items they will be slow to + deliver and display. + +**Filter Options** + +- **Filter by published status.** + +## Toolbar + +At the top of the page you will see the toolbar shown in the Screenshot +above. The functions are: + +- **Actions:** Reveals a list of actions for selected Items. Check one + or more Item checkboxes to activate the list. + + + +- **Enable**. Makes the selected item available for use on your website. + + + +- **Disable**. Makes the selected items unavailable for use on your + website. + + + +- **Default:** Makes the selected item the default item. The default + star symbol + (Icon-16-default.png) will show in the Default + column, indicating that this is now the default item. + + + +- **Check-In**. Checks-in the selected items. Works with one or multiple + items selected. + + + +- **Trash**. Changes the status of the selected items to indicate that + they are trashed. Trashed items can still be recovered by selecting + "Trashed" in the Select Status filter and changing the status of the + items to Published or Unpublished as preferred. To permanently delete + trashed items, select "Trashed" in the Select Status filter, select + the items to be permanently deleted, then click the Empty Trash + toolbar icon. + + + +- **Options.** Opens the Options window where settings such as default + parameters can be edited. + + + +- **Help**. Opens this help screen.