Menu entries configuration: Difference between revisions
From LimeSurvey Manual
mNo edit summary |
mNo edit summary |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
__TOC__ | __TOC__ | ||
<!--T:21--> | |||
{{Alert|text=Under construction}} | {{Alert|text=Under construction}} | ||
| Line 42: | Line 43: | ||
<!--T:15--> | <!--T:15--> | ||
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 57: | Line 58: | ||
<!--T:16--> | <!--T:16--> | ||
{{Note|[[Menu entries configuration#Advanced options - menu entries| | {{Note|[[Menu entries configuration#Advanced options - menu entries|See the last section of this page]] for information on advanced options.}} | ||
==Edit menu entry== <!--T:5--> | ==Edit menu entry== <!--T:5--> | ||
<!--T:17--> | <!--T:17--> | ||
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 | 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== <!--T:6--> | |||
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== <!--T:22--> | |||
<!--T:23--> | |||
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. | |||
<!--T: | <!--T:24--> | ||
[[File: | <center>[[File:Reorder survey menu entries.png]]</center> | ||
==Reset menu entries to the default values== <!--T:25--> | |||
<!--T:26--> | |||
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. | |||
<!--T:27--> | |||
{{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= <!--T:7--> | =Examples= <!--T:7--> | ||
==I want to add a new menu entry to the default survey menu== <!--T:28--> | |||
<!--T:29--> | |||
In this example, it will be shown how to add a [[Label sets]] menu entry to the default survey menu. | |||
<!--T:30--> | |||
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 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): | |||
<!--T:31--> | |||
<center>[[File:Link menu entry example.png]]</center> | |||
<!--T:32--> | |||
Click on the create button and see if the new survey menu entry was added: | |||
<!--T:33--> | |||
<center>[[File:Example menu entry label Sets.png]]</center> | |||
<!--T:34--> | |||
Once done, check the survey menu and see if the survey menu entry is functional: | |||
<!--T:35--> | |||
<center>[[File:Example label sets new entry.png]]</center> | |||
<!--T:36--> | |||
{{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= <!--T:8--> | =Advanced options - menu entries= <!--T:8--> | ||
Revision as of 12:08, 29 May 2018
Under construction
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
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.
Menu entries configuration
The following actions are available to the users:
- Create a menu entry
- Edit menu entry
- Delete menu entry
- Reorder menu entries
- Reset menu entries to the default values
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 (read our wiki on how to create menus here);
- 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)
- 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 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: All the used icons are fontawesome icons by default. To find other available icons, check the following 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 wiki section.
- Menu class:
- Menu link: Link the menu entry to the URL of that function
- Permission:
- Permission grade:
See the last section of this page for information on advanced options.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.
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).
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.
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.
Attention : Please note that in order to backup your survey menu entries configuration, create a LimeSurvey database backup. A separate option will be introduced in the near future to facilitate only the backup of the survey menus.
Examples
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 sets."
- Menu icon: Check the following 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):
Click on the create button and see if the new survey menu entry was added:
Once done, check the survey menu and see if the survey menu entry is functional:
Attention : 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.
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.