Getting Started with Paligo

Table of Contents

Editing Layouts in the Layout Editor

Depending on whether you are creating a layout for PDF or HTML, the options you have are different. PDF styling can be very complex because it normally requires programming skills in XSLT. To make this much easier and make it possible to style your PDFs without any such skills, Paligo has a graphical Style Editor.

For styling HTML, on the other hand, there is a quite easy stylesheet language: CSS. And Paligo provides the option to upload and use your own CSS stylesheet, which is the easiest way to allow powerful styling changes.

Note

If you know that you may still want to be doing more advanced XSLT customization, either yourself through WebDAV access (which can be enabled by support), or by requesting a customization from Paligo, you should first add those custom XSLT stylesheets, and then base the new layout on them before you start.

Contact support if you are unsure about what's best for you.

PDF

When you open the Style Editor for PDF, you will see a tree of elements you can style on the right.

  1. Select items in the tree, and then you will see a pane in the middle with options that you can specify values for. For instance, the entire document where you can select page format, orientation and double-sided (for print binding).

  2. Click Save to save your layout.

See a preview

If you want to see a preview of the layout you are creating without having to publish, you can simply select a publication to the right. Select a project or publication that is not too big, because the preview will be faster if it's reasonably small. If you do not have a small publication, simply create a "dummy" project and use some representative topics with content you want to style, and then choose that for your preview.

When you have saved your layout, it will be available in the Publishing dialog under the dropdown Templates.

HTML

If you are styling HTML, when you click the Settings button, you will see an upload field to upload your own CSS. Simply add CSS rules in a stylesheet on your computer for any HTML element you want to change, and then upload it.

Tip

Right-click an element in a published HTML output, and select Inspect element to see the HTML code for the element you want to style. Then create a rule for it. If you want a primer on CSS, this is a very useful one: CSS Tutorial

Tip

If you have a lot of changes you want to make in CSS, and you have the CSS skills, the fastest way to do this is to:

  1. First add a CSS stylesheet (it can be empty at this point) in the Layout Editor.

  2. Then publish a publication and save it on your computer to use as a development sample.

  3. Open the folder out/css. In there you will find your custom CSS file, but it will be renamed with a random ID name:

  4. Now just open the HTML file in your browser (index.html).

  5. Make any change in the CSS, overriding any of the default CSS rules (again e.g using the Inspect element command in the browser).

  6. Refresh the browser to see the changes.

Other HTML5 settings
Logotype

Replace the sample logo with your own by uploading it here. By default it will be placed in the upper left corner of the header.

It is also possible to use different logos for different publications, and even use variables for the logo, as well as vary the placement. Contact support for more information if this is something you want.

Permalinks

Enable permalinks if you want to generate SEO-friendly file names for your HTML5 output. For instance, instead of a unique ID name, such as /UUID-338b22f2-ef75-cbdd-059a-d41ae9989072.html the file names generated with this option will look something like /myhelp/getting-started/install-the-sim.

In many cases enabling permalinks is a good idea. But not always. The unique ID option has its advantages too, making for a simpler folder structure in the output, and easier portability, etc. You should consider what is best for your content.

Format output

Enable tidy will mean the utility HTMLTidy will run on the HTML5 content when publishing. This can make the output HTML code cleaner to read and work with. Note though that this is not for everyone. If you e.g use lots of code snippets in your content, HTMLTidy may not be a good idea to use.

Output taxonomies as class names

If you use taxonomies to categorize your content, and you want those categories output in the HTML to use it for styling or on-the-fly filtering you can set that here.

TOC section depth

Control how deep in your topic nesting structure you want to show the topics in the Table of Contents. For instance, if you have topic nesting down to level 4 or 5, those lowest levels might be very small subsections that you do not want to show in the Table of Contents.

Syntax highlighting

Select whether you want code snippets to be color highlighted. You have a number of themes to choose from. See sample themes here: Highlighing themes

Chunking

When you author your content in topic-based authoring, you may be breaking down topics as much as possible to small pieces of content to make it as reusable as possible. But then when you publish to HTML/HTML5 you may not want each web page to show just that small piece of content, but rather a larger section with a number of subsections, e.g a chapter or the like.

Setting that a topic should be a chunk means it will come out on a web page of its own. You can control this in several ways. Here you can decide if every topic down to a certain nesting level should be a chunk. The default is down to level 3.

If you want to override this for a particular topic, you can set the attribute xinfo:chunk to the value "yes" on any topic. If you do, that will mean this topic and all topics nested under it will become one web page in your output.

Note

If you reuse topics within a topic (Component Reuse), you can use the chunking to make sure you get one output chunk from the entire "parent" topic. This is especially important if you have any internal sections after the reused topic, as you might otherwise get a confusing order in your output. If you don't want that, then reuse the topics as nested topics in the Structure View instead.