Skip to main content

User Interface

Vale Server's user interface (UI) consists of two parts: a native desktop application and a web-based dashboard.

Preferences#

To access the native application, click on its icon in the context menu and then select Preferences....

Projects#

Projects allow you to manage multiple Vale configuration files in one place. Each project has a name (the left panel) and an associated configuration file (the right panel):

A screenshot of Vale Server's 'Projects' settings page.

To create a new project, click "Add" and then double-click the "Untitled n" entry to give it a name. You can then edit the configuration file on the right to customize the project. To remove a project, click its name and then click the "Remove" button.

After you've created and configured your projects, you can switch between them by choosing Select Project from the context menu.

StylesPath#

Heads up!

You can specify custom StylesPaths on a per-project basis, allowing for easier syncing across multiple writers.

The Styles page provides quick access to all your installed styles. You can add your own styles through the dashboard or by choosing Browse Styles... from the context menu and then copying the relevant files.

A screenshot of Vale Server's 'Styles' settings page.

Advanced#

The Advanced page allows you to configure the port that Vale Server will listen on. You'll need to restart the server for the change to take effect.

A screenshot of Vale Server's 'Advanced' settings page.

Dashboard#

The dashboard provides a web-based interface for managing your Vale-related assets.

A screenshot of Vale Server's dashboard.

To open your dashboard, click the Open Dashboard... option from the context menu.

Vocab#

Each of your Projects can be associated with a Vocabulary that allows you to add your own terms and phrases to any installed style.

Vocabulary entries belong to one of two groups:

  • Preferred: Entries marked as Preferred will be enforced on as-entered basis—for example, if the term "JavaScript" is marked as Preferred, any variation that doesn't exactly match (for example, Javascript, javascript, etc.) will raise an error. Additionally, any Preferred entries will automatically be added as exceptions to spelling, capitalization, and conditional rules in all your active styles.

    A screenshot of a dashboard entry being created.
  • Do not use: Any use of an entry marked as Do not use will raise an error.

To manually edit a Vocabulary file, click Browse Styles... from the context menu and then navigate to the /Vocab/<vocab name> directory.

Styles#

The Styles page allows you to browse, install, and update third-party styles. These styles are open-source and maintained by the community of Vale Server users.

A screenshot of the dashboard's Styles page.

See the dedicated repository to learn more.

Summary#

The summary page allows you to generate a status report for a local folder based on a custom grading scheme.

A screenshot of the dashboard's Styles page.

For each Vale alert level—suggestion, warning, and error—you can specify a count (the number allowed occurrences) and a scheme.

A screenshot of the dashboard's Styles page.

You can choose either strict or sliding as the grading scheme for your report.

strict will cause any file that has more than count number of alerts (for any level) to fail. sliding will assign a grade based on far above or below count each alert level is for the particular file.