KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_text_help_md.h
Go to the documentation of this file.
1// Do not edit this file, it is autogenerated by CMake from the .md file
2_HKI( "<table>\n"
3" <tr>\n"
4" <th>Markup</th>\n"
5" <th></th>\n"
6" <th>Result</th>\n"
7" </tr>\n"
8" <tr>\n"
9" <td>&nbsp;<br><samp>^{superscript}</samp></td>\n"
10" <td></td>\n"
11" <td>&nbsp;<br><samp><sup>superscript</sup>&nbsp;</samp></td>\n"
12" </tr>\n"
13" <tr>\n"
14" <td>&nbsp;<br><samp>Driver Board^{Rev A}</samp></td>\n"
15" <td></td>\n"
16" <td>&nbsp;<br><samp>Driver Board<sup>Rev A</sup></samp></td>\n"
17" </tr>\n"
18" <tr>\n"
19" <td><br></td>\n"
20" </tr>\n"
21" <tr>\n"
22" <td>&nbsp;<br><samp>_{subscript}</samp></td>\n"
23" <td></td>\n"
24" <td>&nbsp;<br><samp><sub>subscript</sub>&nbsp;</samp></td>\n"
25" </tr>\n"
26" <tr>\n"
27" <td>&nbsp;<br><samp>D_{0} - D_{15}</samp></td>\n"
28" <td></td>\n"
29" <td>&nbsp;<br><samp>D<sub>0</sub> - D<sub>15</sub></samp></td>\n"
30" </tr>\n"
31" <tr>\n"
32" <td></td>\n"
33" </tr>\n"
34" <tr>\n"
35" <td> &nbsp;<br><samp>~{overbar}</samp><br> &nbsp;<br><samp>~{CLK}</samp></td>\n"
36" <td></td>\n"
37" <td> <samp><u>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</u></samp><br> <samp>overbar</samp><br> <samp><u>&nbsp;&nbsp;&nbsp;</u></samp><br> <samp>CLK</samp></td>\n"
38" </tr>\n"
39" <tr>\n"
40" <td></td>\n"
41" </tr>\n"
42" <tr>\n"
43" <td>&nbsp;<br><samp>${variable}</samp></td>\n"
44" <td></td>\n"
45" <td>&nbsp;<br><samp><i>variable_value</i></samp></td>\n"
46" </tr>\n"
47" <tr>\n"
48" <td>&nbsp;<br><samp>${PROJECTNAME}</samp></td>\n"
49" <td></td>\n"
50" <td>&nbsp;<br><samp>MyBoard</samp></td>\n"
51" </tr>\n"
52" <tr>\n"
53" <td><br></td>\n"
54" </tr>\n"
55" <tr>\n"
56" <th>PCB Variables</th>\n"
57" <th></th>\n"
58" <th></th>\n"
59" </tr>\n"
60" <tr>\n"
61" <td>&nbsp;<br><samp>${FILENAME}</samp></td>\n"
62" <td></td>\n"
63" <td>&nbsp;<br><samp>board.kicad_pcb</samp></td>\n"
64" </tr>\n"
65" <tr>\n"
66" <td>&nbsp;<br><samp>${FILEPATH}</samp></td>\n"
67" <td></td>\n"
68" <td>&nbsp;<br><samp>/path/to/board.kicad_pcb</samp></td>\n"
69" </tr>\n"
70" <tr>\n"
71" <td>&nbsp;<br><samp>${LAYER}</samp> (in text/tables)</td>\n"
72" <td></td>\n"
73" <td>&nbsp;<br><samp>F.Cu, B.Cu, F.SilkS...</samp></td>\n"
74" </tr>\n"
75" <tr>\n"
76" <td><br></td>\n"
77" </tr>\n"
78" <tr>\n"
79" <th>Footprint Cross-References</th>\n"
80" <th></th>\n"
81" <th></th>\n"
82" </tr>\n"
83" <tr>\n"
84" <td>&nbsp;<br><samp>${refdes:field}</samp></td>\n"
85" <td></td>\n"
86" <td>&nbsp;<br><samp><i>field_value</i> of footprint <i>refdes</i></samp></td>\n"
87" </tr>\n"
88" <tr>\n"
89" <td>&nbsp;<br><samp>${U1:REFERENCE}</samp></td>\n"
90" <td></td>\n"
91" <td>&nbsp;<br><samp>U1</samp></td>\n"
92" </tr>\n"
93" <tr>\n"
94" <td>&nbsp;<br><samp>${U1:VALUE}</samp></td>\n"
95" <td></td>\n"
96" <td>&nbsp;<br><samp>STM32F407VGT6</samp></td>\n"
97" </tr>\n"
98" <tr>\n"
99" <td>&nbsp;<br><samp>${U1:FOOTPRINT_LIBRARY}</samp></td>\n"
100" <td></td>\n"
101" <td>&nbsp;<br><samp>Package_QFP</samp></td>\n"
102" </tr>\n"
103" <tr>\n"
104" <td>&nbsp;<br><samp>${U1:FOOTPRINT_NAME}</samp></td>\n"
105" <td></td>\n"
106" <td>&nbsp;<br><samp>LQFP-100_14x14mm_P0.5mm</samp></td>\n"
107" </tr>\n"
108" <tr>\n"
109" <td><br></td>\n"
110" </tr>\n"
111" <tr>\n"
112" <th>Pad/Pin Functions</th>\n"
113" <th></th>\n"
114" <th></th>\n"
115" </tr>\n"
116" <tr>\n"
117" <td>&nbsp;<br><samp>${refdes:NET_NAME(pad)}</samp></td>\n"
118" <td></td>\n"
119" <td>&nbsp;<br><samp>Net name connected to pad</samp></td>\n"
120" </tr>\n"
121" <tr>\n"
122" <td>&nbsp;<br><samp>${U1:NET_NAME(5)}</samp></td>\n"
123" <td></td>\n"
124" <td>&nbsp;<br><samp>VCC</samp></td>\n"
125" </tr>\n"
126" <tr>\n"
127" <td>&nbsp;<br><samp>${refdes:SHORT_NET_NAME(pad)}</samp></td>\n"
128" <td></td>\n"
129" <td>&nbsp;<br><samp>Short net name or NC</samp></td>\n"
130" </tr>\n"
131" <tr>\n"
132" <td>&nbsp;<br><samp>${J1:SHORT_NET_NAME(3)}</samp></td>\n"
133" <td></td>\n"
134" <td>&nbsp;<br><samp>GND</samp> or <samp>NC</samp></td>\n"
135" </tr>\n"
136" <tr>\n"
137" <td>&nbsp;<br><samp>${refdes:NET_CLASS(pad)}</samp></td>\n"
138" <td></td>\n"
139" <td>&nbsp;<br><samp>Net class for pad</samp></td>\n"
140" </tr>\n"
141" <tr>\n"
142" <td>&nbsp;<br><samp>${J1:NET_CLASS(1)}</samp></td>\n"
143" <td></td>\n"
144" <td>&nbsp;<br><samp>Power</samp></td>\n"
145" </tr>\n"
146" <tr>\n"
147" <td>&nbsp;<br><samp>${refdes:PIN_NAME(pad)}</samp></td>\n"
148" <td></td>\n"
149" <td>&nbsp;<br><samp>Pin function/name</samp></td>\n"
150" </tr>\n"
151" <tr>\n"
152" <td>&nbsp;<br><samp>${U1:PIN_NAME(5)}</samp></td>\n"
153" <td></td>\n"
154" <td>&nbsp;<br><samp>USART1_TX</samp></td>\n"
155" </tr>\n"
156" <tr>\n"
157" <td><br></td>\n"
158" </tr>\n"
159" <tr>\n"
160" <th>Table Variables</th>\n"
161" <th></th>\n"
162" <th></th>\n"
163" </tr>\n"
164" <tr>\n"
165" <td>&nbsp;<br><samp>${ROW}</samp> (in tables)</td>\n"
166" <td></td>\n"
167" <td>&nbsp;<br><samp>1, 2, 3...</samp></td>\n"
168" </tr>\n"
169" <tr>\n"
170" <td>&nbsp;<br><samp>${COL}</samp> (in tables)</td>\n"
171" <td></td>\n"
172" <td>&nbsp;<br><samp>1, 2, 3...</samp></td>\n"
173" </tr>\n"
174" <tr>\n"
175" <td>&nbsp;<br><samp>${ADDR}</samp> (in tables)</td>\n"
176" <td></td>\n"
177" <td>&nbsp;<br><samp>A1, B2, C3...</samp></td>\n"
178" </tr>\n"
179" <tr>\n"
180" <td><br></td>\n"
181" </tr>\n"
182" <tr>\n"
183" <th>Math Expressions</th>\n"
184" <th></th>\n"
185" <th></th>\n"
186" </tr>\n"
187" <tr>\n"
188" <td>&nbsp;<br><samp>@{expression}</samp></td>\n"
189" <td></td>\n"
190" <td>&nbsp;<br><samp><i>evaluated_result</i></samp></td>\n"
191" </tr>\n"
192" <tr>\n"
193" <td>&nbsp;<br><samp>@{2 + 3}</samp></td>\n"
194" <td></td>\n"
195" <td>&nbsp;<br><samp>5</samp></td>\n"
196" </tr>\n"
197" <tr>\n"
198" <td>&nbsp;<br><samp>@{${ROW} - 1}</samp></td>\n"
199" <td></td>\n"
200" <td>&nbsp;<br><samp>3</samp> (when ROW=4)</td>\n"
201" </tr>\n"
202" <tr>\n"
203" <td><br></td>\n"
204" </tr>\n"
205" <tr>\n"
206" <th>String Comparison & Conditional Text</th>\n"
207" <th></th>\n"
208" <th></th>\n"
209" </tr>\n"
210" <tr>\n"
211" <td>&nbsp;<br><samp>@{\"text\" == \"text\"}</samp></td>\n"
212" <td></td>\n"
213" <td>&nbsp;<br><samp>1</samp></td>\n"
214" </tr>\n"
215" <tr>\n"
216" <td>&nbsp;<br><samp>@{\"text\" != \"other\"}</samp></td>\n"
217" <td></td>\n"
218" <td>&nbsp;<br><samp>1</samp></td>\n"
219" </tr>\n"
220" <tr>\n"
221" <td>&nbsp;<br><samp>@{if(condition, true_val, false_val)}</samp></td>\n"
222" <td></td>\n"
223" <td>&nbsp;<br><samp>Conditional text display</samp></td>\n"
224" </tr>\n"
225" <tr>\n"
226" <td>&nbsp;<br><samp>@{if(\"${LAYER}\" == \"F.Cu\", \"TOP\", \"BOTTOM\")}</samp></td>\n"
227" <td></td>\n"
228" <td>&nbsp;<br><samp>TOP</samp> (on front layer) or <samp>BOTTOM</samp></td>\n"
229" </tr>\n"
230" <tr>\n"
231" <td>&nbsp;<br><samp>@{if(${ROW} > 5, \"High\", \"Low\")}</samp></td>\n"
232" <td></td>\n"
233" <td>&nbsp;<br><samp>Numeric comparisons work too</samp></td>\n"
234" </tr>\n"
235" <tr>\n"
236" <td><br></td>\n"
237" </tr>\n"
238" <tr>\n"
239" <th>Escape Sequences</th>\n"
240" <th></th>\n"
241" <th></th>\n"
242" </tr>\n"
243" <tr>\n"
244" <td>&nbsp;<br><samp>\\${LITERAL}</samp></td>\n"
245" <td></td>\n"
246" <td>&nbsp;<br><samp>${LITERAL}</samp> (not expanded)</td>\n"
247" </tr>\n"
248" <tr>\n"
249" <td>&nbsp;<br><samp>Price: \\$25.00</samp></td>\n"
250" <td></td>\n"
251" <td>&nbsp;<br><samp>Price: $25.00</samp></td>\n"
252" </tr>\n"
253" <tr>\n"
254" <td>&nbsp;<br><samp>\\@{x+y}</samp></td>\n"
255" <td></td>\n"
256" <td>&nbsp;<br><samp>@{x+y}</samp> (not evaluated)</td>\n"
257" </tr>\n"
258" <tr>\n"
259" <td><br></td>\n"
260" </tr>\n"
261" <tr>\n"
262" <th>Nested Variables</th>\n"
263" <th></th>\n"
264" <th></th>\n"
265" </tr>\n"
266" <tr>\n"
267" <td>&nbsp;<br><samp>${U1:NET_NAME(@{${ROW}-2})}</samp></td>\n"
268" <td></td>\n"
269" <td>&nbsp;<br><samp>Dynamic net lookup in tables</samp></td>\n"
270" </tr>\n"
271" <tr>\n"
272" <td>&nbsp;<br><samp>${U${ROW}:VALUE}</samp></td>\n"
273" <td></td>\n"
274" <td>&nbsp;<br><samp>Dynamic footprint reference</samp></td>\n"
275" </tr>\n"
276" <tr>\n"
277" <td><br></td>\n"
278" </tr>\n"
279"</table>\n"
280"<p></p>\n"
281"<p></p>\n"
282"<i>Note that markup has precedence over variable expansion.</i>\n"
283"<p></p>\n"
284"<p><b>Footprint Cross-References:</b> Reference fields and pads on other footprints using <samp>${refdes:field}</samp> or <samp>${refdes:function(pad)}</samp> syntax.</p>\n"
285"<p><b>Nested Variables:</b> Variables can contain other variables. Inner variables are expanded first. Maximum nesting depth: 10 levels.</p>\n"
286"<p><b>Error Messages:</b></p>\n"
287"<ul>\n"
288"<li><samp>&lt;UNRESOLVED: token&gt;</samp> - Variable or function cannot be resolved</li>\n"
289"<li><samp>&lt;Unknown reference: U1&gt;</samp> - Footprint not found</li>\n"
290"</ul>\n"
291"\n"
292"" );
_HKI
#define _HKI(x)
Definition page_info.cpp:44