Online Repository Assistant (ORA)

This is an unofficial language extension to facilitate the development of templates to be used with the Online Repository Assistant (ORA) genealogy research tool. This project is not associated with John Cardinal, Online Repository Assistant, or Family History Hosting. Any support questions should be directed to the project GitHub site as described below.

Features

• Syntax highlighting for ORA templates, providing formatting for all brackets, operators, field names, library template parameters, ORA transforms and their parameters, and auto type control sequences.
• Hover tooltips provide syntax, reference information, and examples for all ORA transforms.

Installation

This extension can be installed from the VS Code Extension Marketplace or downloaded from the GitHub repository.

Usage

The primary use case for this tool is editing the template text as it appears in the OraSettings page. The language extension is not designed to edit exported Collections or Library Templates directly, as those are JSON files. To use this extension, copy the text of a template from the OraSettings page into a new text file in your VS Code workspace and use the .ora-template file extension when naming the file. The file type should be detected and the template text will be highlighted as you edit it.

Syntax Highlighting

The syntax of an ORA template saved with the .ora-template filename extension will be displayed with highlighting, making it easier to read and understand. As detailed below, the styles can be configured in the standard VS Code settings.

Hover Preview

Display the full command syntax for an ORA transform, complete with parameters, explanation, and example usage, by hovering over the name of the transform in the editor.

Examples

Sample templates used for testing the extension are available in the GitHub repository.

Configuration

There are no native settings for this extension. However, you can customize the style of the ORA syntax highlighting by making color customizations in your VS Code settings file, either at the User or Workspace level. For example, the following settings will make the ORA field names bold, and the ORA transform parameters two different shades of blue, depending on whether you are using a light or dark theme:

"editor.tokenColorCustomizations": {
  "textMateRules": [
    {
      "scope": "variable.ora-template",
      "settings": {
        "fontStyle": "bold"
      }
    }
  ],
  "[*Light*]": {
    "textMateRules": [
      {
        "scope": "string.parameter.ora-template",
        "settings": {
          "foreground": "#1A4F8C"
        }
      }
    ]
  },
  "[*Dark*]": {
    "textMateRules": [
      {
        "scope": "string.parameter.ora-template",
        "settings": {
          "foreground": "#66A0C8"
        }
      }
    ]
  }
}

These are the ORA elements that you can customize:

Contributing

The source code for this extension is hosted on GitHub. Contributions, pull requests, suggestions, and bug reports are greatly appreciated. Post any issues or suggestions on the GitHub issues page. Add the feature request tag to any feature requests or suggestions. To contribute, fork the project and then create a pull request back to master. Please update the README if you make any noticeable feature changes.

Release Notes

Check the CHANGELOG for any version changes.

License

See the LICENSE file for details.