Working with Text Objects on a Schematic in Altium Designer

A placed Text String

Summary

A text string (also referred to as an annotation) is a non-electrical drawing primitive. It is a single line of free text that can be placed on a schematic sheet. Uses might include section headings, revision history, timing information,or some other descriptive or instructive text.

Availability

Text strings are available for placement in both the Schematic and Schematic Library editor using the following commands:

• Choosing Place » Text String from the main menus.
• Click the Text String button () in the graphic objects drop-down on the Active Bar located at the top of the design space. (Click and hold an Active Bar button to access other related commands. Once a command has been used, it will become the top-most item on that section of the Active Bar.)
• Right-click in the design space then choose Place » Text String from the context menu.
• Clicking the  button on the Utility Tools drop-down () of the Utilities toolbar.

Placement

After launching the command, the cursor will change to a cross-hair and you will enter text string placement mode. A text string will appear floating on the cursor.

1. Position the object then click or press Enter to effect placement.
2. Continue placing further text strings or right-click or press Esc to exit placement mode.

Additional actions that can be performed during placement are:

• Press the Tab key to pause the placement and access the Text mode of the Properties panel from where its properties can be changed on the fly. Click the design space pause button overlay () to resume placement.
• Press the Alt key to constrain the direction of movement to the horizontal or vertical axis depending on the initial direction of movement.
• Press the Spacebar to rotate the text string counterclockwise or Shift+Spacebar for clockwise rotation. Rotation is in increments of 90°.
• Press the X or Y keys to mirror the text string along the X-axis or Y-axis.

Graphical Editing

This method of editing allows you to select a placed text string object directly in the design space and change its location graphically. Text strings can only be adjusted with respect to their size by changing the size of the font used (accessed through the Properties panel). As such, editing handles are not available when the text string object is selected as shown below:

A selected Text String

• Click anywhere inside the dashed box and drag to reposition the text string as required. While dragging, the text string can be rotated (Spacebar/Shift+Spacebar) or mirrored (X or Y keys to mirror along the X-axis or Y-axis).
• The text for a text string object can be edited in-place by:
  1. Single-clicking the text string to select it.
  2. Single-clicking again (or pressing Enter) to enter the in-place editing mode. Sufficient time between each click should be given to ensure the software does not interpret the two single-clicks as one double-click (which would open the Text dialog or the Properties panel).
  3. To finish editing in-place text, press Enter or use the mouse to click away from the text string.

Non-Graphical Editing

The following methods of non-graphical editing are available.

Editing via the Text Dialog or Properties Panel

Panel page: Text String Properties

This method of editing uses the associated Text dialog Properties panel mode to modify the properties of a text string object.

 The Text dialog, on the left, and the Text mode of the Properties panel on the right

After placement, the Text dialog can be accessed by:

• Double-clicking on the placed text object.
• Placing the cursor over the text object, right-clicking then choosing Properties from the context menu.

During placement, the Text mode of the Properties panel can be accessed by pressing the Tab key. Once the text is placed, all options appear.

After placement, the Text mode of the Properties panel can be accessed in one of the following ways:

• If the Properties panel is already active, by selecting the text object.
• After selecting the text object, select the Properties panel from the Panels button at the bottom right of the design space or select View » Panels » Properties from the main menu.

Editing Multiple Objects

The Properties panel supports multiple object editing, where the property settings that are identical in all currently selected objects may be modified. When multiples of the same object type are selected manually, via the  Find Similar Objects dialog or through a Filter or List panel, a Properties panel field entry that is not shown as an asterisk (*) may be edited for all selected objects.

Editing via a List Panel

Panel pages: SCH List, SCHLIB List, SCH Filter, SCHLIB Filter

A List panel allows you to display design objects from one or more documents in tabular format, enabling quick inspection and modification of object attributes. Used in conjunction with appropriate filtering - by using the applicable Filter panel or the Find Similar Objects dialog - it enables the display of just those objects falling under the scope of the active filter – allowing you to target and edit multiple design objects with greater accuracy and efficiency.

Schematic Editor object properties are definable options that specify the visual style, content and behavior of the placed object. The property settings for each type of object are defined in two different ways:

• Pre-placement settings – most Text String object properties, or those that can logically be pre-defined, are available as editable default settings on the Schematic - Defaults page of the Preferences dialog (access from the  button at the top-right of the design space). Select the object in the Primitive List to reveal its options on the right.

• Post-placement settings – all Text String object properties are available for editing in the Text String dialog and the Properties panel when a placed Text String is selected in the design space.

Location (Properties panel only)

• (X/Y)
  • X (first field) - the current X (horizontal) coordinate of the reference point of the object, relative to the current design space origin. Edit to change the X position of the object. The value can be entered in either metric or imperial; include the units when entering a value whose units are not the current default. 
  • Y (second field) - The current Y (vertical) coordinate of the reference point of the object, relative to the current origin. Edit to change the Y position of the object. The value can be entered in either metric or imperial; include the units when entering a value whose units are not the current default. 
• Rotation - use the drop-down to select the rotation.

Properties 

• Text - use the drop-down to select or enter the desired text.
• URL - the URL for the text string, if desired.
• Font - use the controls to select the desired font, font size, color, and attributes to bold, italicize, etc., if desired.
• Justification - select the justification by clicking on an arrow that corresponds with the desired justification or the circle (to center).

A placed Text Frame

Summary

A text frame is a non-electrical drawing primitive that is used to define an area on a schematic to contain textual information. The frame is a re-sizeable rectangular area that can contain multiple lines of text and can automatically wrap and clip text to keep it within the bounds of the frame.

Availability

Text frames are available for placement in both the Schematic and Schematic Library editor using the following commands:

• Choose Place » Text Frame from the main menus.
• Click the Text Frame button () in the graphic objects drop-down on the Active Bar located at the top of the design space. (Click and hold an Active Bar button to access other related commands. Once a command has been used, it will become the top-most item on that section of the Active Bar.)
• Right-click in the design space then choose Place » Text Frame from the context menu.
• Click the  button on the Utility Tools drop-down () of the Utilities toolbar.

Placement

After launching the command, the cursor will change to a cross-hair and you will enter text frame placement mode. Placement is made by performing the following sequence of actions:

1. Position the cursor and click or press Enter to anchor the first corner of the text frame.
2. Move the cursor to adjust the size of the text frame then click or press Enter to complete placement.
3. Continue placing further text frames or right-click or press Esc to exit placement mode.

Additional actions that can be performed during placement while the text frame is still floating on the cursor and before its first corner is anchored are:

• Press the Tab key to pause the placement and access the Text Frame mode of the Properties panel from where its properties can be changed on the fly. Click the design space pause button overlay () to resume placement.
• Press the Alt key to constrain the direction of movement to the horizontal or vertical axis depending on the initial direction of movement.
• Press the Spacebar to rotate the text frame counterclockwise or Shift+Spacebar for clockwise rotation. Rotation is in increments of 90°.
• Press the X or Y keys to mirror the text frame along the X-axis or Y-axis.

Graphical Editing

This method of editing allows you to select a placed text frame object directly in the design space and change its size, shape or location graphically.

When a text frame object is selected, the following editing handles are available:

A selected Text Frame.

• Click and drag A to resize the text frame in the vertical and horizontal directions simultaneously.
• Click and drag B to resize the text frame in the vertical and horizontal directions separately.
• Click anywhere on the text frame away from editing handles then drag to reposition it. While dragging, the text frame can be rotated (Spacebar/Shift+Spacebar) or mirrored (X or Y keys to mirror along the X-axis or Y-axis).

The textual content of a text frame can be edited in-place by:

1. Single-clicking the text frame to select it.
2. Single-clicking again (or pressing Enter) to enter the in-place editing mode. Sufficient time between each click should be given to ensure the software does not interpret the two single-clicks as one double-click (which would open the Properties panel).
3. To finish editing in-place text, either click away from the text frame or press the green tick button (). If you decide the change made is not needed, press the red cross button () to discard the change.

Example of in-place editing, with word wrapping enabled (top) and disabled (bottom).

Non-Graphical Editing

The following methods of non-graphical editing are available.

Editing via the Text Frame Dialog or Properties Panel

Panel page: Text Frame Properties

This method of editing uses the associated Text Frame dialog and the Properties panel mode to modify the properties of a text frame object.

The Text Frame dialog, on the left, and the Text Frame mode of the Properties panel on the right

After placement, the Text Frame dialog can be accessed by:

• Double-clicking on the placed text frame object.
• Placing the cursor over the text frame object, right-clicking, then choosing Properties from the context menu.

During placement, the Text Frame mode of the Properties panel can be accessed by pressing the Tab key. Once the text frame is placed, all options appear.

After placement, the Text Frame mode of the Properties panel can be accessed in one of the following ways:

• If the Properties panel is already active, by selecting the text frame object.
• After selecting the text frame object, select the Properties panel from the Panels button at the bottom right of the design space or select View » Panels » Properties from the main menu.

Editing Multiple Objects

The Properties panel supports multiple object editing, where the property settings that are identical in all currently selected objects may be modified. When multiples of the same object type are selected manually, via the  Find Similar Objects dialog or through a Filter or List panel, a Properties panel field entry that is not shown as an asterisk (*) may be edited for all selected objects.

Wrapping and Clipping Text

In addition to providing a Word Wrap option, the Text Frame mode of the Properties panel provides a Clip to Area option. This option comes into play if word wrapping is disabled. With this option enabled, text will be kept within the bounds of the frame. When disabled, text will spill out of the frame onto the schematic sheet.

Specifying Text Margins

Specify a single value to apply equally to left, top, right, and bottom margins for the current frame using the Text Margin property in the Properties panel.

When editing text in place directly within the text frame (as opposed to using the Properties panel), the defined margins are not present. They will be reapplied after editing is complete and the text changes are applied.

Editing via a List Panel

Panel pages: SCH List, SCHLIB List, SCH Filter, SCHLIB Filter

A List panel allows you to display design objects from one or more documents in tabular format, enabling quick inspection and modification of object attributes. Used in conjunction with appropriate filtering - by using the applicable Filter panel, or the Find Similar Objects dialog - it enables the display of just those objects falling under the scope of the active filter – allowing you to target and edit multiple design objects with greater accuracy and efficiency.

Notes

• While text frames can be rotated or mirrored along the X or Y axis, this has no effect on the orientation of the text within.
• For simple one-line text annotations, consider using the Text String object.
• Special strings and formulas are supported for Text Frames. Special strings and formulas are delineated by opening with the "=" character and closing with a space character.
• Component designators and net names can function as Active Links in a Text Frame, precede the designator or net name with the @ symbol to invoke linking mode, then select the required designator/net object. Learn more about Active Links.

Schematic editor object properties are definable options that specify the visual style, content and behavior of the placed object. The property settings for each type of object are defined in two different ways:

• Pre-placement settings – most Text Frame object properties, or those that can logically be pre-defined, are available as editable default settings on the Schematic - Defaults page of the Preferences dialog (accessed from the  button at the top-right of the design space). Select the object in the Primitive List to reveal its options on the right.

• Post-placement settings – all Text Frame object properties are available for editing in the Text Frame dialog and the Properties panel when a placed Text Frame is selected in the design space.

Location (Properties panel only)

• (X/Y)
  • X (first field) - the current X (horizontal) coordinate of the reference point of the object, relative to the current design space origin. Edit to change the X position of the object. The value can be entered in either metric or imperial; include the units when entering a value whose units are not the current default. 
  • Y (second field) - The current Y (vertical) coordinate of the reference point of the object, relative to the current origin. Edit to change the Y position of the object. The value can be entered in either metric or imperial; include the units when entering a value whose units are not the current default. 

Properties

• Text - enter the desired text.
  To add a new line of text, use Ctrl+Enter, Shift+Enter, or Alt+Enter.
  Special strings and formulas are supported in the Text region. Special strings and formulas are delineated by opening with the "=" character and closing with a space character.

A placed Note

Summary

A note is a non-electrical drawing primitive. It is used to add informational or instructional text to a specific area within a schematic similar to that of commenting a program's source code. The note is a resizable rectangular area that can contain multiple lines of text and can automatically wrap and clip text to keep it within the bounds of the note.

Availability

Notes are available for placement in the Schematic Editor only in the following ways:

• Choose Place » Note from the main menus.
• Click the Note button () in the graphic objects drop-down on the Active Bar located at the top of the design space. (Click and hold an Active Bar button to access other related commands. Once a command has been used, it will become the top-most item on that section of the Active Bar.)
• Right-click in the design space then choose Place » Note from the context menu.

Placement

After launching the command, the cursor will change to a cross-hair and you will enter note placement mode. Placement is made by performing the following sequence of actions:

1. Click or press Enter to anchor the first corner of the note.
2. Move the cursor to adjust the size of the note then click or press Enter to complete placement.
3. Continue placing further notes or right-click or press Esc to exit placement mode.

Additional actions that can be performed during placement while the note is still floating on the cursor and before its first corner is anchored are:

• Press the Tab key to pause the placement and access the Note mode of the Properties panel from where its properties can be changed on the fly. Click the design space pause button overlay () to resume placement.
• Press the Spacebar to rotate the object counterclockwise or Shift+Spacebar for clockwise rotation. Rotation is in increments of 90°.
• Press the X or Y keys to mirror the note along the X-axis or Y-axis.

Graphical Editing

This method of editing allows you to select a placed note object directly in the design space and change its size, shape or location graphically.

A note can be displayed in either expanded (full frame) or collapsed (small triangle) modes. Toggle the display mode by clicking on the top left corner of a placed note.

Click the triangle in the top-left corner to collapse a note.

When a fully expanded note object is selected, the following editing handles are available:

A selected Note (fully expanded).

• Click and drag A to resize the note in the vertical and horizontal directions simultaneously.
• Click and drag B to resize the note in the vertical and horizontal directions separately.
• Click anywhere on the note away from editing handles then drag to reposition it. While dragging, the note can be rotated (Spacebar/Shift+Spacebar) or mirrored (X or Y keys to mirror along the X-axis or Y-axis).

When a note is fully expanded, the textual content of that note can be edited in-place by:

1. Single-clicking the note to select it.
2. Single-clicking again (or pressing Enter) to enter the in-place editing mode. Sufficient time between each click should be given to ensure the software does not interpret the two single-clicks as one double-click (which would open the Properties panel).
3. To finish editing in-place text, either click away from the note or press the green tick button (). If you decide the change made is not needed, press the red cross button () to discard the change.

Examples of in-place editing, with word wrapping enabled (top) and disabled (bottom).

The size and shape of a note cannot be changed graphically when it is in collapsed mode; only its location/orientation can be changed. As such, editing handles are not available when a collapsed note object is selected.

A selected Note (collapsed)

Click anywhere inside the dashed box and drag to reposition the note as required. The note can be rotated or mirrored while dragging.

When a note is in collapsed mode, hover the cursor over it to access a pop-up containing the name of the note's author and the actual text content of the note.

Hover over a collapsed note to display information.

Non-Graphical Editing

The following methods of non-graphical editing are available.

Editing via the Note Dialog or Properties Panel

Properties page: Note Properties

This method of editing uses the associated Note dialog and the Properties panel mode to modify the properties of a note object.

 The Note dialog (the first image) and the Note mode of the Properties panel (the second image)

After placement, the Note dialog can be accessed by:

• Double-clicking on the placed Note object.
• Placing the cursor over the Note object, right-clicking then choosing Properties from the context menu.

During placement, the Note mode of the Properties panel can be accessed by pressing the Tab key. Once the Note is placed, all options appear.

After placement, the Note mode of the Properties panel can be accessed in one of the following ways:

• If the Properties panel is already active, by selecting the Note object.
• After selecting the Note object, select the Properties panel from the Panels button at the bottom right of the design space or select View » Panels » Properties from the main menu.

Editing Multiple Objects

The Properties panel supports multiple object editing, where the property settings that are identical in all currently selected objects may be modified. When multiples of the same object type are selected manually, via the  Find Similar Objects dialog or through a SCH Filter or SCH List panel, a Properties panel field entry that is not shown as an asterisk (*) may be edited for all selected objects.

Wrapping and Clipping Text

In addition to providing a Word Wrap option, the Properties panel provides a Clip to Area option. This option comes into play if word wrapping is disabled. With this option enabled, text will be kept within the bounds of the note's frame. When disabled, text will spill out of the frame onto the schematic sheet.

Example of word wrapping and the effect of clipping

Specifying Text Margins

Specify a single value to apply equally to Left, Top, Right, and Bottom margins for the current note using the Text Margin in the Properties panel.

Example note with a Text Margin setting of 20 (Default DXP Units, equivalent to 200mil).

When editing text in place directly within the note's frame, the defined margins are not present. They will be reapplied after editing is complete and the text changes are applied.

Margins are not shown while graphically modifying the text in place.

Editing via a List Panel

Panel pages: SCH List, SCH Filter

A List panel allows you to display design objects from one or more documents in tabular format, enabling quick inspection and modification of object attributes. Used in conjunction with appropriate filtering - by using the SCH Filter panel or the Find Similar Objects dialog - it enables the display of just those objects falling under the scope of the active filter – allowing you to target and edit multiple design objects with greater accuracy and efficiency.

Notes

• While Notes can be rotated or mirrored along the X or Y axis, this has no effect on the orientation of the text within.
• Special strings and formulas are supported for Notes. Special strings and formulas are delineated by opening with the "=" character and closing with a space character.
• Component designators and net names can function as Active Links in a Text Frame, precede the designator or net name with the @ symbol to invoke linking mode, then select the required designator/net object. Learn more about Active Links.

Schematic editor object properties are definable options that specify the visual style, content and behavior of the placed object. The property settings for each type of object are defined in two different ways:

• Pre-placement settings – most Note object properties, or those that can logically be pre-defined, are available as editable default settings on the Schematic - Defaults page of the Preferences dialog (accessed from the  button at the top-right of the design space). Select the object in the Primitive List to reveal its options on the right.

• Post-placement settings – all Note object properties are available for editing in the Note dialog and the Properties panel when a placed Note is selected in the design space.

Location (Properties panel only)

• (X/Y)
  • X (first field) - the current X (horizontal) coordinate of the reference point of the object, relative to the current design space origin. Edit to change the X position of the object. The value can be entered in either metric or imperial; include the units when entering a value whose units are not the current default. 
  • Y (second field) - The current Y (vertical) coordinate of the reference point of the object, relative to the current origin. Edit to change the Y position of the object. The value can be entered in either metric or imperial; include the units when entering a value whose units are not the current default. 

Properties

• Text - enter the desired text of the note.
  • Word Wrap - check to enable word wrapping.
  • Clip to Area - enable to clip text to the area.
  Special strings and formulas are supported in the Text region. Special strings and formulas are delineated by opening with the "=" character and closing with a space character. 
• Font - use the controls to define the font, size, and color, as well as bolding, italics, etc.
• Alignment - click the desired text alignment.
• Text Margin - enter the desired text margin.
• Width - enter the desired width.
• Height - enter the desired height.
• Border - check to enable a border. Use the drop-down to select the default from the available choices: Smallest, Small, Medium, and Large. Click on the color box to access a drop-down from which you can select the default color.
• Fill Color - click on the color box to access a drop-down from which you can select the default color.
• Author - enter the desired author.
  • Collapsed - enable to collapse the note.

The following are the predefined special strings available for use on a schematic document. The majority of these link to default parameter information defined for the active document on the Parameters tab of the Properties panel in Document Options mode (no objects selected).

• =Address1 – displays the value specified for the default document-level parameter Address1.
• =Address2 – displays the value specified for the default document-level parameter Address2.
• =Address3 – displays the value specified for the default document-level parameter Address3.
• =Address4 – displays the value specified for the default document-level parameter Address4.
• =Application_BuildNumber – displays the version and build for the current Altium Designer installation.
• =ApprovedBy – displays the value specified for the default document-level parameter ApprovedBy.
• =Author – displays the value specified for the default document-level parameter Author.
• =CheckedBy – displays the value specified for the default document-level parameter CheckedBy.
• =CompanyName – displays the value specified for the default document-level parameter CompanyName.
• =CurrentDate – the current date, presented in the current Windows Regional Settings Short Date format, updated upon editing the schematic or on refresh/redraw. Example: 22/09/2015.
• =CurrentTime – the current time, presented in the current Windows Regional Settings Long Time format, updated upon editing the schematic or on refresh/redraw. Example: 2:39:47 PM.
• =Date – used to display static, user-defined date information. Displays the value specified for the default document-level parameter Date. Unlike the =CurrentDate special string, which is automatically calculated and presented in a set format, you can enter static date information in any format you prefer.
• =DocumentFullPathAndName – used to display the full path and name of the document into which the string is placed. Example: C:\MyTestDesign\PSU.SchDoc.
• =DocumentName – used to display the schematic's file name only (without the file path). Example: PSU.SchDoc.
• =DocumentNumber – displays the value specified for the default document-level parameter DocumentNumber. The source parameter can also be updated through the Sheet Numbering For Project dialog when using the Tools » Annotation » Number Schematic Sheets command.
• =DrawnBy – displays the value specified for the default document-level parameter DrawnBy.
• =Engineer – displays the value specified for the default document-level parameter Engineer.
• =ImagePath – displays the value specified for the default document-level parameter ImagePath.
• =Item – the Item that the generated data relates to (e.g., D-810-2000). The data will be used to build that Item.
• =ItemAndRevision – the Item and specific revision of that Item to which the generated data relates in the format <Item ID>-<Revision ID> (e.g. D-810-2000-01.A.1). The data will be used to build that specific revision of that particular Item.
• =ItemRevision – the specific revision of the Item to which the generated data relates (e.g., 01.A.1). The data is stored in that Item Revision within the target Workspace.
• =ItemRevisionBase – the Base Level portion of an Item Revision's naming scheme (e.g., 1).
• =ItemRevisionLevel1 – the Level 1 portion of an Item Revision's naming scheme (e.g., A).
• =ItemRevisionLevel1AndBase – the Level 1 and Base Level portions of an Item Revision's naming scheme (e.g., A.1).
• =ItemRevisionLevel2 – the Level 2 portion of an Item Revision's naming scheme (e.g., 01).
• =ItemRevisionLevel2AndLevel1 – the Level 2 and Level 1 portions of an Item Revision's naming scheme (e.g., 01.A).
• =ModifiedDate – the modified date stamp of the schematic; it is automatically populated. Example: 23/09/2015.
• =Organization – displays the value specified for the default document-level parameter Organization.
• =PCBConfigurationName – the name of the data set from which the output has been generated as defined in the Release view (Project Releaser).
• =ProjectName – displays the actual name of the project (including extension). For example, for a project with filename MyPCB.PrjPcb, this special string will display MyPCB.PrjPcb.
• =Revision – displays the value specified for the default document-level parameter Revision.
• =SheetNumber – the sheet number of the current schematic. This value is calculated when using the following commands from the Tools menu:
  • Number Schematic Sheets – the assigned sheet number in the Sheet Numbering For Project dialog will be entered into the value for the default document-level parameter SheetNumber. The special string, when used on the Editor tab view of the schematic sheet, will source its information from here.
  • Annotate Compiled Sheets – the assigned compiled sheet number in the Annotate Compiled Sheets dialog will be displayed when viewing the string on the Compiled tab view of the schematic. The option to display the expanded compiled names of the Sheet Number object must be enabled in the Compiled Names Expansion region on the Schematic – Compiler page of the Preferences dialog.
• =SheetSymbolDesignator – the designator of the associated Sheet Symbol object that is placed on the parent schematic sheet. This special string can also be used in a multi-channel design. Select a compiled tab of the child schematic sheet to display the converted value of the special string.
• =SheetTotal – the sheet total for the project. This value is calculated when using the following commands from the Tools menu:
  • Number Schematic Sheets – the sheet total in the Sheet Numbering For Project dialog will be entered into the value for the default document-level parameter SheetTotal. The special string, when used on the Editor tab view of the schematic sheet, will source its information from here.
  • Annotate Compiled Sheets – the sheet total, sourced from the number of sheets listed in the Annotate Compiled Sheets dialog, will be displayed when viewing the string on the Compiled tab view of the schematic. The option to display the expanded compiled names of the Sheet Number object must be enabled in the Compiled Names Expansion region on the Schematic – Compiler page of the Preferences dialog.
• =Time – used to display user-defined static time information. Displays the value specified for the default document-level parameter Time. Unlike the =CurrentTime special string, which is automatically calculated and presented in a set format, you can enter static time information in any format you prefer.
• =Title – displays the value specified for the default document-level parameter Title.
• =VariantName - displays the variant from which output has been generated. This follows the entry for the current variant (presented and changed through the Variants toolbar). If the base design is used to generate the output, the value will be [No Variations].
• =VersionControl_ProjFolderRevNumber – the current revision number of the Project, which is incremented whenever a full commit of the project (i.e. including the project file) is performed. Version control must be used for this string to contain any information.
• =VersionControl_ProjFolderRevNumberShort – a short Git hash format (the first eight characters) of the Project. Version control must be used for this string to contain any information.
• =VersionControl_RevNumber – the current revision number of the document. Version control must be used for this string to contain any information.
• =VersionControl_RevNumberShort – a short Git hash format (the first eight characters) of the current revision number of the document. Version control must be used for this string to contain any information.

Special Strings for use with Component Parameters

Several additional special strings (or special interpretations of existing ones) are available when defining component parameters using Text Strings. In each case, the special string is entered as the value for a parameter.

• =CurrentFootprint – displays the name of the currently assigned footprint for the component.
• =Comment – displays the value appearing in the component's Comment field.
• =Description – displays the value appearing in the component's Description field.
• =<ParameterName> – displays the value defined for a specified component parameter. Enter the actual name of a component parameter as the special string name. For example, for a component parameter named PowerRating, enter =PowerRating. When defining the Comment property for a component, use of such a special string will enable quick use of any defined parameters' value for the Comment.