Skip to content

Visual Studio Code syntax highlighting for RDF which utilises IES classes and resources, to help you write and interpret IES RDF.

License

Notifications You must be signed in to change notification settings

telicent-oss/ies-syntax-highlighter-vscode-extension

IES Syntax Highlighter

A Visual Studio Code (VSCode) extension to help working with IES in Terse RDF Triple Language (TTL) (.ttl) files

Features:

  • Colour highlighting - Highlights IES classes according to their defined colours
    Highlights IES classes according to their defined colours
  • Diagnostics - Syntax highlights missing commas, dots, semicolons
    Syntax highlights missing commas, dots, semicolons
  • IES class suggestions - Suggests IES classes as you type
    Suggests IES classes as you type
  • On hover matches - Hover over a URI to reveal IES type
    Hover over a URI to reveal IES type

Install

  1. Download latest releases

In VSCode:

  1. Click "Extensions" icon in the Activity Bar on the side of VS Code or the View: Extensions command Cmd/Ctrl + Shift + x.

  2. Click on the Extensions view command dropdown, the three dots (...), located at the top of the Extensions view and select Install from VSIX...

  3. Navigate to the downloaded release file (step 1) and select it.

  4. Select theme IES Highlighter1 dark+ default Cmd/Ctrl + k then Cmd/Ctrl + t. Or go to the Extensions view -> ies-extension -> Set Colour Theme.

1 Note: Syntax highlighting has not been optimized for "light" themes, e.g. highlights ies: prefix as white.

The extension should now be activated when you open .ttl files.

Additional, optional, steps if you don't want to change themes and still have colour highlighting:

  1. Go to VS Code settings - open the Settings editor by navigating to Code > Settings > Settings or using the shortcut Cmd/Ctrl + ,

  2. Search settings - In the Settings Search bar, type editor.tokenColorCustomizations and select Edit in settings.json

  3. Append contents - Use Ctrl/Cmd + C and then Ctrl/Cmd + V to copy and paste the contents of the file main/for_settings.txt to the JSON in settings.

Further information on managing extensions in VS Code can be found on the Microsoft VS Code Extension Marketplace page.

Usage

  1. Install extension, as above

  2. Select theme within the IES Syntax Highlighter extension page in VS Code, as required

  3. Create or open a file ending with extension .ttl

  4. Enter IES TTL data and the features of the IES Syntax Highlighter will highlight classes, diagnose syntax errors, autocomplete classes and track what type instances are.

About

Visual Studio Code syntax highlighting for RDF which utilises IES classes and resources, to help you write and interpret IES RDF.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published