templates
/
KiBot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[DOCs] Documented the text variable expansion in `output` 

Closes #377
This commit is contained in:
Salvador E. Tropea 2023-01-26 09:26:45 -03:00
parent 8506fb78db
commit fce9a2d581
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -644,6 +644,8 @@ If you use them for an output related to the PCB these values will be obtained f
If you need to force the origin of the data you can use **%bX** for the PCB and **%sX** for the schematic, where
**X** is the pattern to expand.
You can also use text variables (introduced in KiCad 6). To expand a text variable use `${VARIABLE}`.
#### Default *dir* option
The default `dir` value for any output is `.`. You can change it here.
@ -678,6 +680,8 @@ Note that the command line option has precedence over it.
Expansion patterns are applied to this value, but you should avoid using patterns that expand according to the context, i.e. **%c**, **%d**, **%f**, **%F**, **%p** and **%r**.
The behavior of these patterns isn't fully defined in this case and the results may change in the future.
You can also use text variables (introduced in KiCad 6). To expand a text variable use `${VARIABLE}`.
#### Date format option
* The **%d**, **%sd** and **%bd** patterns use the date and time from the PCB and schematic.

4
docs/README.in
View File

@ -416,6 +416,8 @@ If you use them for an output related to the PCB these values will be obtained f
If you need to force the origin of the data you can use **%bX** for the PCB and **%sX** for the schematic, where
**X** is the pattern to expand.
You can also use text variables (introduced in KiCad 6). To expand a text variable use `${VARIABLE}`.
#### Default *dir* option
The default `dir` value for any output is `.`. You can change it here.
@ -450,6 +452,8 @@ Note that the command line option has precedence over it.
Expansion patterns are applied to this value, but you should avoid using patterns that expand according to the context, i.e. **%c**, **%d**, **%f**, **%F**, **%p** and **%r**.
The behavior of these patterns isn't fully defined in this case and the results may change in the future.
You can also use text variables (introduced in KiCad 6). To expand a text variable use `${VARIABLE}`.
#### Date format option
* The **%d**, **%sd** and **%bd** patterns use the date and time from the PCB and schematic.