Help310

Difference between revisions of "Menus Menu Item User Login"

From Joomla! Documentation

m (1 revision: Initial import of 3.0 help screens (derived from 2.5 help screens))
(Corrected succesful to successful and outsite to outside.)
 
(69 intermediate revisions by 5 users not shown)
Line 1: Line 1:
===Default Login Layout===
+
<noinclude><languages /></noinclude>
Allows a user to login to the site, as shown below.
 
[[Image:Menus-Menu-Item-User-Login-default-login-layout-output.png]]
 
  
'''Parameters - Basic'''
+
{{Chunk30:Help_screen_Description_Header/<translate><!--T:75--> en</translate>}}
The Default Login Layout has the following Basic Parameters, as shown below.[[Image:Menus-Menu-Item-default-login-layout-basic-parameters.png]]
+
<translate><!--T:88--> Used to create a 'Login Form' page for users to login to the website.</translate>
*'''Show Login Page Title.''' Hide or Show the Title of this Page.
 
*'''Login Page Title.''' Title to display as the Page Title. If blank, the Title of the Menu Item will be used.
 
*'''Login Redirection URL.''' The URL of the Page that the User will be redirected to after a successful login. If blank, the Front Page will be used.
 
*'''Login JS Message.''' Hide or Show the JavaScript pop-up that indicates a successful login.
 
*'''Login Description.''' Hide or Show the Login Description Text, entered below.
 
*'''Login Description Text.''' Text to display on a successful login. If blank, the variable "LOGIN_DESCRIPTION" will be used.
 
*'''Login Image.''' Image for the Login Page. This must be in the "images/stories" folder.
 
*'''Login Image Align.''' Align image to the left or right of the page.
 
*'''Show Logout Page Title.''' Hide or Show the Logout Page Title.
 
*'''Logout Page Title.''' Text to display at the top of the Page. If blank, the Menu Item Title will be used.
 
*'''Logout Redirection URL.''' The URL of the Page the User will be directed to after a successful logout. If blank, the Front Page will be used.
 
*'''Logout JS Message.''' Hide or Show the JavaScript pop-up that indicates a successful logout.
 
*'''Logout Description.''' Hide or Show the Logout Description Text, entered below.
 
*'''Logout Description Text.''' Text to display on a successful logout. If blank, the variable "LOGOUT_DESCRIPTION" will be used.
 
*'''Logout Image.''' Image for the Logout Page. This must be in the "images/stories" folder.
 
*'''Logout Image Align.''' Align image to the left or right of the page.
 
  
<noinclude>{{cathelp|3.0|Menu Item Manager Help Screens|Menus Help Screens}}</noinclude>
+
{{Chunk30:Help_screen_How_To_Access_Header/<translate><!--T:89--> en</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_Menu_Item_Add/<translate><!--T:78--> en</translate>|<translate><!--T:79--> Login Form</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_By_Menu/<translate><!--T:80--> en</translate>|<translate><!--T:81--> Menus,[name of the menu],Add New Menu Item</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_Menu_Item_Type_Select_Button/<translate><!--T:82--> en</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_Menu_Item_Type_Select/<translate><!--T:83--> en</translate>|<translate><!--T:84--> Users,Login Form</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_Menu_Item_Edit/<translate><!--T:85--> en</translate>|<translate><!--T:86--> Login Form</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_Menu_Item_By_Title/<translate><!--T:87--> en</translate>}}
 +
{{Chunk30:Help_screen_Screenshot_Header/<translate><!--T:77--> en</translate>}}
 +
[[File:Help30-Menus-Menu-Item-User-Login-<translate><!--T:10-->
 +
en</translate>.png|800px|border|none]]
 +
 
 +
{{Chunk30:Help_screen_Form_Header/<translate><!--T:90--> en</translate>}}
 +
{{Chunk30:Help_screen_Menu_Title/<translate><!--T:113--> en</translate>}}
 +
{{Chunk30:Help_screen_Alias/<translate><!--T:114--> en</translate>|<translate><!--T:115--> menu item</translate>}}
 +
{{Chunk30:Help_screen_Form_Details_Header/<translate><!--T:116--> en</translate>}}
 +
{{Chunk30:Help_screen_Menu_Item_Type/<translate><!--T:182--> en</translate>}}
 +
{{Chunk30:Help_screen_Menu_Link/<translate><!--T:183--> en</translate>}}
 +
{{Chunk30:Help_screen_Target_Window/<translate><!--T:184--> en</translate>}}
 +
{{Chunk30:Help_screen_Template_Style/<translate><!--T:185--> en</translate>}}
 +
----
 +
:[[File:Help30-menu-item-details-screenshot-<translate><!--T:162--> en</translate>.png|265px|border|right|<translate><!--T:163--> Menu item sidebar</translate>]]
 +
{{Chunk30:Help_screen_Menu/<translate><!--T:164--> en</translate>}}
 +
{{Chunk30:Help_screen_Parent_Item/<translate><!--T:165--> en</translate>}}
 +
{{Chunk30:Help_screen_Menu_Item_Ordering/<translate><!--T:166--> en</translate>}}
 +
{{Chunk30:Help_screen_Status/<translate><!--T:167--> en</translate>|<translate><!--T:168--> menu item</translate>|}}
 +
{{Chunk30:Help_screen_Default_Page/<translate><!--T:169--> en</translate>|<translate><!--T:170--> menu item</translate>}}
 +
{{Chunk30:Help_screen_Access/<translate><!--T:171--> en</translate>|<translate><!--T:172--> menu item</translate>}}
 +
{{Chunk30:Help_screen_Language/<translate><!--T:173--> en</translate>|<translate><!--T:174--> menu item</translate>}}
 +
{{Chunk30:Help_screen_Note/<translate><!--T:175--> en</translate>|<translate><!--T:176--> Menu item</translate>|<translate><!--T:177--> menu item</translate>}}
 +
{{Chunk30:Help_screen_Form_Options_Header/<translate><!--T:159--> en</translate>}}
 +
:[[File:Help30-Menus-Menu-Item-User-Login-basic-options-screenshot-<translate><!--T:19--> en</translate>.png|400px|none]]
 +
<translate><!--T:97--> *'''Choose Login Redirect Type'''.</translate>
 +
<translate><!--T:98--> **''Menu Item:'' Lets you directly select an existing menu item. For a multilingual site, it is recommended to use 'Menu Item'.</translate>
 +
<translate><!--T:99--> **''Internal URL:'' Lets you manually enter any internal URL in the Redirect field.</translate>
 +
<translate><!--T:100--> *'''Menu Item Login Redirect'''.  Select or create the page the user will be redirected to after a successful login. The default is to remain on the same page.</translate>
 +
<translate><!--T:101--> *'''Login Description'''.  (''Hide''/''Show'')  Show or Hide the login description.</translate>
 +
<translate><!--T:102--> *'''Login Description Text'''.  Enter text to display on Login page.</translate>
 +
<translate><!--T:103--> *'''Login Image'''.  Select or upload an image to display on Login page.</translate>
 +
----
 +
<translate><!--T:104--> *'''Choose Logout Redirect Type'''.</translate>
 +
<translate><!--T:105--> **''Menu Item:'' Lets you directly select an existing menu item. For a multilingual site, it is recommended to use 'Menu Item'.</translate>
 +
<translate><!--T:106--> **''Internal URL:'' Lets you manually enter any internal URL in the Redirect field.</translate>
 +
<translate><!--T:107--> *'''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.</translate>
 +
<translate><!--T:108--> *'''Logout Description'''.  (''Hide''/''Show'')  Show or Hide the logout description.</translate>
 +
<translate><!--T:109--> *'''Logout Description Text'''.  Enter text to display on Logout page.</translate>
 +
<translate><!--T:110--> *'''Logout Image'''.  Select or upload an image to display on Logout page.</translate>
 +
{{Chunk30:Help_screen_Form_Link_Type_Header/<translate><!--T:136--> en</translate>}}
 +
:[[File:Help30-Menus-Menu-Item-options-common-link-type-<translate><!--T:137--> en</translate>.png|400px|none]]
 +
{{Chunk30:Help_screen_Link_Title_Attribute/<translate><!--T:186--> en</translate>}}
 +
{{Chunk30:Help_screen_Link_Class/<translate><!--T:187--> en</translate>}}
 +
{{Chunk30:Help_screen_Link_Image/<translate><!--T:188--> en</translate>}}
 +
{{Chunk30:Help_screen_Image_Class/<translate><!--T:189--> en</translate>}}
 +
{{Chunk30:Help_screen_Add_Menu_Title/<translate><!--T:190--> en</translate>}}
 +
{{Chunk30:Help_screen_Display_In_Menu/<translate><!--T:191--> en</translate>}}
 +
{{Chunk30:Help_screen_Form_Page_Display_Header/<translate><!--T:144--> en</translate>}}
 +
:[[File:Help30-Menus-Menu-Item-options-common-page-display-<translate><!--T:145--> en</translate>.png|400px|none]]
 +
{{Chunk30:Help_screen_Menu_Item_Page_Display/<translate><!--T:146--> en</translate>}}
 +
{{Chunk30:Help_screen_Form_Metadata_Header/<translate><!--T:147--> en</translate>}}
 +
:[[File:Help30-Menus-Menu-Item-options-common-metadata-<translate><!--T:148--> en</translate>.png|400px|none]]
 +
{{Chunk30:Help_screen_Meta_Description/<translate><!--T:178--> en</translate>}}
 +
{{Chunk30:Help_screen_Meta_Keywords/<translate><!--T:179--> en</translate>}}
 +
{{Chunk30:Help_screen_Robots/<translate><!--T:180--> en</translate>}}
 +
{{Chunk30:Help_screen_Secure/<translate><!--T:181--> en</translate>}}{{Chunk30:Help_screen_Form_Module_Assignment_Header/<translate><!--T:155--> en</translate>}}
 +
:[[File:Help30-Menus-Menu-Item-options-common-module-assignment-<translate><!--T:156--> en</translate>.png|800px|none]]
 +
{{Chunk30:Help_screen_Menu_Item_Module_Assignment/<translate><!--T:157--> en</translate>}}
 +
{{Chunk30:Help_screen_Toolbar_Header/<translate><!--T:91--> en</translate>}}
 +
{{Chunk30:Help_screen_Toolbar_Position/<translate><!--T:111--> en</translate>}}
 +
:[[File:Help32-Save-SaveClose-SaveNew-SaveAsCopy-Close-toolbar-<translate><!--T:39--> en</translate>.png|800px|none]]
 +
{{Chunk30:Help_screen_Toolbar_Function/<translate><!--T:112--> en</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Save/<translate><!--T:41--> en</translate>|<translate><!--T:42--> menu item</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_SaveAndClose/<translate><!--T:43--> en</translate>|<translate><!--T:44--> menu item</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_SaveAndNew/<translate><!--T:45--> en</translate>|<translate><!--T:46--> menu item</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_SaveAsCopy/<translate><!--T:73--> en</translate>|<translate><!--T:74--> menu item</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Close/<translate><!--T:47--> en</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Help/<translate><!--T:48--> en</translate>}}
 +
{{Chunk30:Help_screen_Frontend_Screenshot_Header/<translate><!--T:158--> en</translate>}}
 +
{{Chunk30:Help_screen_screenshot_disclaimer/<translate><!--T:50--> en</translate>}}
 +
 
 +
<translate><!--T:51--> '''User Login shown'''</translate>
 +
:[[File:Help30-Menus-Menu-User-Login-front-end-screenshot-<translate>
 +
<!--T:52-->
 +
en</translate>.png|600px|none]]
 +
 
 +
{{Chunk30:Help_screen_Quick_Tips_Header/<translate><!--T:92--> en</translate>}}
 +
<translate><!--T:54--> 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.</translate>
 +
{{Chunk30:Help_screen_Related_Information_Header/<translate><!--T:93--> en</translate>}}
 +
<!--
 +
Put the next statement outside this comment to check if there are new rows needed (or old deleted) in the table under this comment It lists related documents):
 +
{{relatedhelp|Menu_Item_User|not=/}}
 +
If you find new ones please add them to the table.
 +
-->
 +
 
 +
{| class="wikitable"
 +
|-
 +
! <translate><!--T:61-->
 +
Related Help Screens</translate> !! <translate><!--T:62-->
 +
Description</translate>
 +
|-
 +
| [[S:MyLanguage/Help310:Menus_Menu_Item_User_Password_Reset|<translate><!--T:63-->
 +
Menus Menu Item User Password Reset</translate>]] || <translate><!--T:64-->
 +
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.</translate>
 +
|-
 +
| [[S:MyLanguage/Help310:Menus_Menu_Item_User_Profile|<translate><!--T:65-->
 +
Menus Menu Item User Profile</translate>]] || <translate><!--T:66-->
 +
Used to create a form which allows a user to edit their profile settings.</translate>
 +
|-
 +
| [[S:MyLanguage/Help310:Menus_Menu_Item_User_Profile_Edit|<translate><!--T:67-->
 +
Menus Menu Item User Profile Edit</translate>]] || <translate><!--T:68-->
 +
Used to create a form which allows a user to edit their profile settings.</translate>
 +
|-
 +
| [[S:MyLanguage/Help310:Menus_Menu_Item_User_Registration|<translate><!--T:69-->
 +
Menus Menu Item User Registration</translate>]] || <translate><!--T:70-->
 +
Used to create a default User Registration form for user registration. Default form contains basic information: Name, Username, Password, and Email Address.</translate>
 +
|-
 +
| [[S:MyLanguage/Help310:Menus_Menu_Item_User_Reminder|<translate><!--T:71-->
 +
Menus Menu Item User Reminder</translate>]] || <translate><!--T:72-->
 +
Used to create a form which allows a user to request an e-mail with their username.</translate>
 +
|}
 +
 
 +
{{cathelp|3.0,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9,3.10|Menus Help Screens|Menu Item Manager Help Screens}}

Latest revision as of 15:15, 16 September 2022

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


Description[edit]

Used to create a 'Login Form' page for users to login to the website.


How to Access[edit]

Add a new menu item 'Login Form'

  • Select Menus  [name of the menu]  Add New Menu Item from the dropdown menu of the Administrator Panel
  • Click the 'Menu Item Type' Select button Help30-Menu-Item-Type-Select-Button-en.png
  • Select Users  Login Form in the modal popup window.

Edit an existing menu item 'Login Form'

Screenshot[edit]

Help30-Menus-Menu-Item-User-Login-en.png


Form Fields[edit]

  • Menu 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. The default value is the Title in lower case and with dashes instead of spaces. You may enter the Alias manually. Learn more about Aliases.

Details[edit]

  • 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. 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.
    • - Use Default -: Use the default style for the site to show this menu item.
    • [Template Style]: Select a specific template style to always show this menu item with that style.

Menu item sidebar
  • Menu. Shows which menu the menu item 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.
    • Menu Item Root: Select the default value if this is a top-level Menu Item.
    • [menu item title]: Select the Menu Item that is this menu 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 Menu Items.
  • Status. (Published/Unpublished/Trashed) The published status of the menu item.
  • Default Page. (Yes/No) 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 2 ways:
    1. Click on the Home column of the desired menu item in Menu Items.
    2. Open the menu item for the new default page and change the Default Page setting to Yes.
  • Access. Who has access to this menu item.
    • 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.
  • Language. Select the language for this menu item. If you are not using the multi-language feature of Joomla, keep the default of All.
  • Note. Menu item note. This is normally for the site administrator's use (for example, to document information about this menu item) and does not show in the Frontend of the site.

Options[edit]

Help30-Menus-Menu-Item-User-Login-basic-options-screenshot-en.png
  • Choose Login Redirect Type.
    • Menu Item: Lets you directly select an existing menu item. For a multilingual site, it is recommended to use 'Menu Item'.
    • Internal URL: Lets you manually enter any internal URL in the Redirect field.
  • Menu Item Login Redirect. Select or create the page the user will be redirected to after a successful login. The default is to remain on the same page.
  • Login Description. (Hide/Show) 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.
    • Menu Item: Lets you directly select an existing menu item. For a multilingual site, it is recommended to use 'Menu Item'.
    • Internal URL: Lets you manually enter any internal URL in the Redirect field.
  • 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. (Hide/Show) Show or Hide the logout description.
  • Logout Description Text. Enter text to display on Logout page.
  • Logout Image. Select or upload an image to display on Logout page.

Link Type[edit]

Help30-Menus-Menu-Item-options-common-link-type-en.png
  • Link Title Attribute. An optional, custom description for the title attribute of the menu hyperlink.
  • Link Class. An optional class 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. The class which is added to the image (src tag).
  • Add Menu Title. (Yes/No) If optional image is selected, shows a 'Menu Title' next to image.
  • Display in Menu. (Yes/No) 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[edit]

Help30-Menus-Menu-Item-options-common-page-display-en.png
  • 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. (Use Global/Yes/No). Show or hide 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 H1 tag.
  • 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[edit]

Help30-Menus-Menu-Item-options-common-metadata-en.png
  • 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").
    Learn more about Meta Keywords.
  • Robots. The instructions for web "robots" that browse to this page.
    • Use Global: Use the value from the Metadata Settings.
    • 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.
  • Secure. Whether or not to use SSL and the Secure Site URL for this page.
    • Off: Do not use SSL.
    • On: Use SSL.
    • Ignore: Ignore this setting and use the global setting for the site.

Module Assignment[edit]

Help30-Menus-Menu-Item-options-common-module-assignment-en.png
  • Unassigned Modules. (Show/Hide) Show or hide modules unassigned to this menu item.
  • Unpublished Modules. (Show/Hide) Show or hide modules that are unpublished.

Toolbar[edit]

At the top left you will see the toolbar.

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

The functions are:

  • Save. Saves the 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.
    Note: This toolbar icon is only shown if you edit an existing menu 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 Screenshot[edit]

Example Frontend Site images are generic images using Joomla core installation supplied free Frontend 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

Help30-Menus-Menu-User-Login-front-end-screenshot-en.png


Quick Tips[edit]

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[edit]

Related Help Screens Description
Menus Menu Item User 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.
Menus Menu Item User Profile Used to create a form which allows a user to edit their profile settings.
Menus Menu Item User Profile Edit Used to create a form which allows a user to edit their profile settings.
Menus Menu Item User Registration Used to create a default User Registration form for user registration. Default form contains basic information: Name, Username, Password, and Email Address.
Menus Menu Item User Reminder Used to create a form which allows a user to request an e-mail with their username.