Structured authoring in Paligo
Proprietary content is genericized. Paligo's internal attributes are removed in XML code blocks for readability.
The following sample comes from a Paligo library of ~750 topics and reusable components behind ~20 guides. Six levels of structured reuse were in place:
- Topics placed in more than one spot
- Topics inside other topics
- Reusable step sets
- Reusable notes
- Shared sentences and paragraphs
- Variables like product names, users, and icons
Following is a sample of one topic published in two guides. The topic in one guide is customized for one audience and the topic in the other guide is customized for another based on audience attributes.
The shared topic
<section>
<title>Initiate a report review</title>
<!-- Reusable note: Link names customized note (both audiences) -->
<xi:include parse="xml" href="UUID-296d2e52-ffab-0ea5-524f-cf3513a5f2a1"/>
<!-- Each <phrase> in this topic is the product name variable: "Clearpath" -->
<important audience="Employee Compliance">
<para>
This information is for organizations handling compliance internally, not for
organizations working with <phrase xinfo:variable="19" xinfo:varset="320"/>'s managed compliance team.
</para>
</important>
<para>
<phrase xinfo:variable="19" xinfo:varset="320"/> supports customized workflows for sharing a compliance report
with reviewers and tracking its progress. Customized workflows are designed through
collaboration between <phrase xinfo:variable="19" xinfo:varset="320"/> and your organization to meet your
organization's policies and procedures.
</para>
<para>
Reports typically fall into one of two categories: <emphasis>complete</emphasis> (no
flags are raised) or <emphasis>complete with concerns</emphasis> (flags are raised).
</para>
<para audience="Employee Compliance">
A common report approval process is that an organization sends a complete report to a
compliance manager, who reviews and approves the report. However, if the report is
complete with concerns, it is sent to the compliance manager and compliance committee
for review and approval.
</para>
<!-- Included topic: Steps to initiate a report review -->
<xi:include parse="xml" href="UUID-8c12467e-80cf-de83-a66a-bf33fc2ea948"/>
</section>
The reusable pieces it pulls in
<section>
<title>Steps to initiate a report review</title>
<procedure>
<!-- Reusable step: Open Clearpath (used in all guides) -->
<xi:include parse="xml" href="UUID-4f2b8e61-3c7a-4d95-b0e2-7a1c5d9e3f84"/>
<!-- Reusable steps: Employee's page navigation (Employee Compliance only) -->
<xi:include parse="xml" href="UUID-c70510c8-2a61-489e-4328-584e32021cc3"/>
<!-- Reusable steps: Review cycle navigation (Site Compliance only) -->
<xi:include parse="xml" href="UUID-079361d6-03ec-e6de-e310-059d58daa63d"/>
<step>
<para>
On the <emphasis role="bold">Details</emphasis> tab in the modal at right, go to
the <emphasis role="bold">Summary</emphasis> section and click
<phrase xinfo:variable="133" xinfo:varset="320"/> next to <emphasis role="bold">Status</emphasis>.
<!-- "the pencil icon" + pencil image variable -->
</para>
</step>
<step>
<para>
In the <emphasis role="bold">Status</emphasis> field dropdown, select the next
status in the compliance approval workflow. This likely is customized for your
organization. If you're using default functionality, the next status is
<emphasis role="bold">Complete</emphasis>.
</para>
</step>
<step>
<para>
In the <emphasis role="bold">Type</emphasis> field dropdown, select
<emphasis role="bold">Initial</emphasis> if this is the first compliance review.
Select <emphasis role="bold">Renewal</emphasis> if it's not the first time.
</para>
</step>
<step>
<para>Click <emphasis role="bold">Save</emphasis> at the bottom of the screen.</para>
</step>
</procedure>
</section>
<procedure role="reuse-range">
<step audience="Employee Compliance">
<para>
Go to the <emphasis role="strong">Review Cycles</emphasis> modal on the employee's
page.
</para>
<!-- Reusable caution, tagged Employee Compliance -->
<xi:include parse="xml" href="UUID-a3114d50-690e-5d2e-fa34-99c200f749a6"/>
</step>
</procedure>
<procedure audience="Site Compliance" role="reuse-range">
<!-- Site navigation steps -->
<xi:include parse="xml" href="UUID-965ec566-a631-dda4-6047-f77be55549c0"/>
<!-- Click review cycle -->
<xi:include parse="xml" href="UUID-7845ab80-c2d9-ee67-b222-1c7fd4508057"/>
</procedure>
<!-- Site navigation steps (nested range) -->
<procedure role="reuse-range">
<!-- Site list navigation steps -->
<xi:include parse="xml" href="UUID-95c84673-9826-55ce-4b04-14ae60b5c3c6"/>
<step>
<para>
Select a site. If you don't see the site's name in the table, click the
<emphasis role="bold">Recently Viewed</emphasis> dropdown at top left and select
<emphasis role="bold">All Sites</emphasis>.
</para>
</step>
</procedure>
<!-- Site list navigation steps (nested range) -->
<procedure role="reuse-range">
<step>
<para>
In the dropdown menu next to <emphasis role="bold">Compliance</emphasis> at top
left, select <emphasis role="bold">Sites</emphasis>.
</para>
</step>
</procedure>
<!-- Click review cycle (nested range) -->
<procedure role="reuse-range">
<step>
<para>
In the <emphasis role="bold">Review Cycles</emphasis> modal, click the name of the
review cycle.
</para>
</step>
</procedure>
<procedure role="reuse-range">
<step>
<!-- "Clearpath" -->
<para>Go to <phrase xinfo:variable="19" xinfo:varset="320"/>.</para>
</step>
</procedure>
<varset id="320">
<!-- Product name -->
<var id="20" type="text" label="19" label-name="Product name">Clearpath</var>
<!-- Icon phrase: text plus an image variable from the icon set -->
<var id="176" type="text" label="133" label-name="Pencil icon">the pencil icon
(<inlinemediaobject>
<imageobject xinfo:variable="12" xinfo:varset="1556"><imagedata/></imageobject>
</inlinemediaobject>)</var>
</varset>
<!-- Shared by both audiences -->
<note>
<para>Names and locations of links may be customized for your organization.</para>
</note>
<note audience="Employee Compliance">
<para>
The name or location of the <emphasis role="bold">Review Cycles</emphasis> modal may
not match these instructions if customizations were made to the user interface for
your organization.
</para>
</note>
What each reader sees
- outlined text is shared in both guides.
- Orange marks text that comes from a variable.
- marks an icon that comes from an image variable.
- Blue marks a reusable note.
- Pink marks a step that is reused across all guides.
- Clearpath Feature Manual
- Site Compliance Guide
Important: This information is for organizations handling compliance internally, not for organizations working with Clearpath's managed compliance team.
A common report approval process is that an organization sends a complete report to a compliance manager, who reviews and approves the report. However, if the report is complete with concerns, it is sent to the compliance manager and compliance committee for review and approval.
- Go to Clearpath.
-
Go to the Review Cycles modal on the employee's page.
Note: The name or location of the Review Cycles modal may not match these instructions if customizations were made to the user interface for your organization.
- Go to Clearpath.
- In the dropdown menu next to Compliance at top left, select Sites.
- Select a site. If you don't see the site's name in the table, click the Recently Viewed dropdown at top left and select All Sites.
- In the Review Cycles modal, click the name of the review cycle.