Annotation¶
The schematic can be annotated using text, rendered markdown and mathematical equations. Annotations are defined in module definitions. There can be several annotations per module definition. The value of the annotations wil be displayed in the schematic visualizer in the group associated to the containing module instnace.
Signature¶
annotation = <STRING>
Text examples¶
Reminder on strings:
Multi lines string can be written using any TAG :
\
Example :
pcb-module row (idx: Int) :
annotation = to-string("Row %_" % [idx])
...
Several annotations :
pcb-module example :
annotation = "alice"
annotation = "bob
Multi-line annotations :
In stanza, multi-line strings are delimited by a tag: \
pcb-module example :
annotation = \<A>Multi-line
annotation<A>
annotation = trim(\<A>
Multi-line
annotation
<A>)
Maths support¶
LaTeX is compiled within annotations. Example:
pcb-module example :
annotation = "$$L = \\frac{1}{2} \\rho v^2 S C_L$$"
annotation = "$$E = mc^2$$"
pcb-module example :
annotation = \<annotation>$$L = \frac{1}{2} \rho v^2 S C_L$$<annotation>
annotation = \<annotation>$$E = mc^2$$<annotation>
Markdown support¶
Markdown in compiled within annotations including Github flavored markdown (autolink literals, footnotes, strikethrough, tables, tasklists).
So single new lines \n are not creating new lines per markdown specification.
Annotations can be resized and the lines will be wrapped.
Simple example:
pcb-module example :
annotation = to-string("Annotation **bold** again 3\nAnd more text")
annotation = to-string("Annotation **bold** again 3\nAnd more text")
Advanced example :
pcb-module example :
annotation = \<annotation>
__Advertisement__
- __[jitx](https://app.jitx.com)__ - JITX portal.
- __[jitx docs](https:/docs.jitx.com)__ - JITX Docs
and more.
You will like making those PCB designs.
---
# h1 Heading
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading
## Horizontal Rules
___
---
***
## Emphasis
**This is bold text**
__This is bold text__
*This is italic text*
_This is italic text_
~~Strikethrough~~
## Blockquotes
> Blockquotes can also be nested...
>> ...by using additional greater-than signs right next to each other...
> > > ...or with spaces between arrows.
## Lists
Unordered
+ Create a list by starting a line with `+`, `-`, or `*`
+ Sub-lists are made by indenting 2 spaces:
- Marker character change forces new list start:
* Ac tristique libero volutpat at
+ Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
+ Very easy!
Ordered
1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit
3. Integer molestie lorem at massa
1. You can use sequential numbers...
1. ...or keep all the numbers as `1.`
Start numbering with offset:
57. foo
1. bar
## Code
Inline `code`
Indented code
// Some comments
line 1 of code
line 2 of code
line 3 of code
## Tables
| Option | Description |
| ------ | ----------- |
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
Right aligned columns
| Option | Description |
| ------:| -----------:|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
## Links
[link text](http://dev.nodeca.com)
[link with title](http://nodeca.github.io/pica/demo/ "title text!")
## Images
<annotation>
