Difference between revisions of "Create new modules"

From Tourism Barometer Wiki
Jump to navigationJump to search
m (Beveiligde "Create new modules" ([edit=sysop] (vervalt niet) [move=sysop] (vervalt niet)) [cascade])
 
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Create new module ==
+
With this function you can add new modules to the Tourism Barometer. To ensure the quality of the Barometer, you are required to build your module in the Sandbox environment. Go to [[Different environments]] for more information.
  
This function can be used to add new modules to the Tourist Barometer. In order to guarantee the barometer’s high standards, users are requested to build modules in the sandbox environment before asking a Barometer Administrator to include the module in the live environment. Read additional information about the [[different environments]].
+
To create a new module undertake the next steps:
  
The process for creating a new module is as follows:
+
1. Open the module 'Accounts'. The module can be started directly from the ‘Welcome’ screen of the account management section or by selecting 'Accounts' in the module selection on top of the page.
  
1. Open the ‘Accounts’ module.
+
2. Select 'Modules' in the menu on the left-hand side of the screen.
  
2. Click on the ‘Add module’ button.
+
3. Next, click in the left upper corner on 'Add'.
  
3. Enter the name of the new module. Note: the name of the module should be short, clear and unique.
+
4. Specify the name of the new module (in all available languages). Please note: the name of the module needs to be unique, short and clear.  
  
4. Turn the tick next to ‘Include in comparison module’ on and click ‘Save’.
+
5. Tick 'Use in the comparison module?'.
  
5. Open the ‘Accounts’ module and then open the account in which the new module should be available.
+
6. Next, select the accounts to which the new module needs to be linked by ticking the respective boxes. For instance, Amsterdam.
  
6. Click on ‘Link new modules’ at the bottom of the page. Newly-created modules will be linked to the account.
+
7. Click on 'Save' to save the new module.
  
7. Open the ‘Language management’ module.
 
  
8. Search for the terms by selecting ‘General - module’ in ‘Select page’.
+
There are a few more steps to ensure the terms of the module will be displayed correctly in the Barometer.
  
9. Enter the translations for the new module. If you have forgotten a step of the process, the new module will be displayed as ‘naamMeervoud’ (‘nameMultiple’).
+
8. Open the module 'Language settings'. The module can be started directly from the ‘Welcome’ screen of the account management section or by selecting 'Language settings' in the module selection on top of the page.
  
10. Log out and in again to load the new translations.
+
9. Search for the respective terms by clicking ‘module’ in the table. This will result in the list being sorted by module (one click: A-Z, double click: Z-A). Next, find the newly created module by scrolling through the list. Please note: leave all ‘filter’ fields empty.  
  
11. Open the ‘Accounts’ module and open an account.
+
10. Now, at the new module, check the terms such as 98, 101, 102, 479, 480, 481 and 516.
 +
The table below shows what needs to be checked.  
  
12. Go to the tab for the new module and configure the module. Remember to activate the module.
+
{| class="wikitable" width="80%"
 +
| style="width:5%;" | Term  || style="width:19%;" | Description  || style="width:18%;" | Default Value  || style="width:58%;" | Note
 +
|-
 +
| 98 || Name XXX || Name {0} || The figure (e.g. the number of passengers) goes here. This is the same figure as in 481 and 516.
 +
|-
 +
| 101 || Number of participants XXX || Number of participants {0} || Number of participants {0}.  The module name needs to be displayed between the curly brackets (should be filled automatically).
 +
|-
 +
| 102 || Average number XXX || Average number {0} || Average number {0}. This doesn’t usually need to be edited as it is displayed automatically.
 +
|-
 +
| 479 || Module name || Name single or multiple || Name. This number must always be 480. Differentiation between single and multiple is not possible – this won’t be visible and the name will not be displayed.
 +
|-
 +
| 480 || Module name || Name single or multiple || Name.  See note at 479
 +
|-
 +
| 481 || Module figure || Figure || Figure.  See note at  98
 +
|-
 +
| 516 || Module figure || Figure || Figure. See note at  98
 +
|}
  
 +
11. Log out and log in again to load new translations.
  
== Translate new module ==
+
12. Open the module 'Accounts' and open your own account, e.g. Amsterdam.
  
 +
13. Scroll down and select the new module. The module can now be configured, see [[Edit existing modules]] for more information.
  
'''Important:''' The Barometer Administrator also needs to enter the translations before the module can be used.
+
'''Let op:''' don’t forget to set the module to ‘active’.
  
1. Open the ‘Language management’ module.
+
14. Click after configuration on the 'Save' button.  
  
2. Search for the terms by selecting ‘General - module’ in ‘Select page’.
 
  
3. Enter the translations for the new module. If you have forgotten a step of the process, the new module will be displayed as ‘naamMeervoud’ (‘nameMultiple’).
 
  
4. Log out and in again to load the new translations.
+
----
 
 
 
 
== Link new module ==
 
 
 
The ‘Add module’ link will be displayed on the left-hand side of the screen.
 
 
 
The Add module screen is used to enter the module name and to indicate whether the module should be included in the ‘Comparison module’.
 
 
 
 
 
              Example: Module name: Canal cruises
 
              Include in comparison module? [Tick]
 
  
 +
Used in [[Manage Accounts]]
  
Click on "save".
+
Back to [[Barometer Administrator section]]
 
 
 
 
== Configure new module ==
 
 
 
After the module has been saved, it can be configured as described in [[Edit existing modules]].
 
 
 
Remember to activate the module.
 
 
 
 
 
----
 
 
 
Used in [[Accounts]]
 

Latest revision as of 19:11, 20 November 2015

With this function you can add new modules to the Tourism Barometer. To ensure the quality of the Barometer, you are required to build your module in the Sandbox environment. Go to Different environments for more information.

To create a new module undertake the next steps:

1. Open the module 'Accounts'. The module can be started directly from the ‘Welcome’ screen of the account management section or by selecting 'Accounts' in the module selection on top of the page.

2. Select 'Modules' in the menu on the left-hand side of the screen.

3. Next, click in the left upper corner on 'Add'.

4. Specify the name of the new module (in all available languages). Please note: the name of the module needs to be unique, short and clear.

5. Tick 'Use in the comparison module?'.

6. Next, select the accounts to which the new module needs to be linked by ticking the respective boxes. For instance, Amsterdam.

7. Click on 'Save' to save the new module.


There are a few more steps to ensure the terms of the module will be displayed correctly in the Barometer.

8. Open the module 'Language settings'. The module can be started directly from the ‘Welcome’ screen of the account management section or by selecting 'Language settings' in the module selection on top of the page.

9. Search for the respective terms by clicking ‘module’ in the table. This will result in the list being sorted by module (one click: A-Z, double click: Z-A). Next, find the newly created module by scrolling through the list. Please note: leave all ‘filter’ fields empty.

10. Now, at the new module, check the terms such as 98, 101, 102, 479, 480, 481 and 516. The table below shows what needs to be checked.

Term Description Default Value Note
98 Name XXX Name {0} The figure (e.g. the number of passengers) goes here. This is the same figure as in 481 and 516.
101 Number of participants XXX Number of participants {0} Number of participants {0}. The module name needs to be displayed between the curly brackets (should be filled automatically).
102 Average number XXX Average number {0} Average number {0}. This doesn’t usually need to be edited as it is displayed automatically.
479 Module name Name single or multiple Name. This number must always be 480. Differentiation between single and multiple is not possible – this won’t be visible and the name will not be displayed.
480 Module name Name single or multiple Name. See note at 479
481 Module figure Figure Figure. See note at 98
516 Module figure Figure Figure. See note at 98

11. Log out and log in again to load new translations.

12. Open the module 'Accounts' and open your own account, e.g. Amsterdam.

13. Scroll down and select the new module. The module can now be configured, see Edit existing modules for more information.

Let op: don’t forget to set the module to ‘active’.

14. Click after configuration on the 'Save' button.



Used in Manage Accounts

Back to Barometer Administrator section