Using Spellproof is very easy! All you need to do is run Spellproof, and Spellproof will quickly check for spelling, grammar and style issues within your Jira page.
Manually Run Spellproof
Tips
- Spellproof is the book shaped icon
located on the Jira Editor toolbar of each Jira issue - Spellproof icon is available on the Description fields and Comment fields of each Jira issue
Once you have downloaded, installed, configured and licensed Spellproof, you can create content on your Jira issue and manually run Spellproof by clicking on the book shaped icon
in your Jira Editor toolbar.
Spellproof runs through a collection of rules to detect misspelt and misused words, providing suggestions based on the context of the sentence.
The three kinds of suggestions provided by Spellproof are:
- Spelling errors - Denoted by a red underline
- Grammar errors - Denoted by a green underline
Style errors - Denoted by a yellow underline
Spellproof also provides a 'Suggestions Assistant' as a red circle in the Jira Editor window. It shows the number of outstanding suggestions on a Jira issue.
Clicking on the Suggestions Assistant will automatically take you to the next suggestion. This helps with quick visibility and navigation between errors, especially on lengthy Jira issues.
1. Spelling Errors
When Spellproof suggests a Spelling error (red underline), clicking on the word provides the following options:
- Alternate list of spellings - Select one of these spellings to correct the spelling error
- Add to Dictionary option - Select this option to add the error-ed word to the Dictionary (refer to Configure Dictionaries for Spellproof section to manually add or remove words from the Dictionary)
- Ignore All option - Select this option to ignore all the spelling suggestions for this word within the Jira issue
2. Grammar Errors
When Spellproof detects a Grammar error (green underline), clicking on the phrase provides the following options:
- Alternate list of phrases - Select one of these phrases to correct the grammar error
- Ignore Suggestion option - Select this option to ignore all the grammar suggestions for this phrase within the Jira issue
3. Style Errors
When Spellproof detects a Style error (yellow underline), clicking on the phrase provides the following options:
- Alternate list of phrases - Select one of these phrases to correct the style error
- Ignore Suggestion option - Select this option to ignore all the style suggestions for this phrase within the Jira issue
Automatically Run Spellproof
Tips
- Spellproof auto-run checkbox is not selected by default
- Once the Spellproof auto-run checkbox is selected by a Jira user, this option is saved across all Jira issues for that user
Once you have downloaded, installed, configured and licensed Spellproof, you can create content on your Jira issue and automatically run Spellproof by selecting the 'Check spelling & grammar' checkbox on your Jira issue.
If this checkbox is selected, on click of the 'Update' button, Spellproof automatically runs through a collection of rules to detect misspelt and misused words.
- if Spellproof detects no errors, then the Jira issue is saved
- If Spellproof detects errors, then Spellproof provides the spelling / grammar / style errors on the Jira issue, and the user is required to correct or ignore these errors before the Jira issue is saved
If this checkbox is not selected, on click of the 'Update' button, the Jira issue is saved, irrespective of spelling / grammar / style errors on the Jira issue.
