Reference manual

This document is Copyright © 2015 by its contributors as listed below. You may distribute it and/or modify it under the terms of either the GNU General Public License (http://www.gnu.org/licenses/gpl.html), version 3 or later, or the Creative Commons Attribution License (http://creativecommons.org/licenses/by/3.0/), version 3.0 or later.

Contributors

Jean-Pierre Charras.

Feedback

Please direct any bug reports, suggestions or new versions to here:

Publication date and software version

may 23, 2015.

Introduction to Pl_Editor

Pl_Editor is a page layout editor tool to create custom title blocks, and frame references.

The title block, associated to frame references, and other graphic items (logos) is called here a page layout.

Basic page layout items are:

  • Lines

  • Rectangles

  • Texts (with format symbols, that will be replaced by the actual text, like the date, page number…​) in Eeschema or Pcbnew.

  • Poly-polygons (mainly to place logos and special graphic shapes)

  • Bitmaps.

Bitmaps can be plotted only by few plotters (PDF and PS only) Therefore, for other plotters, only a bounding box will be plotted.
  • Items can be repeated, and texts and poly_polygons can be rotated.

Pl_Editor files

Input file and default title block

Pl_Editor reads or writes page layout description files *.kicad_wks (KiCad worksheet).

An internal default page layout description to display the default KiCad title block is used until a file is read.

Output file

The current page layout description can be written in a *.kicad_wks file, using the S-expression format, which is widely used in KiCad.

This file can be used to show the custom page layout in Eeschema and/or Pcbnew.

Theory of operations

Basic page layout items properties:

Basic page layout items are:

  • Lines

  • Rectangles

  • Texts (with format symbols, with will be replaced by the actual text, like the date, page number…​) in Eeschema or Pcbnew.

  • Poly-polygons (mainly to place logos and special graphic shapes). These poly polygons are created by Bitmap2component, and cannot be built inside pl_editor, because it is not possible to create such shapes by hand.

  • Bitmaps to place logos.

Bitmaps can be plotted only by few plotters: PDF and PS only.

Therefore:

  • Texts, poly-polygons and bitmaps are defined by a position, and can be rotated.

  • Lines (in fact segments) and rectangles are defined by two points: a start point and a end point. They cannot be rotated (this is useless for segments).

These basic items can be repeated.

Texts which are repeated accept also an increment value for labels (has meaning only if the text is one letter or one digit).

Coordinates definition

Each position, start point and end point of items is always relative to a page corner.

This feature ensure you can define a page layout which is not dependent on the paper size.

Reference corners and coordinates:

page property 1

  • When the page size is changed, the position of the item, relative to its reference corner does not change.

  • Usually, title blocks are attached to the right bottom corner, and therefore this corner is the default corner, when creating an item.

For rectangles and segments, which have two defined points, each point has its reference corner.

Rotation

Items which have a position defined by just one point (texts and poly-polygons) can be rotated:

Normal: Rotation = 0

text noriented

Rotated: Rotation = 20 and 10 degrees.

text rotated

Repeat option

Items can be repeated:

This is useful to create grid and grid labels.

page property 2

Texts and formats

Format symbols:

Texts can be simple strings or can include format symbols.

Format symbols are replaced by the actual values in Eeschema or Pcbnew.

They are like format symbols in printf function.

A format symbol is % followed by 1 letter.

The %C format has one digit (comment identifier).

Formats symbols are:

%% = replaced by %

%K = KiCad version

%Z = paper format name (A4, USLetter …​)

%Y = company name

%D = date

%R = revision

%S = sheet number

%N = number of sheets

%Cx = comment (x = 0 to 9 to identify the comment)

%F = filename

%P = sheet path (sheet full name, for Eeschema)

%T = title

Example:

"Size: %Z" displays "Size: A4" or "Size: USLetter"

User display mode: pagelayout normal view mode activated. Title block displayed like in Eeschema and Pcbnew

show fields data

"Native" display mode: pagelayout special view mode activated. The native texts entered in Pl_Editor, with their format symbols.

show fields codes

Multi-line texts:

Texts can be multi-line.

There are 2 ways to insert a new line in texts:

  1. Insert the "\n" 2 chars sequence (mainly in Page setup dialog in KiCad).

  2. Insert a new line in Pl_Editor Design window.

Here is an example:

Setup

options multi line

Output

multi line

Multi-line texts in Page Setup dialog:

In the page setup dialog, text controls do not accept a multi-line text.

The "\n" 2 chars sequence should be inserted to force a new line inside a text.

Here is a two lines text, in comment 2 field:

insert newline code

Here is the actual text:

multi line 2

However, if you really want the "\n" inside the text, enter "\\n".

insert slashnewline code

And the displayed text:

multi line 3

Constraints

Page 1 constraint

When using Eeschema, the full schematic often uses more than one page.

Usually page layout items are displayed on all pages.

But if a user want some items to be displayed only on page 1, or not on page 1, the "page 1 option" this is possible by setting this option:

display options

Page 1 option:

  • None: no constraint.

  • Page 1 only: the items is visible only on page 1.

  • Not on page 1: the items is visible on all pages but the page 1.

Text full size constraint

constraint options

Only for texts, one can set 2 parameters :

  • the max size X

  • the max size Y

which define a bounding box.

When these parameters are not 0, when displaying the text, the actual text height and the actual text width are dynamically modified if the full text size is bigger than the max size X and/or the max size Y, to fit the full text size with this bounding box.

When the actual full text size is smaller than the max size X and/or the max size Y, the text height and/or the text width is not modified.

The text with no bounding box. Max size X = 0,0 Max size Y = 0,0

constraints none

The same text with constraint. Max size X = 40,0 Max size Y = 0,0

constraints defined

A multi line text, constrained:

Setup

constraint options

Output

block constraints

Invoking Pl_Editor

Pl_Editor is typically invoked from a command line, or from the KiCad manager.

From a command line, the syntax is pl_editor <*.kicad_wks file to open>.

Pl_Editor Commands

Main Screen

The image below shows the main window of Pl_Editor.

main window

The left pane contains the list of basic items.

The right pane is the item settings editor.

Main Window Toolbar

main toolbar

The top toolbar allows for easy access to the following commands:

new page layout

Select the net list file to be processed.

open page layout

Load a page layout description file.

save

Save the current page layout description in a .kicad_wks file.

sheetset

Display the page size selector and the title block user data editor.

print button

Prints the current page.

delete

Delete the currently selected item.

undo redo

Undo/redo tools.

zoom in zoom out zoom redraw zoom fit in page

Zoom in, out, redraw and auto, respectively.

pagelayout normal view mode

Show the page layout in user mode: texts are shown like in Eeschema or Pcbnew: text format symbols are replaced by the user texts.

pagelayout special view mode

Show the page layout in native mode: texts are displayed "as is", with the contained formats, without any replacement.

set base corner

Reference corner selection, for coordinates displayed to the status bar.

set current page

Selection of the page number (page & or other pages).

This selection has meaning only if some items than have a page option, are not shown on all pages (in a schematic for instance, which contains more than one page).

Commands in drawing area (draw panel)

Keyboard Commands

F1

Zoom In

F2

Zoom Out

F3

Refresh Display

F4

Move cursor to center of display window

Home

Fit footprint into display window

Space Bar

Set relative coordinates to the current cursor position

Right Arrow

Move cursor right one grid position

Left Arrow

Move cursor left one grid position

Up Arrow

Move cursor up one grid position

Down Arrow

Move cursor down one grid position

Mouse Commands

Scroll Wheel

Zoom in and out at the current cursor position

Ctrl + Scroll Wheel

Pan right and left

Shift + Scroll Wheel

Pan up and down

Right Button Click

Open context menu

Context Menu

Displayed by right-clicking the mouse:

  • Add Line

  • Add Rectangle

  • Add Text

  • Append Page Layout Descr File

Are commands to add a basic layout item to the current page layout description.

  • Zoom selection: direct selection of the display zoom.

  • Grid selection: direct selection of the grid.

Append Page Layout Descr File is intended to add poly polygons to make logos.

Because usually a logo it needs hundred of vertices, you cannot create a polygon by hand. But you can append a description file, created by Bitmap2Component.

Status Bar Information

The status bar is located at the bottom of the Pl_Editor and provides useful information to the user.

pl status bar

Coordinates are always relative to the corner selected as reference.

Left window

The left windows shows the list of layout items.

One can select a given item (left clicking on the line) or, when right clicking on the line, display a pop up menu.

This menu allows basic operations: add a new item, or delete the selected item.

→ A selected item is also drawn in a different color on draw panel.

Design tree: the item 19 is selected, and shown in highlighted on the draw panel.

project tree

Right window

The right window is the edit window.

property none

property main

On this dialog you can set the page property and the item property of the current item.

Displayed settings depend on the selected item:

Settings for lines and rectangles

Settings for texts

property line

property text

Settings for poly-polygons

Setting for bitmaps

property polyline

property bitmap

Interactive edition

Item selection

An item can be selected:

  • From the Design tree.

  • By Left clicking on it.

  • By Right clicking on it (and a pop up menu will be displayed).

When selected, this item is drawn in yellow.

edit line

The starting point (edit line start) and the ending point (edit line end) are highlighted.

When right clicking on the item, a pop-up menu is displayed.

The pop menu options slightly depend on the selection:

context line move start

context line move end

context line move

If more than one item is found, a menu clarification will be shown, to select the item:

dialog select element

drag element

Once selected, the item, or one of its end points, can be moved by moving the mouse and placed (right clicking on the mouse).

Item creation

To add a new item, right click the mouse button when the cursor is on the left window or the draw area.

A popup menu is displayed:

Pop up menu in left window

context createnew

Pop up menu in draw area.

context createnew2

Lines, rectangles and texts are added just by clicking on the corresponding menu item.

Logos must first be created by Bitmap2component, which creates a page layout description file.

The Append Page Layout Descr File option append this file, to insert the logo (a poly polygon).

Adding lines, rectangles and texts

When clicking on the option, a dialog is opened:

Adding line or rectangle

dialog newline

Adding text

dialog newtext

Position of end points, and corner reference can be defined here.

However they can be defined later, from the right window, or by moving the item, or one of its end points.

Most of time the corner reference is the same for both points.

If this is not the case, define the corner reference at creation is better, because if a corner reference is changed later, the geometry of the item will be a bit strange.

When an item is created, if is put in move mode, and you can refine its position (this is very useful for texts and small lines or rectangles)

Adding logos

To add a logo, a poly polygon (the vectored image of the logo) must be first created using Bitmap2component.

Bitmap2component creates a page layout description file which is append to the current design, using the Append Page Layout Descr File option.

Bitmap2component creates a page layout description file which contains only one item: a poly polygon.

However, this command can be used to append any page layout description file, which is merged with the current design.

Once a poly polygon is inserted, it can be moved and its parameters edited.

Adding image bitmaps

You can add an image bitmap using most of bitmap formats (PNG, JPEG, BMP …​).

  • When a bitmap is imported, its PPI (pixel per inch) definition is set to 300PPI.

  • This value can be modified in panel Properties (right panel).

  • The actual size depend on this parameter.

  • Be aware that using higher definition values brings larger output files, and can have a noticeable draw or plot time.

A bitmap can be repeated, but not rotated.