Actions

Menu configuration/en: Difference between revisions

From LimeSurvey Manual

(Updating to match new version of source page)
(Updating to match new version of source page)
Line 4: Line 4:




{{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=
=General=


If you would like to create a new menu or add new entries to a preexisting menu, access '''Menu configuration''' from the '''Configuration''' dialog.
If you would like to create a new menu or add new entries to a preexisting menu, access '''Menu configuration''' from the '''Configuration''' dialog.
<center>[[File:Menu Configuration.png]]</center>
<center>[[File:Menu Configuration.png]]</center>


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]].
 
If you are unhappy with the existing survey menus or you wish to create a special suvey menu for a certain user group, 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]].


=Survey Menu=
=Survey Menu=


Once accessed, you can see in the Menu Configuration panel a table with all the existing survey menus.
Once accessed, you can see in the Menu Configuration panel a table with all the existing survey menus.
<center>[[File:Survey Menus.png]]</center>
<center>[[File:Survey Menus.png]]</center>


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==
==Create a menu==


If you would like to create a new menu, press on the green button ('''+ New''') located in the upper part of the window. The following window will pop-up:
If you would like to create a new menu, press on the green button ('''+ New''') located in the upper left part of the window. The following window will pop-up:
 


<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>


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==
 
If you would like to change the details of an already existing menu, click on the green button located in the ''Action'' column. Once done
 
 
<center>[[File:Edit existing survey menu.png]]</center>


==Edit a menu==
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, the '''+New''' button changes to '''Edit menu'''. Click on it and do the edits.
[[File:Edit a survey menu.png|center]]
[[File:Select a survey menu to edit it.png|center]]


==Delete a menu==
==Delete a menu==


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.
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.
==Reset to default values==
In the case in which you edited the default menus and you want to return back to the default values, click on the '''Reset''' button located in the upper right part of the window. Once clicked, you will be asked to confirm the operation. Please note that all the custom menus will be lost if you decide to proceed.
<center>[[File:Restore default survey menus.png]]</center>
{{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=
=Examples=
Check the following examples to better understand how you can edit survey menus
== I want the default collapsed menu to become the new sidemenu ==
The default sidemenu (located under the [[Survey settings|survey settings tab]] is:
<center>[[File:Default survey settings menu.png]]</center>
To change it, access the menu configuration panel. Edit the ''mainmenu'' and change its position from '''sidemenu''' to '''collapsed menu''', and the position of the ''quickmenumenu'' from '''collapsed''' to '''sidemenu'''.
Once the changes are done, the sidemenu of the survey (the options displayed under the settings tab) will become the following one:
<center>[[File:New survey menu example.png]]</center>
== 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 [[Menu entries configuration|wiki section]].

Revision as of 20:10, 25 May 2018


  Under construction


General

If you would like to create a new menu or add new entries to a preexisting menu, access Menu configuration from the Configuration dialog.



If you are unhappy with the existing survey menus or you wish to create a special suvey menu for a certain user group, edit the default ones or create new menus. You can also add new menu entries or edit the existing ones.

Survey Menu

Once accessed, you can see in the Menu Configuration panel a table with all the existing survey menus.



Four actions are available:

Create a menu

If you would like to create a new menu, press on the green button (+ New) located in the upper left part of the window. The following window will pop-up:


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

If you would like to change the details of an already existing menu, click on the green button located in the Action column. Once done



Delete a menu

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.

Reset to default values

In the case in which you edited the default menus and you want to return back to the default values, click on the Reset button located in the upper right part of the window. Once clicked, you will be asked to confirm the operation. Please note that all the custom menus will be lost if you decide to proceed.



  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 the following examples to better understand how you can edit survey menus

I want the default collapsed menu to become the new sidemenu

The default sidemenu (located under the survey settings tab is:



To change it, access the menu configuration panel. Edit the mainmenu and change its position from sidemenu to collapsed menu, and the position of the quickmenumenu from collapsed to sidemenu.

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



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.