Source code exclusions

Introduction¶

The Source Code Exclude feature allows users to configure custom exclusions to website scans. The exclusions target particular elements and stop the contents from being flagged as issues.

Add exclusions to accessibility, readability, and misspelling checks on a customer level and then apply them to specific domains.

This article gives instructions for advanced users on how to configure a source code exclude for a website scan.

Add a Source Code Exclusion to the Accessibility Module¶

This section gives instructions on how to add a source code exclusion to the module on a customer level and then apply it to a domain.

1. Click Admin Settings (gear icon) on the top menu bar of any page in Acquia Optimize. The Domain Settings page opens.

    

   Note

   The Admin Settings button is only available to site admins.

    

   

2. Select Source Code Excludes from the menu on the left side of the page.

   

   The Source Code Excludes page opens.

3. Click Add Source Code Exclude.

   

   The Source Code Excludes page opens.

4. Click to select Accessibility.

   

5. The Source Code Exclude details page opens.

   
6. Short Description (required): Click in the text field and type in a short description for this excluded snippet.

7. Default for CMS: Click in the field and identify the CMS from the drop-down menu, if applicable.

    

   Note

   If a CMS is selected here and a domain with the same selected CMS exists on the account, the domain will automatically have the source code exclude applied to it.

    

    

   Note

   If you use a CMS and it is not present in the list, contact the Support Team to see if it can be added.

    

8. Type (required): Click in the field and select the exclusion type from the drop-down menu.

   • Exact: Identifies and filters out all instances where the complete and exact HTML snippet appears. For example, the snippet https:/ /w ww. example. com/ is an exact match for:

     • https:/ /ww w. example. com/

     While these HTML snippets are NOT a match:

     • https:/ /ww w. example. com
     • http:/ /w ww. example. com/
     • https:/ /example. com/
     • https:/ /example. com/?something=1
     • https:/ /example. com/#something=1
   • Regex: Identifies and filters out specific patterns of HTML through the use of regular expressions.
   • Contains: Identifies and filters out all snippets that contain the HTML values entered. For example, the snippet example.com is a match for these HTML values:
     • https:/ /ww w. example. com/
     • https:/ /ww w. example. com
     • http:/ /ww w. example. com/
     • https:/ /example. com/
     • https:/ /example. com/?query=1
     • https:/ /example. com/subpage
     • https:/ /example. com/subpage/product_page
9. Value (required): Click in the text input field and type or paste in the HTML snippet to be excluded.
10. Identify specific HTML snippets for the filter and enter them into the value field.
11. See the section Locate HTML snippets to use in a Source Code Exclude for instructions on how to find the snippets.

Add a Source Code Exclusion to the Readability module¶

This section gives instructions on how to exclude a segment of the webpage from the spellcheck.

1. Click Admin Settings (gear icon) on the top menu bar. The Domain Settings page opens.

    

   Note

   The Admin Settings button is only available to site admins.

    

   

2. Select Source Code Excludes from the menu on the left side of the page.

   

   The Source Code Excludes page opens.

3. Click Add Source Code Exclude.

   

   The Source Code Exclude page opens.

4. Click Readability.

   

   The Source Code Exclude details page opens.

   
5. Description (required): Click in the text field and type in a short description for the excluded snippet.
6. Default for CMS: Click in the field and select the CMS from the drop-down menu, or select None if there is no CMS. 
   If your CMS is not on the list, contact the Support Team to see if it can be added.

7. CSS Target Selector (required): Click in the field and select an existing CSS selector pattern from the drop-down menu, or click + to add a new one.

   The scan identifies elements that match the entered CSS selector patterns and omits them from the results.

    

   Note

   There is no limit to the number of CSS Target Selectors that you can add.

    

   For more information, see the user guide article:

   Configure Source Code Exclusions with CSS Selectors.

8. Click Save to save the source code exclusion. The Details page closes and the Source Code Excludes list page is visible. The new source code exclusion is on the list.
9. Add the updated script to the website HTML code.

For more information, see the user guide articles:

• Add the Script
• Quality Assurance: Readability
• Configure Source Code Exclusions with CSS Selectors.

Add Source Code Exclusion to the Spellcheck Module¶

This section gives instructions on how to exclude a segment of the webpage from the spellcheck.

1. Click Admin Settings (gear icon) on the top menu bar of any page in Acquia Optimize. The Domain Settings page opens.

    

   Note

   The Admin Settings button is only available to site admins.

    

   

2. Select Source Code Excludes from the menu on the left side of the page.

   

   The Source Code Excludes page opens.

3. Click Add Source Code Exclude.

   

   The Source Code Exclude page opens.

4. Click Misspellings.

   

5. The Source Code Exclude details page opens.

   
6. Description (required): Click in the text field and type in a short description for the excluded snippet.
7. Default for CMS: Click in the field and select the CMS from the drop-down menu, or select None if there is no CMS. If your CMS is not on the list, contact Acquia Optimize Support to see if it can be added.

8. CSS Target Selector (required): Click in the field and select an existing CSS selector pattern from the drop-down menu, or click + to add a new one.

   Once added, subsequent scans identify elements that match the entered CSS selector patterns and omits them from the results.

    

   Note

   There is no limit on the number of CSS Target Selectors that can be added.

    

   For more information, see the user guide article:

   1. Configure Source Code Exclusions with CSS Selectors.
9. Click Save to save the source code exclusion. The Details page closes and the Source Code Excludes list page is visible. The new source code exclusion is on the list.

For more information, see the user guide articles:

• Quality Assurance: Spellcheck
• Quick Guide: Fix Misspelled Words.

Apply the Source Code Exclusion to a Domain¶

This section gives instructions on how to apply a source code exclusion to a domain.

1. Click Admin Settings (gear icon) on the top menu bar of any page in Acquia Optimize. The Domain Settings page opens.

    

   Note

   The Admin Settings button is only available to site admins.

    

   

2. Click Action on the same row as the domain to scan.

   

3. Select Edit Domain from the drop-down list.

   

   The Edit Domain pane opens.

   
4. Locate the Features section.

5. In the Source Code Excludes field: Click the drop-down arrow and select the domain that contains the source code.

   
6. Click Save at the bottom of the page.

Locate HTML snippets to use in a Source Code Exclusion¶

This section gives instructions on how to locate HTML snippets that can be used to set up a source code exclusion.

Locate snippets in FastTrack:¶

HTML snippets that affect the website compliance level can be found in FastTrack, along with a list of the checks the snippets are flagged for.

How to find HTML snippets that affect website compliance levels:

1. Click the domain URL on the domain list, on the left side of the Acquia Optimize landing page. The domain dashboard opens.

2. Click Accessibility (icon of a person standing with arms outstretched) on the menu bar at the top of the domain dashboard. The Accessibility page opens.

   

3. Click FastTrack, from the menu on the left side of the page.

   

   The Accessibility FastTrack pane opens.

   
4. Locate and copy the HTML snippets to include and paste them into the form for Source Code Excludes.

Locate snippets in Accessibility Page Details:¶

1. From the PageDetails section for any page within Acquia Optimize, click Accessibility (icon of a human with outstretched arms) on the top menu bar.

   

2. Snippets with potential errors are listed on the right side panel of the page.

   
3. Copy the HTML snippets to include and paste them into the form for Source Code Excludes.

For more information, see the user guide article:

FastTrack.

Additional Resources¶

For more information, see the user guide articles:

• Configure Domain Scans
• Configure Source Code Exclusions with CSS Selectors
• Configure Scans for Password Protected and Internal Only Pages
• Single Page Scans
• Document Scans
• PDF Accessibility Scans
• Path Constraints and Link Exclusions
• Mobile Accessibility Scans.