Drawing Annotation

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

 

Parent page: Streamlining Board Design Documentation with Draftsman

Draftsman provides a range of additional drawing and annotation tools designed to add important information to a Draftsman drawing document. These include both automated note and highlighting systems.

The Active Bar (positioned at the top of the design space) offers a range of drop-down menus that include placement commands for all Annotation objects.

Annotation placement commands are also available from Draftsman's main Place menu, or from the Drawing Annotations toolbar – View » Toolbars » Drawing Annotations.

Callout

A Draftsman document Callout is a graphic pointer that can be placed in a document to provide information about a specific drawing location or object. The information associated with a Callout may be custom text or data sourced from a BOM entry, a Note item, a component Parameter, a board Region, or a via structure. Its drawing style and information source are configurable in the Properties panel. Callouts can have one or more pointers to source points.

Several Callouts of different types placed on a Board Assembly View.
Several Callouts of different types placed on a Board Assembly View.

To place a Callout, select Place » Annotations » Callout from the main menu or the  icon from the Active Bar dropdown.

  1. When the command is launched, the cursor will change to a crosshair indicating Callout placement mode. Position the cursor in the drawing space to choose between the two Callout placement types as indicated by the cursor highlighting:
    • Object Callout – when the cursor highlights a side or corner of an object outline (such as the perimeter of a drawing view or component), the placed Callout will be 'attached' to that specific object.
    • General Callout – when there is no highlighting at the cursor, the placed Callout simply refers to that location, rather than an object.
  2. Click to place the Callout pointer at the desired location, as determined above.
  3. Move the cursor to a suitable position for the Callout Source Text and click to confirm the placement.
  4. Callouts support multiple sources. After placing the Callout's Source Text position you can move and click again to identify as many other Source locations as required.
  5. Once the required number of Sources have been defined, right-click to complete the placement of this Callout. You remain in Callout placement mode.
  6. Repeat this sequence of steps to place another Callout, or right-click a second time to drop out of Callout placement mode.

Smart Callout text can be placed and configured to read the matching BOM entry for a component (or components), refer to an existing Note Item entry, or just display custom text.

By default, the pointer of placed object type Callout is a dot (positioned on an object outline), while the general type of Callout is indicated by an arrowed pointer. The 'head style' of these pointer ends can be changed in the Properties panel. Note that the Callout pointer line can include a GOST compliant mechanical attachment Symbol.

The information text that is shown at the end of the Callout (the Callout 'tag') is determined by the Source Text property options in the Properties panel. By default, an object type Callout will display its BOM entry; a general type Callout will show a custom text string, initially set to '?'.

If the Source Text setting in the Properties panel is not applicable to the type of Callout you have placed, its tag text will be shown as N/A. For example, if the Source Text is set to BOM for a General Callout (indicated by an arrow pointer), then the callout is referring to a general location, rather than to a BOM component. An Object type callout, which specifies a component, is required in this case.

The end position of a placed Callout may be graphically modified. Select a Callout to enable its end position editing handle, which can be dragged to a new location.

Drag a selected Callout's editing node to move its end point.
Drag a selected Callout's editing node to move its end point.

The starting/target point for a placed Callout can be moved to a new location through a drag and drop action. When moved, the starting node binds to the new object and causes the Callout data to update accordingly, as shown in this animated demonstration.

An existing Callout can have additional sources added and removed. Click to select the Callout, then right-click on it to display the context menu, as shown below. 

Callouts can reference multiple sources; if a specific source reference is selected then it can be deleted.
Callouts can reference multiple sources; if a specific source reference is selected then it can be deleted.

The context menu will include an Add Source command, and if it already has multiple sources defined and an individual source was selected when the right-click was performed, the menu will also include a Delete Source command. Note the Spacebar and Delete Source shortcuts, use these to quickly add and delete Sources to/from a Callout, respectively.

Solder and Glue joint Symbols

The GOST defined symbols for Soldered and Glued joints provide further mechanical information that can be included in Draftsman design production documents.

The symbols for indicating glued and soldered mechanical joints are governed by the GOST 2.313-82 drawing standard for mechanical connections, and are available as special options in Draftsman’s Callout object.

When a Callout has been placed to indicate a glued or soldered mechanical connection, the special symbols can be selected from the Symbol drop-down menu in the Properties panel.

This option is available only if the GOST 2.701-2008/2.106-1996 extension (shown below) is installed from the Extensions and Updates page.

The Symbols and options are defined as follows:

  • Gluing – indicates mechanical joint areas for gluing.
  • Soldering – indicates mechanical joint areas for soldering.
  • Processing of the contour option – check when a glue or solder joint seam is to be made in a closed area. Places a circle symbol at the end or elbow of the Callout line.

Center Mark

The Draftsman Center Mark is crosshair object that automatically locks to the radius origin of a Circle and Arc in a Draftsman document. A placed Center Mark is available as a reference location for placed dimensioning objects such as Linear and Ordinate dimensions.

To place a Center Mark, select Place » Annotations » Center Mark from the main menu or the  icon from the Active Bar dropdown. After launching the command, the cursor will change to a cross-hair and the editor will enter Center Mark placement mode. Placement is made by performing the following actions:

  1. Hover the cursor over a Circle or Arc outline, which will be highlighted (colored orange) as the Center Mark graphic snaps to the Circle/Arc radius center point.
  2. Click the Circle/Arc outline to confirm the placement of the Center Mark object.
  3. Continue placing further Center Marks or right-click or press Esc to exit placement mode.

Center Marks placed on a drawing document are available for dimension bindings. When placing Linear or Ordinate dimensions, select the highlighted dot at intersection of the Center Mark cross as a dimension reference node.

The line style and color of a Center Mark’s indicator cross are available as settings in the Properties panel. The panel also includes a marker Rotation property that can be used to document the angular placement of circles/arcs in a drawing. In this case, a placed Angular Dimension uses one line of a Center Mark cross as an angle dimension reference.

Select a Center Mark by clicking on the intersection of its cross-hairs. Once selected, an editing node is available at its center point.

A selected Center Mark
A selected Center Mark

Click and drag the Center Mark's node to move it to a Circle/Arc object in a different location. The Center Mark is attached to the target Circle/Arc in the same way as during its initial placement – hover then click on the Circle/Arc outline.

Surface Finish Indicator

Draftsman allows the placement of Surface Finish graphical symbols and their associated parameters that comply with the ISO 1302:2002 International Standard for surface texture in technical product documentation. The standard specifies the rules for the indication of surface texture in drawings, based on special symbols and attributes that describe the permitted surface material for the product – in this case, a printed circuit board.

The addition of Surface Finish indicators in Draftsman avoids the need for a separate Surface Finish tool or application when this standardized information is required for PCB manufacture. The graphical symbols are accompanied by a range specialized text codes, as defined by the ISO standard, that are added via the Draftsman Properties panel when a placed Surface Material object is selected.

The symbol style and text attributes for a placed Surface Finish object are configurable in the Properties panel.

A number of Surface Finish objects of different styles placed on a Board Fabrication View.
A number of Surface Finish objects of different styles placed on a Board Fabrication View.

To place a Surface Material symbol in a drawing, select Place » Annotations » Surface Finish from the main menu (or the  icon from the Active Bar). When the command is launched, the cursor will change to a crosshair indicating Surface Finish symbol placement mode. As the cursor is hovered over objects, the object edges will be highlighted as orange-colored lines.

To attach a Surface Finish symbol to a drawing object face:

  1. Position the cursor on a highlighted line then click to nominate that edge position.
  2. Move the cursor to specify the symbol orientation relative to the edge then click to confirm the placement.

To place a free Surface Finish symbol that is not attached to an object edge:

  1. Position the cursor in any position where an object edge is not highlighted.
  2. Click to confirm the placement.

The attached surface indicator can be dragged along the line, and optionally, away from the drawing via an automatic Extension Line – enabled by the With Leader option in the Properties panel. The information attributes that are associated with the Surface Finish symbol, as specified in the Properties panel, will refer to the object face to which it is attached. For a free Surface Finish symbol that is not attached to an object face, its information attributes specify the base, default requirements for all object faces. The panel's Allow Different Requirements option indicates that any attached symbols in the drawing may overrule those base requirements.

A Surface Finish indicator may also be placed in free space, and not attached to (or associated with) a specific drawing view surface – see the symbol styles information below.

In most cases only one or two surfaces need to be defined, such as the surface of the top and bottom layers, so a minimal number of symbols/attributes are usually required. However, the indicators may be applied to the face of any engineered object, including the surfaces of rendered components.

The style of the Surface Finish symbol itself indicates the allowed processing of the surface material, as follows:

  • Any manufacturing process permitted (default).
  • Material shall be removed.
  • Material shall not be removed.
  • A symbol enclosed in brackets is appended to the indicator when the panel's Allow Different Requirements option is checked. This style of Surface Finish indicator, which is placed in free space, specifies a default requirement for all surfaces unless otherwise specified (by other surface indicators that are attached to particular object faces/surfaces).

The string-based parameters (attributes) that are associated with the symbol indicate a range of manufacturing options, as defined by the standard:

  • First requirement (a)
  • Second requirement (b)
  • Manufacturing Method (c)
  • Surface Lay and Orientations (d)
    • Predefined options, with matching symbol graphics, as selected from the drop-down menu in Draftsman's Properties panel (default is None)
  • Machining Allowance (e)
By default, no parameters are included when a Surface Finish indicator is first placed. The default Surface Finish indicator settings can be edited in the Draftsman Preferences dialog – see the Surface Finish Sign section under Defaults.

The position and orientation of a placed Surface Finish may be graphically modified. Select a Surface Finish object to enable its editing modes:

  • For an attached symbol, click and drag its attachment point node to change the connection position.
  • For an attached symbol without an arrowed leader line, drag its mid-point node to invert the symbol orientation.
  • For a free (not attached) symbol, drag its node or the graphic itself to change its position.

Drag a selected Surface Finish symbol's editing nodes to move its position, orientation and connection point.
Drag a selected Surface Finish symbol's editing nodes to move its position, orientation and connection point.

Note

A Note object is an active text-based list that can be placed in a Draftsman document to provide additional and optionally targeted information that relates to drawing views.

The entries in a Note list can include Parameters that are available to the project document and individual list entries can be referred to by placed Callout objects. A Callout–Note reference behaves as an active link, and therefore, changes to the Note entry (such as its list number or border graphic) will be reflected in the Callout label.

The Note object's visual style and its list entries are configurable in the Properties panel.

Two Note objects in a drawing with example Callout objects that refer to Note list entries.
Two Note objects in a drawing with example Callout objects that refer to Note list entries.

To place a Note Item, select Place » Annotations » Note from the main menu or the  icon from the Active Bar, and then click to place the default Note entries in the drawing space. Select an entry in the list to edit its text content and number icon style in the Properties panel. Use the Add/Delete buttons to include and remove list entries, and configure the order of the text entries using the Up/Down buttons.

Select a single entry in a Note Item list to edit its content in the Properties dialog.
Select a single entry in a Note Item list to edit its content in the Properties dialog.

To use a Parameter in a Note entry, along with its related text, first select the relevant note entry and then the  icon in the Properties panel to open the Document Parameters dialog. Choose from the listed Parameters in the dialog and select OK to confirm the selection – the Parameter string will be inserted at the current cursor position within the Note Description text box.

Note that custom parameters can be added under the Properties panel Parameters tab when in Document Options mode (no drawing objects selected).

The position of a placed Note object may be graphically changed by selecting the table object in the design space then dragging it to a new location. To resize a selected Note object, drag any of its editing nodes to set the width – the list text will automatically wrap to remain constrained to the modified area.

Drag a selected Note object's node to resize the list.
Drag a selected Note object's node to resize the list.

When multiple Note objects are placed in a document, the list entry (element) numbering will sequentially flow from one list to the next based on the relative Note locations. The list entry numbering begins at the left-most Note object and, if necessary, will automatically re-order when a Note list is moved.
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Content