Home page settings/en - Revision history

FuzzyBot: Updating to match new version of source page

2021-05-27T11:09:27Z

Updating to match new version of source page

FuzzyBot: Updating to match new version of source page

2017-11-09T14:15:02Z

Updating to match new version of source page

FuzzyBot: Updating to match new version of source page

2017-09-11T09:10:03Z

Updating to match new version of source page

New page

<languages />

=General=
The '''home page settings''' page allows every user to tweak its settings according to his or her needs. The button can be accessed from '''Configuration'''->'''Home page settings''' (located under the '''Settings tab'''):
<center>[[File:Configuration Home page settings.png]]</center>

Besides editing home page settings, new boxes (for different user groups) can be created in order to facilitate the management of your LimeSurvey installation.

=Home page settings=

The following home page settings are available:

<center>[[File:Home page settings view.png]]</center>

*'''Display logo''': If it is turned 'off', the logo situated above the boxes disappears (the default value is 'On');
*'''Show last visited survey and question''': It is turned 'on' by default. It shows the last visited question and survey, the bar being located between the logo and the boxes;
*'''Show survey list''': The default value is 'Off'. If you switch it to 'On', a survey list will appear below the boxes from the home page;
*'''Show search box on survey list''': If it is ticked 'Off', the search box will not be shown in the '''survey list'''. Please note that this option does not have any effect on your home page if the '''Show survey list''' option is not turned on;
*'''Wrap container around Boxes'''{{NewIn|3.0}}: If it is turned 'on', the container around each box gets smaller (useful function when more boxes are added to your home page) ;
*'''Boxes by row''': The number of boxes you would like to have on each row. The default number is '3';
*'''Box offset'''{{ObsoleteIn|3.0}}: '''Box offset''' is a function that helps users center the boxes. For example, if you use 15 boxes, you can use the '''box offset''' function in order to better arrange them into your home page. This function does not exist anymore in LimeSurvey 3.0 (and the later versions) because the boxes are automatically centered;
*'''Box orientation'''{{NewIn|3.0}}: Three options are available: ''left to right'', ''right to left'', ''centered''.

Click on '''Save boxes settings''' once you are done. If everything is turned on, the home page should look like this:
[[File: Home page view.png]]

=Boxes=

The LimeSurvey installation comes by default with six boxes created: ''Create survey'', ''List survey'', ''Global settings'', ''ComfortUpdate'', ''Label sets'', and ''Templates''. They can be either edited (the green pen button) or deleted (the red trash button):

<center>[[File:Boxes Table.png]]</center>

==Create/Edit a box==

In order to add a new box into the '''Boxes''' table, click on '''Create a new box''', located in the upper-part of the screen:
<center>[[File:Creat and reset - boxes.png]]</center>.

Different fields have to be filled in:
<center>[[File:Create a new box.png]]</center>

*'''Position''': It shows the box position (it is a numerical value);
*'''Destination URL''': It is the link via which the respective option/function is accessed. For example, the destination URL to backup the entire database is ''admin/dumpdb'';
*'''Title''': The name of the box;
*'''Icon''': It allows the user to select one of the LimeSurvey predefined icons;
*'''Description''': A small description of what the role of the box is can be typed in;
*'''Display this box to''': It allows you to choose who can see the respective box:
**''Only admin'' : Only the super administrator of the LimeSurvey installation can see those respective boxes;
**''Everybody'' : Everyone who logs in the LimeSurvey installation can see those respective boxes. They are the survey users defined in the [[Manage users|User Control panel]];
**''Nobody'' : Nobody can see those boxes. It can be used when you would like, for example, to hide boxes from a specific [[Users#Manage user groups|user group]].
**''Other user groups'' : A certain user group is allowed to see those boxes. To find out more about user groups, read our wiki [[Users#Manage user groups|on how to manage them]].

Once done, click on the '''Save''' button that is located in the upper-right part of the screen.

<div class="simplebox">[[File:help.png]] The fields of a box can be later edited by clicking on the green pen button located on the last column of the '''Boxes''' table.</div>

{{Note|Check [[Home page settings#Examples|the example provided below]] to better understand this functionality.}}

==Reset to the default settings==

If you did too many changes or you broke up some of the default boxes functionalities, click on the '''Reset to default boxes''' button, located in the upper-right side of the window. This would restore the default boxes.

<center>[[File:Creat and reset - boxes.png]]</center>

=Examples=

==I want to create a new box==

*Access '''Home page settings''' from the '''Configuration''' dialog.
*Click on '''Create new box''', located in the upper right-part of the window.
*Enter the requested information:
<center>[[File:Add a new box - example.png]]</center>

{{Box|The destination URL can be found in the address bar. In this example, the URL leads to the '''General settings''' of a survey:
<center>[[File:Destination URL.png]]</center>}}

*Save the box and access the home page of your LimeSurvey installation.
<center>[[File:Add a new box - example 2.png]]</center>

*Click on the newly created box and check whether it is working or not (if not, re-check its destionation URL):
<center>[[File:Create a new box example test.png]]</center>

← Older revision		Revision as of 13:09, 27 May 2021
Line 1:		Line 1:
	<languages />		<languages />

	=General=		==General==
	The '''home page settings''' page allows ~~every user~~ to ~~tweak its settings according to his or her needs. The button can be accessed from~~ '''Configuration'''->'''~~Home page settings~~''' ~~(located under the~~ '''~~Settings tab'''):~~		The '''home page settings''' page allows users to customize their home page: '''Configuration'''-> '''Settings''' -> '''Home page settings
	<center>[[File:Configuration Home page settings.png]]</center>		<center>[[File:Configuration Home page settings.png]]</center>

	Besides editing home page settings, new boxes (for different user groups) can be created ~~in order~~ to facilitate the management of your LimeSurvey installation.		Besides editing home page settings, new boxes (for different user groups) can be created to facilitate the management of your LimeSurvey installation.

	=Home page settings=		==Home page settings==

	The following home page settings are available:		The following home page settings are available:
Line 14:		Line 14:

	*'''Display logo''': If it is turned 'Off', the logo situated above the boxes disappears (the default value is 'On')		*'''Display logo''': If it is turned 'Off', the logo situated above the boxes disappears (the default value is 'On')
	*'''Show last visited survey and question''': ~~It is turned~~ 'On' by default. It shows the last visited question and survey, the bar being located between the logo and the boxes		*'''Show last visited survey and question''': Turned 'On' by default. It shows the last visited question and survey, the bar being located between the logo and the boxes
	*'''Show survey list''': The default value is 'Off'. If you switch it to 'On', a survey list will appear below the boxes from the home page		*'''Show survey list''': The default value is 'Off'. If you switch it to 'On', a survey list will appear below the boxes from the home page
	*'''Show search box on survey list''': If it is ticked 'Off', the search box will not be shown in the '''survey list'''. Please note that this option does not have any effect on your home page if the '''Show survey list''' option is not turned on		*'''Show search box on survey list''': If it is ticked 'Off', the search box will not be shown in the '''survey list'''. Please note that this option does not have any effect on your home page if the '''Show survey list''' option is not turned on
Line 22:		Line 22:
	*'''Box orientation'''{{NewIn\|3.0}}: Three options are available: ''left to right'', ''right to left'', ''centered''		*'''Box orientation'''{{NewIn\|3.0}}: Three options are available: ''left to right'', ''right to left'', ''centered''

	Click on '''Save boxes settings''' once you are done. If everything is turned on, the home page should look like this:		Click '''Save boxes settings''' once you are done. If everything is turned on, the home page should look like this:
	[[File: Home page view.png]]		[[File: Home page view.png]]

	=Boxes=		==Boxes==

	The LimeSurvey installation comes by default with six boxes created: ''Create survey'', ''List survey'', ''Global settings'', ''ComfortUpdate'', ''Label sets'' and ''Templates''. They can be either edited (the green pen button) or deleted (the red trash button):		The LimeSurvey installation comes by default with six boxes created: ''Create survey'', ''List survey'', ''Global settings'', ''ComfortUpdate'', ''Label sets'' and ''Templates''. They can be either edited (the green pen button) or deleted (the red trash button):
Line 31:		Line 31:
	<center>[[File:Boxes Table.png]]</center>		<center>[[File:Boxes Table.png]]</center>

	==Create/Edit a box==		===Create/Edit a box===

	~~In order to~~ add a new box into the '''Boxes''' table, click on '''Create a new box''', located in the upper part of the screen:		To add a new box into the '''Boxes''' table, click '''Create a new box''', located in the upper part of the screen:
	<center>[[File:Creat and reset - boxes.png]]</center>.		<center>[[File:Creat and reset - boxes.png]]</center>.

Line 50:		Line 50:
	**''Other user groups'' : a certain user group is allowed to see those boxes. To find out more about user groups, read our wiki [[Users#Manage user groups\|on how to manage them]]		**''Other user groups'' : a certain user group is allowed to see those boxes. To find out more about user groups, read our wiki [[Users#Manage user groups\|on how to manage them]]

	Once done, click on the '''Save''' button that is located in the upper right part of the screen.		Once done, click the '''Save''' button that is located in the upper right part of the screen.

	<div class="simplebox">[[File:help.png]] The fields of a box can be edited later by clicking on the green pen button located in the last column of the '''Boxes''' table.</div>		<div class="simplebox">[[File:help.png]] The fields of a box can be edited later by clicking on the green pen button located in the last column of the '''Boxes''' table.</div>
Line 56:		Line 56:
	{{Note\|Check [[Home page settings#Examples\|the example provided below]] to better understand this functionality.}}		{{Note\|Check [[Home page settings#Examples\|the example provided below]] to better understand this functionality.}}

	==Reset to the default settings==		===Reset to the default settings===

	If you ~~did too many~~ changes or you ~~broke up some of the default boxes' functionalities~~, click on the '''Reset to default boxes''' button, located on the upper right side of the window. This would restore the default boxes.		If you want to reverse the changes that you made, click the '''Reset to default boxes''' button, located on the upper right side of the window. This would restore the default boxes.

	<center>[[File:Creat and reset - boxes.png]]</center>		<center>[[File:Creat and reset - boxes.png]]</center>

	=Examples=		==Examples==

	==I want to create a new box==		===I want to create a new box===

	*Access '''Home page settings''' from the '''Configuration''' dialog.		*Access '''Home page settings''' from the '''Configuration''' dialog.
	*Click on '''Create new box''', located in the upper right part of the window.		*Click '''Create new box''', located in the upper right part of the window.
	*Enter the requested information		*Enter the requested information
	<center>[[File:Add a new box - example.png]]</center>		<center>[[File:Add a new box - example.png]]</center>
Line 77:		Line 77:
	<center>[[File:Add a new box - example 2.png]]</center>		<center>[[File:Add a new box - example 2.png]]</center>

	*Click on the newly created box and check whether it is working or not (if not, recheck its destionation URL):		*Click the newly created box and check whether it is working or not (if not, recheck its destionation URL):
	<center>[[File:Create a new box example test.png]]</center>		<center>[[File:Create a new box example test.png]]</center>

← Older revision		Revision as of 16:15, 9 November 2017
Line 13:		Line 13:
	<center>[[File:Home page settings view.png]]</center>		<center>[[File:Home page settings view.png]]</center>

	*'''Display logo''': If it is turned '~~off~~', the logo situated above the boxes disappears (the default value is 'On');		*'''Display logo''': If it is turned 'Off', the logo situated above the boxes disappears (the default value is 'On')
	*'''Show last visited survey and question''': It is turned 'on' by default. It shows the last visited question and survey, the bar being located between the logo and the boxes;		*'''Show last visited survey and question''': It is turned 'On' by default. It shows the last visited question and survey, the bar being located between the logo and the boxes
	*'''Show survey list''': The default value is 'Off'. If you switch it to 'On', a survey list will appear below the boxes from the home page;		*'''Show survey list''': The default value is 'Off'. If you switch it to 'On', a survey list will appear below the boxes from the home page
	*'''Show search box on survey list''': If it is ticked 'Off', the search box will not be shown in the '''survey list'''. Please note that this option does not have any effect on your home page if the '''Show survey list''' option is not turned on;		*'''Show search box on survey list''': If it is ticked 'Off', the search box will not be shown in the '''survey list'''. Please note that this option does not have any effect on your home page if the '''Show survey list''' option is not turned on
	*'''Wrap container around Boxes'''{{NewIn\|3.0}}: If it is turned 'on', the container around each box gets smaller (useful function when more boxes are added to your home page) ;		*'''Wrap container around Boxes'''{{NewIn\|3.0}}: If it is turned 'On', the container around each box gets smaller (useful function when more boxes are added to your home page)
	*'''Boxes by row''': The number of boxes you would like to have on each row. The default number is '3';		*'''Boxes by row''': The number of boxes you would like to have on each row. The default number is '3'
	*'''Box offset'''{{ObsoleteIn\|3.0}}: '''Box offset''' is a function that helps users center the boxes. For example, if you use 15 boxes, you can use the '''box offset''' function in order to better arrange them into your home page. This function does not exist anymore in LimeSurvey 3.0 (and the later versions) because the boxes are automatically centered;		*'''Box offset'''{{ObsoleteIn\|3.0}}: '''Box offset''' is a function that helps users center the boxes. For example, if you use 15 boxes, you can use the '''box offset''' function in order to better arrange them into your home page. This function does not exist anymore in LimeSurvey 3.0 (and the later versions) because the boxes are automatically centered
	*'''Box orientation'''{{NewIn\|3.0}}: Three options are available: ''left to right'', ''right to left'', ''centered''.		*'''Box orientation'''{{NewIn\|3.0}}: Three options are available: ''left to right'', ''right to left'', ''centered''

	Click on '''Save boxes settings''' once you are done. If everything is turned on, the home page should look like this:		Click on '''Save boxes settings''' once you are done. If everything is turned on, the home page should look like this:
Line 27:		Line 27:
	=Boxes=		=Boxes=

	The LimeSurvey installation comes by default with six boxes created: ''Create survey'', ''List survey'', ''Global settings'', ''ComfortUpdate'', ''Label sets'', and ''Templates''. They can be either edited (the green pen button) or deleted (the red trash button):		The LimeSurvey installation comes by default with six boxes created: ''Create survey'', ''List survey'', ''Global settings'', ''ComfortUpdate'', ''Label sets'' and ''Templates''. They can be either edited (the green pen button) or deleted (the red trash button):

	<center>[[File:Boxes Table.png]]</center>		<center>[[File:Boxes Table.png]]</center>
Line 33:		Line 33:
	==Create/Edit a box==		==Create/Edit a box==

	In order to add a new box into the '''Boxes''' table, click on '''Create a new box''', located in the upper-part of the screen:		In order to add a new box into the '''Boxes''' table, click on '''Create a new box''', located in the upper part of the screen:
	<center>[[File:Creat and reset - boxes.png]]</center>.		<center>[[File:Creat and reset - boxes.png]]</center>.

Line 39:		Line 39:
	<center>[[File:Create a new box.png]]</center>		<center>[[File:Create a new box.png]]</center>

	*'''Position''': It shows the box position (it is a numerical value);		*'''Position''': shows the box position (it is a numerical value)
	*'''Destination URL''': ~~It is~~ the link via which the respective option/function is accessed. For example, the destination URL to backup the entire database is ''admin/dumpdb'';		*'''Destination URL''': the link via which the respective option/function is accessed. For example, the destination URL to backup the entire database is ''admin/dumpdb''
	*'''Title''': ~~The~~ name of the box;		*'''Title''': name of the box
	*'''Icon''': It allows the user to select one of the LimeSurvey predefined icons;		*'''Icon''': allows the user to select one of the LimeSurvey predefined icons
	*'''Description''': ~~A small~~ description of ~~what~~ the ~~role~~ of the box ~~is can be typed in;~~		*'''Description''': short description of the purpose of the box
	*'''Display this box to''': It allows you to choose who can see the respective box:		*'''Display this box to''': allows you to choose who can see the respective box
	**''Only admin'' : ~~Only~~ the super administrator of the LimeSurvey installation can see those respective boxes;		**''Only admin'' : only the super administrator of the LimeSurvey installation can see those respective boxes
	**''Everybody'' : ~~Everyone~~ who logs in the LimeSurvey installation can see those respective boxes. ~~They are the~~ survey users defined in the [[Manage users\|User Control panel]];		**''Everybody'' : everyone who logs in the LimeSurvey installation can see those respective boxes, i.e. survey users defined in the [[Manage users\|User Control panel]]
	**''Nobody'' : ~~Nobody~~ can see those boxes. It can be used when you would like~~, for example,~~ to hide boxes from a specific [[Users#Manage user groups\|user group]].		**''Nobody'' : nobody can see those boxes. It can be used when you would like to hide boxes from a specific [[Users#Manage user groups\|user group]] for example
	**''Other user groups'' : A certain user group is allowed to see those boxes. To find out more about user groups, read our wiki [[Users#Manage user groups\|on how to manage them]].		**''Other user groups'' : a certain user group is allowed to see those boxes. To find out more about user groups, read our wiki [[Users#Manage user groups\|on how to manage them]]

	Once done, click on the '''Save''' button that is located in the upper-right part of the screen.		Once done, click on the '''Save''' button that is located in the upper right part of the screen.

	<div class="simplebox">[[File:help.png]] The fields of a box can be later ~~edited~~ by clicking on the green pen button located on the last column of the '''Boxes''' table.</div>		<div class="simplebox">[[File:help.png]] The fields of a box can be edited later by clicking on the green pen button located in the last column of the '''Boxes''' table.</div>

	{{Note\|Check [[Home page settings#Examples\|the example provided below]] to better understand this functionality.}}		{{Note\|Check [[Home page settings#Examples\|the example provided below]] to better understand this functionality.}}
Line 58:		Line 58:
	==Reset to the default settings==		==Reset to the default settings==

	If you did too many changes or you broke up some of the default boxes functionalities, click on the '''Reset to default boxes''' button, located in the upper-right side of the window. This would restore the default boxes.		If you did too many changes or you broke up some of the default boxes' functionalities, click on the '''Reset to default boxes''' button, located on the upper right side of the window. This would restore the default boxes.

	<center>[[File:Creat and reset - boxes.png]]</center>		<center>[[File:Creat and reset - boxes.png]]</center>
Line 67:		Line 67:

	*Access '''Home page settings''' from the '''Configuration''' dialog.		*Access '''Home page settings''' from the '''Configuration''' dialog.
	*Click on '''Create new box''', located in the upper right-part of the window.		*Click on '''Create new box''', located in the upper right part of the window.
	*Enter the requested information:		*Enter the requested information
	<center>[[File:Add a new box - example.png]]</center>		<center>[[File:Add a new box - example.png]]</center>

Line 77:		Line 77:
	<center>[[File:Add a new box - example 2.png]]</center>		<center>[[File:Add a new box - example 2.png]]</center>

	*Click on the newly created box and check whether it is working or not (if not, ~~re-check~~ its destionation URL):		*Click on the newly created box and check whether it is working or not (if not, recheck its destionation URL):
	<center>[[File:Create a new box example test.png]]</center>		<center>[[File:Create a new box example test.png]]</center>