- Paligo Documentation
- Publish
- PDF Styling
- PDF Layout Editor Options
PDF Layout Editor Options
The tree of items you can choose to style in the Layout Editor is divided into several sections. Each section is described below, with the items you can style and the options available for them.
Note
Many of the items and options are self-explanatory and have explanations right in the Layout Editor. So only the items that may not be immediately transparent are explained below.
|
Category |
Description |
|---|---|
|
Document |
Use to set some of the page preferences for the PDF documents that Paligo will produce when you publish with the layout, see PDF Styling. |
|
Languages |
Specify if and how you want language names for a multilingual publication to appear, see Multi-Language PDF. |
|
Page |
Here you can set the number of columns for your output, set some page preferences such as page numbering after the TOC, and also style header and footer rules, see |
|
Page margins |
Use to set the margins around the edge of each page and the body area of each page. Also set the start indent for body content, see Adjust Page Margins (PDF). |
|
Booklet |
You can create multi-fold booklets for your PDF layout (3-fold, 4-fold, etc), see Booklet. To learn about the number divisible by 4 setting, which is often needed for printing, see Troubleshoot a PDF Booklet. |
|
Fonts |
Use to set the default font settings for titles and body text. Paligo will use the default fonts unless you specify different font settings elsewhere, for example, if you set different styles for headings in the Section titles section, see Default Fonts (PDF). It is possible to add additional fonts in your Paligo instance. Contact support and send us:
Most newly added fonts will work out-of-the-box. But if additional customization is needed for it to work, there is a fee for a customization service. |
|
Footnotes |
Use to set the number format and styling for footnotes. These settings apply to all footnotes except table footnotes. Table footnotes have their own settings (in the Tables section, see Style Table Footnotes (PDF). |
|
Images |
If you set a default width for images, any images that have no specific width set on them in the topic itself will get this width. |
|
If you use inline images (the |
|
|
You set it as a compound value: 0.25pt solid silver, setting border width, style, and color. You can also set a border-radius if you want rounded corners. Either use padding to get it as a frame, or if you want to cut the corners of the image itself, experiment with values and a white color to match the page color. Usually, a ratio of 3 gets a good result. Eg., border = 3pt solid white and border-radius = 9pt. You can override the default setting here on individual images by setting the The attribute should be set on the Note that there is one condition for this to work properly: every image that you set borders on must have a width attribute. Otherwise, the border will be as wide as the page, which the image might not be. So if you set borders on images globally in the Layout Editor, you need to set the image "width" attribute on all images. |
|
|
Related Topics Section |
Use to style the related topics section that appears if you set your PDF layout to use the Relationship taxonomy feature, see Automatic Links to Related Topics ("See also" sections). |
|
Glossary, Index, and Bibliography |
Use to set up automatic features for your glossaries, indexes and bibliographies. These include automatic titles, sorting, index columns, and glossary lists, see |
|
Bookmarks |
Options for adding bookmarks to PDF and controlling the number of levels, see Bookmarks (PDF). |
|
Prepress |
If you need to set crop marks, bleed, sometimes required for printing purposes, you can set them here, see Prepress. |
|
Misc |
Options for setting:
|
|
Filtering and taxonomies |
Options for using taxonomies for filtering, see Taxonomy Filters. The options available are the same as for HTML5. |
|
Draft and Watermark |
Use these parameters to set your PDF to drafts, add watermarks, and background images so that readers know they are looking at a draft copy. For more details, see Enable Drafts and Watermarks (PDF). To have your regular styling, create a new layout based on your custom style, and then add these parameters. |
|
PDF Properties |
Use to define the metadata for the PDF document, including title, subject, keywords, display title for accessibility, and initial settings for the PDF viewer, see PDF Document Properties and Metadata. |
|
Category |
Description |
|---|---|
|
General |
Set whether you want a front page generated for your PDF. See Generate a Cover. |
|
Title block |
Positioning and spacing for the title block, including subtitle if used. |
|
Title |
Specific styling for the title. |
|
Subtitle |
Specific styling for the subtitle |
|
Info elements |
Use the Info elements settings to control the styling of the info elements, including the alignment and order. There are various "info elements" that you can add to the publication topic for your publication. These include |
|
Logotype |
Use to upload a logo for the front cover and set its alignment, margins, height and width. See Logo on Cover. |
|
Product image |
Use to upload a foreground image, also known as a product image, on a front cover. |
|
Background image |
Use to upload a background image for the front cover. See Cover Background. |
|
Languages |
Use to control how multiple languages are shown on the front cover. You can choose to:
|
|
Front cover recto |
Use to style various elements and content boxes on the "recto" side of front covers. For details, see Cover Pages and Front Matter. |
|
Front cover verso |
Use to style various elements and content boxes on the "verso" side of front covers. For details, see Cover Pages and Front Matter. |
|
Category |
Description |
|---|---|
|
Back cover recto |
Use to style various elements and content boxes on the "recto" side of back covers. For details, see Cover Pages and Front Matter. |
|
Back cover verso |
Use to style various elements and content boxes on the "verso" side of back covers. For details, see Cover Pages and Front Matter. |
|
Category |
Description |
|---|---|
|
All TOCs and LOTs |
Use to apply settings that affect all tables of contents and lists of tables, see Set Preferences for All TOCs and LOTs (PDF). |
|
Publications |
Use to set up the main table of contents at the start of a PDF, see Set Up Publication TOCs (PDF). |
|
Multilingual publications |
Use to set the main table of contents to include entries in multiple languages, see Set Up Multilingual TOCs (PDF). |
|
Appendices |
Use to set up a table of contents at the start of appendices topics, see Set Up TOCs for Appendices (PDF). |
|
Sections |
Use to set up tables of contents at the start of topics that contain subsections. The table of contents is shown at the start of the topic and has entries for each of the subsections, see Set Up a Section TOC with Links to Subsections (PDF). |
|
TOC titles |
Use to style the titles in tables of contents, see Style TOC Titles (PDF). |
|
LOT titles |
Use to style the titles in lists of titles, such as lists of figures and lists of examples, see Style LOT Titles (PDF). |
|
Entries |
Use to style the entries in tables of contents and lists of titles, see Style TOC and LOT Entries (PDF). |
|
Category |
Description |
|---|---|
|
Page header |
Use to style the header, including: Set the Header Table Height and Column Widths. |
|
Page footer |
Use to style the footer, including: Set the Footer Table Height and Column Widths. |
|
Category/Element |
Styling parameters |
Description |
|---|---|---|
|
General |
Styling for section titles, including: font settings, color, spacing, section numbering, capitalization. |
Use to set the styles that apply to all section headings. For details, see Set the General Styles for All Section Headings |
|
Level 1 |
Same parameters as all sections, and all other levels, and in addition background color. |
Use to set the styles that apply to level 1 section headings. For details, see Style Titles (Levels 1-6). |
|
Level 2, 3, 4, 5, 6 |
Settings for styling font, spacing and alignment for headings at levels 2-6. |
Use to set the styles that apply to level 2-6 section headings. For details, see Style Titles (Levels 1-6). |
|
Bridgehead |
Settings for styling the nesting level, font, and spacing. |
Use to style bridgehead titles. For details, see Bridgehead Styling (PDF). NoteIn most cases, we recommend that you avoid using |
|
Informal topic (sidebar) |
Settings for styling the font and spacing. |
Use to style the title element in your informal topics (sidebar element). By default, informal topics do not have a title, but you can add a title manually. For details on styling an informal topic title, see Title Styling for Informal Topics (PDF). |
|
Appendix |
Settings for setting page breaks for an Appendix topic. |
Use to apply page breaks before and after Appendix topics. For details, see Page Breaks for Appendix. |
|
Category/Element |
Styling parameters |
Description |
|---|---|---|
|
Level All |
Font, spacing, and alignment settings that apply to all levels of subtitles. |
Use to set the default values that will be used for all subtitles. These are only used as a default and will be overridden by any values that are set in the individual Level categories. For details, see Set Styles for All Levels of Subtitle. |
|
Level 1 |
Font, spacing, color, and page break settings for level 1 subtitles. |
Use to set the font, spacing, color, and page break preferences for level 1 subtitles. These will take priority over the Level All settings. For details, see Style Subtitle Levels 1-5. |
|
Level 2-5 |
Font, spacing, color, and page break settings for level 2-5 subtitles. |
Use to set the font, spacing, color, and page break preferences for level 2, 3, 4, and 5 subtitles. These will take priority over the Level All settings. For details, see Style Subtitle Levels 1-5. |
The term Formal elements comes from the content model. It basically is an umbrella term for elements like lists, figures, tables, equations, examples. In this section you can make general settings applying to all such elements consistently if desired.
Note that any settings you make on a higher level (General) can be overridden if you set another value on a lower level (like "informalexample")
Most options are self-explanatory and not described here.
|
Category |
Description |
|---|---|
|
Formal elements / General / Use auto-label text for formal element titles |
Formal elements like tables, figures, and examples will get a title with a label and number, for example: 'Table 3: My Table'. If you only want the title, without the label and numbering, you can disable this here. Default: Enabled |
|
Formal elements / General / Restart auto-label numbering |
If enabled, tables, figures, and examples will restart their numbering for each topic, section (including internal sections inside topics), or chunk. Default: continuous numbering throughout the publication. |
|
Exclude label for abstract |
If enabled, the label for an abstract is excluded from output. This is useful if you do not need it, and if publishing to multiple formats where hiding it with CSS does not work. Default: disabled. |
|
Category |
Description |
|---|---|
|
Enable cross-reference auto-title customization |
When enabled, the cross-reference auto-title customizations below can be used. Otherwise legacy cross-reference auto-text is used, or any stylesheet customization you may have. Default: disabled. |
|
Cross-reference auto-title |
Determines the format of the generated text for cross-references. See Cross-Reference Settings for options available. Default: 'title page', which produces a format like 'My Topic Title (page x)'. |
|
Cross-reference auto-title for formal elements |
Determines the format of the generated text for cross-references for formal elements (like tables, figures, examples). See Cross-Reference Settings for options available. Default: 'default', which produces a format like 'Example 5, "My Title"'. |
|
Cross-reference label/title separator |
Punctuation or space separating label (if used) from title in cross-references, when the auto-title parameter above is set. NoteFor a space, use 's' (without the quotes). Default: ':s', which produces a format like 'Example 5: "My Title"'. |
|
Category/Element |
Styling parameters |
Description |
|---|---|---|
|
General |
Settings for margins, space before and space after, and styling the list titles. |
Use to define general settings that apply to all types of list, including spacing and fonts. For details, see Set the General Preferences for Lists (PDF). |
|
Unordered Lists |
Settings for styling the bullet point. |
Use to apply styles to unordered lists (bullet lists). For details, see Style an Unordered List (PDF) |
|
Ordered Lists |
Settings for styling the numbering and number spacing. |
Use to apply styles to ordered lists (numbered lists). For details, see Style an Ordered List (PDF). |
|
Simple Lists |
Settings for styling the separator. |
Use to apply styles to simple lists. For details, see Style a Simple List (PDF). |
|
Procedures |
Settings for styling the numbering and procedure titles. |
Use to apply styles to procedures. For details, see Style a Procedure (PDF). |
|
Category |
Sub-category |
Description |
|---|---|---|
|
Tabstyle1 - Tablstyle5 |
General |
Use to set options for up to 5 different table styles. You can assign each table in your content to any 1 of the 5 styles. Tables use Tabstyle1 by default. When you publish, Paligo will apply the styles from the appropriate Tabstyle. See Table Styling (PDF). |
|
Header |
Use to set up the header for a table style. |
|
|
Footer |
Use to set up the footer for a table style. |
|
|
Footnotes |
Use to style footnotes for PDF. |
|
Category / Element |
Styling parameters |
Description |
|---|---|---|
|
General |
Graphics and font settings |
Select whether your admonitions (warnings and the like) should use icons or not by setting the graphics option. By default the standard admonition icons in Paligo will be used, but this can be changed to use custom icons. Customize the appearance of the admonitions, see Admonition Styling (PDF). |
|
Graphical |
Various options for styling admonitions with icons, including the possibility to upload your own icons to replace the default ones. |
Use the settings in the General category and the Graphical category if you want admonitions with icons. |
|
Nongraphical |
Various options for admonitions if you don't use icons. |
Use the settings in the General category and the Nongraphical category if you want admonitions without icons. |
Verbatim content appears in the output exactly the same as it appears in the editor, including white space, line breaks, and character symbols. It is especially useful for code samples, like programlisting.
For PDF outputs, use the PDF Layout's verbatim settings to style:
-
Font-size: Set the default font-size for verbatim elements. You can override this on individual elements by using the
roleattribute, setting it to a value like font-size:8pt. You can also use the common size designators similar to CSS: small, smaller, etc. -
Line-wrap: You can enable line wrapping by default for all verbatim elements. And if you do, you can choose to indicate that the line is really meant to continue from the previous line, as is a common convention when exemplifying code. You can choose which character to use as an indicator for this ("hyphenation character"). Note that your font must support the character you choose. This default setting can also be overriden by using the attribute
role, set to a value of either wrap-option:wrap or wrap-option:no-wrap. -
Color and border: You can also select whether you want your programlisting to have a background color and / or border.
-
Graphical rendering of keycap: Use this if you want the keycap elements to render as a keyboard key, like so: AltShiftV.
-
Syntax highlighting: you can turn syntax highlighting on for code snippets (
programlisting, etc), choose a theme, and also the default programming language. If you set thelanguageattribute on a particular element, that will override the default setting here.See this page for some samples of the styles available: Syntax highlighting styles. (Note that the plugin used is not the same as the one used in Paligo, but the styles are the same).
Note
-
Note that syntax highlighting for PDF and HTML uses different highlighting mechanisms, so while both offer a number of themes, some similar, the exact look and feel will not be quite identical for each of these outputs.
-
If syntax highlighting is enabled, this option will also control the background color of the
programlisting. So even if you select a background color for verbatim elements, the syntax highlighting background will override it.However, if you select a syntax highlighting style with a background color other than white, there will be no padding. So you may still want to apply a background color (the same as the one used by the syntax highlighting), to apply padding.
-
The inline elements include: filename, guilabel, guimenus, guibutton, guiicon, glossterm, computeroutput, productname, quote and more.
You can edit the PDF layout to define font family, font weight, font style, font size, font variant, color, border, usage of capitalization and more. For details, see Inline Element Styling (PDF).
|
Category |
Description |
|---|---|
|
Address |
Use to apply styling to text in an address element, see Style the Address (PDF). |
|
Literallayout |
Use to apply styling to text in a literallayout element, see Style Literallayout Elements (PDF). |
|
Legalnotice |
Use to apply styling to text in a legalnotice element, see Style Legalnotice Elements (PDF). |
The keep-together options provide the possibility to control how elements are kept together on the same page or column, by default.
It is available for many of the most common elements, and each one has a dropdown where you select one of three values:
The default values often work very well, and usually you don't have to change these default settings, but if you do these are the options:
-
no - means the element will not be kept together by default.
-
yes - means the PDF processor will attempt to keep the element together. But the processor may in certain cases run into cases where it is not appropriate, and will then attempt to select the best keep option. This is usually the best choice if you want to keep a certain element together.
-
always - means the element will be kept together no matter what. This is the strictest rule, and may be ok, but could also cause some undesired keeps.
Note
Note that you can always override the default values for a particular element in a topic, using the xinfo:keep-together and xinfo:keep-with-next attributes.