KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_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>${REVISION}</samp></td>\n"
49" <td></td>\n"
50" <td>&nbsp;<br><samp>2020.1</samp></td>\n"
51" </tr>\n"
52" <tr>\n"
53" <td><br></td>\n"
54" </tr>\n"
55" <tr>\n"
56" <td>&nbsp;<br><samp>${refdes:field}</samp></td>\n"
57" <td></td>\n"
58" <td>&nbsp;<br><samp><i>field_value</i> of symbol <i>refdes</i></samp></td>\n"
59" </tr>\n"
60" <tr>\n"
61" <td>&nbsp;<br><samp>${R3:VALUE}</samp></td>\n"
62" <td></td>\n"
63" <td>&nbsp;<br><samp>150K</samp></td>\n"
64" </tr>\n"
65" <tr>\n"
66" <td><br></td>\n"
67" </tr>\n"
68" <tr>\n"
69" <td>&nbsp;<br><samp>${ROW}</samp> (in tables)</td>\n"
70" <td></td>\n"
71" <td>&nbsp;<br><samp>0, 1, 2...</samp> (0-based)</td>\n"
72" </tr>\n"
73" <tr>\n"
74" <td>&nbsp;<br><samp>${COL}</samp> (in tables)</td>\n"
75" <td></td>\n"
76" <td>&nbsp;<br><samp>0, 1, 2...</samp> (0-based)</td>\n"
77" </tr>\n"
78" <tr>\n"
79" <td>&nbsp;<br><samp>${ADDR}</samp> (in tables)</td>\n"
80" <td></td>\n"
81" <td>&nbsp;<br><samp>A0, B1, C2...</samp> (0-based)</td>\n"
82" </tr>\n"
83" <tr>\n"
84" <td><br></td>\n"
85" </tr>\n"
86" <tr>\n"
87" <td>&nbsp;<br><samp>@{expression}</samp></td>\n"
88" <td></td>\n"
89" <td>&nbsp;<br><samp><i>evaluated_result</i></samp></td>\n"
90" </tr>\n"
91" <tr>\n"
92" <td>&nbsp;<br><samp>@{2 + 3}</samp></td>\n"
93" <td></td>\n"
94" <td>&nbsp;<br><samp>5</samp></td>\n"
95" </tr>\n"
96" <tr>\n"
97" <td>&nbsp;<br><samp>@{${ROW} + 1}</samp></td>\n"
98" <td></td>\n"
99" <td>&nbsp;<br><samp>4</samp> (when ROW=3)</td>\n"
100" </tr>\n"
101" <tr>\n"
102" <td><br></td>\n"
103" </tr>\n"
104" <tr>\n"
105" <th>String Comparison & Conditional Text</th>\n"
106" <th></th>\n"
107" <th></th>\n"
108" </tr>\n"
109" <tr>\n"
110" <td>&nbsp;<br><samp>@{\"text\" == \"text\"}</samp></td>\n"
111" <td></td>\n"
112" <td>&nbsp;<br><samp>1</samp></td>\n"
113" </tr>\n"
114" <tr>\n"
115" <td>&nbsp;<br><samp>@{\"text\" != \"other\"}</samp></td>\n"
116" <td></td>\n"
117" <td>&nbsp;<br><samp>1</samp></td>\n"
118" </tr>\n"
119" <tr>\n"
120" <td>&nbsp;<br><samp>@{if(condition, true_val, false_val)}</samp></td>\n"
121" <td></td>\n"
122" <td>&nbsp;<br><samp>Conditional text display</samp></td>\n"
123" </tr>\n"
124" <tr>\n"
125" <td>&nbsp;<br><samp>@{if(\"${LAYER}\" == \"F.Cu\", \"TOP\", \"BOTTOM\")}</samp></td>\n"
126" <td></td>\n"
127" <td>&nbsp;<br><samp>TOP</samp> (on front layer) or <samp>BOTTOM</samp></td>\n"
128" </tr>\n"
129" <tr>\n"
130" <td>&nbsp;<br><samp>@{if(${ROW} > 5, \"High\", \"Low\")}</samp></td>\n"
131" <td></td>\n"
132" <td>&nbsp;<br><samp>Numeric comparisons work too</samp></td>\n"
133" </tr>\n"
134" <tr>\n"
135" <td><br></td>\n"
136" </tr>\n"
137" <tr>\n"
138" <th>Symbol Pin Functions</th>\n"
139" <th></th>\n"
140" <th></th>\n"
141" </tr>\n"
142" <tr>\n"
143" <td>&nbsp;<br><samp>${refdes:REFERENCE(pin)}</samp></td>\n"
144" <td></td>\n"
145" <td>&nbsp;<br><samp>Full reference with unit for pin</samp></td>\n"
146" </tr>\n"
147" <tr>\n"
148" <td>&nbsp;<br><samp>${J1:REFERENCE(3)}</samp></td>\n"
149" <td></td>\n"
150" <td>&nbsp;<br><samp>J1B</samp> (for multi-unit symbol)</td>\n"
151" </tr>\n"
152" <tr>\n"
153" <td>&nbsp;<br><samp>${refdes:SHORT_REFERENCE(pin)}</samp></td>\n"
154" <td></td>\n"
155" <td>&nbsp;<br><samp>Reference without unit letter for pin</samp></td>\n"
156" </tr>\n"
157" <tr>\n"
158" <td>&nbsp;<br><samp>${J1:SHORT_REFERENCE(3)}</samp></td>\n"
159" <td></td>\n"
160" <td>&nbsp;<br><samp>J1</samp></td>\n"
161" </tr>\n"
162" <tr>\n"
163" <td>&nbsp;<br><samp>${refdes:UNIT(pin)}</samp></td>\n"
164" <td></td>\n"
165" <td>&nbsp;<br><samp>Unit letter only for pin</samp></td>\n"
166" </tr>\n"
167" <tr>\n"
168" <td>&nbsp;<br><samp>${J1:UNIT(3)}</samp></td>\n"
169" <td></td>\n"
170" <td>&nbsp;<br><samp>B</samp> (unit letter for pin 3)</td>\n"
171" </tr>\n"
172" <tr>\n"
173" <td>&nbsp;<br><samp>${refdes:NET_NAME(pin)}</samp></td>\n"
174" <td></td>\n"
175" <td>&nbsp;<br><samp>Net name connected to pin</samp></td>\n"
176" </tr>\n"
177" <tr>\n"
178" <td>&nbsp;<br><samp>${R1:NET_NAME(1)}</samp></td>\n"
179" <td></td>\n"
180" <td>&nbsp;<br><samp>VCC</samp></td>\n"
181" </tr>\n"
182" <tr>\n"
183" <td>&nbsp;<br><samp>${refdes:PIN_NAME(pin)}</samp></td>\n"
184" <td></td>\n"
185" <td>&nbsp;<br><samp>Pin name or selected alternate</samp></td>\n"
186" </tr>\n"
187" <tr>\n"
188" <td>&nbsp;<br><samp>${U1:PIN_NAME(5)}</samp></td>\n"
189" <td></td>\n"
190" <td>&nbsp;<br><samp>USART1_TX</samp> (alternate) or <samp>PA9</samp> (base)</td>\n"
191" </tr>\n"
192" <tr>\n"
193" <td>&nbsp;<br><samp>${refdes:PIN_BASE_NAME(pin)}</samp></td>\n"
194" <td></td>\n"
195" <td>&nbsp;<br><samp>Base pin name (ignoring alternates)</samp></td>\n"
196" </tr>\n"
197" <tr>\n"
198" <td>&nbsp;<br><samp>${U1:PIN_BASE_NAME(5)}</samp></td>\n"
199" <td></td>\n"
200" <td>&nbsp;<br><samp>PA9</samp></td>\n"
201" </tr>\n"
202" <tr>\n"
203" <td>&nbsp;<br><samp>${refdes:PIN_ALT_LIST(pin)}</samp></td>\n"
204" <td></td>\n"
205" <td>&nbsp;<br><samp>All alternate pin functions (excludes base name)</samp></td>\n"
206" </tr>\n"
207" <tr>\n"
208" <td>&nbsp;<br><samp>${U1:PIN_ALT_LIST(5)}</samp></td>\n"
209" <td></td>\n"
210" <td>&nbsp;<br><samp>USART1_TX, TIM1_CH2, I2C1_SCL</samp></td>\n"
211" </tr>\n"
212" <tr>\n"
213" <td>&nbsp;<br><samp>${refdes:SHORT_NET_NAME(pin)}</samp></td>\n"
214" <td></td>\n"
215" <td>&nbsp;<br><samp>Short net name or NC if unconnected</samp></td>\n"
216" </tr>\n"
217" <tr>\n"
218" <td>&nbsp;<br><samp>${J1:SHORT_NET_NAME(3)}</samp></td>\n"
219" <td></td>\n"
220" <td>&nbsp;<br><samp>GND</samp> or <samp>NC</samp></td>\n"
221" </tr>\n"
222" <tr>\n"
223" <td>&nbsp;<br><samp>${refdes:NET_CLASS(pin)}</samp></td>\n"
224" <td></td>\n"
225" <td>&nbsp;<br><samp>Net class for pin</samp></td>\n"
226" </tr>\n"
227" <tr>\n"
228" <td>&nbsp;<br><samp>${J1:NET_CLASS(1)}</samp></td>\n"
229" <td></td>\n"
230" <td>&nbsp;<br><samp>Power</samp></td>\n"
231" </tr>\n"
232" <tr>\n"
233" <td><br></td>\n"
234" </tr>\n"
235" <tr>\n"
236" <th>Escape Sequences</th>\n"
237" <th></th>\n"
238" <th></th>\n"
239" </tr>\n"
240" <tr>\n"
241" <td>&nbsp;<br><samp>\\${LITERAL}</samp></td>\n"
242" <td></td>\n"
243" <td>&nbsp;<br><samp>${LITERAL}</samp> (not expanded)</td>\n"
244" </tr>\n"
245" <tr>\n"
246" <td>&nbsp;<br><samp>Price: \\$25.00</samp></td>\n"
247" <td></td>\n"
248" <td>&nbsp;<br><samp>Price: $25.00</samp></td>\n"
249" </tr>\n"
250" <tr>\n"
251" <td>&nbsp;<br><samp>\\@{x+y}</samp></td>\n"
252" <td></td>\n"
253" <td>&nbsp;<br><samp>@{x+y}</samp> (not evaluated)</td>\n"
254" </tr>\n"
255" <tr>\n"
256" <td><br></td>\n"
257" </tr>\n"
258" <tr>\n"
259" <th>Nested Variables</th>\n"
260" <th></th>\n"
261" <th></th>\n"
262" </tr>\n"
263" <tr>\n"
264" <td>&nbsp;<br><samp>${J1:REFERENCE(@{${ROW}+2})}</samp></td>\n"
265" <td></td>\n"
266" <td>&nbsp;<br><samp>J1B</samp> (when ROW=0, pin 2 in unit B)</td>\n"
267" </tr>\n"
268" <tr>\n"
269" <td>&nbsp;<br><samp>${J1:NET_NAME(${COL})}</samp></td>\n"
270" <td></td>\n"
271" <td>&nbsp;<br><samp>Dynamic net lookup in tables</samp></td>\n"
272" </tr>\n"
273" <tr>\n"
274" <td><br></td>\n"
275" </tr>\n"
276" <tr>\n"
277" <th>Table Cell References</th>\n"
278" <th></th>\n"
279" <th></th>\n"
280" </tr>\n"
281" <tr>\n"
282" <td>&nbsp;<br><samp>${CELL(\"A0\")}</samp></td>\n"
283" <td></td>\n"
284" <td>&nbsp;<br><samp>Evaluated value from cell A0</samp></td>\n"
285" </tr>\n"
286" <tr>\n"
287" <td>&nbsp;<br><samp>${CELL(0, 1)}</samp></td>\n"
288" <td></td>\n"
289" <td>&nbsp;<br><samp>Value from row 0, column 1</samp></td>\n"
290" </tr>\n"
291" <tr>\n"
292" <td>&nbsp;<br><samp>${CELL(${ADDR})}</samp></td>\n"
293" <td></td>\n"
294" <td>&nbsp;<br><samp>Dynamic cell reference</samp></td>\n"
295" </tr>\n"
296" <tr>\n"
297" <td>&nbsp;<br><samp>${CELL(${ROW}-1, ${COL})}</samp></td>\n"
298" <td></td>\n"
299" <td>&nbsp;<br><samp>Value from cell above (if ROW > 0)</samp></td>\n"
300" </tr>\n"
301" <tr>\n"
302" <td><br></td>\n"
303" </tr>\n"
304" <tr>\n"
305" <td><br></td>\n"
306" </tr>\n"
307" <tr>\n"
308" <th>Bus Definition</th>\n"
309" <th>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</th>\n"
310" <th>Resultant Nets</th>\n"
311" </tr>\n"
312" <tr>\n"
313" <td>&nbsp;<br><samp>prefix[m..n]</samp></td>\n"
314" <td></td>\n"
315" <td>&nbsp;<br><samp>prefixm to prefixn</samp></td>\n"
316" </tr>\n"
317" <tr>\n"
318" <td>&nbsp;<br><samp>D[0..7]</samp></td>\n"
319" <td></td>\n"
320" <td>&nbsp;<br><samp>D0, D1, D2, D3, D4, D5, D6, D7</samp></td>\n"
321" </tr>\n"
322" <tr>\n"
323" <td><br></td>\n"
324" </tr>\n"
325" <tr>\n"
326" <td>&nbsp;<br><samp>{net1 net2 ...}</samp></td>\n"
327" <td></td>\n"
328" <td>&nbsp;<br><samp>net1, net2, ...</samp></td>\n"
329" </tr>\n"
330" <tr>\n"
331" <td>&nbsp;<br><samp>{SCL SDA}</samp></td>\n"
332" <td></td>\n"
333" <td>&nbsp;<br><samp>SCL, SDA</samp></td>\n"
334" </tr>\n"
335" <tr>\n"
336" <td><br></td>\n"
337" </tr>\n"
338" <tr>\n"
339" <td>&nbsp;<br><samp>prefix{net1 net2 ...}</samp></td>\n"
340" <td></td>\n"
341" <td>&nbsp;<br><samp>prefix.net1, prefix.net2, ...</samp></td>\n"
342" </tr>\n"
343" <tr>\n"
344" <td>&nbsp;<br><samp>USB1{D+ D-}</samp></td>\n"
345" <td></td>\n"
346" <td>&nbsp;<br><samp>USB1.D+, USB1.D-</samp></td>\n"
347" </tr>\n"
348" <tr>\n"
349" <td><br></td>\n"
350" </tr>\n"
351" <tr>\n"
352" <td>&nbsp;<br><samp>MEM{D[1..2] LATCH}</samp></td>\n"
353" <td></td>\n"
354" <td>&nbsp;<br> <samp>MEM.D1, MEM.D2, MEM.LATCH</samp> </td>\n"
355" </tr>\n"
356" <tr>\n"
357" <td>&nbsp;<br><samp>MEM{D_{[1..2]} ~{LATCH}}</samp></td>\n"
358" <td></td>\n"
359" <td> <samp>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<sub>&nbsp;</sub>&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<sub>&nbsp;</sub>&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;<u>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</u></samp><br> <samp>MEM.D<sub>1</sub>, MEM.D<sub>2</sub>, MEM.LATCH</samp> </td>\n"
360" </tr>\n"
361" <tr>\n"
362" <td><br></td>\n"
363" </tr>\n"
364"</table>\n"
365"<p></p>\n"
366"<p></p>\n"
367"<i>Note that markup has precedence over bus definitions.</i>\n"
368"<p></p>\n"
369"<p><b>Pin Functions:</b> Automatically find the correct unit placement. For multi-unit symbols, functions like <samp>NET_NAME(pin)</samp> work even if the pin is in a different unit than the one on the current sheet.</p>\n"
370"<p><b>Table Cell References:</b> The <samp>CELL()</samp> function works only in table cells. Use <samp>${CELL(\"A0\")}</samp> or <samp>${CELL(row, col)}</samp> to reference other cells in the same table. Row and column numbers are 0-based (A0 is the first row, first column). CELL returns the evaluated/displayed value, not the raw cell text.</p>\n"
371"<p><b>Nested Variables:</b> Variables can contain other variables. Inner variables are expanded first. Maximum nesting depth: 6 levels.</p>\n"
372"<p><b>Error Messages:</b></p>\n"
373"<ul>\n"
374"<li><samp>&lt;UNRESOLVED: token&gt;</samp> - Variable or function cannot be resolved</li>\n"
375"<li><samp>&lt;Unit X not placed&gt;</samp> - Pin is in a unit not placed on any sheet</li>\n"
376"<li><samp>&lt;Unresolved: Cell X not found&gt;</samp> - Cell address is out of table bounds</li>\n"
377"</ul>\n"
378"\n"
379"" );
_HKI
#define _HKI(x)
Definition page_info.cpp:44