Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This table:

Gets indexed as:

Image RemovedImage Added

Image Removed

Image Added

Here is the default configuration for requirements in tables:

With the configuration macro, you can:

  • Rename properties.

  • Change the column type.

Image RemovedImage Added
  1. Here, I changed the column of "Author" in "Original Author".

  2. The "Dependencies" column was indexed both as a dependency and as a property, so we added a 4th column to the configuration macro and unchecked the indexing as a property, and set it to Dependency

  3. We ticked “Apply to all the following tables in the document", if this is unticked, the configuration will only apply to the following table. This configuration is not global, you need to add the macro to every Confluence page with requirements.

Image RemovedImage Added

After inserting the macro and publishing the edited Confluence page, my requirement is now indexed with the changed properties as:

Image RemovedImage Added

You can quickly "unindex" the requirements in a page by adding a configuration macro at the top of the document and uncheck the requirements column. It can be useful when you have duplicated requirement definitions.

...

When you define requirements in paragraph or headings, by default, the description of the requirement is the following text.

Requirement keys in paragraphs:

Image RemovedImage Added

Here are my requirements:

With the configuration macro, you can:

  • Change the property name.

  • Treat the bold text as normal text.

  • Change the dependency name.

  • Ignore the numbering in headings.

Image RemovedImage Added

After inserting the macro and publishing the document, here is my requirement again:

...

You can ignore the numbered headings by passing a regular expression specifying the numbering format.

My headings:

Image Modified

will get saved as:

Here are a few common ways to number headings and their regexes:

...

Read the documentation, or watch the tutorial.

What your document looks like:

What we index:

Image RemovedImage Removed
Image AddedImage Added

Image Removed
Image Added