Menu entries configuration/en - Revision history

FuzzyBot: Updating to match new version of source page

2021-06-05T15:07:43Z

Updating to match new version of source page

← Older revision		Revision as of 17:07, 5 June 2021
Line 5:		Line 5:
	{{Alert\|text=Under construction}}		{{Alert\|text=Under construction}}

	{{Box\|The wiki is incomplete. More details have to be provided. If you would like to contribute to this wiki.}}		{{Box\|The wiki is incomplete. More details have to be provided. If you would like to, you can contribute to this wiki.}}

	=General=		=General=

	To access the Menu entries table, click on '''Configuration''' and then on '''Menu entries configuration'''		To access the Menu entries table, click '''Configuration''' and then '''Menu entries configuration'''.


Line 15:		Line 15:


	This function allows you to create, edit or delete menu entries. ~~In order to~~ be ~~shown~~, these entries have to be added into a [[Menu configuration\|menu]].		This function allows you to create, edit or delete menu entries. To be visible/displayed, these entries have to be added into a [[Menu configuration\|menu]].

	=Menu entries configuration=		=Menu entries configuration=
Line 23:		Line 23:


	The following actions are available ~~to the users~~:		The following actions are available:
	*[[Menu entries configuration#Create a menu entry\|Create a menu entry]]		*[[Menu entries configuration#Create a menu entry\|Create a menu entry]]
	*[[Menu entries configuration#Edit menu entry\|Edit menu entry]]		*[[Menu entries configuration#Edit menu entry\|Edit menu entry]]
Line 33:		Line 33:
	==Create a menu entry==		==Create a menu entry==

	To create a new menu entry, click on the '''+ New''' button located on the top-left side of the window. ~~Once clicked, you the~~ following menu options will be displayed:		To create a new menu entry, click the '''+ New''' button located on the top-left side of the window. The following menu options will be displayed:
	*'''Menu''': Select the menu where the new entry will be located ([[Menu configuration#Create a menu\|read our wiki on how to create menus here]]);		*'''Menu''': Select the menu where the new entry will be located ([[Menu configuration#Create a menu\|read our wiki on how to create menus here]]);
	*'''Name''': Type in the name of the menu entry;		*'''Name''': Type in the name of the menu entry;
	*'''Title''': The title of the respective entry which will be displayed in the menu or under certain tabs (e.g., under the survey settings tab)		*'''Title''': The title of the respective entry which will be displayed in the menu or under certain tabs (e.g., under the survey settings tab)
	*'''Ordering''': If more menu entries are added to a menu, use this function to order them.		*'''Ordering''': If more menu entries are added to a menu, use this function to order them.
	*'''Menu title''': ~~Once you accessed~~ a tab or a menu entry, the menu title will be displayed on the first line. For example, if you click on '''Overview''' ~~which is~~ located under the '''Survey settings''' tab, the overview panel will be displayed with the ''(menu) title'': Survey overview		*'''Menu title''':On a tab or a menu entry, the menu title will be displayed on the first line. For example, if you click '''Overview''', located under the '''Survey settings''' tab, the overview panel will be displayed with the ''(menu) title'': Survey overview
	*'''Menu name''': ~~It is displayed~~ when you hover the mouse over the respective entry. For example, if you hover the mouse over '''Theme options''', the following message will show up: ''Edit theme options for this survey''.		*'''Menu name''': Displayed when you hover the mouse over the respective entry. For example, if you hover the mouse over '''Theme options''', the following message will show up: ''Edit theme options for this survey''.
	*'''Menu icon''': All the used icons are fontawesome icons by default. To find other available icons, check the following [https://www.w3schools.com/icons/fontawesome_icons_text.asp link]. Introduce in the box the string located after "fa fa-". E.g., for a floppy disk, we have "fa fa-floppy-o". To use it as an icon for a menu entry, type in this box only "floppy-o".		*'''Menu icon''': All the used icons are fontawesome icons by default. To find other available icons, check the following [https://www.w3schools.com/icons/fontawesome_icons_text.asp link]. Introduce in the box the string located after "fa fa-". E.g., for a floppy disk, we have "fa fa-floppy-o". To use it as an icon for a menu entry, type in this box only "floppy-o".
	*'''Menu icon types''': It depends on the ones used within your current theme. For further details, check the following [[Themes\|wiki section]].		*'''Menu icon types''': It depends on the ones used within your current theme. For further details, check the following [[Themes\|wiki section]].
Line 51:		Line 51:
	==Edit menu entry==		==Edit menu entry==

	~~If you would like to~~ change the details of an already existing menu entry, click on the green button located in the '''Action''' column. The respective menu will get selected and you can do the edits.		To change the details of an already existing menu entry, click the green button located in the '''Action''' column. The respective menu will get selected and you can do the edits.

	==Delete menu entry==		==Delete menu entry==

	~~If you want to~~ delete a menu entry, click on the red trash button that corresponds to that respective menu entry (located in the '''Action''' column).		To delete a menu entry, click the red trash button that corresponds to that respective menu entry (located in the '''Action''' column).


	==Reorder menu entries==		==Reorder menu entries==

	The ordering process takes first into account the '''menu''' an entry belongs to, and then it orders the entries according to the value from the '''order field'''. Once you change these values, click on the '''reorder''' button to get the entries rearranged in the table.		The ordering process takes first into account the '''menu''' an entry belongs to, and then it orders the entries according to the value from the '''order field'''. Once you change these values, click the '''reorder''' button to get the entries rearranged in the table.


	<center>[[File:Reorder survey menu entries.png]]</center>		<center>[[File:Reorder survey menu entries.png]]</center>


	==Reset menu entries to the default values==		==Reset menu entries to the default values==

	~~If you wish to~~ reset all the values of the survey menu entries to their default values, click on the '''reset''' button located in the upper right part of the screen. A message will ~~pop up~~ asking you to confirm the action. Please note that once you confirm the action, all the custom menu entries will be lost.		To reset all the values of the survey menu entries to their default values, click the '''reset''' button located in the upper right part of the screen. A message will be displayed asking you to confirm the action. Please note that once you confirm the action, all the custom menu entries will be lost.


Line 75:		Line 73:
	=Examples=		=Examples=

	==~~I want to add~~ a new menu entry to the default survey menu==		==Add a new menu entry to the default survey menu==

	~~In this~~ example~~, it will be shown~~ how to add a [[Label sets]] menu entry to the default survey menu.		This example demonstrates how to add a [[Label sets]] menu entry to the default survey menu.

	First, click on the '''+ New''' button located on the top left side of the screen and start completing the fields:		First, click the '''+ New''' button located on the top left side of the screen and start completing the fields:
	*''Menu'': Select from the dropdown list the menu you wish to add to the menu entry.		*''Menu'': Select from the dropdown list the menu you wish to add to the menu entry.
	*''Name'': labelsets.		*''Name'': labelsets.
Line 92:		Line 90:


	Click on the create button ~~and see if~~ the new survey menu entry was added:		Click the create button to verify that the new survey menu entry was added:


Line 98:		Line 96:


	~~Once done, check~~ the survey menu ~~and see if~~ the survey menu entry is functional:		Check the survey menu to verify that the survey menu entry is functional:


Line 108:		Line 106:
	=Advanced options - menu entries=		=Advanced options - menu entries=

	When creating or editing a menu entry, you may find in the lower right part of the dialog the '''Toggle advanced options''' button. The following extra fields will be shown once you ~~press~~ it:		When creating or editing a menu entry, you may find in the lower right part of the dialog the '''Toggle advanced options''' button. The following extra fields will be shown once you click it:
	*'''Action'''		*'''Action'''
	*'''Template'''		*'''Template'''
Line 117:		Line 115:
	*'''Language'''		*'''Language'''

	Once the edits are done, do not forget to click ~~on the~~ '''Save''' ~~button~~.		Once the edits are done, do not forget to click '''Save'''.

C schmitz: Text replacement - "Check the following" to "Check out the following"

2020-10-18T17:12:19Z

Text replacement - "Check the following" to "Check out the following"

← Older revision		Revision as of 19:12, 18 October 2020
Line 85:		Line 85:
	*''Menu title'': Label sets.		*''Menu title'': Label sets.
	*''Menu name'': "Click here to edit the available sets."		*''Menu name'': "Click here to edit the available sets."
	*''Menu icon'': Check the following [https://www.w3schools.com/icons/fontawesome_icons_text.asp link] to find the right icon for the new menu entry. In the screenshot from above, I used "fa fa-battery-three-quarters".		*''Menu icon'': Check out the following [https://www.w3schools.com/icons/fontawesome_icons_text.asp link] to find the right icon for the new menu entry. In the screenshot from above, I used "fa fa-battery-three-quarters".
	*''Menu icon type'': Select from the dropdown box the "Fontawesome icon" option.		*''Menu icon type'': Select from the dropdown box the "Fontawesome icon" option.
	*''Menu link'': Find the URL of the option you wish to link the entry to, and copy everything after the website name (admin/labels/sa/view in our case):		*''Menu link'': Find the URL of the option you wish to link the entry to, and copy everything after the website name (admin/labels/sa/view in our case):

FuzzyBot: Updating to match new version of source page

2018-05-29T10:15:02Z

Updating to match new version of source page

← Older revision		Revision as of 12:15, 29 May 2018
Line 51:		Line 51:
	==Edit menu entry==		==Edit menu entry==

	If you would like to change the details of an already existing menu entry, click on the green button located in the '''Action''' column. The respective menu will get selected and ~~in the upper right the '''+New menu entry''' button changes to '''Edit menu entry'''. Click on it and~~ do the edits.		If you would like to change the details of an already existing menu entry, click on the green button located in the '''Action''' column. The respective menu will get selected and you can do the edits.

	==Delete menu entry==		==Delete menu entry==
Line 84:		Line 84:
	*''Order'': 20.		*''Order'': 20.
	*''Menu title'': Label sets.		*''Menu title'': Label sets.
	*''Menu name'': Click here to edit the available ~~label~~ sets.		*''Menu name'': "Click here to edit the available sets."
	*''Menu icon'': Check the following [https://www.w3schools.com/icons/fontawesome_icons_text.asp link] to find the right icon for the new menu entry. In the screenshot from above, I used "fa fa-battery-three-quarters".		*''Menu icon'': Check the following [https://www.w3schools.com/icons/fontawesome_icons_text.asp link] to find the right icon for the new menu entry. In the screenshot from above, I used "fa fa-battery-three-quarters".
	*''Menu icon type'': Select from the dropdown box the "Fontawesome icon" option.		*''Menu icon type'': Select from the dropdown box the "Fontawesome icon" option.
Line 92:		Line 92:


	Click on the ~~save~~ button and see if the new survey menu entry was added:		Click on the create button and see if the new survey menu entry was added:


Line 104:		Line 104:


	{{Alert\|title=Attention\|text=Do not forget to check the LimeSurvey installation permissions to see which users can access and edit label sets. For more details, check the following wiki section.}}		{{Alert\|title=Attention\|text=Do not forget to check the LimeSurvey installation permissions to see which users can access and edit label sets. For more details, check the [[Manage_users\|following wiki section]].}}

	=Advanced options - menu entries=		=Advanced options - menu entries=

FuzzyBot: Updating to match new version of source page

2018-05-26T15:15:02Z

Updating to match new version of source page

← Older revision		Revision as of 17:15, 26 May 2018
Line 3:		Line 3:
	__TOC__		__TOC__

			{{Alert\|text=Under construction}}

	~~{{Box\|This function will suffer important changes in the upcoming LimeSurvey releases.}}~~
	{{Box\|The wiki is incomplete. More details have to be provided. If you would like to contribute to this wiki.}}		{{Box\|The wiki is incomplete. More details have to be provided. If you would like to contribute to this wiki.}}

Line 10:		Line 10:

	To access the Menu entries table, click on '''Configuration''' and then on '''Menu entries configuration'''		To access the Menu entries table, click on '''Configuration''' and then on '''Menu entries configuration'''


	<center>[[File:Menu Entries Configuration.png\|Menu Entries Configuration.png]]</center>		<center>[[File:Menu Entries Configuration.png\|Menu Entries Configuration.png]]</center>


	This function allows you to create, edit or delete menu entries. In order to be shown, these entries have to be added into a [[Menu configuration\|menu]].		This function allows you to create, edit or delete menu entries. In order to be shown, these entries have to be added into a [[Menu configuration\|menu]].

	=Menu entries configuration=		=Menu entries configuration=


	[[File:Menu Entries List.png\|center]]		[[File:Menu Entries List.png\|center]]


	The following actions are available to the users:		The following actions are available to the users:
Line 23:		Line 27:
	*[[Menu entries configuration#Edit menu entry\|Edit menu entry]]		*[[Menu entries configuration#Edit menu entry\|Edit menu entry]]
	*[[Menu entries configuration#Delete menu entry\|Delete menu entry]]		*[[Menu entries configuration#Delete menu entry\|Delete menu entry]]
			*[[Menu entries configuration#Reorder menu entries\|Reorder menu entries]]
			*[[Menu entries configuration#Reset menu entries to the default values\|Reset menu entries to the default values]]


	==Create a menu entry==		==Create a menu entry==

	~~The~~ following options ~~are available~~:		To create a new menu entry, click on the '''+ New''' button located on the top-left side of the window. Once clicked, you the following menu options will be displayed:
	*'''Menu''': Select the menu where the new entry will be located ([[Menu configuration#Create a menu\|read our wiki on how to create menus here]]);		*'''Menu''': Select the menu where the new entry will be located ([[Menu configuration#Create a menu\|read our wiki on how to create menus here]]);
	*'''Name''': Type in the name of the menu entry;		*'''Name''': Type in the name of the menu entry;
	*'''Title''':		*'''Title''': The title of the respective entry which will be displayed in the menu or under certain tabs (e.g., under the survey settings tab)
	*'''Ordering''': If more menu entries are added to a menu, use this function to order them		*'''Ordering''': If more menu entries are added to a menu, use this function to order them.
	*'''Menu title''':		*'''Menu title''': Once you accessed a tab or a menu entry, the menu title will be displayed on the first line. For example, if you click on '''Overview''' which is located under the '''Survey settings''' tab, the overview panel will be displayed with the ''(menu) title'': Survey overview
	*'''Menu name''':		*'''Menu name''': It is displayed when you hover the mouse over the respective entry. For example, if you hover the mouse over '''Theme options''', the following message will show up: ''Edit theme options for this survey''.
	*'''Menu icon''':		*'''Menu icon''': All the used icons are fontawesome icons by default. To find other available icons, check the following [https://www.w3schools.com/icons/fontawesome_icons_text.asp link]. Introduce in the box the string located after "fa fa-". E.g., for a floppy disk, we have "fa fa-floppy-o". To use it as an icon for a menu entry, type in this box only "floppy-o".
	*'''Menu icon types''':		*'''Menu icon types''': It depends on the ones used within your current theme. For further details, check the following [[Themes\|wiki section]].
	*'''Menu class''':		*'''Menu class''':
	*'''Menu link''': Link the menu entry to the URL of that function		*'''Menu link''': Link the menu entry to the URL of that function
Line 40:		Line 47:
	*'''Permission grade''':		*'''Permission grade''':

	{{Note\|[[Menu entries configuration#Advanced options - menu entries\|~~Read our wiki~~]] for information on advanced options.}}		{{Note\|[[Menu entries configuration#Advanced options - menu entries\|See the last section of this page]] for information on advanced options.}}

	==Edit menu entry==		==Edit menu entry==

	If you would like to change the details of an already existing menu entry, click on the green button located in the '''Action''' column. The respective menu will get selected and in the upper right the '''+New menu entry''' button changes to '''Edit menu entry'''. Click on it and do the edits.		If you would like to change the details of an already existing menu entry, click on the green button located in the '''Action''' column. The respective menu will get selected and in the upper right the '''+New menu entry''' button changes to '''Edit menu entry'''. Click on it and do the edits.

	~~[[File:Create new menu entry.png]]~~
	~~[[File:Edit menu entry.png]]~~

	==Delete menu entry==		==Delete menu entry==

	If you want to delete a menu entry, click on the red trash button that corresponds to that respective menu entry (located in the '''Action''' column).		If you want to delete a menu entry, click on the red trash button that corresponds to that respective menu entry (located in the '''Action''' column).


			==Reorder menu entries==

			The ordering process takes first into account the '''menu''' an entry belongs to, and then it orders the entries according to the value from the '''order field'''. Once you change these values, click on the '''reorder''' button to get the entries rearranged in the table.


			<center>[[File:Reorder survey menu entries.png]]</center>


			==Reset menu entries to the default values==

			If you wish to reset all the values of the survey menu entries to their default values, click on the '''reset''' button located in the upper right part of the screen. A message will pop up asking you to confirm the action. Please note that once you confirm the action, all the custom menu entries will be lost.


			{{Alert\|title=Attention\|text=Please note that in order to backup your survey menu entries configuration, create a [[Backup entire database\|LimeSurvey database backup]]. A separate option will be introduced in the near future to facilitate only the backup of the survey menus.}}

	=Examples=		=Examples=

			==I want to add a new menu entry to the default survey menu==

			In this example, it will be shown how to add a [[Label sets]] menu entry to the default survey menu.

			First, click on the '''+ New''' button located on the top left side of the screen and start completing the fields:
			*''Menu'': Select from the dropdown list the menu you wish to add to the menu entry.
			*''Name'': labelsets.
			*''Order'': 20.
			*''Menu title'': Label sets.
			*''Menu name'': Click here to edit the available label sets.
			*''Menu icon'': Check the following [https://www.w3schools.com/icons/fontawesome_icons_text.asp link] to find the right icon for the new menu entry. In the screenshot from above, I used "fa fa-battery-three-quarters".
			*''Menu icon type'': Select from the dropdown box the "Fontawesome icon" option.
			*''Menu link'': Find the URL of the option you wish to link the entry to, and copy everything after the website name (admin/labels/sa/view in our case):

			<center>[[File:Link menu entry example.png]]</center>


			Click on the save button and see if the new survey menu entry was added:


			<center>[[File:Example menu entry label Sets.png]]</center>


			Once done, check the survey menu and see if the survey menu entry is functional:


			<center>[[File:Example label sets new entry.png]]</center>


			{{Alert\|title=Attention\|text=Do not forget to check the LimeSurvey installation permissions to see which users can access and edit label sets. For more details, check the following wiki section.}}

	=Advanced options - menu entries=		=Advanced options - menu entries=

FuzzyBot: Updating to match new version of source page

2018-04-27T10:55:02Z

Updating to match new version of source page

← Older revision		Revision as of 12:55, 27 April 2018
Line 40:		Line 40:
	*'''Permission grade''':		*'''Permission grade''':

	{{Note\|[[Menu entries configuration#Advanced options - menu entries\|Read our wiki]] for information on advanced ~~settings~~.}}		{{Note\|[[Menu entries configuration#Advanced options - menu entries\|Read our wiki]] for information on advanced options.}}

	==Edit menu entry==		==Edit menu entry==

FuzzyBot: Updating to match new version of source page

2018-03-25T11:45:02Z

Updating to match new version of source page

← Older revision		Revision as of 13:45, 25 March 2018
Line 20:		Line 20:

	The following actions are available to the users:		The following actions are available to the users:
	*[[Menu entries configuration#Create a ~~new~~ menu entry\|Create a menu entry]]		*[[Menu entries configuration#Create a menu entry\|Create a menu entry]]
	*[[Menu entries configuration#Edit menu entry\|Edit menu entry]]		*[[Menu entries configuration#Edit menu entry\|Edit menu entry]]
	*[[Menu entries configuration#Delete menu entry\|Delete menu entry]]		*[[Menu entries configuration#Delete menu entry\|Delete menu entry]]

	==Create a ~~new~~ menu entry==		==Create a menu entry==

	The following options are available:		The following options are available:

FuzzyBot: Updating to match new version of source page

2018-03-19T16:25:02Z

Updating to match new version of source page

New page

<languages />

__TOC__

{{Box|This function will suffer important changes in the upcoming LimeSurvey releases.}}
{{Box|The wiki is incomplete. More details have to be provided. If you would like to contribute to this wiki.}}

=General=

To access the Menu entries table, click on '''Configuration''' and then on '''Menu entries configuration'''

<center>[[File:Menu Entries Configuration.png|Menu Entries Configuration.png]]</center>

This function allows you to create, edit or delete menu entries. In order to be shown, these entries have to be added into a [[Menu configuration|menu]].

=Menu entries configuration=

[[File:Menu Entries List.png|center]]

The following actions are available to the users:
*[[Menu entries configuration#Create a new menu entry|Create a menu entry]]
*[[Menu entries configuration#Edit menu entry|Edit menu entry]]
*[[Menu entries configuration#Delete menu entry|Delete menu entry]]

==Create a new menu entry==

The following options are available:
*'''Menu''': Select the menu where the new entry will be located ([[Menu configuration#Create a menu|read our wiki on how to create menus here]]);
*'''Name''': Type in the name of the menu entry;
*'''Title''':
*'''Ordering''': If more menu entries are added to a menu, use this function to order them
*'''Menu title''':
*'''Menu name''':
*'''Menu icon''':
*'''Menu icon types''':
*'''Menu class''':
*'''Menu link''': Link the menu entry to the URL of that function
*'''Permission''':
*'''Permission grade''':

{{Note|[[Menu entries configuration#Advanced options - menu entries|Read our wiki]] for information on advanced settings.}}

==Edit menu entry==

If you would like to change the details of an already existing menu entry, click on the green button located in the '''Action''' column. The respective menu will get selected and in the upper right the '''+New menu entry''' button changes to '''Edit menu entry'''. Click on it and do the edits.

[[File:Create new menu entry.png]]
[[File:Edit menu entry.png]]

==Delete menu entry==

If you want to delete a menu entry, click on the red trash button that corresponds to that respective menu entry (located in the '''Action''' column).

=Examples=

=Advanced options - menu entries=

When creating or editing a menu entry, you may find in the lower right part of the dialog the '''Toggle advanced options''' button. The following extra fields will be shown once you press it:
*'''Action'''
*'''Template'''
*'''Partial'''
*'''Classes'''
*'''Data'''
*'''Get data method'''
*'''Language'''

Once the edits are done, do not forget to click on the '''Save''' button.