Inline XBRL Document Set

See COPYRIGHT.md for copyright information.

Overview

The Inline XBRL Document Set (IXDS) plugin facilitates the handling of inline XBRL documents. It allows for opening and extracting XBRL data from document sets, either defined as an Inline XBRL Document Set or in a manifest file (such as JP FSA) that identifies inline XBRL documents.

Key Features

• XBRL Document Set Detection: Detect and load iXBRL documents from a zip file or directory.

• Target Document Selection: Load one or more Target Documents from an Inline Document Set.

• Extract XML Instance: Extract and save XML Instance of a Target Document.

• Command Line Support: Detailed syntax for file and target selection.

• GUI Interaction: Selection dialog for loading inline documents and saving target documents.

Usage Instructions

Command Line Usage

• Load from a ZIP file:

  Simple:

  python arelleCmdLine.py --plugins inlineXbrlDocumentSet --file report.zip
  

  Verbose:

  python arelleCmdLine.py --plugins inlineXbrlDocumentSet --file '[{"ixds": [{"file": "report.zip"}]}]'
  

• Load from a directory:

  Simple:

  python arelleCmdLine.py --plugins inlineXbrlDocumentSet --file filing-documents-directory
  

  Verbose:

  python arelleCmdLine.py --plugins inlineXbrlDocumentSet --file '[{"ixds": [{"file": "filing-documents-directory"}]}]'
  

• Load multiple documents:

  Simple:

  python arelleCmdLine.py --plugins inlineXbrlDocumentSet --file 'document-1.html|document-2.html'
  

  Verbose:

  python arelleCmdLine.py --plugins inlineXbrlDocumentSet --file '[{"ixds": [{"file1": "document-1.html", "file2": "document-2.html"}]}]'
  

• Specify target document:

  • Default target:

    Simple:

    python arelleCmdLine.py --plugins inlineXbrlDocumentSet --file report.zip --inlineTarget "(default)"
    

    Verbose:

    python arelleCmdLine.py --plugins inlineXbrlDocumentSet --file '[{"ixds": [{"file": "report.zip"}], "ixdsTarget": "(default)"}]'
    

  • Named target (e.g., DKGAAP):

    Simple:

    python arelleCmdLine.py --plugins inlineXbrlDocumentSet --file report.zip --inlineTarget DKGAAP
    

    Verbose:

    python arelleCmdLine.py --plugins inlineXbrlDocumentSet --file '[{"ixds": [{"file": "report.zip"}], "ixdsTarget": "DKGAAP"}]'
    

• Load multiple IXDS sets:

  python arelleCmdLine.py --plugins inlineXbrlDocumentSet --file '[{"ixds": [{"file": "report-1.zip"}]}, {"ixds": [{"file": "report-2.zip"}]}]'
  

• Extract XML instance:

  python arelleCmdLine.py --plugins inlineXbrlDocumentSet --file reports/report.html --saveInstance
  

GUI Usage

• Load IXDS documents:

  1. Go to the File menu.

  2. Select “Open File Inline Doc Set”.

  3. Ctrl/Cmd-click to select multiple files as an IXDS.

• Save XML instance:

  1. Load the IXDS.

  2. Open the Tools menu.

  3. Select “Save target document” to export the XML instance.

Additional Notes

• On Windows, escape quotes and backslashes when using verbose JSON:

  .\arelleCmdLine.exe --plugins inlineXbrlDocumentSet --file
  "[{""ixds"":[{""file"":""C:\\report.zip""}], ""ixdsTarget"":""DKGAAP""}]"
  

• If no “ixdsTarget” is specified in JSON, all targets are loaded.

• “(default)” matches the default IXDS target (i.e., no target defined in the instance).

• Use “–encodeSavedXmlChars” to apply EDGAR-style encoding to non-ASCII characters.

• The extracted XML instance is saved in the same directory with the suffix “_extracted.xbrl”.