Versions Compared

Key

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

...

Excerpt
hiddentrue
namePage transformations

With the page transformation wizard and video tutorial, learn how to transform your existing documents and create requirement yogi macros in bulk.

Panel
panelIconId1f4cc
panelIcon:pushpin:
panelIconText📌
bgColor#DEEBFF

Transform your existing documents

This wizard helps you format documents and insert Requirement Yogi macros in bulk.

...

When to use it?

  • When you've imported a Word document into Confluence and you need to clean up the formatting for Requirement Yogi,

  • When you are writing requirement pages and you need to assign requirement keys in bulk.

  • When you have a company policy for requirement keys, and you want everyone to apply the same formatting to their documents.

What operations are available?

...

Image Added

These simple operations already fit 90% of our observed usecases. If you need other operations, please don't hesitate to submit a support ticket.

...

How to use the Transformation

...

wizard?

Access the wizard in

...

From the page menu :

...

3 ways

On your Confluence page, from the page menu:

Image Added

On your Confluence page, click on the byline at the top of the page:

Image Added

From the Pages tab, click "Transform" :

...

Image Added

Using the Transformation Wizard

Wizard features :

  • Transform text in requirement yogi macros
  • Automatically find requirement keys and convert them to link macros
  • Automatically generate unique keys
  • Add, or rename table headers used to generate requirement properties
  • and more to come (handle vertical tables, generate requirements from paragraphs, ... )

...

Go with the flow and let us analyse your document

On the left, you'll see a preview of the page you'll be transforming

...

.

On the right, you’ll be able to create a new transformation, or reuse a saved transformation

...

.

  • If you click on Add rule, you’ll be able to choose a specific rule mentioned above.

  • If you directly click on Next, we’ll parse your document and guide you to the basic transformations (Generation, or keys and links transformation)

Image Added

Let's

...

click on Next

The Transformation Wizard will ask you in which tables you want to create requirement macros, allowing you to select tables, using multiple criteria (and even regular expressions), or manually exclude single requirements.

...

...

the dependencies and links. Find more information on the links transformation here.

The Transformation Wizard will scan the table cells for text matching requirement macros already created, or that are in the process of being transformed, and convert them to requirement yogi link macros.

...

Once this is done, you will be taken to the summary screen, allowing you to edit the rules you defined, or add more.

Image Removed

Before transforming the page, let's save this transformation. You will be able to reuse it later on other pages.

...

Image Added

In the end, you’ll see a summary of the rules.

  • You can edit them and add more.

  • You can also save this transformation by giving it a name.

Image Added

And voilà ! Your page is now transformed.

...

Image Added

Reuse a saved transformation.

...

Once a transformation is saved, you can reuse it on another page by accessing the transformation wizard again.

...

Notice the padlocks : They indicate a transformation only accessible to some users. By default, all transformations are private, and we'll see how to share them later.

Image Added

Transform multiple pages at once.

...

 

If you need to apply a transformation to multiple pages at once

...

. Go to the Pages tab.

Generating hundreds of requirements has never been this easy !

...

Image Added

Share your transformations

...

Everyone can share their transformations, and administrators can override them. Use the "Administration" tab in the Requirement Yogi search screen

...

.

Image Removed

Admins have access to all transformations in the space, while simple users can only manage their own transformations.

...

Image Added

Edit a transformation and click on the "Share" checkbox:

...

Image Added