Skip to main content

Add an XBRL Text Block

A text block is an assembly of one or more sections of text, which might include escaped HTML, that is drawn from one or more reporting objects in XBRL. You can use CDM XBRL to create a text block from data in Excel and Word objects.

A text block can be assembled from many parts from Excel and Word objects. You can select any block of data in an Excel or Word object, and then add a tag to it to specify that it is data that is required for XBRL.

In an Excel object, the text block can be either:

  • From all data in the Excel object, as defined by a ##RS and ##RE variable combination.
  • A section of data defined by a ##XS and ##XE variable combination. The ##XS and ##XE variable combination must be within either a print area or a ##RS and ##RE variable combination. If it is not then you will get an unexpected result on the output.

In a Word object, the text block can be a sentence, a paragraph, or the entire content in the Word object if necessary.

Note: When you add tags, you can create several tags at the same time, and then save them. However, when you add text blocks, you must save each one individually.

To add an XBRL text block:

  1. Open the project that you want to work with.
  2. Open and check out the Excel or Word object and toggle on tagging mode for it.
  3. In the Data Tools area on the ribbon, click Pivot Grid.
  4. Above the Tag Inspector tab, click Pivot Grid.

    Tip: To simplify your tagging work, you can pivot or filter the Pivot Grid to approximate the appearance of the data in the Excel object. For example, you can change the Pivot Grid to move columns to rows, and rows to columns. If the Pivot Grid contains extra rows or columns that are not visible in your Excel object, you can filter them so that they are no longer visible in the Pivot Grid.

  5. If the source of the text block is an Excel object, complete the following steps:
    1. In the Excel object, highlight the data that you want to tag. The text block can be a section of data, or all data in the Excel object if necessary. If you want to select all the cells and contents between the ##RS and ##RE variables, select the cell that contains the ##RS variable. If you want to select all the cells and contents between the ##XS and ##XE variables, and also the cells on the same rows as the ##XS and ##XE variables, select the cell that contains the ##XS variable.

      Restrictions:

      • When using the ##XS and ##XE variable combinations in conjunction with a ##RS and ##RE variable combination, the variables must follow this format:
        • The ##RS and ##XS variables must be placed in the same vertical column and the ##XE variable must also be in the same vertical column as ##RE.
        • You cannot have multiple ##RS combinations on a sheet in an Excel object.
        • You can have multiple ##XS and ##XE combinations within a ##RS and ##RE combination, however, the ranges must not overlap.
      • When using the ##XS and ##XE variable combinations in conjunction with a print area, the variables must follow this format:
        • The ##XS variable must be in a column adjacent to the left edge and within a row of a print area.
        • The ##XE variable must be in a column adjacent to the right edge and within a row of a print area.
        • You can have multiple ##XS and ##XE combinations, however, the ranges must not overlap. You cannot place a ##XS or an ##XE variable within an area defined by an existing ##XS and ##XE combination.
      • When a ##RS and ##RE variable combination and print area both exist in the same Excel report object, only the ##RS and ##RE variable combination is considered and the print area is ignored.
    2. In the Pivot Grid, select the intersection where you want to create the text block for the data that you selected in the Excel object. You cannot select an intersection that is shaded gray.

      Important: You must select an intersection whose type is textBlock or escapedItem, or any type that extends any of these two. To find the type of an intersection, hover over its header, and view the type in the window that opens. Also, the concept's time period type must match the time period you are tagging against. If the selected concept has a period type of Instant, you must select an intersection with a time period of Instant.

  6. If the source of the text block is a Word object, complete the following steps:
    1. In the Word object, highlight the content that you want to tag. The text block can be a sentence, a paragraph, or the entire content in the Word object if necessary.
    2. In the Pivot Grid, select the intersection where you want to create the text block for the data that you selected in the Word object. You cannot select an intersection that is shaded gray.

      Important: You must select an intersection whose type is textBlock or escapedItem, or any type that extends any of these two. To find the type of an intersection, hover over its header, and view the type in the window that opens.

  7. To create the text block, complete the following steps:
    1. Click Tag.
    2. In the confirmation window that opens, click Yes to confirm that you want to save the document during the creation of the text block. The Text Block Preview window opens, showing all text blocks in the Pivot Grid.
    3. By default, when you generate your instance document, the component parts of a text block appear in the order in which they were added to the text block. If you want a different order, select Allow components to be reordered, and drag the component parts of the text block to the order that you prefer.
    4. Click OK. An HTML link appears in the intersection. To view the contents of the text block that you added, click the HTML link.
    5. In the Text Block Preview window that opens, you can see the contents of the text block. If the intersection contains multiple text block tags, the Text Block Preview window contains the text blocks from all text block tags in that intersection.
  8. In the Tag Inspector tab, you can view details of your new text block and any other tags in the Pivot Grid. In the Value or Source Value column, click the HTML link in the row associated with your text block tag. If the intersection contains multiple text block tags, the Tag Inspector tab contains a separate row for each tag.
  9. Click the Excel or Word object and save your changes.
  10. Check in the report object.

Was this article helpful?

We're sorry to hear that.