Zoomin is software that is designed to provide a single portal for all of your documentation, including PDFs, Word documents, knowledge base articles, and content you create in Paligo too.
To use your Paligo content in Zoomin, you will need a Zoomin account and then in Paligo you will need to set up:
-
The Zoomin integration settings, see Connect Paligo to Zoomin
-
A publication and topics in Paligo. These contain the content you will "push" to Zoomin.
There are no special requirements for your publication and topics when publishing to Zoomin.
You can then publish from Paligo to your Zoomin software. The content that you publish is an HTML5 output that is customized to contain metadata and other details that are needed for Zoomin.
You can publish content directly from Paligo to your Zoomin instance. But to do that, you first need to set up Paligo and Zoomin to connect to each other.
-
Log in to Paligo via a user account that has administrator permissions.
-
Select the avatar in the top-right corner.
-
Select Settings from the menu.
-
Select the Integrations tab.
-
In the Zoomin box, select Add (or Change if an integration has been set up previously).
Paligo displays the integration settings.
-
Enter the Account name.
This has to match the name of the account in Zoomin.
-
Use the Choose environment option to select one of the environments. You can have up to five environments.
-
Enter:
-
An Environment name.
This can be any name you like and it is used to identify the environment in Paligo. We recommend that you give your environments names that make it easy for users to differentiate between your environments. This is because when you publish from Paligo, you will need to choose the environment to publish to and these are listed by name.
-
An Upload URL.
The upload path is the URL of the location (in Zoomin) that will receive the content that Paligo publishes.
Paligo adds a default structure for the URL path. You should overwrite it with the specific address for your Zoomin environment.
-
-
If you want the selected environment to be the default Zoomin environment for publishing, check the Set as default box. Leave it clear if you want a different environment to be the default. When you publish, you can choose a different environment if required.
-
Select Generate Key.
Paligo generates an SSH key. The key is shown in the SSH key box above the button. SSH stands for secure shell and it is used for encrypting your connection between Paligo and Zoomin.
-
Select Save.
-
Select Copy key to copy the SSH key. Then send the SHH key to Zoomin. Ask them to add it to your Zoomin instance. When they have added it, you can come back to the settings in Paligo and use the Test Settings button to see if the connection works. This button is only available when you edit the settings and is not shown when you first set up the integration.
Tip
When the connection test is successful, you can publish from Paligo to Zoomin.
If the connection test fails, make sure that you have entered the account name and environment details correctly, and that you have sent the SSH key to Zoomin. Check closely for typing mistakes, such as incorrect spaces or characters.
To publish Paligo content to Zoomin, you will need to use a Zoomin layout. The layout has settings that apply when Paligo converts your XML content into HTML, such as the number of levels in the table of contents, and whether taxonomies are included in the output.
The HTML that Paligo "pushes" to Zoomin is actually a multipage classic HTML output, but with some additional changes in the underlying code, so that it can be recognized by Zoomin. So the settings on the Zoomin layout work in exactly the same way as those on the multipage classic HTML output. The only differences are:
-
In the underlying code, the Zoomin layout adds some metadata to the HTML output. The metadata is needed by Zoomin.
-
Your Paligo output will include a taxonomies.xml file. Zoomin can then use any taxonomies that you have in place in Paligo.
You can use the built-in Zoomin layout, create your own, or edit an existing one.
To learn how to create your own Zoomin layout, see Create a Zoomin Layout.
To edit an existing Zoomin layout, follow the steps in Edit a Layout . You can find information on the available settings in HTML5 Layout Editor Options. But be aware that some of the settings may not be relevant when publishing to Zoomin.
To publish content to Zoomin, you need to use a Zoomin layout. You can use the built-in Zoomin layout or create your own. Alternatively, if your Paligo instance already contains some Zoomin layouts, you could edit one of those and use that.
To create a Zoomin layout:
-
Select the Layout tab in the top menu.
Paligo displays a list of Layouts. The list is empty if there are no custom Layouts in your Paligo instance.
-
Select an Output format.
The output format is the base layout for your new layout that defines the:
-
Type of content that you can publish with the template.
-
Source of default values. If you set a value to Default in your new layout, it means the value is inherited from the base layout. To learn more, see Layout Relationships - Base, New, Duplicate.
-
-
Select OK.
Paligo creates your new layout.
-
Select the new layout in the list to open it in the Layout Editor.
-
Use the Layout Editor to choose the publication settings. Paligo will apply these settings when it converts your XML content into the output format.
Zoomin layouts have the same settings as an HTML help center, although be aware that some of the settings may not be relevant when publishing to Zoomin.
-
Select Save.
To publish your Paligo content to Zoomin:
-
Make sure that you have set up the Zoomin integration settings correctly. In the integration settings, select Test Settings. Paligo will test the connection and display a notification that tells you if it was a success or failure.
If the test was a success, you can publish to Zoomin.
If the test was a failure, double-check that the integration settings are correct. If there is still a failure, contact customer support for advice.
-
Make sure that you have set up a Zoomin layout. You need a Zoomin layout to publish to Zoomin. There is a built-in Zoomin layout included in Paligo, but you may want to create your own if you have specific requirements for how the content is transformed from Paligo XML to HTML.
-
In the Content Manager, select the dotted menu ( ...) for your publication, and then select Publish.
-
On the Settings tab, select HTML5.
-
Choose the Zoomin layout that you want your publication to use.
-
Select the Zoomin environment that will receive the published content from Paligo.
The Select environment list contains the names of each Zoomin environment that has been added to your Paligo-to-Zoomin integration settings.
When you select an environment, the Zoomin upload path preview field updates to show the location that will receive the published content. The URL for the location is also defined in the Paligo-to-Zoomin integration settings.
-
Choose the Languages that you want to publish.
If you do not have any translations, you can only select the original language (source language).
If you have multiple languages translated and approved, you can select which ones to include. Paligo will publish each language as a separate output.
When the content is sent to Zoomin, it is processed by Zoomin. As part of the processing, Zoomin will manage the translations so that they appear in the correct place in Zoomin.
-
If you have marked up your content to use filters (profiles), use the Profiling attributes section to choose which filters to apply. If you do not want to use filters, ignore this step and continue from the next step.
To apply filters for publishing, select Edit to display a list of the filter properties that are used.
Choose the filter values that you want to include. Leave the fields blank for the filters that you do not want to apply.
When you select OK, the chosen profile settings are shown in the Profiling attributes section.
Note
With the filter settings, you tell Paligo which content to include. For example, if you have used an
outputformatfilter, you could mark up some content to have a PDF value and other content to have an HTML value. In the publishing settings, if you set Output Format to HTML, it will include the content that has anoutputformat:HTMLfilter and will exclude any content that has anoutputformat:PDFfilter (or any value other than HTML). -
If you have used variables in your content, use the Variables section to choose which variants to use for the publication.If you do not want to use variables, ignore this step and continue from the next step.
To choose the variants, select Edit to display a list of variable sets that are used. For each variable set, there is a field that you can use to choose which variant to apply. If there are variable sets that you do not want to apply to your publication, leave the fields for those empty.
-
Use the Upload Output settings to upload the published content to other platforms as well, such as GitHub. This is optional and the uploads will only be possible if the relevant Paligo integration settings are in place. For example, you can only upload to GitHub if you have set up the Paligo to GitHub integration.
To find out how to set the integrations up, see Integrations.
-
Set the Optional Parameters (leave unchecked if you do not want these features):
-
Save the output in Paligo - Check the box to save the zip file the in the Resource View. Clear the box if you want Paligo to only download the published output file in your browser.
-
Email me - Check this box if you want Paligo to send you an email when the publication is ready. This is useful if you have very large publications that can take a longer time to process and publish.
-
Make debug build - Check this box if you want Paligo to include a log file and link report. If there is an issue with your content, Paligo support may ask you to enable this feature so that they can use the log files to investigate.
-
-
Select Publish Document to start publishing. Paligo will then process your content and apply your layout and publishing settings. The time that this takes can vary depending on how much content you are publishing (the more content there is, the longer it takes).
A progress bar shows you how much of the processing Paligo has completed and how much is left to do. When the processing is complete, Paligo "pushes" the production content into Zoomin.
Tip
You can also save your publishing settings so that you can select the saved version instead of re-applying all the filters, variables, etc., each time. Any settings you save can also be used for Batch Publishing.
Comments
0 comments
Article is closed for comments.