LuaCAD Help

Templates

Choosing a template

Goal: decide which template Annotate and Multiple use.

Detail of the template tree: Automatic (1), discipline Plumbing (2), plug-in Piping 3D (3), part type Pipes (4), a template (5), style button (6)
Detail of the template tree: Automatic (1), discipline Plumbing (2), plug-in Piping 3D (3), part type Pipes (4), a template (5), style button (6)
  1. In the palette expand the folders of the tree: discipline › plug-in › part type – for example Ventilation › Ducts.
  2. Click the template. Below the tree you see its content (lines separated by "|"), what it applies to ("applies to: Ventilation: Duct") and – if it is not the default style of the discipline – its annotation style. The status line names the choice.
  3. Annotate now uses this template. A double-click on the template starts Annotate right away.

Options

Video coming soon: Choosing a template

Searching and filtering

Goal: quickly find the right one among many templates.

  1. Type part of the name into the search box above the tree – for example "slope". It searches name, content, description and folder; case does not matter. While searching all folders are open.
  2. Below it choose a part type under applies to – for example "Duct". The tree only shows templates that apply to this part type (and those that apply to everything). "Other objects (lines, blocks …)" shows the templates for objects that are not from LuaCAD.
  3. Clearing the search box or choosing "all part types" shows everything again.

The "applies to" choice is remembered. If no template matches, the tree is empty except for "Automatic".

Video coming soon: Searching and filtering

Automatic

Goal: give every part its usual annotation without thinking about it.

  1. Click Automatic in the tree (at the top, in italics).
  2. Annotate and click a part – LuaCAD takes the first matching template:
    • first the templates of the part's plug-in, then the general ones, then the rest;
    • for Piping the copy of the discipline of the system (a pipe with a heating system gets the template under Heating and with it the heating layer);
    • among the default templates the first choice of the part type: on a pipe "System and size", on a fitting "Fitting and nominal size", on a valve "Valve and nominal size", on a duct "Duct dimensions", on a drain line "Nominal size and slope";
    • if you took another template on a part of the same plug-in in this session, that one comes first.
  3. In step 2 at the cursor the Template option switches to another matching one.
Video coming soon: Automatic

The template editor

Goal: look at a template, change it or create a new one.

The template editor "Annotation - Annotation templates": at the left the template tree with New, Copy, Delete, Import, Export (1), in the middle at the top the default note, name, folder, form, leader (2), content (3), preview with sample values (4), collapsed Appearance, Elevation reference, Advanced, Filter (5), at the right the properties with Search, Insert, Calculate … (6), OK / Cancel (7)
The template editor "Annotation - Annotation templates": at the left the template tree with New, Copy, Delete, Import, Export (1), in the middle at the top the default note, name, folder, form, leader (2), content (3), preview with sample values (4), collapsed Appearance, Elevation reference, Advanced, Filter (5), at the right the properties with Search, Insert, Calculate … (6), OK / Cancel (7)
  1. In the palette select the template you want to change (or any one in the folder where a new one should go).
  2. Click Edit / add template (or gear › Design templates …). The editor opens on this template.
  3. In the middle at the top change name, folder, form, leader and the content; the preview shows the result at once on a part of the drawing (list above it) or with sample values.
  4. Below, expand the collapsed sections as needed: Appearance (annotation style), Elevation reference, Advanced, Filter. Collapsed, the header names the state ("Standard", "absolute", "applies everywhere" …).
  5. OK saves all changes of all templates; the command line says that they apply to new annotations. Cancel discards everything.

Options

Every field of the editor: Template editor in detail.

Video coming soon: The template editor

Creating a new template

Goal: a template of your own, for example "Pipe with room" for the site management.

  1. In the editor at the bottom left New – this creates "New annotation" with the content {Bezeichnung}, form with frame, applies to everything, in the selected folder (otherwise under Custom). Or Copy: a copy of the selected template ("… copy") in the same folder.
  2. Give it a name – it must be unique.
  3. Choose the folder or type a new path with "/" between the parts (for example "Plumbing/Site"); Enter or leaving the field applies it, the tree shows the template there.
  4. Set content, form, filter etc., OK.

Delete asks for confirmation for a template of your own (annotations using it keep their content); an unchanged default template cannot be deleted.

Video coming soon: A new template

Content with fields

Goal: decide which text goes onto the part.

Picture coming soonThe editor, detail: the content box with two lines: system with nominal size, and the length in meters (1), at the right the property list with "Length" selected (2), Insert (3), the preview "CW DN 25 / L = 2.50 m" (4), below it the gray note about sample values (5)
  1. Write into the content box. Every line becomes a line of the annotation.
  2. Insert a field: search the properties at the right (name or key), double-click or ← Insert – the field goes to the cursor position. At the top of the list are the values the plug-in calculates on the part ("calculated on the part": slope, spot elevation …), the elevation of the arrowhead and the elevation reference as text.
  3. Append a format: {Laenge:m:2} = meters with 2 decimals, {Daemmdicke:mm:0} = mm without decimals.
  4. Put optional parts into {? …}: {? ({Daemmdicke:mm:0})} only appears with insulation.
  5. Check the preview: choose a matching part of the drawing above it. Sample values are shown gray and in italics – for fields the part does not provide or that only exist in the drawing (slope, spot elevation); below is the note which ones.

Options

Video coming soon: Content with fields

Calculate

Goal: have a value calculated, for example the length in meters or the height of a part.

  1. In the editor click the position in the content, then Calculate … at the right.
  2. In the dialog box build the expression from the properties and choose the format; the trial shows the value on the selected sample part.
  3. OK – the field goes to the cursor position as {=expression:format}, for example {=Laenge/1000:0.00}, {=HoeheOK-HoeheUK} or {=Gewicht*Anzahl}.
Video coming soon: Calculate

Form and leader

Goal: show the annotation in a frame, in a circle or as text only.

The same annotation on a pipe in three forms: with frame (1), no leader – the masked text interrupts the line (2), circle (3)
The same annotation on a pipe in three forms: with frame (1), no leader – the masked text interrupts the line (2), circle (3)
  1. In the editor choose under Form: text with leader · no leader · with frame · box · circle · divided circle · circle, no leader.
  2. For a form with a visible leader choose under Leader: landing at left, text at right or single vertical line, centered. With "no leader", "box" and "circle, no leader" the choice is gray.
  3. The preview shows frame or circle.

What each form means: Forms and Leader. A single placed annotation gets another form in Edit annotation.

Video coming soon: Form and leader

Elevation reference of a template

Goal: decide what the elevations of a template are measured from.

The editor with the Elevation reference section expanded: reference with "i", here "absolute (from project zero)" (1), Show plus sign (2), reference level and level – grayed out while the reference is absolute (3)
The editor with the Elevation reference section expanded: reference with "i", here "absolute (from project zero)" (1), Show plus sign (2), reference level and level – grayed out while the reference is absolute (3)
  1. In the editor expand Elevation reference.
  2. Choose the reference: absolute (from project zero) · from home level · from level (empty = level of the drawing) · above sea level.
  3. For a level reference choose the reference level (TOS, FF, FC, BOS or one of the project's own); for a fixed level the level (abbreviation; empty = the level of the drawing).
  4. For "above sea level" enter the sea level elevation of ±0 (in m for a mm drawing) – the template shows Z plus this value, followed by "a.s.l.".
  5. Show plus sign: values above the reference level with "+".

The reference applies to the elevation fields {HoeheUK}, {HoeheAchse}, {HoeheOK}, {HoeheSohle} and {Punkt.Z}; {HoeheBezug} writes it as text. In the preview the elevation is taken at the middle of the part, in the drawing at the arrowhead. The supplied elevation templates exist four times per discipline (absolute, from level, from home level, above sea level) – see Elevations and spot elevations.

Video coming soon: Elevation reference of a template

Only if and Part removed

Goal: allow an annotation only on certain parts and decide what happens to it when its part is deleted.

  1. In the editor expand Advanced.
  2. Only if … is filled: required fields, separated by commas (for example Position). If one of them is empty on the part, it does not get this annotation – not with Multiple either. Empty = always.
  3. Part removed: mark (own layer, not plotted) – the annotation goes on the layer "Orphaned annotation", Check shows it, Reassign attaches it again – or delete: it goes along with the part (for example the room tag of the floor heating).
Video coming soon: Only if and part removed

Filter: what the template applies to

Goal: offer a template only for the parts it fits.

The editor with the Filter section expanded: plug-in, here "Piping 2D" (1), search with "i" (2), the list to check, at the top "everything (every part, every object)" (3)
The editor with the Filter section expanded: plug-in, here "Piping 2D" (1), search with "i" (2), the list to check, at the top "everything (every part, every object)" (3)
  1. In the editor expand Filter.
  2. Plug-in: under which plug-in the template appears in that plug-in's lists (Annotate and Multiple of a plug-in show by default only its templates and the general ones).
  3. Check in the list what it applies to: everything, per plug-in all parts or single part types ("Piping: Pipe", "Ventilation: Duct" …), other objects by object type (LINE, LWPOLYLINE, INSERT, 3DSOLID …). Narrow the list with search.
  4. Nothing checked = applies everywhere.

The part types of the list come from all templates and from the parts of the drawing – a part type the drawing does not have yet only appears once such a part exists or a template names it.

Video coming soon: Filter of a template

Sharing templates: import and export

Goal: bring your own templates to another computer or to the whole office.

  1. In the editor select the template, Export – save a template file.
  2. On the other computer Import in the editor, choose the file. If the name already exists, the new one gets a number added.
  3. OK saves.

All settings including templates also go along with LuaCAD settings › "Export settings …" – see Transferring settings.

Video coming soon: Import and export