Skip to content

Commit

Permalink
Change 'checkbox' to 'switch'
Browse files Browse the repository at this point in the history
  • Loading branch information
kristian-lange committed Jun 6, 2024
1 parent 72ec2ae commit c06772a
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 2

## Set up group studies

First and common to all group setups is to check the Group study checkbox in the study properties.
First and common to all group setups is to check the Group study switch in the study properties.

![Group's property](/img/v39x/study-properties-group-study.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ By clicking the _Studies_ button you'll get to an overview about all studies tha

The information is displayed in a table with the columns:

* **Active** - In cases where e.g. a study uses to many server resources, an admin can **deactivate** (or activate again) it by clicking the checkbox in the 'Active' column. A deactivated study cannot be started by participants (workers) anymore, but an already started study run can be continued. That means, an admin will not interrupt a participant if they already started doing a study, but no new participants will be able to start it. The study members can still see and edit the study, as well as export its result data.
* **Active** - In cases where e.g. a study uses to many server resources, an admin can **deactivate** (or activate again) it by clicking the switch in the 'Active' column. A deactivated study cannot be started by participants (workers) anymore, but an already started study run can be continued. That means, an admin will not interrupt a participant if they already started doing a study, but no new participants will be able to start it. The study members can still see and edit the study, as well as export its result data.
* **Study Assets Size** - The disk size of all asset files associated to this study (HTML, JS, CSS, images, videos, etc.).
* **Result Count** - The number of study results collected so far on this JATOS instance.
* **Result Data Size** - The size of all result data that are stored in the database. In brackets is the average size per result count.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Every user can be granted Admin rights, by checking the corresponding box in the

![User manager screenshot](/img/v39x/user_manager_3.png)

A user can be **deactivated** (and activated again) by clicking the checkbox in the 'Active' column. A deactivated user cannot log in anymore but their studies can still be run by participants (to prevent a study from running, deactivate it in the study _Administration_ page).
A user can be **deactivated** (and activated again) by clicking the switch in the 'Active' column. A deactivated user cannot log in anymore but their studies can still be run by participants (to prevent a study from running, deactivate it in the study _Administration_ page).

If you're an admin and need to get more information about a user's studies, click on the _Studies_ column. You'll see _Result Data Size_ and _Result File size_, which can give you an idea of how many of the server's resources this user needs.

Expand All @@ -43,7 +43,7 @@ Superusers can access all studies on this JATOS instance regardless if they were

JATOS allows password authentication via LDAP (which lets an institution manage their users in a centralized way). LDAP is disabled by default. To enable it [change the JATOS config file](JATOS_Configuration.html#ldap-authentication).

Once LDAP is enabled, there will be an additional checkbox 'LDAP' on the overlay dialog when an admin creates a new user. Check this box to enforce authentication by LDAP. Normal JATOS users (locally authenticated) and LDAP users can co-exist in the same JATOS instance.
Once LDAP is enabled, there will be an additional switch 'LDAP' on the overlay dialog when an admin creates a new user. Check this box to enforce authentication by LDAP. Normal JATOS users (locally authenticated) and LDAP users can co-exist in the same JATOS instance.

At the moment it is not possible to let JATOS create LDAP users automatically - they must be created by an JATOS admin manually.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@ If set to `true` an user with the Admin role can grant the role Superuser to any
## LDAP authentication
At the moment LDAP users still have to be created manually in JATOS' _User manager_ (with the checkbox LDAP turned on). Only the authentication is done via LDAP.
At the moment LDAP users still have to be created manually in JATOS' _User manager_ (with the switch LDAP turned on). Only the authentication is done via LDAP.

If your LDAP server uses encryption, you have to add your certificate to JATOS' trusted certificates defined with `play.ws.ssl.trustManager.stores` (only possible in a config file). E.g., if your certificate's location is in `/jatos/conf/certs/ca.pem`, then use the following to add it:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ Let's first say what we understand under the _study flow_:

## Allow reload or prevent a reload of the same component

A worker can press their browser's reload button and by default JATOS will respond with the same component again: by default, the worker can do a component multiple times. To prevent this each **component properties** has a checkbox _Allow reload_.
A worker can press their browser's reload button and by default JATOS will respond with the same component again: by default, the worker can do a component multiple times. To prevent this each **component properties** has a switch _Allow reload_.

![GUI Screenshot](/img/v39x/component-properties-reload.png)

If you want to prevent this behaviour uncheck the box. If a participant reloads the page, they will see an error message. Then the study run will be finished and put to state FAIL. Since each component properties has their own _Allow reload_ checkbox it can be defined differently for each component, e.g. reloading is allowed in the introduction but is prohibited in the actual experiment.
If you want to prevent this behaviour uncheck the box. If a participant reloads the page, they will see an error message. Then the study run will be finished and put to state FAIL. Since each component properties has their own _Allow reload_ switch it can be defined differently for each component, e.g. reloading is allowed in the introduction but is prohibited in the actual experiment.

**Hint**: You should tell your workers in your study description if you disable reloads, in order to prevent them from accidentally pressing the reload button and failing your study. Consider also adding a warning (e.g. a pop-up) informing participants that they will not be able to continue with the study.

Expand All @@ -34,7 +34,7 @@ If you want to prevent this behaviour uncheck the box. If a participant reloads

## Ensure a linear study flow

A worker can press their browsers back button and by default JATOS will response with the previous component, the one that was done before by the worker. This might allow a worker to divert from the intended study flow. To prevent this each **study properties** has a checkbox _Linear study flow_.
A worker can press their browsers back button and by default JATOS will response with the previous component, the one that was done before by the worker. This might allow a worker to divert from the intended study flow. To prevent this each **study properties** has a switch _Linear study flow_.

![Study Properties Screenshot](/img/v39x/study-properties-linear-flow.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ After clicking the **Study Links** button you get a new window where you can cre
1. Lets you create several study links and lets you add a comment to them. The comment is only a hint for you that you can use to distinguish your study links. You can create Personal type study links in bulk by changing the Amount value.
1. This is the study code. [You can hand this to your workers](Run-your-Study-with-Study-Links.html#study-code--study-entry-page).
1. This is your actual study link. Hand this to your workers. There are two links that can be toggled by a button: 1) [The 'Open Directly' link starts the study right away](Run-your-Study-with-Study-Links.html#start-directly-with-a-study-link). 2) [The 'Confirm First' lets your worker confirm first with a button press](Run-your-Study-with-Study-Links.html#study-link--study-entry-page-for-confirmation). Use the <span class="glyphicon glyphicon-duplicate"></span> button to copy the link to the clipboard or <span class="glyphicon glyphicon-qrcode"></span> to get the QR code.
1. Use this checkbox to de-/activate a single study link. A deactivated study link can not be used to start a study run (but an already started study run can continue to run).
1. Use this switch to de-/activate a single study link. A deactivated study link can not be used to start a study run (but an already started study run can continue to run).
1. Use these buttons to filter the study links. You can show _All_, only the _Active_ or _Deactivated_ ones, or show only the links that were already _Used_.

![Study Links page screenshot](/img/v39x/study_links_14.png)
Expand Down Expand Up @@ -127,7 +127,7 @@ Each study comes with a "Default" batch (although it can be renamed in its batch

![Study Links page screenshot](/img/v39x/study_links_12.png)

You can **deactivate** or **activate** a batch by clicking on the checkbox button in each batch row. A deactivated batch doesn't allow any study runs.
You can **deactivate** or **activate** a batch by clicking on the switch in each batch row. A deactivated batch doesn't allow any study runs.


### Batch Properties
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Each study has a **Change users** button in its study toolbar.

In this menu you can add single users by their username. Of course this works only if this is already a JATOS user. For privacy reasons JATOS never shows the username (which is often an email address) in the member list.

A single user is removed by unchecking the checkbox in front of its name.
A single user is removed by clicking the **Remove** button in the user's row.

Additionally it is possible, if your admins allow it, to add all JATOS users at once or remove all members at once. Then you will see the **Add All** and **Remove All** buttons.

Expand Down

0 comments on commit c06772a

Please sign in to comment.