SPJ - Configuring Spellproof

Owned by Bunney Apps
Last updated: Apr 24, 2022
5 min read


Configuring languages and dictionaries for Spellproof is easy. Just follow the instructions below to customize your experience!

Configure Spellproof - as System Admin


1. Find Spellproof Configuration

Spellproof can be configured by System Admins to set global and project languages, and also custom dictionaries per language.


Tips

  • To configure Spellproof Languages and Dictionaries on the Jira Administration screen, you need to have System Admin access 
  • To start configuration, Spellproof needs to be installed and licensed on Jira Data Center (refer to Getting Started with Spellproof page)


To open Spellproof Configuration,

  • Log in to Jira with a System Admin account

  • Click the "Administration" link in the Jira header and select "General configuration"

  • Click the "Spellproof Configuration" link in the sidebar (under the Configuration menu)

  • You can now view the Spellproof Configuration page with two tabs

    • Languages tab

    • Dictionaries tab

2. Configure Languages for Spellproof

The Languages configuration tab allows you to configure

  • Spellproof Global Language 
  • Spellproof Project Language


Tips

  • Spellproof provides spelling, grammar and style support in multiple languages, namely, Chinese, English (UK), English (US), French, German, Italian, Japanese, Portuguese (Brazil), Portuguese (Portugal), Russian, and Spanish
  • Spellproof languages can be configured globally and per project. 


a. Spellproof Global Language

The Global Language is the default language used to spellcheck when no Project Language has been specified for each project within Jira. If not configured, the Global Language defaults to the language set on Jira's User Profile.

To configure the Global Language for Spellproof

  • Hit the "Edit" icon under the Languages configuration tab on the Spellproof Configuration page

  • Select one of these options from the 'Global Language' dropdown list:

    • Automatically detect User Profile Language setting (Default option)

    • Chinese

    • English (United Kingdom)

    • English (United States)

    • French

    • German

    • Italian

    • Japanese

    • Portuguese (Brazil)

    • Portuguese (Portugal)

    • Russian

    • Spanish

  • Hit the "Save" button

Your Global Language setting for Spellproof will now be saved.




b. Spellproof Project Language

The Project Language is the language specified to spellcheck for each project within Jira. If not configured, the Project Language defaults to the Global Language setting for each project.

To configure a Project Language for each project within Jira:

  • Hit the "Edit" icon under the Languages configuration tab on the Spellproof Configuration page

  • For each project within Jira, select one of the following options from the 'Language' dropdown box:

    • Use Global Language (Default option)

    • Chinese

    • English (United Kingdom)

    • English (United States)

    • French

    • German

    • Italian

    • Japanese

    • Portuguese (Brazil)

    • Portuguese (Portugal)

    • Russian

    • Spanish

  • Hit the "Save" button

Your Project Language setting for each project within Jira will now be saved.

3. Configure Dictionaries for Spellproof

The Dictionaries configuration tab allows users to

  • add custom words to dictionary
  • remove custom words from dictionary


Tips

  • Spellproof supports dictionaries in multiple languages, namely, Chinese, English (UK), English (US), French, German, Italian, Japanese, Portuguese (Brazil), Portuguese (Portugal), Russian, and Spanish
  • Spellproof dictionaries are unique per language supported by Spellproof


a. Add Dictionary Word

To add a new custom word to a Dictionary:

  • Click on the Dictionaries configuration tab on the Spellproof Configuration page
  • Select a language from the list of languages supported by Spellproof
  • Enter a custom word in the 'Add a new word' field on the selected language's Dictionary page
  • Hit the "Add Word" button

Your custom word will be now be added as a Dictionary word to the Dictionary page for the selected language, along with the date the word was added, and the user who added it.

Note: The Dictionary page also displays custom words added by Jira users' to Jira pages using Spellproof (refer to Spelling Errors "Add to Dictionary" option for help with this feature). 




b. Remove Dictionary Word

To remove a custom word from a Dictionary:

  • Click on the Dictionaries configuration tab on the Spellproof Configuration page
  • Select a language from the list of languages supported by Spellproof
  • Select the Dictionary word to be deleted using the checkbox field
  • Click the "Delete Selected" button

Your custom word will be now be removed from the Dictionary page for the selected language.

Note: You can also remove multiple words from the Dictionary page or select multiple words using the "Select All" checkbox field in the table header.


Configure Spellproof - as Project Admin



1. Find Project Settings

Spellproof can be used by Project Admins to configure project languages per project within Jira.


Tips

  • To configure Spellproof Languages on the Project Settings screen, you need to have Project Admin access
  • Project Languages can be configured by both System Admins and Space Admins

To find Project Settings Configuration,

  • Log in to Jira with a Project Admin account

  • Open the Project for which you want to change the Project Language
  • Expand the Project sidebar on the left panel of the screen

  • Click the "Project Settings" link in the Project sidebar to access the Project settings menu

  • Select the "Project Language" option in the Project settings menu

  • You can now view the Spellproof app section where you can configure a specific language for this project 

2. Configure Project Language for Spellproof

The Project settings screen allows Project Admins to configure a Project Language for Spellproof, and this language is used to spellcheck each project.


Tips

  • Changes made to Project Language on the Project settings screen will be automatically be reflected as the Project Language on the Jira Administration screen and vice versa (both fields hold the same Project Language value)
  • If Project Language is not configured by the Project Admin, the Project Language defaults to the Global Language setting (refer to Configure Spellproof - As System Admin section 2a).

To configure a Project Language for each project within Jira:

  • Open the Project for which you want to change the Project Language
  • On the Project settings → Project Language screen, select one of the following options from the 'Project Language' dropdown box:
    • Use Global Language (Default option)
    • Chinese
    • English (United Kingdom)
    • English (United States)
    • French
    • German
    • Italian
    • Japanese
    • Portuguese (Brazil)
    • Portuguese (Portugal)
    • Russian
    • Spanish
  • Hit the "Save" button

Your Project Language setting for Spellproof for this project will now be saved.


That's all! You are now ready to start using a fully configured Spellproof app.