PDF template placeholders - Fluid Topics

PDF template placeholders - Fluid Topics - 3.8

Fluid Topics Configuration and Administration Guide

Category

Reference Guides

Audience

public

Version

3.8

The following placeholders are used in the custom pdf-template.vm file:

$author-display-name: the user's display name
$author-email: the user's email
$description: the string "Personal book download: $pbk-title"
$formatted-date: the current date (MM DD YYY)
$formatted-time: the current time (HH:MM)
$outline: the outline of the document (Table of contents) as HTML (arborescent list describing the structure of the personal book)
$pbk-title: the title of the Personal book
$tenant-title: the name of the tenant
$topics: the Personal book's topics as HTML (succession of root topic blocks)
Each topic block contains:
- the topic title, annotated with a CSS class indicating the depth level of the topic in the book structure (.pdf-header-lvl{depth})
- the topic content, wrapped in a container annotated with a CSS class carrying the language of the content (.content-locale-{locale})
- the topic source indicating from where the topic was collected (or information about the writing date if it is a personal topic)
- the succession of child topic blocks

Examples

When the $outline placeholder is used, a DOM like the following lines is generated:

<ol>
    <li class="outline-entry-1">Fluid Topics Installation
        <ol>
            <li class="outline-entry-2">Prerequisites
                <ol>
                    <li class="outline-entry-3">Hardware Prerequisites</li>
                    <li class="outline-entry-3">Software Prerequisites</li>
                    <li class="outline-entry-3">Installation Types</li>
                </ol>
            </li>
            <li class="outline-entry-2">Architecture Examples</li>
        </ol>
    </li>
</ol>

Each tree level is annotated with a CSS class indicating the topic depth in this structure (.outline-entry-{depth}).

When the $topics placeholder is used, a DOM like the following lines is generated.

<div class="pdf-topic">
    <h1 class="pdf-header-lvl1">Fluid Topics Installation</h1>
    <div class="pdf-topic-content-wrapper">
        <div class="content-locale-en">
            <!-- original topic content -->
        </div>
    </div>
    <div class="topic-source">From : Fluid Topics v2 - Installation and Integration Guide</div>
    <div class="pdf-topic">
        <h2 class="pdf-header-lvl2">Prerequisites</h2>
        <div class="pdf-topic-content-wrapper">
            <div class="content-locale-en">
                <!-- original topic content -->
            </div>
        </div>
        <div class="topic-source">From : <!-- original topic location breadcrumb --></div>
        <div class="pdf-topic">
            <h3 class="pdf-header-lvl3">Hardware Prerequisites</h3>
            <div class="pdf-topic-content-wrapper">
                <div class="content-locale-en">
                    <!-- original topic content -->
                </div>
            </div>
            <div class="topic-source">From : <!-- original topic location breadcrumb --></div>
        </div>
        <div class="pdf-topic">
            <h3 class="pdf-header-lvl3">Software Prerequisites</h3>
            <div class="pdf-topic-content-wrapper">
                <div class="content-locale-en">
                    <!-- original topic content -->
                </div>
            </div>
            <div class="topic-source">From : <!-- original topic location breadcrumb --></div>
        </div>
        <div class="pdf-topic">
            <h3 class="pdf-header-lvl3">Installation Types</h3>
            <div class="pdf-topic-content-wrapper">
                <div class="content-locale-en">
                    <!-- original topic content -->
                </div>
            </div>
            <div class="topic-source">From : <!-- original topic location breadcrumb --></div>
        </div>
    </div>
    <div class="pdf-topic">
        <h2 class="pdf-header-lvl2">Architecture Examples</h2>
        <div class="pdf-topic-content-wrapper">
            <div class="content-locale-en">
                <!-- original topic content -->
            </div>
        </div>
        <div class="topic-source">From : <!-- original topic location breadcrumb --></div>
    </div>
</div>