Creating a custom rule

• Contents

• Creating a Custom Rule

Qordoba allows you to create custom rules for Capitalization, Punctuation, Date & Time, and Grammar in your Styleguide

To create a custom rule, go to Styleguide > Writing Style or to Styleguide > Grammar. Click to Edit to 

Below each section, you can click  +Add custom rule to create your rule.

Note:

Please make sure that you have clicked the + Add custom rule button within the correct category so Qordoba can properly flag issues within your Workspace.

To start, two fields will appear. You should enter an example of a wrong sentence and correct sentence. To continue setting the rule parameters, click Create initial error pattern.

A new set of fields will appear for you to set the error pattern.

Select the checkbox if the rule should include case-sensitive word matching.

In the Token #1 box, you have three options. You can select whether the token is a Word (i.e. saw, 1, 2) , Part of Speech  (i.e. noun, verb), or Word + Part of Speech  (i.e. saw, verb - as in to saw something vs. a saw).

1. Word - This covers particular spellings of a given dictionary word, or base forms, which will be able to match all versions of the word. For example, if you select the Word and base form options and look for the token "see," the token would be able to match ‘see’, ‘sees’, ‘saw’, ‘seeing’, ‘seen’, etc. in your document.
   
2. Part of speech - Since all the tokens are passed through a part-of-speech tagger, a particular token can be searched for using a part-of-speech tag, such as NN for singular nouns, or VBN for past participles.
   
3. Word as Part of speech- Because it's possible for a word to be used as two different parts of speech (for example, "walk" as a noun vs. "walk" as a verb), this way of defining a token allows you to select which of those combinations is relevant for the rule you are trying to input. 

Then select if you’re using  RegExp, Base form, and/or Negate. 

To add an exception to your custom rule, click Add exception. To add another token to the pattern, click Add token to pattern.

Scroll down the page to find fields to add a Rule Name, Description, and (optional) Suggestion.

Click Verify custom rule to validate the selections you’ve made. If the rule logic makes sense, an option will appear to add the rule.

To add the custom rule, click Add rule. Make sure to click Save changes at the top of the page to completely save your new rule.