Tpled Editor User Guide

User Manual:

Open the PDF directly: View PDF .
Page Count: 114

Download
Open PDF In Browser	View PDF

Template Editor
User’s Guide

Product version 3.33
September 2014

© 1992-2014 Tekla Corporation - part of Trimble Navigation Ltd and its licensors. All rights reserved.
This Software Manual has been developed for use with the referenced Software. Use of the Software, and use of this
Software Manual are governed by a License Agreement. Among other provisions, the License Agreement sets certain
warranties for the Software and this Manual, disclaims other warranties, limits recoverable damages, defines permitted
uses of the Software, and determines whether you are an authorized user of the Software. All information set forth in this
manual is provided with the warranty set forth in the License Agreement. Please refer to the License Agreement for
important obligations and applicable limitations and restrictions on your rights. Tekla does not guarantee that the text is
free of technical inaccuracies or typographical errors. Tekla reserves the right to make changes and additions to this
manual due to changes in the software or otherwise.
In addition, this Software Manual is protected by copyright law and by international treaties. Unauthorized reproduction,
display, modification, or distribution of this Manual, or any portion of it, may result in severe civil and criminal penalties,
and will be prosecuted to the full extent permitted by law.
Tekla, Tekla Structures, Tekla BIMsight and also BIMsight are either registered trademarks or trademarks of Tekla
Corporation in the European Union, the United States, and/or other countries. Read more: http://www.tekla.com/teklatrademarks. Trimble is a registered trademark of Trimble Navigation Limited in the United States and in the European
Union. Trimble is a registered trademark or a trademark of Trimble Navigation Limited in other countries. Read more: http:/
/www.trimble.com/copyrights.aspx. Other product and company names mentioned in this Manual are or may be
trademarks of their respective owners. By referring to a third-party product or brand, Tekla does not intend to suggest an
affiliation with or endorsement by such third party and disclaims any such affiliation or endorsement, except where
otherwise expressly stated. Copyright and license statements of third-party software used in the software described in this
Manual can be found in the installation folder of this software.
Tekla Technology kits and tools are property of Tekla Corporation.
Elements of the software described in this Manual may be the subject of pending patent applications in the European
Union and/or other countries.

Conventions used in this guide
Typographical
conventions

The following typographical conventions are used in this guide:

Font

Usage

Bold

Any text that you see in the user interface appears in bold. This
font is used, for example, for window and dialog box titles, box
and button names, and list items.

Italic bold

New terms are in italic bold when they appear in the current
context for the first time.

Monospace

Extracts of program code, HTML, or other material that you
would normally edit in a text editor, appear in monospaced
font.
This font is also used for file names and folder paths, and for
any text that you should type yourself.

Noteboxes

The following types of noteboxes are used in this guide:

A tip might introduce a shortcut, or suggest alternative ways of
doing things.

A note draws attention to details that you might easily overlook. It
can also point you to other information in this guide that you might
find useful.

You should always read very important notes and warnings, like
this one. They will help you avoid making serious mistakes, or
wasting your time.

This symbol indicates advanced or highly technical information
that is usually of interest only to advanced or technically-oriented
readers.

Contents
Conventions used in this guide ..............................................................................................................3

About Template Editor .................................................................................. 9

1.1
1.2

1.5

Main features of Template Editor....................................................................................... 9
What are templates? .......................................................................................................... 10
Graphical templates.................................................................................................................................... 10
Textual templates ........................................................................................................................................ 10
Template components......................................................................................................... 10
Template objects ................................................................................................................. 11
Template shapes and text ......................................................................................................................... 11
Template field objects ................................................................................................................................ 11
Template symbols and files....................................................................................................................... 12
Template definition files .................................................................................................... 12

User interface overview............................................................................... 13

2.1

Interface components......................................................................................................... 13
Workarea........................................................................................................................................................ 13
Template Editor toolbars ........................................................................................................................... 13
Content Browser .......................................................................................................................................... 14
Preview pane................................................................................................................................................. 15
Modifying interface components............................................................................................................ 15
Template windows............................................................................................................... 15
Arranging template windows................................................................................................................... 16
Panning........................................................................................................................................................... 16
Zooming in and out..................................................................................................................................... 16
Restoring the original view....................................................................................................................... 16
Setting up the interface..................................................................................................... 16
Modifying general preferences ................................................................................................................ 17
Modifying Workarea preferences............................................................................................................ 17
File Location preferences........................................................................................................................... 18
Modifying File Location preferences ...................................................................................................... 19
Template grid ................................................................................................................................................ 19
Activating the grid ...................................................................................................................................... 19
Setting the grid density ............................................................................................................................. 20
Showing or hiding the grid ....................................................................................................................... 20
Tips for the Template Editor interface ............................................................................. 20
Starting Template Editor with the command line.............................................................................. 20
Keyboard shortcuts...................................................................................................................................... 21
Pop-up menus............................................................................................................................................... 22
Status bar....................................................................................................................................................... 22

1.3
1.4

2.2

2.3

2.4

Tooltips ........................................................................................................................................................... 22
Setting the presentation file and pen settings ................................................................................... 23

Introduction to templates ........................................................................... 25

3.1
3.2
3.3
3.4
3.5

Creating and saving a template ........................................................................................
Opening and closing templates .........................................................................................
Template properties ............................................................................................................
Modifying template page properties ................................................................................
Changing the template type ..............................................................................................

Template components and objects ............................................................. 29

4.1

Inserting components and objects..................................................................................... 29
Drawing a polyline....................................................................................................................................... 30
Inserting a text object................................................................................................................................ 30
Inserting a graphical field ......................................................................................................................... 31
Inserting a page header or page footer............................................................................ 31
Selecting components and objects.................................................................................... 32
Cutting, copying and pasting components and objects .................................................. 32
Duplicating objects ..................................................................................................................................... 33
Modifying component and object properties................................................................... 33
Modifying the name of a template component or object ............................................................... 33
Modifying the size of a template component or object................................................................... 34
Moving a template component ............................................................................................................... 34
Cropping template components .............................................................................................................. 34
Changing the template component type.............................................................................................. 35
Grouping or ungrouping template objects ........................................................................................... 35
Setting default properties for new template objects ........................................................................ 35
Rotating template objects......................................................................................................................... 36
Aligning template objects ......................................................................................................................... 36
Aligning template objects to the grid.................................................................................................... 36
Moving a template object......................................................................................................................... 37
Tips for component and object tasks................................................................................ 37
Output options for headers and footers................................................................................................ 37
Special drawing operations ...................................................................................................................... 38
Drawing with the numeric pad................................................................................................................ 38
Drawing with the grid ................................................................................................................................ 39
Viewing or hiding template objects ....................................................................................................... 39
Font properties for objects........................................................................................................................ 39
Searching for text........................................................................................................................................ 40

4.2
4.3
4.4
4.5

4.6

25
26
26
26
27

Template rows .............................................................................................. 41

5.1
5.2
5.3
5.4
5.5
5.6
5.7

Creating rows ......................................................................................................................
Content types ......................................................................................................................
Row output properties........................................................................................................
Column settings ..................................................................................................................
Modifying the content type of a row ...............................................................................
Modifying the sort type of a row......................................................................................
Modifying column settings ................................................................................................

41
42
42
43
44
44
45

5.8
5.9
5.10

Hiding rows from output.................................................................................................... 45
Modifying row hierarchy.................................................................................................... 45
Controlling row output with rules .................................................................................... 46
Creating and saving a rule ........................................................................................................................ 47
Creating a rule with Rule Wizard............................................................................................................ 47
Modifying a row rule .................................................................................................................................. 48
Pre-defined rules.......................................................................................................................................... 48
Duplicate lines .............................................................................................................................................. 49

Value fields ................................................................................................... 51

6.1
6.2

Creating a value field ......................................................................................................... 51
Value field output properties ............................................................................................ 52
Value field meanings .................................................................................................................................. 53
Setting the sort order of a value field ............................................................................. 53
Setting the priority of a value field.................................................................................. 53
Setting the data type of a value field .............................................................................. 54
Assigning value field meanings ......................................................................................... 54
Setting the layout of value fields ..................................................................................... 55
Hiding value fields from output ........................................................................................ 55
Formatting value fields ...................................................................................................... 55
Aligning value field texts in output.................................................................................. 56
Value field formulas ........................................................................................................... 56
Creating and saving a formula ................................................................................................................ 56
Formula content properties ...................................................................................................................... 57
Modifying a value field formula.............................................................................................................. 58
Get a single piece of data from the database ..................................................................................... 58
Creating a listing of objects from the database ................................................................................. 59
Creating a summary field .......................................................................................................................... 59
Tips for value fields ............................................................................................................ 60
String translations of texts ....................................................................................................................... 60
Setting Tekla Structures advanced options for value fields ............................................................ 60

6.3
6.4
6.5
6.6
6.7
6.8
6.9
6.10
6.11

6.12

Symbols and pictures ................................................................................... 63

7.1
7.2
7.3
7.4
7.5
7.6
7.7

Symbol and picture libraries .............................................................................................. 63
Adding symbols to a template ........................................................................................... 63
Adding pictures to a template........................................................................................... 64
Adding a logo to a template.............................................................................................. 64
Viewing and modifying symbol file contents ................................................................... 65
Changing the symbol and the symbol file ........................................................................ 65
Tips for symbols and pictures ............................................................................................ 65
Modifying a symbol in Template Editor ................................................................................................ 66
Setting paths for symbols and pictures................................................................................................. 66

AutoCAD and Microstation files................................................................. 67

8.1
8.2
8.3

Importing AutoCAD and MicroStation files with import method defined ................... 67
Importing AutoCAD and MicroStation files with no import method defined .............. 68
Setting fill type and font import settings........................................................................ 69

8.4
8.5
8.6

Limitations in AutoCAD and MicroStation file imports ................................................ 70
AutoCAD and Microstation import errors ........................................................................ 70
Modifying imported AutoCAD and MicroStation files.................................................... 71

Template attributes...................................................................................... 73

9.1

9.3

User-defined template attributes ..................................................................................... 74
Adding user-defined template attributes in Template Editor......................................................... 75
Adding comments to user-defined template attributes................................................................... 76
Adding hierarchy to user-defined template attributes..................................................................... 77
Free attributes..................................................................................................................... 78
Adding free attributes ................................................................................................................................ 78
Deleting free attributes.............................................................................................................................. 78
Modifying free attributes .......................................................................................................................... 79
Global attributes ................................................................................................................. 79

Using templates in products ....................................................................... 81

10.1
10.2
10.3
10.4
10.5
10.6

Outputting a template .......................................................................................................
Template output options....................................................................................................
Material listings ..................................................................................................................
Hierarchical listings ............................................................................................................
Labels ...................................................................................................................................
Creating an HTML report ...................................................................................................

Formula and rule reference......................................................................... 87

11.1

Tips for value field formulas and row rules ..................................................................... 87
Adding comments to rules and formulas.............................................................................................. 88
Offset............................................................................................................................................................... 88
Conditional structure.......................................................................................................... 88
Comparison and logical operators..................................................................................... 89
Control functions ................................................................................................................ 91
IsFirst............................................................................................................................................................... 92
IsLast ............................................................................................................................................................... 92
Output............................................................................................................................................................. 92
PageBreak ...................................................................................................................................................... 92
StepIn .............................................................................................................................................................. 93
StepOut........................................................................................................................................................... 93
StepOver ......................................................................................................................................................... 93
Attribute functions............................................................................................................. 94
GetValue......................................................................................................................................................... 94
NextValue....................................................................................................................................................... 94
PreviousValue................................................................................................................................................ 95
IsSet ................................................................................................................................................................. 95
Value field functions .......................................................................................................... 95
GetFieldFormula ........................................................................................................................................... 96
CopyField........................................................................................................................................................ 96
Sum.................................................................................................................................................................. 97
Total................................................................................................................................................................. 97
Count............................................................................................................................................................... 97
All ..................................................................................................................................................................... 98

9.2

11.2
11.3
11.4

11.5

11.6

81
82
82
84
85
86

11.7

11.8

11.9

String operations ................................................................................................................ 98
find................................................................................................................................................................... 98
match .............................................................................................................................................................. 99
mid ................................................................................................................................................................... 99
length .............................................................................................................................................................. 99
reverse............................................................................................................................................................. 99
getat ................................................................................................................................................................ 99
setat.............................................................................................................................................................. 100
Data type conversion functions....................................................................................... 100
int .................................................................................................................................................................. 100
double .......................................................................................................................................................... 101
string ............................................................................................................................................................ 101
vwu (Value with unit).............................................................................................................................. 101
format .......................................................................................................................................................... 102
Mathematical operations ................................................................................................. 102
Arithmetic operators................................................................................................................................ 102
Trigonometric functions.......................................................................................................................... 103
Statistical functions................................................................................................................................. 104
ceil ......................................................................................................................................................... 104
floor ....................................................................................................................................................... 105
min ........................................................................................................................................................ 105
max ........................................................................................................................................................ 105
sqsum .................................................................................................................................................... 105
ave ......................................................................................................................................................... 106
sqave ..................................................................................................................................................... 106
Miscellaneous functions......................................................................................................................... 106
fabs ........................................................................................................................................................ 106
exp ......................................................................................................................................................... 107
ln ............................................................................................................................................................ 107
log .......................................................................................................................................................... 107
sqrt ........................................................................................................................................................ 107
mod ....................................................................................................................................................... 108
pow ........................................................................................................................................................ 108
hypot ..................................................................................................................................................... 108
n! ............................................................................................................................................................ 108
round ..................................................................................................................................................... 109
and ......................................................................................................................................................... 109
or ............................................................................................................................................................ 109

About Template Editor

Template Editor, also known as TplEd or TempEd is for creating, editing and managing template
definitions in your products.
You can produce labels, reports and legends using Template Editor, allowing you to gather and
produce accurate and targeted information your product.
Tekla Structures features a number of ready-made templates and you can use Template Editor to
edit the existing template or create new ones to suit your needs.
See also

Main features of Template Editor (9)

1.1 Main features of Template Editor
With Template Editor you can do the following:

•
•
•
•
•
•
•
•
•
•
See also

Print data from your product, either textual or graphical.
Modify the size and use of columns and customize template output.
Print different page headers and footers by defining one of many different output options.
Customize the way the row component is output when creating listings of product objects.
Build a row hierarchy that reassembles the hierarchy of objects in the product database, and
also output a part list of a product object.
Exclude value fields or rows from the output template.
Use free attributes to customize the way the template is output. Free attributes are productspecific.
Use AutoCAD and MicroStation files in templates.
Print company logos from picture files and use symbols from your product symbol files.
Create simple HTML reports.

User interface overview (13)
Column settings (43)
Template output options (82)
Template field objects (11)
Hiding rows from output (45)
Hiding value fields from output (55)
Free attributes (78)
AutoCAD and Microstation files (67)
Symbols and pictures (63)
About Template Editor

Main features of Template Editor

Creating an HTML report (86)

1.2 What are templates?
Templates are descriptions of forms and tables that can be included in your products. Templates are
either graphical or textual. The contents of the template fields are filled in by the product at run
time.
Templates are used for a variety of different purposes, for example, to print a list of parts used in a
construction assembly, to denote the legend on an electrical network map, or to provide statistics
on the contents of the map such as city area, scale or date.
See also

Graphical templates (10)
Textual templates (10)

Graphical templates
Graphical templates are generally used to display map legends and labels, or project and company
information. In addition to text, they can contain graphics, such as tables, pictures or symbols.
Graphical templates can also employ different font types and settings. Graphical template
definitions have the file extension .tpl.
See also

Textual templates (10)

Textual templates
Textual templates only contain text. They are primarily used for creating reports or listings of
application area-specific objects, for example in material lists of steel construction assemblies in
Tekla Structures.
You can modify the column settings in order to print templates with multiple columns.
You can use various font types in textual templates, but they do not appear in the output template.
If you want to use specific font types in template output, you have to use a graphical template even
if the template contains only text.
Textual template definitions have the file extension .rpt.
See also

Graphical templates (10)
Font properties for objects (39)
Column settings (43)
File Location preferences (18)

1.3 Template components
Template layout is designed with template components. Templates can be made up of five different
component types, but not all components have to be present to build a template. There are many
different options for specifying the output policy.

Header

A header appears once at the beginning of a template.

Page header

A page header appears at the beginning of template page.

About Template Editor

What are templates?

See also

Row

A template can have multiple rows. A row defines the things
that are listed in the template, each row usually
representing an object from the product database. Rows
contain field objects that define the attributes to get from
the database.

Page footer

A page footer is output at the end of a template page.

Footer

A footer appears once at the end of a template.

Template rows (41)
Inserting components and objects (29)
Modifying the name of a template component or object (33)
Modifying the size of a template component or object (34)

1.4 Template objects
Template objects are inserted into template components and they can include:

See also

Drawing shapes

Basic geometric shapes like lines, rectangles and circles.

Text objects

Static texts are headings or title line texts.

Symbols

Symbols from product symbol libraries.

Pictures

Raster format files.

Imported files

AutoCAD and MicroStation files.

Field objects

Textual or graphical data gathered from the product
database, known as value fields and graphical fields.

Template shapes and text (11)
Template field objects (11)
Template symbols and files (12)

Template shapes and text
Template Editor shapes include lines, arcs, polylines or polygons. They only appear in graphical
templates.
Template Editor text objects are static text strings. Text objects can appear in both graphical
templates and textual templates.
See also

Inserting components and objects (29)
Modifying component and object properties (33)
Drawing with the numeric pad (38)

Template field objects
Template field objects are graphical fields and value fields, which can be used to get data from the
product.
Value fields contain textual information that is referenced from the product database during
template output. Data is retrieved by using value field formulas.
About Template Editor

Template objects

A graphical field is a space that is left empty until the product draws what should appear in the
field: a symbol, picture or text. Graphical fields can appear only in graphical templates. Template
Editor displays the area that is reserved for product graphics as a rectangle. The line color of the
rectangle is copied from the default settings for rectangle objects. This outline does not appear in
the final template.
See also

Value fields (51)
Inserting a graphical field (31)
Adding a logo to a template (64)
Modifying component and object properties (33)

Template symbols and files
Symbols and files of different formats can be inserted into graphical templates.
See also

Adding symbols to a template (63)
Adding pictures to a template (64)
Importing AutoCAD and MicroStation files with import method defined (67)
Importing AutoCAD and MicroStation files with no import method defined (68)

1.5 Template definition files
Template Editor definition files contain product-specific information that is used in rows, value
fields and graphical fields. Definition files are editable text files. There are three different types of
definition files: row content types, global attributes or value field meanings. The contents and
syntax of the files are described at the beginning of each file.
See also

Content types (42)
Value field meanings (53)
Global attributes (79)

About Template Editor

Template definition files

User interface overview

This is an overview of the Template Editor user interface and its basic features.
Click the links below to find out more:
See also

Interface components (13)
Template windows (15)
Setting up the interface (16)
Tips for the Template Editor interface (20)

2.1 Interface components
This is an overview of the Template Editor user interface components.
Click the links below to find out more:
Content Browser (14)
Workarea (13)
Preview pane (15)
Template Editor toolbars (13)
Modifying interface components (15)

Workarea
The Workarea is the primary area where you modify templates. It shows the selected template, so
you can insert components and objects. You can customize the appearance of the Workarea to your
liking, for example, the background and component outline colors.
If you have multiple templates open, each of them appears in its own window.
If you right-click the mouse in the Workarea, a pop-up menu opens access to the most common
viewing and modifying operations.
See also

Template windows (15)
Modifying Workarea preferences (17)

Template Editor toolbars
The toolbars contain buttons that give easy access to some of the most frequently-used commands.

User interface overview

Interface components

You can either dock the toolbars at the edges of the application window or leave them floating
anywhere on your screen.
To show or hide a toolbar, click View > Toolbars and click the toolbar name. Visible toolbars have a
check mark beside their name. Template Editor saves and maintains toolbar visibility settings across
sessions.

Content Browser
In the Content Browser you can see a folder list that describes the contents of an open template.
Each template appears in it as a top-level folder. Template components appear as sub folders, each
of them containing a list of included template objects. Template components and objects are
identified by their names which do not appear in the final template.

If you right-click in the Content Browser, a pop-up menu opens access to the most common viewing
and modifying operations.
See also

Template components and objects (29)
Modifying component and object properties (33)
Viewing or hiding template objects (39)
Searching for text (40)

User interface overview

Interface components

Preview pane
The Preview Pane is a read-only table within the Content Browser. It shows the properties of the
selected template, component or object.
If you want to modify the properties, you must open the property dialog box for the selected part.
You can do that by clicking Edit > Properties.
See also

Content Browser (14)

Modifying interface components
You can modify the visibility and location of Template Editor interface components such as toolbars
and the Content Browser

To...

See also

Do this...

Dock or undock the Content
Browser

Double-click the move handle at the top of the
Content Browser.

Dock or undock toolbars

Double-click the move handle on the toolbar.

View or hide the Content
Browser

Click View > Content Browser > Visible.

View or hide toolbars

Click View > Toolbars > and the toolbar to view or hide.

Hiding value fields from output (55)
Viewing or hiding template objects (39)

2.2 Template windows
Template window operations include arranging windows in the Workarea and focusing and zooming
in a template window.
With Template Editor you can open several templates simultaneously. Each template window is
displayed separately inside the Workarea and as a folder in the Content Browser.
You can cut or copy template objects from one template and paste them into another one when
multiple templates are open.
See also

Arranging template windows (16)
Panning (16)
Zooming in and out (16)
Restoring the original view (16)

User interface overview

Template windows

Arranging template windows
If you open multiple templates to modify them, you can arrange the template windows by using the
Window menu commands. This menu also contains a list of open templates. If you select a template
name from the list, Template Editor brings the corresponding template window to the front and
activates it.

Panning
You can use panning to focus the view to a selected point or to move the template around the
Workarea. To pan in a template window:
1. Click the Pan button on the Zoom toolbar.
2. You can use panning in three ways:
• Click to center the view around the selected point.

•
•

Drag to move the template around the Workarea.
Drag with the middle mouse button (this is often the same as the scroll bar button).

3. Repeat step 2 to continue panning. Press Esc to stop panning.

Zooming in and out
Zooming allows you to focus in on a particular area, or pull out for a wider view. To zoom on a
template window:
1. If you want to magnify the template, click the Zoom In button on the Zoom toolbar.
If you want to reduce the template to see more of it, use the Zoom Out button instead.
2. Click to zoom to the next preset percentage. The display centers around the point you click.
You can also drag to center the display around the selected area.
3. Repeat step 2 to continue zooming. To stop zooming, press Esc.

Restoring the original view
To fit and display the whole template in its window, do one of the following:

•
•
•

Click View > Restore.
Click the Restore view icon on the Zoom toolbar.
Right-click and select Restore from the pop-up menu.

2.3 Setting up the interface
Before you get started with Template Editor, you can customize the interface. Set up the Workarea
and the grid settings. It is also critical to set up file location preferences in order for Template Editor
value fields and row rules to gather template and part-related information at run time.
See also

Modifying general preferences (17)
Modifying Workarea preferences (17)
File Location preferences (18)
Modifying File Location preferences (19)
Activating the grid (19)
Setting the grid density (20)
Showing or hiding the grid (20)

User interface overview

Setting up the interface

Modifying general preferences
General preferences allow you to select the measurement unit of graphical templates, show
different buttons, set message preferences and optionally use TrueType fonts.
Click Options > Preferences. The General tab is active by default. You can modify the settings in the
fields listed below. Click OK to save the changes.

To set...

Modify this...

Graphical units

Sets the measurement unit for graphical
templates to millimeters or inches.
All size-related information (for example height
and width of components or objects) is displayed
using the selected unit. In textual templates the
unit is always character (char(s)).

Always ask for import method

Click this option if you want the Select Import
Method dialog box to appear whenever you
import AutoCAD or MicroStation files.
If you leave the option unchecked, you will have
to double-click for the Select Import Method
dialog box to appear.

See also

Show TrueType fonts

Select this if you want to use TrueType fonts in
Template Editor. If unselected, you can use only
Tekla fonts.

Reset messages to visible

Resets the user messages setting so that all
messages are displayed again.

Importing AutoCAD and MicroStation files with import method defined (67)
Importing AutoCAD and MicroStation files with no import method defined (68)
Template properties (26)

Modifying Workarea preferences
Workarea preferences allow you to change the appearance of the Workarea to your liking.
These settings do not affect the output template in any way.
To modify Workarea preferences, click Options > Preferences and click the Workarea tab. You can
modify the color, line width and grid color.
Click OK to save the changes.

Field

Description

Background

Sets the Workarea background color.

Grid

Sets the grid color.

Header, Page header, Row, Page
footer, Footer

For each template component you can change the
color of the component frame (if you use
presentations, you select from pen names).
You can also change the line thickness.

User interface overview

Setting up the interface

See also

Workarea (13)
Modifying general preferences (17)
File Location preferences (18)
Template grid (19)
Setting the presentation file and pen settings (23)

File Location preferences
File location preferences define the default work directory and locations where Template Editor
searches for images and product-specific definition files and directories.

Definition file

Description

Value field meanings

Sets the definition file for value field
meanings.

Row contents

Sets the definitions file for row contents.

Global attributes

Sets the definition file for global attributes. If
this setting is missing, no attribute name
check is performed.

Work directory (*)

Sets the initial working directory for Template
Editor. When opening or saving template files
it is automatically active in the file selection
dialog box.

Symbols, pictures (*)

Sets the folders where you can insert symbols
and pictures from. You can define several
directories by separating them with
semicolons (;).

Fonts (*)

Sets the folders containing font files. You can
define several directories by separating them
with semicolons (;).

Predefined Rules

Sets the definition file for predefined rules
that are applied to row output.

Presentation

Sets the presentation file from which the pen
and color settings are loaded.
Tekla Structures does not use presentations.

Conversion fonts

Sets the font map file to use in template
conversion.

Conversion colors

Sets the color map file to use in template
conversion.

Conversion attributes

Sets the attribute map file to use in template
conversion.

Fill import

Sets the fill import map file to use in template
conversion and in AutoCAD and MicroStation
file importation.

User interface overview

Setting up the interface

Definition file

Description

Color Map
See also

Sets the color map file to use.

Modifying File Location preferences (19)

Modifying File Location preferences
File location preferences define the default work directory and locations where Template Editor
searches for images and product-specific definition files. If you leave these empty, Template Editor
will not be able to find product-specific symbols, pictures and fonts that you may want to use in
your templates.
To add or modify the default file locations:
1. Click Options > Preferences and click the File Locations tab. The list of modifiable file locations is
in two columns.
The Type column contains the definition file type and cannot be modified. The Location field
contains the path for the definition file or directory and can be modified.
2. To set a definition file, click on the line that you want to modify and click the Select File button.
This opens the standard file selection dialog box.
3. To set a directory (*), click in the Location field on the line that you want to modify, and type in
the directory path, for example C:\Program Files\Company Product\symbols.
4. Click OK to accept or Cancel to discard the changes.
See also

File Location preferences (18)

Template grid
The template grid helps you to draw regular shapes and position template objects.
For textual templates the distance between the grid points in the Workarea is fixed to one character
unit and you cannot change it. For graphical templates you can change the grid size to suit your
needs.
See also

Activating the grid (19)
Setting the grid density (20)
Showing or hiding the grid (20)

Activating the grid
Activating the grid means that template objects will be aligned to grid points when they are added
to the template.
To activate the grid right-click in an empty area in the Workarea and click Grid > Visible from the
pop-up menu.
The check mark in front of the option indicates that the grid is activated.
If you have drawn or added template objects before activating the grid, you can align them to the
active grid later on.
See also

Aligning template objects to the grid (36)
Showing or hiding the grid (20)
Setting the grid density (20)

User interface overview

Setting up the interface

Setting the grid density
If you want to align objects to the grid points automatically as you draw or modify them, make sure
that the grid is active.
You can set the distance between the grid points in graphical templates to aid drawing operations.
Do the following:
1. Click Options > Grid > Density. This opens the Grid Settings dialog box.
2. Type in the distance between the grid points by defining the Horizontal and Vertical settings.
3. Click OK to save the changes.
See also

Activating the grid (19)
Showing or hiding the grid (20)

Showing or hiding the grid
You can show or hide the grid while working on templates. The grid is useful for aligning objects as
they are drawn.
To show or hide the template grid, right-click in an empty area in the Workarea and click Grid >
Visible from the pop-up menu.
The check mark in front of the option indicates that the grid is visible.
Activating the grid does not automatically make it visible. Note that the grid can be visible without
being active.
See also

Activating the grid (19)
Aligning template objects to the grid (36)

2.4 Tips for the Template Editor interface
Here are some useful hints and tips that help you use the Template Editor user interface and its
basic features more efficiently.
Click the links below to find out more:
Starting Template Editor with the command line (20)
Keyboard shortcuts (21)
Status bar (22)
Pop-up menus (22)
Setting the presentation file and pen settings (23)
Tooltips (22)

Starting Template Editor with the command line
This is aimed at administrator level users, who can start Template Editor through the command
prompt. Use these command line options to start Template Editor.
All command line options are case insensitive, so uppercase letters are equal to lowercase letters.

User interface overview

Tips for the Template Editor interface

Command line option

Description

-L

Allows you to select the language for the Template
Editor user interface. is a three-letter
language identifier. Available languages depend on
your product. Please refer to your product
documentation for information on available
languages.

-i

Allows you to set the Template Editor initialization
file that holds the information on where Template
Editor searches for certain definition files. refers to an ASCII format initialization file
named with the extension -ini. This is an example of
such a command line option:
-i C:\My
Documents\Product\Templates\mysetting
s.ini

Click Options > Preferences to modify the default file
location preferences.
-w

Allows you to set the work folder for Template Editor.
This folder is, for example, is the base folder for file
open and save operations.

Keyboard shortcuts
Keyboard shortcuts in Template Editor:

Shortcut

Action

Ctrl + N

Creates a new template file.

Ctrl + O

Opens a template file.

Ctrl + S

Saves a template file.

Ctrl + Q

Exits Template Editor.

Ctrl + Z

Undoes the previous operation.

Ctrl + Y

Redoes the previous operation.

Ctrl + X

Cuts the selected component or object.

Ctrl + C

Copies the selected component or object.

Ctrl + V

Pastes the selected component or object.

Delete

Deletes the selected component or object.

Ctrl + G

Groups selected individual objects into one group so that
they are handled as one object.

Ctrl + U

Turns the selected group of objects into individual
objects.

User interface overview

Tips for the Template Editor interface

Shortcut

Action

Ctrl + Home

Moves the selected row component higher on the current
hierarchy level.

Ctrl + End

Moves the selected row component lower on the current
hierarchy level.

Ctrl + Page Up

Moves the selected row to a higher level in the hierarchy.

Ctrl + Page Down

Moves the selected row to a lower level in the hierarchy.

Ctrl + D

Makes a copy of the selected object. Modify the settings
in the dialog box.

Ctrl + M

Moves the selected object a specified distance in the
template. Modify the settings in the dialog box.

Esc

Ends the current drawing action and enables selection of
objects.

Alt + Enter

Opens the property dialog box for the selected item,
where you can modify the properties and settings.

Pop-up menus
You can open context sensitive pop-up menus in the main window by right-clicking the mouse. The
commands vary depending on which area in the Template Editor main window you click.
The Content Browser pop-up menu commands contain the most common modifying operations and
allow you to change the location or hierarchy of row components, customize the view in the
browser or access properties of the selected part. Some of the commands are also available in the
Sort and Drawing order toolbar.
The Workarea pop-up menu commands contain the most common modifying operations, zooming,
panning and setting Template Editor drawing options. You can also open the properties dialog box
of the selected template, component or object.
See also

Setting the sort order of a value field (53)
Template windows (15)
Template properties (26)

Status bar
The status bar shows information on the selected tool or command and is located on the bottom left
side of the main window.
See also

Drawing with the numeric pad (38)

Tooltips
When you rest the mouse pointer on a toolbar button, a tooltip appears.
Template Editor only has basic tooltips that display the name of a command.
See also

Template Editor toolbars (13)

User interface overview

Tips for the Template Editor interface

Setting the presentation file and pen settings
If your product does not use presentations, you can skip the following instructions.
A presentation file defines a set of pens that you can use when drawing. The presentation uses a
color map file that defines a set of product-specific colors. You can use a presentation in Template
Editor only if your product uses them. The pens and colors of the presentation file replace the
Template Editor color, line type and line width. This means you specify the color, line type and line
width for a Template Editor part that has these properties by selecting a pen.
Presentation files are created and modified with Presentation Editor (PresEd).
Do the following to define the default presentation file location in Template Editor
1.
2.
3.
4.
5.
6.

Click Options > Preferences and click the File Location preferences tab.
Click in the Presentation line and then click Select File.
Select the presentation file to use and click OK.
Click in the Color Map line and then Select File.
Select the color map file to use and click OK.
Click OK to apply the changes and close the Preferences dialog box.

The pens of the presentation appear in the template object property dialog boxes and can customize
the colors in the Template Editor Workarea.
See also

File Location preferences (18)

User interface overview

Tips for the Template Editor interface

User interface overview

Tips for the Template Editor interface

Introduction to templates

This is an overview of templates. Here you will find out more about textual and graphical templates,
how to use data from your product in templates; and template parts, which you need to be familiar
with when you design templates.
See also

Creating and saving a template (25)
Opening and closing templates (26)
Template properties (26)
Modifying template page properties (26)
Changing the template type (27)

3.1 Creating and saving a template
Before you start, we recommend you define various Template Editor preferences including the
appearance of the Workarea, the graphical units (Metric or Imperial) and the references to data files.
1. Click File > New
2. Select the template type: graphical or textual.
3. Click OK.
An empty template opens in the Workarea and you are ready to begin working with the
template.
4. Click File > Save As to save the template.
The standard file selection dialog box will appear for you to specify the name, save location and
file extension. Template Editor automatically adds the selected extension to the file name.
5. Click OK.
You can begin working with the template and add components and objects.
See also

Modifying general preferences (17)
Modifying Workarea preferences (17)
File Location preferences (18)
Graphical templates (10)
Textual templates (10)
Opening and closing templates (26)

Introduction to templates

Creating and saving a template

3.2 Opening and closing templates
When you open an existing textual template, Template Editor checks for overlapping objects. If you
receive a message about overlapping template objects, you should reposition or resize the objects to
eliminate overlapping.
If you receive a message regarding template conversion when you open a template, contact your
service representative for assistance if you do not know how to proceed.
To open an existing template file:
1. Click File > Open.
2. When the file selection dialog box opens, click the location you want to open the file from and
click OK.
If you have recently worked on a template, you can open it by clicking File > Recent Files, which
lists the ten most recent template files you have worked on.
3. To close a template file, click File > Close.
If you have many files open and want close them without exiting Template Editor, click File >
Close All.
If there are unsaved changes in any of the template files that you close, Template Editor asks if
you want to save them. Select the option that best suits your situation.
See also

Creating and saving a template (25)

3.3 Template properties
Properties determine things such as the size, color, font and output options of a template,
component or object. You can modify properties through specific property dialog boxes.
Click the links below to find out more:
Modifying template page properties (26)
Changing the template type (27)

3.4 Modifying template page properties
Both graphical and textual templates require page and margin settings. The units used in the
dimensions of a template are based on the template type. Graphical templates use graphical units
(Metric or Imperial) and textual templates use character units.
For a graphical template meant to be a map legend or label, these settings specify the total width
and height of it.
To set and modify the template page settings and margin settings:
1. Double-click the template to open the Template Page Properties dialog box.
2. In the Output, Workarea and Margins areas, modify the following fields:
• Width and Height: set in graphical units or characters.
• View height: sets the page height for template design, but does not affect template output.
• Margins: sets the margins for the left, right and bottom of the template in graphical units or
characters.

Introduction to templates

Opening and closing templates

3. Click OK to save the changes.
You can also add notes about the template and assign free attributes to it.
See also

Modifying column settings (45)
Free attributes (78)
Adding free attributes (78)

3.5 Changing the template type
Change the template type when you need to use certain types of content in the template, for
example, if you need to use Metric or Imperial measures in your reports. Changing the template type
is also useful if you need to transfer the template output to Excel or some other editor.
To change the template type:
1. Click File > Template > Type. A dialog box opens.
Select the template type.
2. Click OK.
3. Be sure to use Save As to save the template with the new (and correct) file extension (.rpt for
textual templates and .tpl for graphical templates).
If you turn a graphical template into a textual template, only the text and value fields remain. All
graphical objects will be deleted.
See also

Graphical templates (10)
Textual templates (10)

Introduction to templates

Changing the template type

Introduction to templates

Changing the template type

Template components and objects

Templates are made up of components and objects. Template layout is designed with template
components. Template objects are inserted into template components.
Here you will find out more about common operations applied to template components and objects.
See also

Inserting components and objects (29)
Selecting components and objects (32)
Cutting, copying and pasting components and objects (32)
Modifying component and object properties (33)
Tips for component and object tasks (37)

4.1 Inserting components and objects
Inserting template components and objects is accomplished through the toolbars. Insert template
components before inserting template objects. A template can have only one header and one footer
component. Other components may be repeated.
To insert a template component:
1. Click the component you want to insert.
Template Editor inserts components in the following order: header, page header, row, page
footer, footer.
2. Modify the properties of the component by selecting and double-clicking it.
3. Click the object you want to insert and then click in the component to position it.
The object is added to the template with the current default properties, which you can modify.
The output of the final template is determined by the output settings.
Rows and value fields are used widely and offer more functionality in terms of gathering and
outputting information.

Template components and objects

Inserting components and objects

If you double-click a button in the Object toolbar, you can draw
several objects without clicking the button again. Press Esc or click
another button to stop drawing.
Hold down the Shift key while moving an object to lock the
movement horizontally or vertically.
See also

Template rows (41)
Value fields (51)
Creating rows (41)
Inserting a page header or page footer (31)
Tips for component and object tasks (37)
Creating a value field (51)
Inserting a text object (30)
Drawing a polyline (30)
Modifying component and object properties (33)

Drawing a polyline
To draw a polyline:
1.
2.
3.
4.
5.

Click the Polyline icon.
Click to define the starting point.
Move the mouse and click to define the next vertex point.
Repeat the previous step to add more points.
Double-click where you want to end drawing.

If you draw an unclosed object and later decide to fill it, Template Editor will automatically insert a
line to close the shape.
See also

Modifying component and object properties (33)

Inserting a text object
You may want to adjust the font settings before you begin, but you can always change them later.
To insert text into a template:
1. Click the Text icon.
A dialog box appears prompting you to type in the text.
2. Type the text and click OK.
You can also insert a text object with the default string, simply click OK. The default string is
defined with the check box Set as default for new texts in the Text Properties dialog box.
3. Click to define the insertion point of the text.
Double-click the text to modify the text properties and font settings.
See also

Setting default properties for new template objects (35)
Font properties for objects (39)

Template components and objects

Inserting components and objects

Inserting a graphical field
Insert a graphical field to a template component when you want to reserve the area to include a
logo or a graphic.
If the field is placed inside a row component, note that the row content type may block some
attributes from use.
To insert a graphical field:
1. Click Insert > Graphical Field or click the Graphical field button.
2. Specify the insertion point:
• Click twice to define the opposing corners or
• Drag and release to end drawing.
3. Open the Graphical Field Properties dialog box.
4. In the Attribute list, select a global attribute to determine how the graphical field is used when
the template is output,
You can also click the Attribute button to select an attribute from the attribute tree.
5. Click OK to accept the changes and close the property dialog box.
See also

Modifying the size of a template component or object (34)
Modifying the name of a template component or object (33)

4.2 Inserting a page header or page footer
Use page headers and page footers in a template if you want to print different headers or footers on
specified pages during output. Do the following:
1. Click the page header or page footer icon.
The page header appears below the header, or if no header exists, at the top of the template
page.
The page footer appears above the footer, or if no footer exists, at the bottom of the template
page.
2. Set the name, height and output policy of the page header / footer in the properties dialog.
The output policy options include:

•
•
•
•
•
•
•
•
•
•

All - component prints on every page.
Even - component prints on even pages.
Odd - component prints on odd pages.
Exactly on - component prints only on the page you specify.
Not on - component does not print on the page you specify.
Last - component prints on the last page.
Not last - component does not print on the last page.
From - component printing starts on the page you specify.
Until - component prints only up to the page you specify.
Between - component prints pages between the numbers you specify.

Template components and objects

Inserting a page header or page footer

3. Insert template objects inside the component.
The output of the final template is determined by the output policy.
See also

Modifying the name of a template component or object (33)
Modifying the size of a template component or object (34)

4.3 Selecting components and objects
In Template Editor you can specify how area selection works. You can choose to select all template
components or objects that are either completely or partially inside the drag frame, or just the ones
that are completely inside.
To select components and objects:
1. Start with setting the selection properties. Click Options > Pick > Partially.
The check mark next to the option indicates that the option is on, and parts that fall only
partially inside the drag frame are selected.
2. You can select multiple template components or objects or only one. Drag to make an area
selection in the Workarea.
3. Hold down the Ctrl key to select multiple objects (you can do this in the Content Browser too).
4. To deselect all components or objects, click in an empty space in the Workarea. To deselect one
component or object press the Ctrl key and click the part to deselect.
Selected parts appear highlighted in the Workarea and also show on the status bar. Only the most
recently selected part appears in the Content Browser.

If the Pick Multiple setting is deactivated, you can select only one
part.

See also

Special drawing operations (38)

4.4 Cutting, copying and pasting components and objects
You can cut or copy template objects and components in Template Editor and paste them to another
position in the same template or in another open template.
To cut, copy and paste template components and objects, do any of the following:

To...

See also

Do this...

Cut a component or object

Select it and press Ctrl + X.

Copy a component or object

Select it and press Ctrl + C.

Paste the contents of the cut buffer

Press Ctrl + V and click to give the insertion
point in the Workarea.

Duplicating objects (33)

Template components and objects

Selecting components and objects

Duplicating objects
You can make identical duplicates of template objects without having to create a new object from
scratch.
To make a duplicate of an existing object:
1. Select the template object and press Ctrl +D.
2. Give the offset for the duplicate object in the Duplicate Object dialog box:
The offset is the distance from the current coordinate point in graphical units. Positive values
given horizontally and vertically insert the object to the right and up.
3. Click OK.
See also

Cutting, copying and pasting components and objects (32)

4.5 Modifying component and object properties
The properties of template components and objects determine things such as the size, color, font
and the output options. You can modify these properties through part-specific property dialog
boxes.
To open the property dialog box for a template component or object, select and double-click the
template component or object in the Workarea or in the Content Browser
Template Editor opens a component- or object-specific property dialog box. The changes you make
there update the component or object when you accept them by clicking OK.
See also

Modifying the name of a template component or object (33)
Modifying the size of a template component or object (34)
Moving a template component (34)
Cropping template components (34)
Changing the template component type (35)
Grouping or ungrouping template objects (35)
Setting default properties for new template objects (35)
Rotating template objects (36)
Aligning template objects (36)
Aligning template objects to the grid (36)
Moving a template object (37)

Modifying the name of a template component or object
The name of a component or object is a critical identifier in Template Editor.
For example, the names of value fields are used when referencing them in formulas or rules. So if
you modify the name of a value field after you have used it in formulas or rules, you must also
change the name in those formulas and rules. Template Editor does not update formulas or rules
with the new name.
To modify the name of a template component or object:
1. Select and double-click the component or object to open the properties dialog box.
2. In the Name field type in a new name for the component or object.
3. Click OK.

Template components and objects

Modifying component and object properties

The name you give does not appear during output, but does appear in the Content Browser.
See also

Modifying the size of a template component or object (34)
Modifying a value field formula (58)

Modifying the size of a template component or object
You can modify the size of a template component or object.
To modify the size of a template component or object:
1. Select the component or object and double-click to open the properties dialog box.
2. Depending on the template component or object modify the size, length or radius.
For some template objects, such as imported pictures, you can retain the aspect ratio by clicking
Keep aspect ratio in the properties dialog box.
3. Click OK to save the changes.
Template components and objects can also be reshaped (and resized) by dragging the resize handles.
To do that select the component. Note that dragging the handles of polylines, polygons and free
form areas is the only way to resize them.
See also

Modifying the name of a template component or object (33)

Moving a template component
You can move a template component by changing its location in the Content Browser.
1. Select the template component.
2. Click the appropriate button in the sort and draw toolbar.

3. Save the template.
Moving a template component also affects the sort and draw order during the final output.
See also

Row output properties (42)
Value field output properties (52)

Cropping template components
You can crop unneeded space from around template components.
To crop a component:
1. Select the component you want to crop.
2. Depending on which part of the component you want to crop, click Edit > Crop and the side of
the component to crop.
Template Editor redraws the Workarea after you crop the template. Cropping cannot be undone once
you save the template, the effects of which appear in the final output template.
See also

Template components (10)

Template components and objects

Modifying component and object properties

Changing the template component type
You can change the template component type without losing any of the information it contains.
Remember that you can only insert a header and a footer once in a template. In addition, if you
change the template component to a row, you must define the content type for the row.
1. Select the component to crop.
2. Click Edit > Change Type. A dialog box opens prompting you to select a new template
component type.
3. Select the template component type and click OK.
Template Editor changes the component type in the Workarea and the Content Browser.
4. Save the changes.
See also

Content types (42)

Grouping or ungrouping template objects
When you want to handle several objects as one object, you can create a group from existing
template objects. When you need to resize or modify an individual object of the group you must
ungroup the objects first.
To group and ungroup template objects:
1. Select the template objects you want to group or ungroup.
2. Right-click and select Group or Ungroup.
Double-click the group to open the Object Properties dialog box to modify the group. If you want to
modify a single ungrouped item, double-click on it to open the properties dialog box.

Grouped objects have some limitations with regards to modifying
them.

•
•
•

See also

You cannot rotate a group.
If the group contains different types of objects, for example
shapes and texts, you cannot modify its properties.
If you modify the color properties of the group, the new color is
applied to both lines and fills.

Inserting components and objects (29)
Modifying the size of a template component or object (34)
Moving a template object (37)

Setting default properties for new template objects
You can set the default properties for new template objects without having to define them every
time a new, similar object is added to the template.
To set the default properties for new template objects:
1. Select an object that has the desired properties and object type.
2. Double-click to open the property dialog box for the object.
3. Click Set as default for new

Tpled Editor User Guide

Navigation menu

Versions of this User Manual:

Views

Navigation