PDFs

Each article can be exported to an individual PDF that will match the look and feel of your knowledge base. PDF exports can be toggled on and off globally as well as for individual articles.

To format and style your individual article PDFs, go to Settings > PDF.

Sample Settings > PDF page

Here, you can add:

1. Single PDF Watermark: Add text to serve as a watermark on individual article PDFs. This text will be displayed as a diagonal watermark text:
   Sample watermark text of "watermark"
   
2. Single PDF Password: Enter a password that readers will have to enter in order to view the PDF once they download it. This password will apply to all individual article PDFs.
3. Page Size: Choose between A4 and US letter.
4. PDF header HTML: Add raw HTML to add a header to each page of your individual article PDFs. You can use a PDF Merge Code to add page numbers if you'd like!
5. PDF footer HTML: Add raw HTML to add a footer to each page of your individual article PDFs. You can use a PDF Merge Code to add page numbers if you'd like!
   
   Not used to formatting raw HTML? Try creating what you need in the article editor, then toggling to Code View to copy the HTML!

While PDFs will have the same styles as your overall knowledge base, you can override the styles for your PDFs using the CSS class "hg-pdf". This way, PDF articles can have styling different than your online versions. Add appropriate styles in Settings > Styles in the Custom CSS section.

The header and footer sections here are not impacted by CSS; to add and style headers and footers, you'll need to use straight HTML with in-line styles. We recommend placing headers or footers within a div or table and adding in-line styles for the div or table to help position the text where you'd like it.

For example, our PDF footers include this chunk of HTML:

<div style="text-align: center; font-size: 11px">Copyright © 2015 – 2024 Silly Moose, LLC. All rights reserved.<br>Powered by KnowledgeOwl knowledge base software.</div>

This div will be aligned in the center with a font-size of 11px. It then displays our copyright statement.

See PDF look and feel for more ways to style or customize your individual article PDFs!

The Standard PDF Export creates a PDF of all Published and Needs Review articles in your entire knowledge with a clickable table of contents. This PDF can optionally be displayed at the bottom of your table of contents to allow your readers to download an offline version of your content.

The Standard PDF can be customized with the following options:

• Customizable cover page
• Choose whether to include restricted content
• Exclude video content
• Specify A4 vs. US Letter page size
• Add a watermark and/or a password
• Add a custom footer

What does include all private content do?

By default, the Standard PDF settings will leave the "Include all private content" box unchecked. With the box unchecked, the PDF will only include published content that has no reader group restrictions. If your Standard PDF is missing categories, it's likely because of this setting!

If you'd like the Standard PDF to include categories and/or articles that are restricted to reader groups, check this box and regenerate the PDF.

Custom PDFs can be created from your knowledge base content, using only the categories and articles you specify. Custom PDFs are stored and can be regenerated on demand. They're great if you want to create a curated collection of some of your content, such as for new employee or new user onboarding, quick start guides, and so on.

Custom PDFs can only include articles with a Published or Needs Review status.

Sample Custom PDFs page with two custom pdfs created

Custom PDFs include many of the same options of the Standard PDF:

• Customizable cover page
• Specify A4 vs. US Letter page size
• Add a watermark and/or a password
• Edit the title of the table of contents
• Add a custom footer

There are four overall steps to generating a new Custom PDF:

1. Create the PDF.
2. Configure the PDF.
3. Select the content.
4. Save and generate the PDF.

We cover each in more detail below.

Create a Custom PDF

1. In the left navigation, go to Exports.
2. Select the Custom PDFs tab.
3. Select + Create New Custom PDF.
   

Configure the Custom PDF

Now that you've created the initial custom PDF, Use the Custom PDF Options page to customize the layout of your PDF:

1. Choose whether to Include a cover page using the Content options checkbox (defaults to no cover page).
2. Enter a PDF Name. This name is displayed in the Custom PDF tab and is used as the file name when the PDF is downloaded.
3. Select a Page Size. Options are A4 (default) and US Letter.
4. Optional: Add the text you'd like used as a watermark in Watermark Text. This text will be displayed diagonally across the page of the PDF.
5. Optional: If you'd like to password-protect this PDF, add a Password. Anyone opening the PDF will have to enter the password before they can see the content.
6. All Custom PDFs generate with a Table of Contents, titled "Table of Contents." Change the page heading by editing the Table of Contents Title.
7. If you've included a cover page using the Content options checkbox at the top, edit the Cover Page Title to display the title you'd like. It will default to "[your knowledge base's name] Knowledge Base PDF". You can then include this wherever you'd like in the cover page by adding [pdf("cover-title")] into the Custom Cover Page Content.
8. If you've included a cover page using the Content options checkbox at the top, you can also add additional Custom Cover Page Content in the box provided. This will take standard HTML.
9. If you'd like anything displayed in the left section of the PDF footer, edit the Content Footer Left section.
10. If you'd like anything displayed in the center section of the PDF footer, edit the Content Footer Center section.
11. If you'd like anything displayed in the right section of the PDF footer, edit the Content Footer Right section.
    For the Content Footer sections or the Custom Cover Page content, several merge codes can help you quickly add certain text, like the knowledge base title or page numbers. Refer to PDF Merge Codes for a list of available merge codes and what they do.

Select your Custom PDF's content

Once you've configured the Custom PDF Options, use the checkboxes in the Included Content section to select the categories or articles you'd like include. Checking the box for a category will automatically check the boxes for all subcategories or articles it contains. Unlike Standard PDFs, Custom PDFs will include restricted content if it's checked.

Save and Generate your Custom PDF

Once you've finished your selections, scroll to the very bottom of the page and select Save and Generate PDF.

Once you select this option, you'll be returned to the Custom PDFs tab. A progress bar displays under your custom PDF. Once that progress bar disappears, the PDF is available for download and you'll see a different display. Refer to Use a Custom PDF below for more info!

Use a Custom PDF

Once you've generated at least one Custom PDF, you can see all of your Custom PDFs by going to Exports and selecting the Custom PDFs tab.

You'll see one card for each Custom PDF. Here's the anatomy of a custom PDF card:

1. The top of the card displays the title. This pulls directly from the PDF Name field in the Custom PDF configuration.
2. If you select the View PDF Download Embed Code link, we'll display the HTML needed to embed this PDF somewhere in your knowledge base. Click anywhere in the code box that displays, right-click, and select Copy. You can then paste this code in wherever you'd like to use it (such as in Settings > Style in one of the Custom HTML templates, or within the Code View of an individual article or category).
   
3. We'll show the date and timestamp that the PDF was Last generated, so you know how up-to-date it is.
4. Use the Download link to download the PDF to your computer.
5. If you don't need to change the PDF's settings and just want to regenerate it to be sure it has the latest content, select Regenerate.
6. If you'd like to open the Custom PDF to edit its configuration, name, layout, or the content it contains, select the gear icon in the upper right.
7. If you'd like to delete the PDF completely, select the trashcan icon in the upper right.

Regenerate a Custom PDF

Custom PDFs are a snapshot of your articles at the date and time your PDF is generated. If your articles change, you will want to regenerate your PDFs to update the content. 

To regenerate a custom PDF:

1. In the left navigation, go to Exports.
2. Select the Custom PDFs tab.
3. Find the card for the custom PDF you'd like to regenerate.
4. Select Regenerate.
5. A progress bar displays to show you the regeneration's progress. Once it's complete, the Last generated statement will reappear with a new Download link. If you have embedded the PDF in your knowledge base, regenerating it will also update the PDF located at the embed code.

If you'd like to make edits to a PDF or view the content it contains before you regenerate, use the gear icon in the upper right of the custom PDF card instead!

By default, PDFs inherit the styles of your knowledge base. However, you can customize some styles (such as web fonts that don't generate in PDFs well) by adding custom CSS that references the .hg-pdf class.

For individual article PDFs, add overall layout/style changes in Settings > PDF. For Standard and Custom PDF exports, add overall layout/style changes in Knowledge Base > Exports in the appropriate tab.

Clickable hyperlinks will automatically generate in all three PDF types, though we have two warnings about this:

• If you are primarily using PDFs as print resources, you may want to display the full URL of a hyperlink. See Display full URL of links in PDFs for how to do so.
• Hyperlinks to same-page anchors will not work properly.

You have the ability to specify watermark text and a password for your PDFs.

Watermark text will be displayed diagonally across each page of the PDF.

If you add a password, a reader will have to enter that password before they can successfully open the PDF.

To add to each type of PDF:

• For Individual article PDFs, go to Settings > PDF. If you add a watermark or password, make a small change to a single article and re-check the PDF to see how you like it. (PDFs can take a few minutes to regenerate.) Once you're happy with the change, contact us to regenerate all your article PDFs.
• For Standard PDF export (Full PDF Download), go to Knowledge Base > Exports. This page should open to the Standard PDF tab and you can add your watermark or password there.
  • Once you make your changes, be sure to click the Save and Regenerate PDF Export button to update your Standard PDF.
• For Custom PDF exports, go to Knowledge Base > Exports.
  • Open the Custom PDFs tab.
  • Find the card for the custom PDF you'd like to add a watermark or password to, and select the gear icon to the right of the PDF's name.
  • Once you've made the changes you'd like, be sure to click the Save and Regenerate PDF Export button at the bottom of the page to regenerate your custom PDF with those settings!