Publication Manager crashes while opening a publication

Last Updated : Jun 25, 2021 |

Condition

  • Publication Manager crashes while opening a publication.

  • Publication fails to open.

Cause

Publication either takes unusually longer to open or fails to open due to multiple circular references within topics. If the number of recursions cross the threshold in a publication, Publication Manager crashes before the publication opens.

You must avoid these loops by removing the circular references.

The following are some examples of circular references in the order of severity:

  1. Para A from Topic 1 referenced in Topic 2, para B from Topic 2 referenced in Topic 3, and para C from Topic 3 referenced in Topic 1.

    For example, a step from Adding users topic is referenced in Editing users topic, a paragraph from Editing users topic is referenced in Duplicating users topic, and a step from Duplicating users topic is referenced in Adding users topic.

  2. Step 1 from Topic 1 referenced in Topic 2, Step 2 from Topic 2 referenced in Topic 1.

    For example, a step from Adding users topic is referenced in Editing users topic, and a paragraph from Editing users topic is referenced in Adding users topic.

  3. A para or a step from a topic referenced in the same topic.

Circular references also applies to content references made by using xref element.

Solution

Procedure

  1. Start Publication Manager and open a publication.

    Publication Manager lists errors in the publication in the Error list section at the bottom, if any. For example, any unresolved hyperlinks, conrefs, and circular references.

  2. Note the topics with circular references:


    Topics reference itself, also called circular references

  3. In Error list, double-click the error message to navigate to the topic, and check out the topic.
  4. If the content is referenced in the same topic, do one of the following:
    1. If a simple paragraph or a step is reused, copy from the first location, and paste in the second location.




    2. If the reused content is a complex step with substeps, an ordered list, or unordered list, and if you want to reuse more than once, move the content to a common topic, and reuse in all applicable topics.
  5. If the first topic references content from the second topic, and the second topic references content from the third topic, and the third topic references content from the first topic:
    1. From the three topics, remove the reused content and add the content in a common topic.
    2. Reuse the appropriate content from the common topic in three topics.
    Important:

    In a common topic, do not reuse content from other common topics. Because common topics are used across publications and programs, reuse from other common topic multiplies the references very quickly causing loops resulting in delays in opening publication or publication crashes.

    The only exception is common topics: Product names, Applications, Snapin-names, and Languages.

  6. After you resolve the circular references in topics, consult Information Architect to replace the topics in the publication that fails to open.

    This step applies only if the publication fails to open and crashes Publication Manager.

To prevent circular references, when you reuse content:

  • Always make references to common topics instead of the peer topics used in the project.

  • Ensure that the direction of references must be in the direction depicted in the image.





For example, add frequently used content, such as steps, uicontrols, and wintitles in a common topic and reuse the content in Adding users, Editing users, and Deleting users. Do not reuse content from the Adding users topic in the Editing users topic.