Description

The wording of the required rights feature is currently confusing for users who aren't familiar with the feature - and the feature is quite complex. The most important part of this improvement is to improve the wording of the information that is displayed to all users. Users should be able to understand that a page that enforces a right is a page containing scripts even without fully understanding required rights. The following shows the state before any fixes.

Information About the Current Required Rights

This is in the "Information" tab:

 or 

There are the following texts:

1. When required rights aren't enforced: "This page is not enforcing any right. The rights of its last author apply to the page content."
2. When required rights are enforced, but no right is set: "This page is enforcing required rights but no rights are specified. Edit right is sufficient to edit this page and no rights are applied to the page content."
3. When required rights are enforced and a right is set: "This page is enforcing required rights. The following right(s) are necessary to edit this page and applied to its content:". Below this message, normally, one of the following is displayed in a list. In theory, there could be several values configured, but this isn't possible through the UI.
   1. Script right
   2. Admin right on the wiki level
   3. Programming rights

Call to Action

When the current user is advanced or has at least script right and can edit the current page, one of the following calls to action could be displayed depending on the current state and the result of the automated analysis, always followed by a button "Review required rights". When required rights are already enforced, one of the following can be displayed:

1. This document's content is missing a required right. Review the required rights to add it.
2. This document's content might be missing a required right, but the automated analysis couldn't determine if it is actually necessary. Review the required rights to determine if it should be added.
3. This document's content might not need the configured required right, but the automated analysis couldn't determine if it is actually necessary. Review the required rights to determine if fewer rights might be enough.
4. According to the automated analysis, this document's content doesn't need the configured required right. Review the required rights to remove it.

When required rights aren't enforced, "Review the required rights and enforce them to increase the security of this page." is displayed.

When a required right is missing, the first message is also displayed as a warning above the content.

Dialog - Introduction

At the start of the dialog, there are two options with some explanations for each of those options:

Dialog - Selection

The selection screen marks certain rights based on the automated analysis:

When hovering/clicking on those icons, a help text is displayed:

The possible texts here are:

• Required: The automated analysis determined that the "{0}" right is required by the content of this document.
• Might be required: The automated analysis determined that the "{0}" right might be required by the content of this document, review the analysis details below to verify if the right is actually required.

For the "None" option there are the following two possibilities:

• Might be enough: The automated analysis hasn't found any content that definitely requires any rights. Review the analysis details below to verify if indeed no rights are required.
• Enough: The automated analysis hasn't found any content that requires any rights.

Proposed wording improvements

Information About the Current Required Rights

1. When required rights aren't enforced: "No rights are currently enforced on this page. It runs using the rights of the last person who edited it."
2. When required rights are enforced, but no right is set: "Required rights are enabled for this page, but none are defined. Only the standard "Edit" right is used on this page, and no special rights apply to its content."
3. When required rights are enforced and a right is set: "Required rights are enabled for this page. The content of this page runs with the following right, so users need to have this right for editing it:"
   1. Scripting: Allows running scripts (macros, Velocity, JavaScript, CSS, etc.)
   2. Administrating the wiki: Allows making administrative changes at the wiki level.
   3. Programming: Allows advanced scripts with full access to the wiki farm.

Call to action

When the current user is advanced or has at least script right and can edit the current page, one of the following calls to action could be displayed depending on the current state and the result of the automated analysis, always followed by a button "Check page rights". When required rights are already enforced, one of the following can be displayed:

1. This page is missing a right to run correctly. Check the page rights to add it.
2. This page may need an additional right, but the analysis couldn’t confirm it. Check the page rights to review whether it should be added.
3. This page may not need one of its configured rights, but the analysis couldn’t confirm it. Check the page rights to see if fewer rights are enough.
4. This page doesn’t appear to need one of its configured rights. Check the page rights to remove it.

When required rights aren't enforced, "Improve the security of this page by requiring rights." is displayed.

Dialog

Don't enforce required rights

• Scripts and objects are executed with all the rights of the last person who edited the page.
• Anyone with the “Edit” right can modify the page.

Enforce required rights

• Scripts and objects are executed only with the explicitly required rights of the last person who edited the page (even if they have more rights).
• Only users with “Edit” right and the selected rights can edit the page.

Select the right to enforce

Each right level includes all the rights listed before it.

The possible texts here are:

• Required: The analysis shows that the "{0}" right is needed for this page’s content to work correctly.
• Might be required: The analysis shows that the "{0}" right may be needed, but it’s not certain. Review the details below to confirm whether it is actually required.

For the "None" option there are the following two possibilities:

• Might be enough: The analysis didn’t find any content that definitely needs special rights. Review the details below to confirm that none are required.
• Enough: The analysis shows that no special rights are required for this page to work correctly.