Skip to main content
Skip table of contents

How to configure a linear document ?

A Linear Document is a Confluence page containing a "Linear document" Requirement Yogi macro.

The following steps explain how to index a confluence page as Linear document.

Step 1: add the RY Configuration macro

Click on the “Document” tab on the opened dialog box.

Step 2: Create the linear document configuration

Select “Create new configuration” if you want to create new one. You can also select an existing configuration.

1️⃣ Allow to create new configuration or select an existing configuration.

2️⃣ The name of the Linear Document configuration. By default it’s the page title.

3️⃣ Describe the configuration

4️⃣ This option, allow you show a text on page which indicate the page is processed as Linear Document.

5️⃣ The table contains all of the titles on the page hierarchically organised. It allow to ignoring or re-numbering a title.

  1. Set numbering: This option allow to create new numbering for the title. By default, when ticked, the title itself and his non numbered children are ticked.

  2. Ignore: when ticked, the title and his children are ignored. It mean, they will not be processed as requirement.

6️⃣ Specify how the requirement key will be generated.

  1. Prefix: represent the prefix of the requirement key. It can be a simple text, or variable or mixed.
    The available variables are:

    1. The id of the current page.

    2. page.title: the title of the current page.

    3. page.title.capitals: the first char of each word in the page title.

    4. space.key: the current Confluence space key.

    5. space.key.capitals: the first char of each Confluence space key.

    6. the title of the parent page.

    7. the first char of each word in the title of the parent page.

  2. Number: the number is automatically generated. By default it’s the numbering of the title.

  3. The suffix: represent the suffix of the requirement key. It can be empty of valued like the prefix.

7️⃣ Property and dependency section allow to choose which property or dependency to create.

  1. @Level: is a helpful property. It can have the following values:

    1. First: the title is the first in the titles hierarchy.

    2. Last: the title is the last in the titles hierarchy.

    3. Intermediate: the title is surrounded by other titles

    4. First and Last: the tiles is the title stands alone and has no previous or next titles.

  2. @Section (Property): this property content all of the parents of the current titles.

  3. @Section (Dependency): create dependency between the current title to his parents.

8️⃣ Allow the numbering customisation. It’s only use on the titles without numbering.

  1. Pattern: set the type of numbering of each level of title. It can be mixed, for example: 1.A.a.1.1.1.
    The supported numbering type are:

    1. Number

    2. Upper case alphabet

    3. Lower case alphabet

  2. Start with: define from which value to start the numbering.

9️⃣ Allow the edition of the configuration name, description and link display option.

Step 3: Finalise the creation

After setting the macro configuration, save it by ticking on save button.

Now the page contains a Requirement Yogi macro.

To finalise the operation, save the page.

Final result

What your document looks like:

What we index:

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.