Versions Compared

Key

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

...

It is also possible to add a Configuration macro from the view mode, with the Transformation wizard.

Table Configuration

If your requirements are in tables, it is absolutely not mandatory. The Requirement Yogi configuration macro is useful to change the way your requirements are indexed and override column titles, or choose to put the 3rd column as the description instead of the 2nd.

...

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.

Paragraph Configuration

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

Requirement keys in paragraphs:

...

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.

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

When requirements are in headings

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

My headings:

will get saved as:

...

Numbering

Example

Regex

Decimal

1.2.

^(\d+\.)+\s*

ISO-2145

1.2

^(\d+\.?)+\s*

Lower-latin

a.b.

^([a-z]+\.?)+\s*

Upper-latin

A.B.

^([A-Z]+\.?)+\s*

Upper-roman

I.II.III.

^([IVXLC]+\.?)+\s*

Document Configuration

Info

New Feature 🚀

This is the evolution of the paragraph configuration. We call this feature Linear Documents. It is best suited when requirements are written outside of tables, when you reuse public standards or your customer’s requirements.

...