Actions

Difference between revisions of "Menu configuration"

From LimeSurvey Manual

(Marked this version for translation)
m
 
(27 intermediate revisions by 5 users not shown)
Line 6: Line 6:
  
  
<!--T:8-->
+
<!--T:17-->
{{Box|This function will suffer important changes in the upcoming LimeSurvey releases.}}
+
{{Alert|text=Under construction}}
{{Box|The wiki is incomplete. More details have to be provided. If you would like to contribute to this wiki,  [[LimeSurvey_Manual|join us]] and become a LimeSurvey wiki contributor.}}
 
 
 
  
 
=General= <!--T:2-->
 
=General= <!--T:2-->
  
 
<!--T:9-->
 
<!--T:9-->
If you would like to create a new menu or add new entries to a preexisting menu, access '''Menu configuration''' from the '''Configuration''' dialog.
+
To create a new menu or add new entries to a preexisting menu: '''Configuration''' -> '''Settings''' -> '''Menu configuration'''  
 +
 
 +
 
 +
<!--T:18-->
 
<center>[[File:Menu Configuration.png]]</center>
 
<center>[[File:Menu Configuration.png]]</center>
 +
  
 
<!--T:10-->
 
<!--T:10-->
If you are unhappy with the existing survey menus, edit the default ones or create new menus. You can also add new [[Menu entries configuration#Create a menu entry|menu entries]] or [[Menu entries configuration#Edit menu entry|edit the existing ones]].
+
You can change the existing survey menus or create a special survey menu for a certain user groups. You can also add new [[Menu entries configuration#Create a menu entry|menu entries]] or [[Menu entries configuration#Edit menu entry|edit the existing ones]].
  
 
=Survey Menu= <!--T:3-->
 
=Survey Menu= <!--T:3-->
  
 
<!--T:11-->
 
<!--T:11-->
Once accessed, you can see in the Menu Configuration panel a table with all the existing survey menus.
+
The Menu Configuration panel has a table with all the existing survey menus.
 +
 
 +
 
 +
<!--T:19-->
 
<center>[[File:Survey Menus.png]]</center>
 
<center>[[File:Survey Menus.png]]</center>
 +
  
 
<!--T:12-->
 
<!--T:12-->
Three actions are available:
+
Four actions are available:
 
*[[Menu configuration#Create a menu|Create a menu]]
 
*[[Menu configuration#Create a menu|Create a menu]]
 
*[[Menu configuration#Edit a menu|Edit a menu]]
 
*[[Menu configuration#Edit a menu|Edit a menu]]
 
*[[Menu configuration#Delete a menu|Delete a menu]]
 
*[[Menu configuration#Delete a menu|Delete a menu]]
 +
*[[Menu configuration#Reset to default values|Reset to default values]]
  
 
==Create a menu== <!--T:4-->
 
==Create a menu== <!--T:4-->
  
 
<!--T:13-->
 
<!--T:13-->
If you would like to create a new menu, press on the green button ('''+ New menu''') located in the upper-right part of the window. The following window will pop-up:
+
To create a new menu, press the green button ('''+ New''') located in the upper left part of the window. The following window will be displayed:
 +
 
  
 
<!--T:14-->
 
<!--T:14-->
 
<center>[[File:Create a New Menu.png|Create a New Menu.png]]</center>
 
<center>[[File:Create a New Menu.png|Create a New Menu.png]]</center>
 +
  
 
<!--T:5-->
 
<!--T:5-->
 
A group of options is available:
 
A group of options is available:
*'''Parent''':  
+
*'''Parent''': Use this option to select the parent menu of another survey menu. In this way, a survey menu will be displayed within another menu once clicked. For example, the plugin menu is a survey menu that has as parent menu the ''mainmenu'', being displayed the bottom of it due to its '''order'''.
*'''Survey''': You can choose to which survey is the menu available. It comes automatically set up for ''All surveys'';
+
*'''Survey''': You can choose the survey the menu will be available for. It comes automatically set up for ''All surveys'';
*'''Ordering''':If you use more menus that have the same position, ordering them would help you better organize them.
+
*'''Ordering''': If you use more menus that have the same position, ordering them would help you better organize them.
 
*'''Title''': The tile of the menu;
 
*'''Title''': The tile of the menu;
*'''Description''': A short summary of the entries that will be added to that menu can be added;
+
*'''Description''': A short summary of the entries that will be added to that menu can be added - useful for other LimeSurvey administrators that wish to later change the configuration of the survey menus;
 
*'''Position''': Four positions are available:
 
*'''Position''': Four positions are available:
**''Sidemenu'' : The menu will be located on the left side of the window.
+
**''Sidemenu'' : The menu will be located on the left side of the window;
**''Collapsed menu'' :
+
**''Collapsed menu'' : A collapsed menu will display only the icons of the survey menu entries;
**''Top bar'' : The menu is going to be on a bar located in the upper part of the window:
+
**''Top bar'' : The menu is going to be on a bar located in the upper part of the window;
**''Bottom bar'' : The menu is going to be on a bar located in the lower part of the window:
+
**''Bottom bar'' : The menu is going to be on a bar located in the lower part of the window.
 +
 
 +
==Edit a menu== <!--T:20-->
  
==Edit a menu== <!--T:15-->
+
<!--T:15-->
If you would like to change the details of an already existing menu, click on the green button located in the ''Action'' column. The respective menu will get selected and in the upper right, the '''+New menu''' button changes to '''Edit menu'''. Click on it and do the edits.
+
To change the details of an already existing menu, click the green button located in the ''Action'' column.  
[[File:Edit a survey menu.png|center]]
+
 
[[File:Select a survey menu to edit it.png|center]]
+
 
 +
<!--T:21-->
 +
<center>[[File:Edit existing survey menu.png]]</center>
  
 
==Delete a menu== <!--T:6-->
 
==Delete a menu== <!--T:6-->
  
 
<!--T:16-->
 
<!--T:16-->
If you want to delete a menu, click on the red trash button that corresponds to that respective menu (located in the '''Action''' column). If you click '''Delete now''', all the menu entries of that menu will also be deleted.
+
To delete a menu, click the red trash button that corresponds to that respective menu (located in the '''Action''' column). If you click '''Delete now''', all the menu entries of that menu will also be deleted.
 +
 
 +
==Reset to default values== <!--T:22-->
 +
 
 +
<!--T:23-->
 +
If you edit the default menus and want to reverse the changes, click the '''Reset''' button located in the upper right part of the window. Once clicked, you will be asked to confirm the action. Please note that all the custom menus will be lost if you decide to proceed.
 +
 
 +
 
 +
<!--T:24-->
 +
<center>[[File:Restore default survey menus.png]]</center>
 +
 
 +
 
 +
<!--T:25-->
 +
{{Alert|title=Attention|text=Please note that in order to backup your survey menus 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-->
 +
 +
<!--T:26-->
 +
Check out the following examples to better understand how you can edit survey menus.
 +
 +
== I want the default collapsed menu to become the new side menu == <!--T:27-->
 +
 +
<!--T:28-->
 +
The default side menu (located under the [[Survey settings|survey settings tab]]) is:
 +
 +
 +
<!--T:29-->
 +
<center>[[File:Default survey settings menu.png]]</center>
 +
 +
 +
<!--T:30-->
 +
To change it, access the menu configuration panel. Edit the ''main menu'' and change its position from '''side menu''' to '''collapsed menu''', and the position of the ''quick menu'' from '''collapsed''' to '''side menu'''.
 +
 +
<!--T:31-->
 +
Once the changes are done, the side menu of the survey (the options displayed under the settings tab) will become the following one:
 +
 +
 +
<!--T:32-->
 +
<center>[[File:New survey menu example.png]]</center>
 +
 +
 +
==Display a list button menu== <!--T:35-->
 +
 +
 +
<!--T:36-->
 +
Let's suppose that you wish to add a new (sub)menu to easily access from the settings tab the list question and question groups options. To do that, you have to create the menu option:
 +
 +
 +
<!--T:37-->
 +
<center></center>
 +
 +
 +
<!--T:38-->
 +
We wish to have it displayed in front of the '''Plugin menu''', so we select "Survey menu" to be the parent menu,order "2", to be displayed before the '''plugin menu''', and position "sidemenu" (similar to the position of the parent menu).
 +
 +
<!--T:39-->
 +
Now, the menu is empty. We have to add menu entries to the newly created menu. To do that, we have to access the [[Menu entries configuration|menu entries panel]] and add the two links that correspond to "list questions" and "list question groups":
 +
 +
<!--T:40-->
 +
* '''List questions'''
 +
 +
 +
<!--T:41-->
 +
<center></center>
 +
 +
 +
<!--T:42-->
 +
*''' List question groups'''
 +
 +
<!--T:43-->
 +
<center></center>
 +
 +
== I want to change the icons and add new menu entries to the default main menu == <!--T:33-->
 +
 +
 +
<!--T:34-->
 +
To do that, you need to configure the LimeSurvey menu entries. To do that, please continue reading the following [[Menu entries configuration|wiki section]].
  
 
</translate>
 
</translate>

Latest revision as of 08:02, 31 May 2021

Other languages:
Deutsch • ‎English • ‎Nederlands • ‎日本語


Important.png  Under construction


General

To create a new menu or add new entries to a preexisting menu: Configuration -> Settings -> Menu configuration


Menu Configuration.png


You can change the existing survey menus or create a special survey menu for a certain user groups. You can also add new menu entries or edit the existing ones.

Survey Menu

The Menu Configuration panel has a table with all the existing survey menus.


Survey Menus.png


Four actions are available:

Create a menu

To create a new menu, press the green button (+ New) located in the upper left part of the window. The following window will be displayed:


Create a New Menu.png


A group of options is available:

  • Parent: Use this option to select the parent menu of another survey menu. In this way, a survey menu will be displayed within another menu once clicked. For example, the plugin menu is a survey menu that has as parent menu the mainmenu, being displayed the bottom of it due to its order.
  • Survey: You can choose the survey the menu will be available for. It comes automatically set up for All surveys;
  • Ordering: If you use more menus that have the same position, ordering them would help you better organize them.
  • Title: The tile of the menu;
  • Description: A short summary of the entries that will be added to that menu can be added - useful for other LimeSurvey administrators that wish to later change the configuration of the survey menus;
  • Position: Four positions are available:
    • Sidemenu : The menu will be located on the left side of the window;
    • Collapsed menu : A collapsed menu will display only the icons of the survey menu entries;
    • Top bar : The menu is going to be on a bar located in the upper part of the window;
    • Bottom bar : The menu is going to be on a bar located in the lower part of the window.

Edit a menu

To change the details of an already existing menu, click the green button located in the Action column.


Edit existing survey menu.png

Delete a menu

To delete a menu, click the red trash button that corresponds to that respective menu (located in the Action column). If you click Delete now, all the menu entries of that menu will also be deleted.

Reset to default values

If you edit the default menus and want to reverse the changes, click the Reset button located in the upper right part of the window. Once clicked, you will be asked to confirm the action. Please note that all the custom menus will be lost if you decide to proceed.


Restore default survey menus.png


Important.png  Attention : Please note that in order to backup your survey menus 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

Check out the following examples to better understand how you can edit survey menus.

I want the default collapsed menu to become the new side menu

The default side menu (located under the survey settings tab) is:


Default survey settings menu.png


To change it, access the menu configuration panel. Edit the main menu and change its position from side menu to collapsed menu, and the position of the quick menu from collapsed to side menu.

Once the changes are done, the side menu of the survey (the options displayed under the settings tab) will become the following one:


New survey menu example.png


Display a list button menu

Let's suppose that you wish to add a new (sub)menu to easily access from the settings tab the list question and question groups options. To do that, you have to create the menu option:



We wish to have it displayed in front of the Plugin menu, so we select "Survey menu" to be the parent menu,order "2", to be displayed before the plugin menu, and position "sidemenu" (similar to the position of the parent menu).

Now, the menu is empty. We have to add menu entries to the newly created menu. To do that, we have to access the menu entries panel and add the two links that correspond to "list questions" and "list question groups":

  • List questions



  • List question groups

I want to change the icons and add new menu entries to the default main menu

To do that, you need to configure the LimeSurvey menu entries. To do that, please continue reading the following wiki section.