Getting Started

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.

There will always be some limitations in what can be imported from one format to another, and some import formats will work better than others. In general, the more structured the legacy format, the more complete the import will be.

Warning

An import is not the same as a migration, but a tool that speeds up the process of migration significantly. But every import must always be checked manually to make sure no content is missing or incorrect in any way.

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.

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. 

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 the Custom options tab, if you want to change any of the following settings:

    • Adding a title prefix: This is generally not required, but is available if you have some reason to mark your imported topics with a prefix.

    • Enable folder numbering: If you want your folders in the import to be numbered to have a specific sequence, enable this.

    • Max folder levels: By default Paligo will create a folder structure on import that mirrors the structure of your legacy content down to the second level. I.e if you for example have a manual with chapters and sub sections, the import will create a folder for each "chapter" and the first level under that. You can set it to more or less levels if you want.

    • Match with existing variable set: (Only applicable import formats) If you have imported a format that creates variable sets from your legacy content, and already have done this once so you have the variable set created already, you should select to use that in any subsequent imports. If you don't, you will get duplicate variable sets.

  7. 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

Note

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

DocBook 4.5

Direct import in Paligo import wizard

Note

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

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

The DITA import can also import keyrefs/conkeyrefs as variable sets. If you have any trouble with this, ask support for instructions about how to prepare the content.

Note

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

Microsoft Word

There are three 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.

Note

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

MadCap Flare

Direct import in Paligo import wizard

Besides the content itself, the MadCap Flare import also handles most "snippets" and variables. If you import multiple projects one after another, you can also specify to reuse the already existing variables, in the options tab.

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

The Help & Manual import will be able to import the bulk of the content well. There are however some known limitations:

  • Help & Manual uses a very flat structure that needs to be converted into more structured nested XML. This is a great challenge for a conversion, and you should make sure the attempt to fix this has not misinterpreted the intended content order.

  • Variables are only partially supported, as the use of variables differs greatly from the way it is implemented in Paligo. Non-supported variable types will be marked with a "remark" element in the import ("UNHANDLED VARIABLE")

  • Conditional filtering is completely different in Help & Manual than in Paligo and most XML-based single-sourcing, so a direct conversion of this is not possible. Instead, it is marked up by "remark" elements to be manually fixed post-import.

Note

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

Author-it

Export to XHTML and then import directly in the Paligo import wizard using the Author-it format option.

If conditional filtering has been used, this is not included in the XHTML export, and needs to be applied post-import.

Note

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

Framemaker

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

Note

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

If conditional filtering has been used, this is not included in the XHTML export, and needs to be applied post-import.

Other formats:

  • 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.

Search results