For PDF outputs, you can use the PDF Layout to control the header that appears at the top of the page. The header consists of a three-column table that appears on every page in your output.
The PDF Layout has header configuration settings and these are divided into categories:
-
Use the General settings for setting up the header table. These settings apply to both recto and verso pages (see Set Up a Header Table).
-
Use the Header cells - default (recto page) settings to style the header table on odd-numbered pages (or all pages in single-sided documents). See Add Content to Header for details.
-
Use the Header cells - verso page settings to style the header table on even-numbered pages (in double-sided documents). By default, the recto page settings also apply to the verso pages, but only if the verso settings are set to default or empty. If you change the verso settings, Paligo will apply your changes to the verso pages instead. See Add Content to Header for details.
Note
If you use Layouts that are based on other Layouts, there is a "chain" of Layouts that Paligo uses when publishing (see Layout Relationships - Base, New, Duplicate). Paligo will look on every Layout in the "chain" for verso settings. If it finds any, it will apply those verso settings.
Paligo only applies the recto page settings to verso pages if all Layouts in the "chain" have no verso settings in place. This applies to headers and footers.
The PDF Layout has General header settings for setting up and styling the header table in your PDF outputs.
-
Select Layout 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 the Layout you want to update or Create a Layout.
Tip
You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.
-
Select Header and Footer and then Page header.
-
Select General in the Page header category.
-
Set the widths of the header columns in the Page header table relative column widths field.
By default, the three columns are set to 1 8 1, which means that the left column is 10% of the header width, the center column is 80%, and the right column is 10%. Change the values to the widths you need. For example, if you set the value to 3 5 2, the left column would be 30% width, the center column 50%, and the right column 20%.
The table has to have three columns. If you need more columns, it may be possible to achieve through a customization project. Contact customer support for more details.
-
Set the minimum height of the header table in the Page header table height field.
The default is 14pt. When you enter a value, make sure to include the units of measurement, for example, pt.
-
Set the border styling in the Page header table cell border field.
Having a visible border can be useful when you are setting up your PDFs. It makes it easier to judge the spacing and positioning. But in most cases, authors remove the border before publishing a finished document.
To add a border, enter the thickness, style, and color of the line, for example: thin solid silver. You can use:
-
Thickness: thin, medium, thick, or an exact value, such as 3pt
-
Style: none, hidden, dotted, dashed, solid, double, groove, ridge, inset, outset
-
Color: color name, RGB value or hex value.
-
-
Use the following settings to style the header font:
-
Page header font family
Choose the typeface for the text in the cells.
-
Page header font size
Set the size of the text in the cells.
Include the units of measurement, for example, pt or mm.
-
Page header font weight
Set the thickness of the text in the cells.
-
Page header font style
Use to set the text in the cells to italic, backslant (leaning backwards), or normal.
-
Page header font variant
Choose the variation of the chosen font. You can choose normal or small-caps (all letters are small and upper-case).
-
Page header font color
Use to set the color of the text in the cells. You can check the box to use the default color or you can clear the box and choose a different color. Enter an RGB value or select the color block to display a color selector.
-
Page header line height
Set the height of each line of text in the cells. You need to include the units of measurement too, for example, px, pt, em.
-
Page header capitalization
Set the text in the page header cells to be shown in all full-size capital letters, all lowercase letters, or capitalized (first letter capital, other letters lowercase).
Note
If you have set the Page header font variant to small caps:
-
The capitalized option sets upper case letters to be full-size capitals. The other letters will be shown as reduced height capital letters (small caps).
Example of capitalized and small caps used at the same time.
-
The lowercase option has no effect.
-
-
-
Use the following settings to control the spacing and positioning:
-
Page header letter-spacing
Define the amount of spacing between the letters of the text in the cells.
Include the units of measurement, for example, pt or mm.
-
Page header table vertical alignment
Choose from:
-
Auto - Sets the content to have the same baseline. This looks similar to vertically aligning content to the bottom of the cells.
-
Before - Vertically align the content to the top.
-
Center - Vertically align the content to the middle.
-
After - Vertically align the content to the bottom.
-
-
-
Select Save.
You have now defined the General values for the header table. Next, you should define what content appears in the header table.
Use the PDF Layout to add content to the header table cells for PDFs.
Note
The header table is shown on all pages, but the header on the front cover does not show text. As a result, the cover header has a fixed height of 0.
To add text, images, or auto-generated content such as page numbers to your header:
-
Select Layout 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 the Layout you want to update or Create a Layout.
Tip
You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.
-
Select Header and Footer and then Page header.
-
In the Page header category, select Header cells - default (recto page). These settings are for the odd-numbered pages. They will also apply to the even-numbered pages, by default.
-
Use the Page header <column> cell content settings to define what type of content you are going to add to the header. There are separate Page header <column> cell content settings for the left, center and right cells.
Choose from:
-
None - Paligo will not include any content in the cell.
-
Text - Set the cell to contain text that you will define in the Page header <column> cell content: text field.
-
Image - Set the cell to contain an image that you will choose in the Page header <column> cell content: image field.
-
Pagenumber - Adds the page number to the cell.
Note
The page number is only shown in the PDF output if the General > Page > Print page numbers setting is set to Yes (or Default). For details, see Include Page Numbers in PDFs.
-
Page X - Adds the word "Page" followed by the page number to the cell.
-
Page X of Y - Adds current page and total page number to the cell, for example, "Page 6 of 75".
-
Title - Adds the first title element in your content to the cell. Depending on what you publish, this is the title of your publication or a topic.
-
Chapter title - Adds the title element of the "chapter" to the cell. The "chapter" is a top-level topic in your publication.
For example, let's say you have a top-level topic called "Installation" and then lower-level topics for "Install the battery" and "Install the fan unit". In this scenario, all three topics will have "Installation" in the cell, as they are all part of the same "chapter". Topics in a different "chapter" will have a different title in the cell.
-
Section title - Adds the title element of the topic to the cell. For example, if you have an "Install the battery" topic, it will have "Install the battery" in the cell, but other topics will have their title in the cell instead.
-
-
This step only applies if you selected Text as the Page header <column> cell content.
In the Page header <column> cell content: Text field, enter:
-
Plain text
-
A dynamic variable to reference an element in your documentation. A popular use for a dynamic variable here is to reference an element that appears in the publication topic, such as copyright details. We have included an example after this procedure. To find out more, see Dynamic Text Variables.
-
A combination of plain text and dynamic variables
Note
There are separate Page header <column> cell content: Text settings for the left, center, and right cells.
-
-
This step only applies if you selected Image as the Page header <column> cell content.
In the Page header <column> cell content: Image field, use the Upload feature to add the image you want to use. Paligo uploads the image, gives it an auto-generated name, and stores it with the Layout. It is not stored in the Media library.
Note
There are separate Page header <column> cell content: Image settings for the left, center, and right cells.
-
Repeat steps 5-7 to add content to each cell, if required.
-
In the Page header category, select Header cells - verso page.
The Header cells - verso page settings work in the same way as those for the Header cells - recto page, except that:
-
Any settings that you change for the verso page will be used on even-numbered pages.
-
If you leave any verso page settings set to default or empty, Paligo will match them to the same settings on the recto page. This happens during publishing and is not shown on the Layout.
-
-
Select Save.
When you publish content with this PDF layout, Paligo will add the images and text you have selected.
Example 12. Dynamic variable to insert organization name in PDF header
Let's say you have set up your publication topic to include author and orgname elements (see Edit a Publication Topic). You are going to publish to PDF and you want the left cell of your header to contain the organization name.
You edit your PDF layout and set:
-
Page header left cell content to Text
-
In the Page header left cell content: text field, you enter a dynamic variable to reference the
author>orgnameelement. The syntax is:${//d:article/d:info/d:author/d:orgname}$Notice how the dynamic variable has to reference each element in the path from the top of the publication topic to the element you want to use. So it starts with the top-level
d:article, which represents the publication topic, then the next level down isd:infofor theinfoelement, followed byd:authorfor theauthorelement, and finallyd:orgnamefor theorgnameelement.
When you publish, Paligo:
You can use the PDF layout editor to change the height and widths to suit your requirements.
Note
The table has to have three columns. If you need more columns, it may be possible to achieve through a customization project. Contact customer support for more details.
-
Select Layout 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 the Layout you want to update or Create a Layout.
Tip
You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.
-
Select Header and Footer and then Page header.
-
Select General in the Page header category.
-
Set the widths of the header columns in the Page header table relative column widths field.
By default, the three columns are set to 1 8 1, which means that the left column is 10% of the header width, the center column is 80%, and the right column is 10%. Change the values to the widths you need. For example, if you set the value to 3 5 2, the left column would be 30% width, the center column 50%, and the right column 20%.
-
Set the minimum height of the header table in the Page header table height field.
The default is 14pt. When you enter a value, make sure to include the units of measurement, for example, pt.
-
Select Save.
When you publish your content using this PDF layout, Paligo will apply the settings to the header of the PDF.
Use the PDF layout control the vertical alignment of the content in the header cells:
-
Select Layout 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 the Layout you want to update or Create a Layout.
Tip
You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.
-
Select Header and Footer and then Page header.
-
Set the Page header table vertical alignment to:
-
Auto - Sets the content to have the same baseline. This looks similar to vertically aligning content to the bottom of the cells.
-
Before - Vertically align the content to the top.
-
Center - Vertically align the content to the middle.
-
After - Vertically align the content to the bottom.
-
-
Select Save.
When you publish your content using this layout, Paligo will apply the alignment settings to the header.
By default, Paligo PDF outputs have a header rule at the top of each page. To style the rule, or remove it completely, use the Page settings in the PDF layout.
To set up the header rule:
-
Select Layout 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 the Layout you want to update or Create a Layout.
Tip
You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.
-
Select General and choose Page.
-
Use the Header rule setting to control whether the header rule is shown.
Choose either:
-
Yes
-
No
-
-
Set the Header rule length. This is the amount of page width that the header rule will cover and it has to be a numerical value with units of measurement. By default, it is set to 100%.
-
Use the Header rule alignment setting to control the position of the header rule. Choose from:
-
Start - The start of the line is aligned to the start of the content on the page. For example, on a left-to-right page, the line is left-aligned.
For example, the following image shows a line that is set to 50% width and aligned to the start of the page.
-
End - The start of the line is aligned to the end of the content on the page. For example, on a left-to-right page, the line is right-aligned.
For example, the following image shows a line that is set to 50% width and aligned to the end of the page.
-
Center - The line is aligned in the center of the page. This is only noticeable if the header rule length is less than 100%.
For example, the following image shows a line that is set to 50% and aligned to the center of the page.
-
Justify - If you use a line with spaces in it, such as a dashed line or dotted line, Justify sets both ends of the line to be solid. Paligo adjusts the spacing of the gaps in the line to compensate (spaces in the line cannot be at the start or end of the line).
-
Inside - The line is aligned to the inside edge of the page (the binding edge).
-
Outside - The line is aligned to the outside edge of the page.
-
-
Set the Header rule thickness. Enter the amount and the units of measurement (points), for example, 0.25pt. The higher the amount, the thicker the header rule will be.
-
Choose the Header rule style. You can choose from any of the available line styles including dotted, solid, and dashed.
For example, the following image shows a dashed header rule.
-
Set the Header rule color.
-
Clear the Use default color checkbox to select a color of your own choice.
-
Set the color either by:
-
Entering an RGBA code for the color you want (1).
-
Selecting the Color square to display the color selector (2).
-
Choose the color with the spectrum bar (3).
-
Control the transparency with the opacity bar (4).
-
Choose the color shade with the main color panel (5).
-
-
-
Select Save.
When you publish with this PDF layout, Paligo will create a PDF that uses the header rule settings that you have defined.
Use the PDF layout to choose the font settings for your header cells. You can choose the font family, set the color, spacing and more.
-
Select Layout 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 the Layout you want to update or Create a Layout.
Tip
You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.
-
Select Header and Footer and then Page header.
-
Use the following settings to define the font and text spacing settings for the header table text:
-
Page header font family
Choose the typeface for the text in the cells.
-
Page header font size
Set the size of the text in the cells.
Include the units of measurement, for example, pt or mm.
-
Page header font weight
Set the thickness of the text in the cells.
-
Page header font style
Use to set the text in the cells to italic, backslant (leaning backwards), or normal.
-
Page header font variant
Set the font to display as normal or as small caps. The small caps option turns lower case letters into reduced height capital letters.
-
Page header font color
Use to set the color of the text in the cells. You can check the box to use the default color or you can clear the box and choose a different color. Enter an RGB value or select the color block to display a color selector.
-
Page header line height
Set the height of each line of text in the cells. You need to include the units of measurement too, for example, px, pt, em.
-
Page header capitalization
Set the text in the page header cells to be shown in all full-size capital letters, all lowercase letters, or capitalized (first letter capital, other letters lowercase).
Note
If you have set the Page header font variant to small caps:
-
The capitalized option sets upper case letters to be full-size capitals. The other letters will be shown as reduced height capital letters (small caps).
Example of capitalized and small caps used at the same time.
-
The lowercase option has no effect.
-
-
Page header letter-spacing
Define the amount of spacing between the letters of the text in the cells.
Include the units of measurement, for example, pt or mm.
-
-
Select Save.
When you publish content with this PDF layout, Paligo will use the font settings when it generates the PDF.
Use the Page header table cell border setting to add a visible border to the header. The borders can be useful when you are setting up your header and you need to see the cell boundaries so that you can better judge the cell widths.
Note
The header will appear on every page and may appear as a line on the front cover. This is because the front cover header does not show the header text and so has a forced block height of 0.
-
Select Layout 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 the Layout you want to update or Create a Layout.
Tip
You can copy the URL of the Layout Editor and paste it into a new tab in your browser. This can be useful if you frequently switch between your Paligo content and the Layout settings.
-
Select Header and Footer and then Page header.
-
Set the border styling in the Page header table cell border field.
-
Select Save.
Comments
0 comments
Article is closed for comments.