Created by staff of the U.S. Securities and Exchange Commission.
Data and content created by government employees within the scope of their employment are not subject to domestic copyright protection. 17 U.S.C. 105.

# MetaLinks.json Information README

## Purpose

High level Developer information regarding MetaLinks.json used within the IXViewer. The MetaLinks.json file is required to maximize functionality of the IXViewer, it is typically located in the same directory as the XHTML form:
XHTML Location: `test/form/123.htm`
MetaLinks.json Location: `test/form/MetaLinks.json`

## Format

The MetaLinks.json file must in the JSON format.

## Most Used Key(s)=>Value(s)

- `instance` => `{{XHTML Path}}` => `report`
  - This holds information such as `groupType`, `longName` and `shortName` all of which are used in the Sections Menu.
  - The IXViewer transforms this data from an Object to an Array of Objects to allow such built-in functions as map, and filter amongst others.
  - The original key (for example `R1`) is now `original-name: "R1"`.
- `instance` => `{{XHTML Path}}` => `tag`.
  - This holds information such as `xbrlType`, `auth_ref`, and a multitude of labels, such as `documentation`, `label`, `terseLabel` .
  - The keys of this object correspond to the `[name]` attribute in the XHTML form, replace the `:` with `_`.
  - The IXViewer transforms this data from an Object to an Array of Objects to allow such built-in functions as map, and filter amongst others.
  - The original key (for example `dei_AmendmentFlag`) is now `original-name: "dei_AmendmentFlag"`.
- `std_ref`.
  - This holds information such as `Glossary`, `Name`, `Publisher`, and `URI`
  - The IXViewer transforms this data from an Object to an Array of Objects to allow such built-in functions as map, and filter amongst others.
  - The original key (for example `r0`) is now `original-name: "r0"`.