Applied Rules
Overview
A correct conversion depends on having annotations properly applied to content elements. This requires rule conditions to be accurately specified. The rules editor allow you to see which rules have applied to content elements.
Procedure
- From the content panel, select the content element that you are interested in.
Result
The Element Properties tab is automatically put into view and is updated to correspond with the content element you have selected.
The Annotations section lists the annotations which have applied to the selected content element.
The Applied Rules section lists the rules which have applied to the selected content element.
Example: Element Properties
- The selected element in the content panel has a green background.
- The selected element’s properties are shown on the right.
Properties of an Element
Overview
Content elements have associated properties, such as font-size, that have been carried over from the authoring environment. These are important for conversion mapping purposes.
Procedure
From the content panel, select the content element that you are interested in.
Result
The Element Properties tab is automatically put into view and is updated to correspond with the content element you have selected.
The Metadata section shows the selected element’s type, unique id, style, and any conditions that it may have. The Properties section shows all of the properties associated with the selected content that Migrate was able to capture from the source document format.
Example: Element Properties
- The selected element in the content panel has a green background.
- The selected element’s properties are shown on the right.
Moving a Test in a Condition
Overview
A rule condition consists of one or more tests which are grouped together logically. You may reorder the tests either to make the condition more readable, or to optimize performance. For example, pattern matching tests are typically less efficient than property tests, so it does make sense to test properties first.
Procedure
- In the displayed rules view, double click anywhere on the rule you want to update. This places the rule in edit mode.
- Right click on the test you would like to move. The row you selected will be This places the rule in edit mode.
- Move the test
- Click Move up
- or Move down.
Result
The test has been moved.
Once You Are Done
Although the rule has been updated within the rules editor, the change has not yet been propagated to the portal. To commit the change to the portal, you must save the rule set.
Deleteting a Test From a Condition
Overview
A rule condition consists of one or more tests which are grouped together logically. You may delete a test from the condition.
Procedure
- In the displayed rules view, double click anywhere on the rule you want to update. This places the rule in edit mode.
- Right click on the test you would like to delete. The row you selected will have a green background highlight.
- Click Delete.
Result
The test has been removed from the rule. If the test you suggested was a logical group test or a contains element test, then the entire test including the nested parts will be deleted. You can of course delete just one test inside such a composed test by deleting one of its child rows.
Once You Are Done
Although the rule has been updated within the rules editor, the change has not yet been propagated to the portal. To commit the change to the portal, you must save the rule set.
Adding a Test Condition
Overview
A rule condition consists of one or more tests which are grouped together logically. You may add any number of tests to a rule’s condition.
Procedure
- In the displayed rules view, double click anywhere on the rule you want to update. This places the rule in edit mode.
- Click on a green plus to choose the type of test you’d like to add.
- Fill out the details that are appropriate to the test you selected. See the reference documentation for each test type for more information.
Result
The test has been added to the rule.
Once You Are Done
Although the rule has been updated within the rules editor, the change has not yet been propagated to the portal. To commit the change to the portal, you must save the rule set.
Turning a Rule On or Off
Overview
Individual rules can be turned on or off in Migrate. When a rule is created, it is turned on by default.
Procedure
- In the rules grid view, select the Rules tab. You may need to click the left arrow to get to the Rules tab.
- Click the rule that you want to turn on or off.
- Double click the Status column of the rule. If the rule is on, there will be nothing displayed in this column.
- Select the desired option from the drop-down menu that appears.
- Click anywhere else on the screen.
Result
The rule has been turned on or off. A rule that has been turned off will have “off” displayed in the Status column in the rules grid. The rule will also be greyed out in the displayed rules area. Although the rule has been updated within the rules editor, the change has not yet been propagated to the portal. To commit the change to the portal, you must save the rule set.
Using Edit Mode
Overview
To edit a rule, enter edit mode by double-clicking anywhere on it in the displayed rules view. In edit mode, there are a few extra things that show up all for the purpose of allowing you to make changes to the various parts of the rule.
- a green plus symbol allows you to add a condition
- another green plus allows you to add an annotation
- fields for providing extra details for each annotation
- specify cases when the annotation applies with when
- specify to which element the annotation applies with on
- specify repeated applications of the annotation with for each
- OK and Cancel buttons
- a Delete button to delete the entire rule
- the left margin has been altered further indicate
- that the rule is in edit mode
In edit mode, you can change a rule’s: applicability (i.e. paragraph, span, etc.), name. comment, condition and annotations. Simply double-click on whatever you want to change, and options will be displayed. You will notice that anything which you can edit will change to blue when your mouse hovers over it. When you are done, you can press the OK, Cancel to back out of the changes. Clicking OK only updates the rule in the rules editor. It does not save your changes to the portal.
Understanding Rules
Overview
Rules are the mechanism for guiding Migrate conversions. They are the key to obtaining the target output that you desire. A rule set is a collection of such rules, and it are associated to documents using the dashboard. Rules consist of two main parts: annotations and a condition. The annotations are instructions to Migrate as to how different portions of your document should be treated during conversion. For example, this content is the title of a task topic, or the term of a definition list entry. The condition is used to determine when a rule matches, that is on what pieces of your document the rule’s annotations should be applied. Conditions can potentially be quite complex.
Anatomy of a Rule
Condider the following rule which tells Migrate that any content styled as ListParagraph, having a list-style property of decimal, and a margin-left property of 720twips, should be considered an ordered list item with a nesting level of 1 (i.e. an outermost list entry).
| 1 | applicability | The rule will only be tried on elements of the indicated type. This helps improve Migrate’s performance. |
| 2 | name | A descriptive name for the rule chosen by you. |
| 3 | condition | Conditions test the properties of content to see if the rule matches, and hence whether or not the rule’s annotation should be applied to that unit of content. |
| 4 | annotations | Annotations indicate how a chunk of input text should be converted. |
Rule Condition
A rule condition can be simple or complex. A simple condition may consist of a single test, such as a style test. This is actually quite common. On the other hand, a condition may be composed of several tests, carefully combined together to capture your specific intent.
A variety of tests types are available so as to enable you to accurately identify the exact portions of your content that require special treatment, thus allowing you to carefully place annotations where they belong. The available test types are summarized in the following table.
| Test | Description |
|---|---|
| style | test the styling applied to the content by the authoring tool |
| property | test some property associated with the content (e.g. the size of the left margin, font size, or the column header if in a table) |
| content | test the content (e.g. see if it starts with some specific initial characters, or if it matches a provided regular expression) |
| condition | test if a particular condition was applied to the content |
| logical combination of tests | test if all of, some of, none of, or not all of the following conditions are true |
| contains element | test if the current element contains a nested element with specific properties |
| context | test the current user managed context |
| id | test the unique identifier of the element |
2020 Interim Results Now Available
We are pleased to announce that the 2020 Interim Results are now available and a PDF copy will be emailed directly over the coming days to all those shareholders who have registered with us on our website here.
If you are an existing shareholder and would like to otherwise request a copy of the accounts, or have follow-up questions that you would like to raise, then please contact us at [email protected].
What is the Rules Editor?
Overview
When you open the rules editor on a particular document, you are presented with quite a bit of information that is intended to help you when you want to update rules and create new rules. This includes:
- What rules have fired on this element?
- What annotation have been applied to this element?
- Where has this rule fired?
- What are the properties of this element?
To work effectively with the rules editor, you need to know how to get answers to the above questions. This will help you to understand your document’s structure and the existing rule set. You will then be ready to modify rules as needed. Everything you need to know is presented in the:
- Content Panel,
- Element properties tab,
- and rules grid
Content Panel and Content Elements
The Migrate rules editor displays a rendition of your document in the content panel. This is intended to look similar to your source document, but won’t be an exact match as it is an HTML rendition of the document that is specifically suited for Migrate. Sufficient formatting is retained, however, so that the content looks familiar to you. If the document is large, Migrate may actually split the document into chunks. In fact, you can control the chunking behaviour yourself.
If you click around in the content panel, you will see that Migrate provides information associated with text you have selected in the Element Properties tab. The information displayed in the Element Properties tab stays synchronized with the selection in the content panel.
Migrate decomposes your document into content elements. Only the following content element types are available: paragraph, span, image, table, row, and title. Some content elements can be nested inside others. For example, a span is contained in a paragraph. If you click on a nested content element, you will see its properties.
To change your selection to the containing content element, simply click on the highlighted selection again. Each click will cause the selection to grow to the containing element. Once the outermost selection is current, the next click will cycle back to the innermost element at the point where you click.
For example, if you repeatedly click on a span which is inside a table, the current selection will change from the span, to the containing paragraph, to the containing row, to the containing table. This is how you can select a table to see all of the information Migrate has about it.
The grey bars in the left margin indicate that no rules have been applied to the content element. This is often not a problem, as Migrate will map simple paragraphs to paragraphs, and tables to tables. But if the corresponding element is to have special semantic significance, you will likely need to ensure a rule applies to it.
Element Properties Tab
The Element Properties tab provides the following information on the current content selection in the content panel.
Rules Grid
The rules grid provides a condensed display of your rule set. As with the Element Properties tab, the rules grid also stays synchronized with the content panel. As you select different rules in the grid, the content element in the content panel for which the rule has has matched will be highlighed with a green border. The Rules Grid provides a toolbar for stepping through these matches. This allows you to quickly see where the in the content the selected rule has applied.
The rules grid is also synchronized with the displayed rules view. As you change your selection in the rules grid, the displayed rules view will automatically scroll to show you the rule’s full definition.
