PDF Packager

This topic provides an overview of the PDF package. This package enables the generation of a PDF Package from Capital E/E Publisher that includes wiring diagrams in a selected scope, additional documentation such as 2D location views, connector face views and embedded reports.

The package can be configuration specific, filtering diagrams as needed at generation time. Off page references can be selected and followed, and components can be selected to view their attributes and properties. The files will be exported to the location specified on the Generate Documentation Dialog in a folder structure matching that of the selected scope.

The following artifacts are available with the PDF packager:

• 2D Location Views

• Assembly BOM - Report

• Attributes and Properties

• Component BOM - Report

• Cross References

• Connector Views

• Diagrams

• Information

• Multicore List - Report

• Functions and Related Locations - Report

• Locations and Related Functions - Report

• Net List - Report

• Wire List - Report

Note Any collateral within the Introduction folder, of the external Resources folder of the Capital installation, will be automatically included in the package within the Information section of the PDF package.

Graphics for device pins, connector pins and so on, are not displayed while exporting wiring diagrams as PDF, DXF, CGM and SVG. You can indicate the presence of pins using styleset decorations such as “Pin Name."

Configuring a PDF Package

This topic provides an overview of the PDF package, and its configuration options.

Package configuration only needs to be performed once after the Capital E/E Publisher installation. However, it can be repeated should you ever decide to change how your generated PDF package looks and operates.

Various aspects of the PDF package can be configured, such as the attributes and properties, page size and margins, orientation, headers, footers and font. The publisher/pdf folder in the Capital installation directory contains the following files:

• a4LandscapeTemplate.xsl

• a4PortraitTemplate.xsl

• html_to_fo.xsl

• pdfConfiguration.xml

The following aspects of the PDF packager are configurable:

• Attributes and Properties

• PDF Table of Contents and Chapter Order

• Page Numbers

• Page Size and Margins

• Orientation including Auto Mode

• Header, Footer Strings

• Monochrome PDF Setting

• Additional Parameters

• Fit to Page

• Configuring Font File Path

• Reports

Caution PDF package configuration should only be performed by a system administrator or an experienced user.

Attributes and Properties

Each object within a design has its own set of attributes and properties. The Attributes and Properties artifact will export those values and make them available on selection of that object within the HTML application.

The set of attributes and properties to be included are specified in the attributeList.xml which is located in the Publisher directory of the Capital Application installation folder. The attributeList.xml can be configured as follows:

Each attribute or property is made up of a triplet of text elements that define how it is identified on an object and how it is displayed to the user.

The tag refers to either an attribute or a property:

name='PartNumber' refers to the Part Number attribute on any object

displayName='PartNumber' refers to the text that is displayed in the PDF Packager for that attribute.

Note: The class attribute for an object can be used with the API JavaDoc to identify the correct attribute names for any object. This list will be included in the appendix but can also be found with any install of a Capital Application.

Translation Management

In a generated PDF package, the Table of Contents, pop-up menu attribute and property names can all be translated using the language dictionary as follows:

1. Ensure that the Language Dictionary is defined. The Language Dictionary should include translation strings for required object attributes and property names. For further information see Language Dictionary in the Capital Design Tools - Common Functions User Guide.

Additionally for non-English locales, import the language dictionary with the following mandatory quick code translations.

CopyQuickCode,EN:ENGLISH:UK:BRITISH,ZH:Chinese:CHINA:CHINA,FR:FRENCH:FR:FRANCE,DE:GERMAN:GERMANY:GERMAN,JA:Japanese:JAPAN:JAPANESE,ES:ESPAÑOL:SP:SPAIN,IT:ITALIAN:IT:ITALY,RU:RUSSIAN:RU:RUSSIA TOC,TOC,強迫症,TOC,ZWANGSSTÖRUNG,強迫性障害,TOC,Disturbo ossessivo-compulsivo,ОКР Index,Index,索引,Index,Index,インデックス,Índice,Indice,Индекс Systems,Systems,系统,Systèmes,Systeme,システム,Sistemas,Sistemi,Системы Information,Information,信息,Informations,Informationen,情報,Información,Informazioni,Информация

2. Ensure that the desired locale tags are defined in \config\clientprops.xml

3. Set the desired language code in the bottom right of the status bar of your Capital application.

4. Update item names in accordance with the language in the \publisher\pdf\pdfConfiguration.xml as detailed in the following table:

English

Chinese

French

German

Index

索引

Index

Index

TOC

強迫症

TOC

ZWANGSSTÖRUNG

Systems

系统

Systèmes

Systeme

Information

信息

Informations

Informationen

_2DViews

2D 视图

2DViews

2D-Ansichten

Face Views

正面视图

Vues de face

Frontansichten

Wire List

导线列表

Liste de fils

Leitungsliste

Component BOM

部件 BOM

Nomenclature des composants

Komponenten-Stückliste

Assembly BOM

组件 BOM

Nomenclature de sous-ensembles

Baugruppen-Stückliste

Multicore List

多芯线列表

Liste de câbles multifilaires

Liste der mehradrigen Kabel

Net List

网表

Liste de net

Netzliste

Functions and Related Locations

功能和相关位置

Fonctions et positions associées

Funktionen und dazugehörige Positionen

Locations and Related Functions

位置和相关功能

Positions et fonctions associées

Positionen und dazugehörige Funktionen

Japanese

Spanish

Italian

Russian

インデックス

Índice

Indice

Индекс

強迫性障害

TOC

Disturbo ossessivo-compulsivo

ОКР

システム

Sistemas

Sistemi

Системы

情報

Información

Informazioni

Информация

2Dビュー

2DViews

2DViews

2D-виды

フェイスビュー

Vistas de la cara

Viste frontali

Виды граней

ワイヤリスト

Lista de alambres conductores

Elenco cavi

Список соединений

コンポーネント BOM

BOM de componente

BOM componenti

Спецификация компонентов

アセンブリBOM

BOM de ensamble

BOM assiemi

Спецификация сборки

マルチコアリスト

Lista de multinúcleos

Elenco multipolari

Список кабелей с многожильным сердечником

ネットリスト

Lista de componentes electrónicos

Lista di connessioni logiche

Список цепей

ファンクションおよび関係するロケーション

Funciones y ubicaciones relacionadas

Funzioni e posizioni correlate

Компоненты и связанные расположения

ロケーションおよび関係するファンクション

Ubicaciones y funciones relacionadas

Posizioni e funzioni correlate

Расположения и связанные Компоненты

Example pdfConfiguration.xml for Chinese locale

PDF Table of Contents and

Chapter Order

The settings for the PDF table of contents and chapter order is determined in the pdfconfiguration.xml file. The table of contents is always shown at the start and the index is always shown at the end, reordering of the other artifacts is allowed.

In the example shown in Figure 41 the table of contents is followed by the Information chapter, followed by Systems, Face Views, 2D Views and, finally, the index.

Figure 41: Table of Contents and Chapter Configuration

Page Numbers

You can configure the page number settings for PDF packages by editing the page number template contained within the pdfConfiguration.xml. These settings allow you to control the template text displayed in the PDF, the placement on the page of the numbering, as well as which page the numbering begins at.

Template Text and Begins At

Copy

<global>
<pagenumbertemplate text="Page {PageNo} of {TotalPages}" beginAt="Systems"/>
</global>

The template will take a composite string with two placeholders, where {PageNo} will be replaced with the actual page number and {TotalPages} will be replaced with the total number of 'numbered' pages. So, for example the string 'Page {PageNo} of {TotalPages}' for a page with page number 11 and total pages 20 will be translated to 'Page 11 of 20'

The Begins At setting takes the item name of the artifact from where the page numbering should start from, subject to the following considerations:

• The system only takes the top level item names, not design level names.

• Any pages before the specified start point are not stamped with page numbers. These will still be shown in the Table of Contents, but without page numbers.

• The number of pages that are shown in the template will be only the ones which are numbered.

• If the page numbers start from the Table of Contents then it, also, will be numbered. If they do not, then the Table of Contents will be numbered using roman numerals.

Placement

The placement of the page number string is configured in the xsl file which is defined at generator level. A parameter with the name 'pageNumber' is defined in the xsl file.

Copy

<xsl:param name="pageNumber" select="''"/>

By default the page number string is configured to be shown in the footer area, center aligned, as shown in the following example. The location of the string, and its alignment can also be configured.

Copy

<fo:static-content flow-name="footer-normal">
<!--below static content will go into the footer of every page which uses this template-->
<!--The footer string defined for the generator in the pdfConfiguration.xml is shown here-->
<fo:block text-align="center" font-family="customfont,Helvetica">
<xsl:value-of select="$pageNumber"/>
</fo:block>
</fo:static-content>

Page Size and

Margins

Page size and margins, the extent of the region before (header), region after (footer), region start (left) and region end (right) of the page are defined in the a4LandscapeTemplate.xsl or a4PortraitTemplate.xsl. See Figure 42.

Figure 42: Page Size and Margins

Orientation including Auto

Mode

You can specify whether a portrait template or a landscape template is used for PDF generation. If you specify both, then the system considers this to be auto mode, whereby the orientation of the PDF is determined based on the width and height of the content of a page, and the appropriate template applied.

Header, Footer

Strings

You can specify header, footer, start and end strings. These can either be a static string, for example:

Copy

header = "Table of contents"

or a dynamic string, for example:

Copy

header = "{attribute:name}"

or a combination of both for example:

Copy

header = "Design : {attribute:name} ,{property: shortDescription}".

The dynamic part of the string is evaluated on the context of the generator, that is, if the generator is a design level generator; the attribute/property is evaluated on the design. Similarly if the generator is an object level generator, the attribute/property is evaluated on the object. These values are sent to the html_to_fo.xsl file and are shown at the appropriate location.

The query in the curly brackets is evaluated on the object. The query in the square bracket is evaluated on the parent of the object. For example, for an object data generator, the string {attribute:name} [attribute:name] would be evaluated as follows.

The query attribute:name in the curly bracket would be evaluated on the object which gives the name of the object. The query attribute:name in the square bracket would be evaluated on the design where the object is present which would give the design name.

Other static strings and images can also be added in these locations.

Note

The page numbers are not controlled through this header/footer framework, they are added post generation.

Monochrome PDF

Setting

You can specify whether the PDF generates color or black and white diagrams (for Capital Diagrams only) by changing the color value setting to “false” in the global configuration section of pdfConfiguration.xml.

Copy

<color value="false"/>

By default the color value is set to “true”.

Additional

Parameters

Additional attributes provided to a generator are evaluated similarly to the header/footer composite strings and will be sent as a parameter to the template XSL of the corresponding generator, as shown in Figure 43. However any such parameters must be added in the XSL file for it to be accessed as in Figure 44.

Figure 43: Additional Parameters

Figure 44: Additional Parameters Template Entry

Fit to Page

This can be selected by setting the scale to fit attribute for a generator as true in the pdfConfiguration.xml.

Copy

<Information landscapeLayout="a4LandscapeTemplate.xsl" scaleToFit="true" />

If the content of a page is larger than the dimensions defined in the template, the page will be scaled down irrespective of whether the scale to fit option is selected or not. However, if the content of the page is smaller than the dimensions defined in the template, the page will not be scaled up if the scale to fit is selected as false or is not defined.

If scale to fit option is selected as true, then the content of the page will be scaled up to fit the dimensions of the template.

Note

While scaling up or down, the aspect ratio of the content is never changed.

Configuring Font File

Path

To specify the font to be used for text, add the 'fontFilePath' attribute in the pdfConfiguration.xml, for example as follows:

Copy

<Item name="TOC" landscapeLayout="a4LandscapeTemplate.xsl" header="TABLE OF CONTENTS" fontFilePath="C:\Windows\Fonts\ARIALUNI.TTF"/>
<Item name="Systems" landscapeLayout="a4LandscapeTemplate.xsl" portraitLayout="a4PortraitTemplate.xsl" header="{attribute:name}"
             scaleToFit="true" fontFilePath="C:\Windows\Fonts\ARIALUNI.TTF">

Reports

The following reports are available to be included in the PDF package. The reports are in the default Capital format and can be additionally customized by amending the publisher_report.xsl stylesheet found in the Publisher folder in the Capital installation directory.

• Assembly BOM - Report

• Component BOM - Report

• Multicore List - Report

• Net List - Report

• Wire List - Report

• Functions and Related Locations - Report

• Locations and Related Functions - Report

Parent Topic:

Packagers

Capital E/E Publisher User Guide, 2512.2606

Unpublished work. © 2026 Siemens