DIBDOCSCHEMA EXTENSION

Description

This is the README for 'dibdobschema'. This extension employs the use of the TMF json schema, with added intellisense functionality for ease of use when writing files named 'composition.json'. The intellisense comes switched-off with the extension however, through built-in commands, it can be switched-on.

Structure

. 
├── dibdocschema
│   ├── dibPD.json // Property description file from dib executable
│   └── Program.cs // Program used to update json files
├── schema
|   ├── gadget // TMF schema files for gadget
|   ├── properties // TMF schema files for property description
|   |    └── stub.json // Program.cs can switch intellisense 'on' and 'off' 
|   |                     through referenced files here.
|   ├── starfish // schema files for starfish
|   └── definitions.json // definitions schema file; references properties
├── package.json // The extension manifest.
└── src
    └── extension.ts // The dibdocschema vscode extension

Features + Utilization

Intellisense:

The intellisense features do not come activated with this extension. To use the features your json file must be named 'composition.json' and you will need to switch the intellisense on using the dibdocschema 'Update Property Intellisense' command. Please restart VS-Code after using this command.

Use the keyboard shortcut ctrl + space to pop-up the intellisense menu when writing in composition.json files.

For 'type' and 'properties' in all sections, a menu of options will appear after using the keyboard shortcut. Pressing the arrow to the right of each property will open a menu of additional helpful details, including the property's description and type.

Commands:

`dibdocschema.UpdatePropertyIntellisense`

Update Property Intellisense is currently the only command within the dibdocschema extension. Use it in these steps:

First, open a terminal using the keyboard shortcut ctrl + `
To access the command itself, use the keyboard shortcut ctrl + shift + p to open the Command Palette.
Begin searching for "dibdocschema" and it should pop-up. Press enter or click on it to run.

After running the command, a series of questions will be asked in the terminal:

Do you want to update the dib -pd property documentation json file?
Do you want to to switch on/off the intellisense feature?

User input your responses and appropriate directories in the terminal when updating! Please restart VS Code before use of the intellisense if anything is updated.

dibdocschema

Telestream