Skip to main content

Multi-Publication Portal

If you have many related publications, you might want to make them all available in the same HTML5 help center. With this approach, there is a home page (a portal) that provides links to each of your publications.

multi-publication-help-center-annotated.jpg

We call these portals "parent publications" and there are two ways to do it:

  • Manually create a portal page and then link your published Paligo outputs to it, with the search provided by a third-party system, such as SwiftType. Then to update the content, you publish each manual separately and set up the portal so that it has links going to each publication. The way to achieve this can vary, depending on what search engine you use and how you create the portal page. For example you can publish once, use the portal page created and then manually modify it to fit. We also offer professional services if you need help with this, contact support for more information.

  • Create a parent publication in Paligo, with the search being provided by Paligo's built-in search. Apply the layout settings and prerequisites for parent publications. Build the parent publication and then follow the steps for one of the publishing methods (Single Publish or Multiple Publish) that best suits your requirements. There are pros and cons to both methods. To decide which method is best for you, consider what you need from your content.

    Note

    The Paligo parent publication work well for a small number of publications. For more complex use cases, a manually created portal page might work better.

    If you find that your use case does not fit the Paligo parent publication, ask support about professional services for a custom solution.

Prerequisites for Parent Publications

When you create a parent publication, you use a layout to publish to HTML5. The layout needs to have certain settings in place, otherwise the parent publication portal will not work correctly.

Note

Algolia faceted search is not supported by the parent publication portals.

System Settings for Parent Publications

For parent publications, you need to have the Persistent image file names setting enabled in the system settings. This setting means that the image files will use a persistent ID for the file name which is better for consistency.

Note

To make changes to the system settings, use an Admin user account. Users with an Author user account can change the layout settings and complete all of the other steps needed to create a parent publication.

  1. Select the arrow to the right of your avatar in the top menu.User avatar. It shows the user's image and their name. Next to the name is a downward pointing arrow, which when selected, reveals a menu.

  2. Select Settings. Cog icon.

  3. Select the System Settings tab.

    System settings tab showing the Persistent image filenames section. The Enable persistent filenames slider is set to on.

  4. Make sure you have Persistent image file names enabled.

Layout Settings for Parent Publications

To get Paligo to publish content for parent publication portals, you need an HTML5 layout that has certain settings enabled. Before you can adjust the layout settings, you have to Create a Layout.

Important

If you enable the layout option Only create topic for reused publications if no top-level topic (located under General) you must remember to link to a topic in the subpublication, not to the subpublication itself.

OnlyCreateTopicForReusedPublicationsIfNoTopLevelTopic.jpg

Apply the following settings to the layout:

  1. Select Layout in the top menu.

    Paligo editor. The Layout option in the header menu is highlighted.

    Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.

  2. Select the Layout you want to update or Create a Layout.

    Tip

    You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.

  3. Select General.

    Layout_General_HTML5_small.png

  4. Select Enable for SEO-friendly output filenames.

    Important

    This setting must be enabled.

  5. Select Enable for Use a short and flat URL structure for output files (or Ajax-enabled if you use that).

  6. Select Enable for Use output filenames made from id and SEO name (a particular file naming for the HTML files).

  7. Select Enable for Multiple publication portal prefix if your subpublications contain further nested subpublications, reusing the same sub topics.

    When enabled, this setting adds the publication id to the start of the output filename. This means that each topic has a unique filename for the different subpublications, no matter how many levels of subpublications there are.

    Note

    Only enable Multiple publication portal prefix if you have multiple levels of nested subpublications.

    If you only have one level of subpublications (under the parent publication), make sure the setting is disabled.

  8. Select Enable for Use resource name instead of title for the HTML output file name if you use variables in your topic titles.

    This is because the parent publication depends on the file names being the same when you publish both the parent publication and the subpublications. With variables in the titles, the file names will be different, unless you enable Use resource name instead of title for the HTML output file name. When enabled, the topic names are used for the filenames instead of the titles.

  9. Select Enable for Create a title topic for reused publications.

    HTML layout settings. Create a title topic for reused publications setting is shown.

    Important

    This setting needs to be enabled for the filtering to work for the parent publication.

  10. Select Help center theme options.

    Layout_General_HTML5_small.png

  11. Select Enable for Open portal category on first topic for nested publications.

    Open_Portal_Category_on_First_Topic_For_Nested_Publications_small.jpg

  12. Select Enable for Treat nested subpublications as topicheads.

    Treat_Nested_Subpublications_as_Topicheads_small.jpg

  13. Select Toc and Chunking.

    Layout_General_HTML5_small.png

  14. Select Disable for Standalone TOC.

  15. Select Save.

Topic Requirements for Parent Publications

Before you publish your content to a parent publication portal, make sure that:

  • Subpublication topics do not use the element attribute role with the value portal-category. It is incompatible with parent publications that use the subpublications for categories.

  • The first topic in each subpublication does not use a variable in the title element. You can use variables in your subpublication topics, but not in the title of the first topic. This only applies if you are using the Multiple Publish method to create your help center portal.

Create a Parent Publication

If you have a series of publications that you want to release as one output, you can create a parent publication. This means that publications are added to a main publication. The reused publications become subpublications that appear as sections in the output (such as PDF or HTML5 help center). For the HTML5 help center output, the parent publication will become the portal that contains all subpublications.

Before you build the parent publication, you have to consider whether to use Single Publish or Multiple Publish.

Tip

There are layout settings that you can use to control how the top-level of a publication is presented in HTML5 outputs, see HTML5 Layout Editor Options.

You can use filters to hide a reused publication's topics in the output. For example, you may want to filter out introduction topics. To find out more about filtering topics, see Filtering / Profiling.

  1. Make sure that the Prerequisites for Parent Publications are in place.

  2. Create a Publication that will become the parent publication

  3. Select the publication in the Content Manager. Publication.png

    Empty_PublicationStructure.jpg

  4. Drag and drop the subpublications from Content Manager into the publication structure. Subpublication.png

    SuperPublication_PublicationStructure.jpg

    Reused publications get a reuse symbol. To remove a subpublication, select the X to the right of it.

  5. Rearrange the topic position with the arrows or drag and drop it in the structure.

    Arrow buttons used to change position of content forks in publication structure.

  6. Select Save to confirm the publication changes. Save_Publication.jpg

  7. Select the Dotted menu (...) for the parent publication in the Content Manager.

  8. Select Edit and choose Open in Editor. Open_Editor.png

  9. Select the article element in the Element Structure Menu and choose Go to element.

    super-pub-article-element-context-menu.jpg

  10. Add the role attribute and set its value to multi-publication-portal in the Element Attributes Panel.

    element-attributes-role-multi-publication-portal.jpg

    Important

    You should only use the multi-publication-portal role on the the parent publication article element. Do not add it to the subpublications.

  11. Select Save. Save icon.

Publish a Parent Publication

A parent publication is a main publication that consists of subpublications or a mix of topics and subpublications. This is used when wanting to have multiple publications in the same portal. There are two ways to publish a parent publication:

Single Publish

  • Publish once to create or update the entire help center.

  • Use cross-references between the subpublications.

  • Use the same Variables and Filtering / Profiling.

    However, you can use Scoped Filtering to apply different filter values to the subpublication content.

  • Navigation menus include all subpublications, not just the one you are viewing.

Multiple Publish

  • Update each subpublication individually. First, you publish the parent publication without variables. Then publish each subpublication with individual settings.

  • Use different Variables and Filtering / Profiling for each subpublication.

  • Navigation menus only include the subpublication you are viewing.

Note

With multiple publish you cannot use cross-references between the subpublications.

However, there is a workaround for cross-references that makes it possible, but it is only suitable if you have a low amount of cross-references.

The workaround is to publish the help center and make a note of the urls for the pages that will be linked to. Then, in Paligo, add external links to those urls instead of cross-references, and then re-publish.

Single Publish

The single publish method means that you publish the entire parent publication with all its subpublications at the same time. This means that you only publish once to create the finished help center.

If you instead want to publish the subpublications separately, see Multiple Publish.

super-portal-blank.jpg

To publish the entire parent publication with the same Variables and Filtering / Profiling:

  1. Select the Dotted menu ( ... ) for the parent publication in the Content Manager.

  2. Select Publish. Download icon.

  3. Select HTML5 and choose the layout that contains the appropriate settings for a help center portal.

    Note

    If you set any variables or profiling (filters) for the publication, they will apply to all topics in all of the subpublications. If you need to apply different filters to the subpublications, you can use scoped filtering or use the Multiple Publish to create the parent publication.

    Publishing settings for a super help center.

  4. Select Publish document.

    Your browser will download the zipped publication. It is stored in the folder your browser uses for downloads. Typically, this is the "Downloads" folder on your computer.

  5. Unzip the parent publication download and store it on the server or network that will host your help center.

  6. Open the index.html file in the output to launch your parent publication portal.

    Your parent publication now has a "portal" page with Category Panel Section for each subpublication. Users can select the panels to access the subpublications.

Tip

To find out about how to upload the content, see Upload Manually to Your Web Server and Upload Directly to a Web Server or Portal.

Multiple Publish

The multiple publish method is used if you want to use separate Variables and Filtering / Profiling for each subpublication.

  • The parent publication is published without variables and filtering, see Publish without Variables and Filters. It will only be updated if topics are removed or added in the subpublications.

  • The subpublications are published with individual settings, see Publish Subpublications. The HTML files for each subpublication must be manually replaced in the parent publication output to complete your help center.

super-portal-blank.jpg

Tip

If you instead want to publish the entire parent publication with the same Variables and Filtering / Profiling, see Single Publish.

Publish without Variables and Filters

To be able to use different Variables and Filtering / Profiling for the subpublications, the parent publication must be published without Variables and Filtering / Profiling.

Note

Once the parent publication is published, the only time you have to update it, is if topics have been added or removed from one of the subpublications.

Changes to existing topics only require an update of the affected subpublication.

To publish the entire parent publication without Variables and Filtering / Profiling:

  1. Select the dotted menu (...) for the parent publication in the Content Manager.

  2. Select Publish. Download icon.

  3. Select HTML5 and choose the layout that contains the appropriate settings for a help center portal.

    Important

    Do not set any Profiling attributes (filters) or variables.

    Publishing settings for a super help center.

  4. Select Publish document. Your browser will download the zipped publication.

    It is stored in the folder your browser uses for downloads. Typically, this is the "Downloads" folder on your computer.

Note

Now the subpublications are to be published with Variables and Filtering / Profiling.

Publish Subpublications

Once the parent publication has been published without Variables and Filtering / Profiling, each subpublication is published separately with individual settings.

To complete the update of your help center, the HTML files for each subpublication must be manually replaced in the parent publication output.

To publish a subpublication with Variables and Filtering / Profiling:

  1. Expand the parent publication to reveal its Forks in the Content Manager.

    superhelpcenter-select-fork.jpg

    Forks are references between a publication and the content included in the publication.

  2. Select the dotted menu (... ) for one of the subpublication forks and choose Publish. Download icon.

  3. Select HTML5 and choose the same layout that you used for the parent publication.

    super-pub-subpub-publishing-settings.jpg

  4. Apply any Profiling attributes (filters) and variables that you want the subpublication to use.

    The filters and attributes will only apply to the selected subpublication. They will not affect the other subpublications in the help center.

  5. Select Publish document.

    Your browser will download the zipped publication. It is stored in the folder your browser uses for downloads. Typically, this is the "Downloads" folder on your computer.

  6. Move the downloaded zip files for the parent publication and the subpublication to a folder on the network or web server that will host your help center content.

    Note

    When you have moved the files, unzip them.

  7. Browse to the out > en folder in the subpublication output.

  8. Copy the HTML files with the subpublication's number.

    sub-pub-en-content.jpg

    Important

    Do not copy toc-en.html, index-en.html or params.manifest.

  9. Browse to the out > en folder in the parent publication output.

  10. Manually remove the corresponding old HTML files for that subpublication to avoid getting stray HTML pages.

    Note

    The files that belong to the subpublication can be identified by the prefix in the filenames.

    For example 6081-6097-troubleshooting.html where 6081 is the subpublication prefix for ACME 100 User Guide.

  11. Paste the copied HTML files into the parent publication's out > en folder.

    super-pub-en-content.jpeg

    Note

    The en folder is for English outputs.

    For outputs in other languages, there is a two character folder for that language instead, for example, "de" for German. To learn more, see Language Management.

  12. If the subpublication uses variable images:

    1. Browse to the out > en > Image folder.

    2. Copy the images.

    3. Paste them into the parent publication's out > en > Images folder.

  13. Repeat this procedure for each subpublication in the parent publication.