Using Libraries
January 2021
Circuit employs three forms of library...
Symbols - for storing your own created electrical symbols of components and equipment
Borders - for storing user created borders that can be used to unify and encapsulate your schematics with common images and global texts
Forms - for storing forms that can be automatically populate with list data, such as Component Lists
These libraries are nothing more than folders located somewhere readily on your file system.
Consider however, placing them in either a Cloud storage synchronised location*, or perhaps a Network shared drive that is backed up.
*Note: It's recommended that you turn off Sync when editing files in Circuit, as there is quite a lot of file saves carried out when the app is working.
Setting Library Paths
To initially set the paths to these folders choose Options > Set Path To > Symbols, Borders or Forms...
The Folder Browser dialogue will pop up and allow you to browse to the required folder, for example..
The recommendation would be you create a common high level folder, in the example above "XMLC", and then place all your library folders under that for ready access.
Once you have changed ANY library path, be sure to use the feature of Options > Update Libraries...
Finally, to see all library path locations at a glance choose Options > Environment...
For example...
Symbols Library
As with any designer or organisation, there will be many folders that logically group symbols by perhaps manufacturer, component type or product range, as examples.
Circuit doesn't attempt replicate the file storage solution your Windows Operating System already provides, so you can organise your symbols using Windows Explorer to meet your needs.
Circuit does however provide a "fast folder switching" method to enable you to change the Symbols Library quickly.
To see the current folder path hover over the Symbols node...
To fast switch the folder, single click the Symbols node to select it, then tap the right mouse button...
Browse to and choose the required folder, press [OK] to complete.
Symbol Preview
To preview any symbol simply click on it's name in the project explorer, for example...
Note: Symbols will save in the exact position you created them at. And when used in a project, they will be pasted into the target Sheet also at that exact position!
Using A Symbol
Using a Symbol means to take it from your library then apply it to a project Sheet.
There are different methods to accomplish this, for example, when you just previewed a symbol it's reference was automatically copied, see the Status Bar at the bottom of the app...
Now open in Edit Mode the Sheet in your project where you'd like to use that symbol, choose Symbol > Paste Symbol (or press ALT+P)...
You will be prompted to choose whether to include any parts data embedded in the symbol...
Press [Yes] or [No] as required, then the symbol will be pasted into its original position, and pre-selected so that you can then use the arrow keys to move it into final position.
Borders Library
When you create a Sheet and choose to save it as a Border, every entity on that Sheet will be saved (unlike Symbols where you would typically select a few entities on the Sheet).
Create the Border to suit the dimensions of the target Sheet Width and Sheet Height of the projects you intend to use it in.
When you're ready to save it as a border, ensure you are in Edit Mode, then choose Symbol > Create Border...
Once you have created one or more borders, be sure to use the Options > Update Libraries option to refresh the Borders Library node.
To apply a border to any project, right click the manifest node and choose Properties...
Scroll to, if required, and select the row of $border...
The file browser dialogue will pop up and default to list the *.border files in the Border folder...
Select the required border (or use the [...] button to browse somewhere else) then press [Apply] to complete.
Finally, press [Apply] to finish.
Forms Library
Forms are created in the same manner as Borders, however their function is very different.
Typically a form will comprise of a table of data rows and columns, and be used by the automatic Form Filler function found with the data tools.
An example of a filled out form...
You would add as many forms, of a particular type, as you need to hold all the data or information required to be printed out with your project.
In the above example the form is named Component List - and tabulates all the components per object TAG in the schematic.
The actual form is made from a Sheet and saved as a Form using Symbol > Create Form in the same manner as creating a Border.
Note: The way the forms are configured is critical!
Ensure all rows and columns contain the Text objects in perfect horizontal and vertical alignment.
Each Text object must be associated with a relevant gene, for example, with the Component List Form, each row of Text objects are configured as follows:-
TAG - gene of $text
Q - gene of $quantity
Partcode - gene of $partcode
Description - gene of $desc_short
To create a Bill of Materials Form, use the exact same fields and layout, except change some Texts, for example...
By creating your own Forms you can customise the layout, fonts and colours to suit your own requirements, plus add additional lines and boxes for other columns, for example "Purchase Date".
Note: Do NOT include any Border, or any elements around the edge of your Form, as the intention is that the Form contents are effectively brought into a project as a very large Symbol!
Adding Forms
Forms must be added to the target project (however, once the first Form of a particular type has been added, you may subsequently just copy that Form within the project).
We are in effect adding a new Sheet to the project, then pasting a copy of the Form into that Sheet as a very large Symbol, so open the target project then select the Project node, for example...
Then to add a Form, choose File > Add Form...
You will be prompted to specify the new Sheet Number for the Form to be assigned...
The file browser will default to your Forms Folder... select the required file...
Press [Open] to finish.
Alternate Form Add Method
Another method to add a form is to preview it... and make sure it's node is selected in the Project Explorer...
Then use COPY (CTRL+C).
Now click on the target Project Folder node and PASTE (CTRL+V). This will take you to the Sheet number entry dialogue detailed previously to continue.
Using Forms
Using forms works in conjunction with the Data Tools.
Note: It's recommended that NO Forms are being edited, or even being displayed, before running this feature!
In this example you must first create some component data within your project, meaning add parts and quantities into components as required.
Then choose Data > Component List...
The Component List mode of the data form will open...
Use the Column Headers to sort the data per your requirements, then choose File > Form Filler...
With the Form Filler selection dialogue, choose the form type (such as are added and available to your project) that you would like to fill...
Press [Begin] to proceed, or [Close] to cancel.
If proceeding, then after some time, you will receive a confirmation of the outcome.
If there are not enough fields to fill with the given amount of Forms, then this error message...
Otherwise, if all Ok, then this message...
Press [Close] on the Data Form to finish.
Note: If any Form is currently being displayed when you run the Form Filler it will not be updated until you reload that Sheet!
As with Symbols, a Form added to a Project becomes merged with the Project completely. Any changes made to the Form outside of the Project will NOT be reflected or updated in the Project.
That's all for using libraries for now.