> For the complete documentation index, see [llms.txt](https://docs.wproofreader.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.wproofreader.com/v6.18.1/features/style-guide-builder/style-guide-cloud-admin-panel.md).

# Style guide: Cloud admin panel

This guide covers how to manage custom style guide rules through the admin panel at [app.wproofreader.com](https://app.wproofreader.com).

{% hint style="info" %}
For the [self-hosted admin panel](/v6.18.1/admin-panel/self-hosted.md), use your installation's address.
{% endhint %}

Rules are grouped in collections. A collection applies to all languages or to one language.

For an overview of the style guide feature, custom rules structure, case sensitivity, and limitations, refer to the [Style guide overview →](/v6.18.1/features/style-guide-builder.md).

The owner and administrators can create and edit collections and rules. Developers can view them.

### Accessing the style guide builder

1. Sign in to your admin panel. For Cloud, use [app.wproofreader.com](https://app.wproofreader.com).
2. In the left navigation panel, select **Style guide**.

The page shows your collections. An empty list shows "No collections currently added."

To view a collection's rules, click the collection.

<figure><img src="https://2257447898-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FiyQMCOvN8kKwZftNXZft%2Fuploads%2Fgit-blob-e59eda8a998811bc56c522e70239722311e951a7%2FStyle%20guide%20collections%20list.png?alt=media" alt="Style guide page with the list of collections and the Create collection button"><figcaption></figcaption></figure>

In a collection, the rule list has the columns Patterns, Suggestions, Description and Status. An empty collection shows "No custom rules currently added."

You can use the **Search for pattern...** field to find rules. Search matches the start of each pattern and ignores case. It searches only the **Patterns** column.

To go back to the collection list, click the back arrow (**Back to collections**).

### Creating a collection

1. Click **Create collection**.
2. Enter the collection name in **Name**. Use up to 250 characters: English letters, numbers, spaces or hyphens.
3. Keep **All languages**, or select **Specific language**.
4. If you selected **Specific language**, select a language from the list.
5. Click **Create**.

The admin panel shows "Collection created successfully."

When your plan or license has a collection limit, the page shows **Style guide collections: \<USED> of \<LIMIT> used**. **Create collection** is not available when the limit is reached.

**Create collection** is also unavailable when no numeric collection limit is available. If this happens, ask your server administrator to check the server connection and collection limits.

### Editing and deleting a collection

To edit the current collection:

1. Open **Collection actions**.
2. Click **Edit collection**.
3. Change the collection details.
4. Click **Save**.

To delete the current collection:

1. Open **Collection actions**.
2. Click **Delete collection**.
3. In **Delete collection**, click **Delete**.

You can also use the three-dot menu next to a collection on the **Style guide** page.

### Adding a rule

1. Open a collection.
2. Click **New rule**.
3. Fill in the following fields:
   * **Patterns**. The exact word or phrase to be flagged. Enter it in **Add new** and press Enter. This field is required.
   * **Suggestions**. The replacement text to offer users. Optional.
   * **Description**. An explanation shown with the suggestion. Optional. Use up to 200 characters. Do not use `# ; < > { } [ ]`, line breaks or tabs.
4. Optionally, configure context awareness to control when the rule applies:
   * **Include in context**. The rule only activates when at least one of these entries appears in the same sentence as the pattern.
   * **Exclude from context**. The rule is skipped when any of these entries appears in the same sentence.
5. Click **Save**.

Each list (Patterns, Suggestions, Include in context, Exclude from context) accepts up to six entries, with 150 characters in total. The characters `# ; < > { } [ ]` are not allowed. A list cannot contain the same entry twice. An entry cannot repeat across **Patterns**, **Include in context** and **Exclude from context**. **Suggestions** is checked separately.

The rule takes effect after synchronization. WProofreader highlights text that matches a pattern with a yellow underline. It displays the configured suggestions and description.

For example, if you create a rule with the pattern "WSC", the suggestion "WebSpellChecker", and the description "Use the full company name.", whenever a user types "WSC" in their text, it will be underlined with a yellow line. Clicking the underlined word shows the description and the suggested replacement.

### Editing a rule

1. Find the rule in the list. Use the search field if you have many rules.
2. Click on the rule row to open **Edit rule**.
3. Make your changes.
4. Click **Save**.

### Importing rules in bulk

{% hint style="warning" %}
A successful import replaces all rules in the collection. Export the current rules before you import.
{% endhint %}

1. In the collection, click **Import rules** next to **New rule**.
2. Click **Upload a file**.
3. Select a CSV file.
4. Click **Close** when the upload finishes.

Selecting a file starts the upload immediately. You can also drag a file into the upload area.

The file must meet the following requirements:

* CSV format with five columns: Patterns, Suggestions, Description, Context include, and Context exclude. The first row must contain these column headers.
* The file must not exceed 5 MB.
* Maximum of 2,000 rules.

If a rule has multiple patterns or suggestions, separate them with a semicolon (`;`). Context include and Context exclude values are also separated by semicolons. To import a rule in a disabled state, add `#` before the first pattern value.

Example CSV content:

```
Patterns,Suggestions,Description,Context include,Context exclude
WSC,WebSpellChecker,Use the full company name instead.,product,
marketing team,Marketing team,Use capitalization for official department names.,company;our,external
```

You can prepare this file in Google Sheets or similar software. Make sure the first row contains the column headers, then export as CSV (File > Download > Comma Separated Values).

### Downloading rules

1. Open **Collection actions**.
2. Click **Export rules**.

The admin panel saves the collection's rules as a CSV file. Use it as a backup or edit it in a spreadsheet. **Export rules** is unavailable for an empty collection.

### Enabling or disabling a rule

Use the **Status** control in the rule row. Disabled rules aren't applied during spell check but aren't deleted. They can be re-enabled at any time.

### Deleting a rule

{% hint style="warning" %}
Deleting a rule removes it immediately without a confirmation prompt.
{% endhint %}

To delete a rule, click the trash icon (**Delete rule**) in its row.

If you only need to temporarily stop a rule from being applied, consider disabling it instead of deleting it.

### FAQ

#### Why don't my style guide changes take effect immediately?

Changes to style guide rules require a short time to synchronize. Currently, synchronization can take up to 3 minutes. This is a temporary limitation that WebSpellChecker is working to improve.

#### What's the difference between built-in style check rules and custom rules?

Built-in style check rules are predefined categories (profanity, inclusive language, etc.) maintained by WebSpellChecker and enabled by default for all users. Custom rules are the ones you create through the style guide builder to enforce your organization's specific writing standards. Both appear to end users in the same way, as yellow-underlined text with suggestions. Custom rules always take priority over built-in ones. For details on built-in categories, see [Style check](/v6.18.1/features/style-check.md).

#### Can I scope custom rules to specific languages?

Yes. When you create a collection, select **Specific language** and choose the language. The rules in this collection apply only to that language.

#### Can I use context awareness to make rules more precise?

Yes. When adding or editing a rule, you can use the **Include in context** and **Exclude from context** fields to control when a rule triggers. For example, you could create a rule that flags "*lead*" only when "paint" appears in the same sentence by adding "*paint*" as an include context entry. This helps avoid false positives for ambiguous patterns.

#### What file format does the import accept?

The import accepts CSV files only. The file must have five columns (Patterns, Suggestions, Description, Context include, Context exclude) with headers in the first row, and must not exceed 5 MB.

#### Can I import rules with context awareness settings?

Yes. The CSV import supports context awareness through the Context include and Context exclude columns.
