Getting Started with Paligo

Importing

Paligo let's you easily import existing content in a number of formats. Formats you can import include HTML, DocBook, Word and Paligo Export Format (XML), DITA, Confluence, MadCap Flare, Framemaker, Author-it, InDesign, and more.

Some can be imported directly, but in other cases we have chosen an indirect import strategy by a multi-step process, in order to achieve the best results, as described below.

Smart Import

"Smart Import" means that Paligo doesn't just blindly import all your content, it will create reuse directly.

It can intelligently detect in many cases whether the same content has already been imported. That is, it will recognize if a topic or image is identical to one previously imported. So you will not get unnecessary duplicates, and your work on reuse may begin already during import.

For Paligo to recognize topics and images they need to be identical. But if they are, it will automatically ignore the topic or image and instead reuse the one already in the system. 

Indirect import

There is a reason why not all import formats are direct imports. Migrating content from one format to another is notoriously a big challenge. And sometimes some manual tweaking, and/or pre-processing of the legacy content may be necessary. If a pre-conversion is done, you have more control over this tweaking process, and the end results are usually much better.

Well-structured legacy content

A prerequisite for a successful import is that the legacy format is fairly well-structured. It should also be noted that if you're moving from unstructured and non-topic-based content (such as Word e.g), you are likely to want to rewrite quite a bit of the content to make it topic-based, reusable, and so on. So while the import functionality works very well, you should always consider carefully what is the best strategy for your content.

If your content is well-structured and divided into topic-like sections already, you may gain a lot from an import, saving you time on migration. But if a lot of rewriting is necessary anyway, the gains will be smaller, and importing in such a case might not even be a good idea at all.

Importing direct import formats

  1. To import any of the direct import formats (see below), first put the content in a folder, and zip it. There must only be one main content file in the folder, such as index.html for HTML format. Images can be in folders or not, as long as they are in the same zipped folder, and the references to them are correct.

  2. Then in Paligo, click the context menu on the folder where you want to import to and select Import content.

     The Import content dialog opens:

  3. Then in the import dialog, select the zip file you just created.

  4. Select the correct import format for the content you are importing.

  5. Select the parameters:

    • If you want to use the Smart Import, recognizing already identical already imported topics (recommended), check that box.

    • Select if you want admonitions (notes, warnings, etc) to be imported as separate reusable components. This is recommended if you know you have many identical admonitions. But if most are unique, leave it unchecked.

    • In most cases, also choose to ignore warnings unless you have any problems when trying the import. Paligo will usually fix minor problems during import.

  6. Click Ok.

For the indirect import types, first do the pre-processing as described below, and then follow the above procedure. If you need help with any of the pre-processing, please contact support.

Import Types

Below is an overview of the types of import, and you can read more detailed instructions for each of the types in separate topics.

Format to import

Description

DocBook 5

Direct import in Paligo import wizard

DocBook 4.5

Direct import in Paligo import wizard

HTML

Direct import in Paligo import wizard

Note

It is also possible to have this import customized for your needs. Contact support for more information.

Note

HTML is not a structured format. The import will handle many flavors of HTML, but because of the many proprietary variants there is no guarantee it will work for yours. If you have problems, inquire about the possibilities to tweak the content.

Confluence

Direct import in Paligo import wizard

The import works with an HTML Confluence Space export.

Note

It is also possible to have this import customized for your needs. Contact support for more information.

Paligo Export Format

Direct import in Paligo import wizard

This XML format is used for backups, among other things.

DITA (ditamap)

Direct import in Paligo import wizard

Note

It is also possible to have this import customized for your needs. Contact support for more information.

Microsoft Word

There are two options:

  1. Direct import in Paligo import wizard

    This will handle most well-structured Word documents well. If it has problems with your Word styles, try one of the other two options.

  2. Convert to DocBook using the optional Oxygen editor client.

  3. Get a customized Word import from support if your content is not easily imported directly.

MadCap Flare

Direct import in Paligo import wizard

The direct import handles all the basic content import. For more advanced import, with more support for variables and "snippets", please contact support.

Note

It is also possible to have this import customized for your needs. Contact support for more information.

Help & Manual

Direct import in Paligo import wizard

Framemaker

Export to XHTML and then import directly in the Paligo import wizard.

Other formats:

  • Author-it

  • RoboHelp

  • InDesign

  • Any other format that can export to one of the supported formats

Export your content to any of the supported formats (available from all of these applications), and then follow the steps above for the applicable format

Pre-processing may be necessary

Depending on the output of the export from any of these tools, some tweaks may be necessary to get the desired results. For instance, the HTML output from InDesign may not always be structured enough, and a pre-transformation and/or some manual tweaks may be necessary.

If you need help with this, please contact support.