...
Note for Vertical Tables: The comparison tool will not show the differences in dependencies (see Anchor
| Table of Contents | ||
|---|---|---|
|
, but it will not apply them (see “Vertical tables”).
Tables and lists
We don’t flatten lists and tables anymore.
Bug scenario: None expected, this one will only make the users happier 🎉
...
Only the second column is used for the description
We only use the first cell as the body of the requirement. All the other cells are stored as properties, and the text of properties is not repeated in the cells.
...
Rationale: Users didn’t understand why the same text was repeated in the description and properties. In most cases, the description of the requirement is indeed in the 2nd column, and in other situations, the RY Property macro can be used.
Links
We store the link’s relative URL:
...
Rationale: It is more future-proof when you change the URL of Confluence, which happens for all our customers who have a merger-acquisition.
Images
We save a lot more attributes, and we save relative links (as explained in the previous paragraph about relative URLs)
...
Rationale: Customers complained that we reformatted documents in v1, and images were reduced to their minimum, so we store the image as rendered by Confluence.
Vertical
...
tables and parent/child dependencies
In Indexing V1, we used to create automatic parent/child dependencies between vertical tables and the following requirements.
Bug scenario: The comparison tool doesn’t show the differences, and upgrading those requirements doesn’t change their dependencies, but the next time they are indexed, dependencies will have changed.
...
Rationale: Some customers would like to make other uses of the “parent” dependencies and this automatic dependency was disturbing to them. However, removing this system brought controversy, so we might reinstate it later.
Scaffolding
Configurations are varied, so please report any difference that is affecting your business.
...
Recursive macros,
Repeat macros,
Excerpt/include macros with definitions: They will appear as duplicate definitions if they appear on several pages.
There is extra HTML added to my requirements
We save more HTML than before, and it sometimes leads to HTML such as div class=”content-wrapper”> to be inserted:
...
Bug scenario: None. The rendered content is the same and it just occupies more space in a database.
Rationale: We ackowledge those elements are visually polluting. However, there are added by Confluence and we have technical difficulties identifying them using a streaming parser (it would be easy using a DOM parser, but we try not to load the full XML of pages in RAM). Since they don’t cause issues, we don’t consider it a bug when they are present.