Versions Compared

Old Version 4

changes.mady.by.user Mileva Briand

Saved on

compared with

New Version Current

changes.mady.by.user Mileva Briand

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
title
Tip
Excerpt
hiddentrue
nameKeyword Dictionaries and blueprints

Documentation page on the keyword dictionaries and the blueprints of Requirement Yogi.

Panel
panelIconId1f4cc
panelIcon:pushpin:
panelIconText📌
bgColor#DEEBFF

Release 1.4

Those features were published in version 1.4 in March 2016.

Annotate keywords, error messages and part numbers

We're introducing the dictionary blueprint in Requirement Yogi. It starts with a template where people can enter any kind of key/description entry:

...

Image Added

The user can assign a color to distinguish, for example, error messages from normal messages:

Image Removed

Importing documents from the customer

People often have to quickly import new requirements from the customer. Requirement Yogi makes it very efficient. On a page, select a candidate for a requirement key. In the inline pop-up, click "Define as a requirement" or press Alt + Shift + R:

Image Removed

The list of types appear:

Image Removed

After you click Create, the requirement will be added to the blueprint page. All references in the page (and optionally in the space) will be transformed to links.

...

Image Added

Specifications of the feature

This part will explain how this feature works. It leverages the Properties feature, so users could reach the same results without using the template. It defines the special properties named "Type" and "_formatting". Here are more details:

Property

Value

Notes

Type

Any string

  • The type will be displayed in the requirement properties,

  • When using the inline creation popup, types are suggested,

  • There is the inconvenience that people who already use "Type" for another purpose will populate the inline dialog unnecessarily. We think this is a minor inconvenience because the inline dialog isn't used often.

_formatting

#color; bold; italic; underlined;

Image Added

  • All requirements with this property will be formatted accordingly.

  • Elements must be in the specific order, followed by a semi-colon and an optional space.

  • The first item is a CSS color in hex/css format, such as " #ff0000" for red.

  • Note that this property is not searchable or visible in the details, since it contains "_"

.

Creating a new type

Image Removed

...

  • .