Understanding Common Rendering Problems

Scroll may find wiki syntax which it does not completely understand, or even does not support at all. This page explains how to deals with these problems.

There are tree types of messages:

• Errors prevent Scroll from exporting a valid document. Therefor Scroll will not proceed with the export, before the source of the error message is fixed.
• Warnings indicate that Scroll has found wiki syntax, which is not officially supported. In most cases Scroll will still produce a document, however it might have 'red areas' which indicate problems.
• Infos provide additional information, but they do not indicate real problems for the Scroll exporter.

Errors

Errors prevent Scroll from exporting a valid document. Therefor Scroll will not proceed with the export, before the source of the error message is fixed.

The figure above shows a sample error message. It can be fixed by clicking on the page link.

Found unsupported macro {macro name}, which is known to break Scroll

Generally, unsupported macros cause a warning message. In this case an unsupported macro was found which is known to break Scroll.

To fix the problem, there are only two possibilities:

• Replace the macro by other wiki syntax or macros.
  or
• If the macro is not needed in the exported document, you can also use the {scroll-ignore} macro to let Scroll ignore this macro.

Element '...' does not accept child element of type '...'

The Scroll meta model introduces some restrictions regarding the combinatorial diversity of constructs. Thus an element does not accept every element as a child.

Please refer to the authoring guide and change your wiki markup according the supported wiki subset of Scroll.

Macro {macro name} is creating a circular reference

In Confluence {include} or {excerpt-include} macros can be used to include a page or its excerpt into another page. However, it is possible to create circular references which could cause an infinite loop while exporting the documentation.

Review the way you used {include} or {excerpt-include} macros starting from the mentioned page and remove the circular reference.

Could not parse page content (Reason: ...)

This error is due to an internal error of Scroll.

Please contact you system administrator, who will probably needs to contact K15t support.

Unexpected error: ...

This error is due to an internal error of Scroll.

Please contact you system administrator, who will probably needs to contact K15t support.

Warnings

Warnings indicate that Scroll has found wiki syntax, which is not officially supported. In most cases Scroll will still produce a document, however it might have 'red areas' which indicate problems.

The figure above shows a sample warning message. It can be fixed by clicking on the page link.

Monospaced text does not accept nested formatting of type ...

Scroll has some restrictions for monospaced text. It is not possible to nest text effects such as color, citation, emphasis, etc. within monospaced text (the only exceptions are ^superscript and _subscript). For example {{*monospaced and strong*}} won't work and causes this warning message.

As a workaround, you can nest the text effects the other way around. Referring to the example above the problem could be fixed by transforming {{*monospaced and strong*}} to *{{monospaced and strong}}*.

Further Information about this can be found in the Authoring Guide (in the red box).

Invalid admonition type ...

This indicates that Scroll has detected an admonition other than the standard admonitions provided by Confluence.

Avoid this warning by only using the standard admonition types. Please note, that this warning message might theoretically also be caused in other circumstances, which will require you system admin to contact K15t support.

Invalid URL for external link 'href' (Reason: 'description of reason')

This problem indicates that a malformed URL has occurred when processing a link e.g. because of a missing protocol such as http://.

Please check and correct your external link target.

Undefined linkend: ...

The linked page could not be resolved.

Please check and correct your link target.

Unexpected element ...

While parsing the HTML content of the page an unexpected HTML element was found. This problem primarily occurs in combination with an unsupported macro warning.

There is no direct way to fix this problem. Instead, solve all other problems reported for this page.

Unsupported macro: {macro name}

Currently Scroll only supports a limited set of macros as described in the authoring guide.

To fix the problem, there are only two possibilities:

• Replace the macro by other wiki syntax or macros.
  or
• If the macro is not needed in the exported document, you can also use the {scroll-ignore} macro to let Scroll ignore this macro.

Infos

Info messages provide additional information, but they do not indicate real problems for the Scroll exporter.

The figure above shows a sample info message. It can be fixed by clicking on the page link.

Confluence reported problem in the wiki syntax

This problem occurs because Confluence itself reported problems with the wiki syntax. This could be for example because of the use of an {unknown macro} or due to an [internal link|aaa:bbb] pointing to an unknown location.

There are several ways to deal with this problem:

1. correcting the wiki markup manually
2. adding the missing dependencies such as not available {macros} or nonexistent pages

No content for example element

This problem occurs because an admonition such as {tip}, {note}, {info} or {warning} was used without specifying any content.

There are several ways to deal with this problem:

1. removing the admonition in the wiki markup
2. adding content to the admonition element. E.g. transforming {tip} {tip} to {tip} some content {tip}.
3. ignoring the problem => Scroll will ignore the corresponding admonition element during export too.