mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-13 17:53:11 +02:00
Restore .h files generated from .md
Weblate translations don't work if these files are missing.
This commit is contained in:
Alex Shvartzkop
parent
fbd277a02d
commit
84fd260fc0
56
eeschema/dialogs/dialog_bom_help_md.h
Normal file
56
eeschema/dialogs/dialog_bom_help_md.h
Normal file
@ -0,0 +1,56 @@
|
||||
// Do not edit this file, it is autogenerated by CMake from the .md file
|
||||
_HKI( "# 1. Summary\n"
|
||||
"\n"
|
||||
"The Bill of Materials tool creates a BOM which lists all of the components in the design.\n"
|
||||
"\n"
|
||||
"The tool uses an external script to generate a BOM in the desired output format. Choosing a different script changes how the BOM is formatted.\n"
|
||||
"\n"
|
||||
"Generating a BOM is described in more detail in the Schematic Editor manual.\n"
|
||||
"\n"
|
||||
"# 2. Usage\n"
|
||||
"\n"
|
||||
"Select a generator script in the **BOM generator scripts** list. Details for the selected generator are shown on the right of the dialog.\n"
|
||||
"\n"
|
||||
"Clicking the **Generate** button creates a BOM file with the selected generator.\n"
|
||||
"\n"
|
||||
"The default settings present several generator script options, although some additional scripts are installed with KiCad and can be added to the list with the **+** button.\n"
|
||||
"\n"
|
||||
"**Note:** On Windows, there is an additional option **Show console window**. When this option is unchecked, BOM generators run in a hidden console window and any output is redirected and printed in the dialog. When this option is checked, BOM generators run in a visisble console window.\n"
|
||||
"\n"
|
||||
"# 3. Custom generators and command lines\n"
|
||||
"\n"
|
||||
"Internally, KiCad creates an intermediate netlist file in XML format that contains information about all of the components in the design. A BOM generator script converts the intermediate netlist file to the desired output format. KiCad runs the BOM generator scripts according to the command line entered at the bottom of the BOM dialog.\n"
|
||||
"\n"
|
||||
"The command line format accepts parameters for filenames. Each formatting parameter is replaced with a project-specific path or filename. The supported formatting parameters are:\n"
|
||||
"\n"
|
||||
" * `%I`: absolute path and filename of the intermediate netlist file, which is the input to the BOM generator\n"
|
||||
" * `%O`: absolute path and filename of the output BOM file (without file extension)\n"
|
||||
" * `%B`: base filename of the output BOM file (without file extension)\n"
|
||||
" * `%P`: absolute path of the project directory, without trailing slash\n"
|
||||
"\n"
|
||||
"**Note:** the `%O` output file parameter does not include a file extension. KiCad will attempt to add an appropriate extension to the command line automatically, but an extension may need to be added by hand.\n"
|
||||
"\n"
|
||||
"Python is the recommended tool for BOM generator scripts, but other tools can also be used.\n"
|
||||
"\n"
|
||||
"## Example command lines for Python scripts\n"
|
||||
"\n"
|
||||
"The command line format for a Python script is of the form:\n"
|
||||
"\n"
|
||||
"```\n"
|
||||
"python <script file name> <input filename> <output filename>\n"
|
||||
"```\n"
|
||||
"\n"
|
||||
"On Windows, if the desired generator script for a CSV BOM is `C:\\Users\\username\\kicad\\my_python_script.py`, the command line would be:\n"
|
||||
"\n"
|
||||
"```\n"
|
||||
"python.exe C:\\Users\\username\\kicad\\my_python_script.py \"%I\" \"%O.csv\"\n"
|
||||
"```\n"
|
||||
"\n"
|
||||
"On Linux, if the desired generator script for a CSV BOM is `/home/username/kicad/my_python_script.py`, the command line would be:\n"
|
||||
"\n"
|
||||
"```\n"
|
||||
"python /home/username/kicad/my_python_script.py \"%I\" \"%O.csv\"\n"
|
||||
"```\n"
|
||||
"\n"
|
||||
"Double quotes (`\"`) around the arguments are recommended in case filenames contain spaces or special characters.\n"
|
||||
"" );
|
||||
133
eeschema/sch_text_help_md.h
Normal file
133
eeschema/sch_text_help_md.h
Normal file
@ -0,0 +1,133 @@
|
||||
// Do not edit this file, it is autogenerated by CMake from the .md file
|
||||
_HKI( "<table>\n"
|
||||
" <tr>\n"
|
||||
" <th>Markup</th>\n"
|
||||
" <th></th>\n"
|
||||
" <th>Result</th>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td> <br><samp>^{superscript}</samp></td>\n"
|
||||
" <td></td>\n"
|
||||
" <td> <br><samp><sup>superscript</sup> </samp></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td> <br><samp>Driver Board^{Rev A}</samp></td>\n"
|
||||
" <td></td>\n"
|
||||
" <td> <br><samp>Driver Board<sup>Rev A</sup></samp></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td><br></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td> <br><samp>_{subscript}</samp></td>\n"
|
||||
" <td></td>\n"
|
||||
" <td> <br><samp><sub>subscript</sub> </samp></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td> <br><samp>D_{0} - D_{15}</samp></td>\n"
|
||||
" <td></td>\n"
|
||||
" <td> <br><samp>D<sub>0</sub> - D<sub>15</sub></samp></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td> <br><samp>~{overbar}</samp><br> <br><samp>~{CLK}</samp></td>\n"
|
||||
" <td></td>\n"
|
||||
" <td> <samp><u> </u></samp><br> <samp>overbar</samp><br> <samp><u> </u></samp><br> <samp>CLK</samp></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td> <br><samp>${variable}</samp></td>\n"
|
||||
" <td></td>\n"
|
||||
" <td> <br><samp><i>variable_value</i></samp></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td> <br><samp>${REVISION}</samp></td>\n"
|
||||
" <td></td>\n"
|
||||
" <td> <br><samp>2020.1</samp></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td><br></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td> <br><samp>${refdes:field}</samp></td>\n"
|
||||
" <td></td>\n"
|
||||
" <td> <br><samp><i>field_value</i> of symbol <i>refdes</i></samp></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td> <br><samp>${R3:VALUE}</samp></td>\n"
|
||||
" <td></td>\n"
|
||||
" <td> <br><samp>150K</samp></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td><br></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td><br></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <th>Bus Definition</th>\n"
|
||||
" <th> </th>\n"
|
||||
" <th>Resultant Nets</th>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td> <br><samp>prefix[m..n]</samp></td>\n"
|
||||
" <td></td>\n"
|
||||
" <td> <br><samp>prefixm to prefixn</samp></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td> <br><samp>D[0..7]</samp></td>\n"
|
||||
" <td></td>\n"
|
||||
" <td> <br><samp>D0, D1, D2, D3, D4, D5, D6, D7</samp></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td><br></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td> <br><samp>{net1 net2 ...}</samp></td>\n"
|
||||
" <td></td>\n"
|
||||
" <td> <br><samp>net1, net2, ...</samp></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td> <br><samp>{SCL SDA}</samp></td>\n"
|
||||
" <td></td>\n"
|
||||
" <td> <br><samp>SCL, SDA</samp></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td><br></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td> <br><samp>prefix{net1 net2 ...}</samp></td>\n"
|
||||
" <td></td>\n"
|
||||
" <td> <br><samp>prefix.net1, prefix.net2, ...</samp></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td> <br><samp>USB1{D+ D-}</samp></td>\n"
|
||||
" <td></td>\n"
|
||||
" <td> <br><samp>USB1.D+, USB1.D-</samp></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td><br></td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td> <br><samp>MEM{D[1..2] LATCH}</samp></td>\n"
|
||||
" <td></td>\n"
|
||||
" <td> <br> <samp>MEM.D1, MEM.D2, MEM.LATCH</samp> </td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td> <br><samp>MEM{D_{[1..2]} ~{LATCH}}</samp></td>\n"
|
||||
" <td></td>\n"
|
||||
" <td> <samp> <sub> </sub> <sub> </sub> <u> </u></samp><br> <samp>MEM.D<sub>1</sub>, MEM.D<sub>2</sub>, MEM.LATCH</samp> </td>\n"
|
||||
" </tr>\n"
|
||||
" <tr>\n"
|
||||
" <td><br></td>\n"
|
||||
" </tr>\n"
|
||||
"</table>\n"
|
||||
"<p></p>\n"
|
||||
"<p></p>\n"
|
||||
"<i>Note that markup has precedence over bus definitions.</i>\n"
|
||||
"\n"
|
||||
"" );
|
||||
37
eeschema/sim/user_defined_signals_help_md.h
Normal file
37
eeschema/sim/user_defined_signals_help_md.h
Normal file
@ -0,0 +1,37 @@
|
||||
// Do not edit this file, it is autogenerated by CMake from the .md file
|
||||
_HKI( "SPICE functions:\n"
|
||||
"\n"
|
||||
" sqrt(x)\n"
|
||||
" sin(x)\n"
|
||||
" cos(x)\n"
|
||||
" tan(x)\n"
|
||||
" sinh(x)\n"
|
||||
" cosh(x)\n"
|
||||
" tanh(x)\n"
|
||||
" asin(x)\n"
|
||||
" acos(x)\n"
|
||||
" atan(x)\n"
|
||||
" asinh(x)\n"
|
||||
" acosh(x)\n"
|
||||
" atanh(x)\n"
|
||||
" arctan(x)\n"
|
||||
" exp(x)\n"
|
||||
" ln(x)\n"
|
||||
" log(x)\n"
|
||||
" abs(x)\n"
|
||||
" nint(x)\n"
|
||||
" int(x)\n"
|
||||
" floor(x)\n"
|
||||
" ceil(x)\n"
|
||||
" pow(x, y)\n"
|
||||
" pwr(x, y)\n"
|
||||
" min(x, y)\n"
|
||||
" max(x, y)\n"
|
||||
" sgn(x)\n"
|
||||
" ternary_fcn(x, y, z)\n"
|
||||
" gauss(nom, rvar, sigma)\n"
|
||||
" agauss(nom, avar, sigma)\n"
|
||||
" unif(nom, rvar)\n"
|
||||
" aunif(nom, avar)\n"
|
||||
" limit(nom, avar)\n"
|
||||
"" );
|
||||
11
pcb_calculator/attenuators/bridget_tee_formula.h
Normal file
11
pcb_calculator/attenuators/bridget_tee_formula.h
Normal file
@ -0,0 +1,11 @@
|
||||
// Do not edit this file, it is autogenerated by CMake from the .md file
|
||||
_HKI( "### Bridged Tee Attenuator\n"
|
||||
"___a___ is attenuation in dB<br>\n"
|
||||
"___Z<sub>in</sub>___ is desired input impedance in Ω<br>\n"
|
||||
"___Z<sub>out</sub>___ is desired output impedance in Ω<br>\n"
|
||||
"___Z<sub>0</sub> = Z<sub>in</sub> = Z<sub>out</sub>___\n"
|
||||
"\n"
|
||||
"___L = 10<sup>a/20</sup>___<br>\n"
|
||||
"___R1 = Z<sub>0</sub> · (L−1)___<br>\n"
|
||||
"___R2 = Z<sub>0</sub> / (L−1)___\n"
|
||||
"" );
|
||||
13
pcb_calculator/attenuators/pi_formula.h
Normal file
13
pcb_calculator/attenuators/pi_formula.h
Normal file
@ -0,0 +1,13 @@
|
||||
// Do not edit this file, it is autogenerated by CMake from the .md file
|
||||
_HKI( "### Pi Attenuator\n"
|
||||
"___a___ is attenuation in dB<br>\n"
|
||||
"___Z<sub>in</sub>___ is desired input impedance in Ω<br>\n"
|
||||
"___Z<sub>out</sub>___ is desired output impedance in Ω<br>\n"
|
||||
"\n"
|
||||
"___K = V<sub>I</sub>/V<sub>O</sub> = 10<sup>a/20</sup>___<br>\n"
|
||||
"___L = K<sup>2</sup> = 10<sup>a/10</sup>___<br>\n"
|
||||
"___A = (L+1) / (L−1)___<br><br>\n"
|
||||
"___R2 = (L−1) / 2·√(Z<sub>in</sub> · Z<sub>out</sub> / L)___<br>\n"
|
||||
"___R1 = 1 / (A/Z<sub>in</sub> − 1/R2)___<br>\n"
|
||||
"___R3 = 1 / (A/Z<sub>out</sub> − 1/R2)___\n"
|
||||
"" );
|
||||
9
pcb_calculator/attenuators/splitter_formula.h
Normal file
9
pcb_calculator/attenuators/splitter_formula.h
Normal file
@ -0,0 +1,9 @@
|
||||
// Do not edit this file, it is autogenerated by CMake from the .md file
|
||||
_HKI( "### Split Attenuator\n"
|
||||
"Attenuation is 6 dB<br>\n"
|
||||
"___Z<sub>in</sub>___ is desired input impedance in Ω<br>\n"
|
||||
"___Z<sub>out</sub>___ is desired output impedance in Ω<br>\n"
|
||||
"___Z<sub>0</sub> = Z<sub>in</sub> = Z<sub>out</sub>___\n"
|
||||
"\n"
|
||||
"___R1 = R2 = R3 = Z<sub>0</sub>/3___\n"
|
||||
"" );
|
||||
13
pcb_calculator/attenuators/tee_formula.h
Normal file
13
pcb_calculator/attenuators/tee_formula.h
Normal file
@ -0,0 +1,13 @@
|
||||
// Do not edit this file, it is autogenerated by CMake from the .md file
|
||||
_HKI( "### Tee Attenuator\n"
|
||||
"___a___ is attenuation in dB<br>\n"
|
||||
"___Z<sub>in</sub>___ is desired input impedance in Ω<br>\n"
|
||||
"___Z<sub>out</sub>___ is desired output impedance in Ω<br>\n"
|
||||
"\n"
|
||||
"___K = V<sub>I</sub>/V<sub>O</sub> = 10<sup>a/20</sup>___<br>\n"
|
||||
"___L = K<sup>2</sup> = 10<sup>a/10</sup>___<br>\n"
|
||||
"___A = (L+1) / (L−1)___<br><br>\n"
|
||||
"___R2 = 2·√(L · Z<sub>in</sub> · Z<sub>out</sub>) / (L−1)___<br>\n"
|
||||
"___R1 = Z<sub>in</sub> · A − R2___<br>\n"
|
||||
"___R3 = Z<sub>out</sub> · A − R2___\n"
|
||||
"" );
|
||||
14
pcb_calculator/eseries_display_help.h
Normal file
14
pcb_calculator/eseries_display_help.h
Normal file
@ -0,0 +1,14 @@
|
||||
// Do not edit this file, it is autogenerated by CMake from the .md file
|
||||
_HKI( "Passive components are commonly made with E-series values appropriate to their precision.\n"
|
||||
"Capacitors commonly use E12 values. 10% and 5% resistors commonly use E24 values. 1%\n"
|
||||
"resistors use E96 values. Other series are not commonly used.\n"
|
||||
"\n"
|
||||
"To select a value begin with the calculated target value and then round it to 2\n"
|
||||
"significant figures for E24 or below or 3 significant figures for E48 and up.\n"
|
||||
"Then find the value in the table which is nearest to the significant figures\n"
|
||||
"remaining and substitute it for those figures.\n"
|
||||
"\n"
|
||||
"For example if the calculated target value is 16,834.2Ω then this rounds to 16,800Ω.\n"
|
||||
"The nearest value to 168 is 169 and the selected E96 value is 16.9kΩ.\n"
|
||||
"\n"
|
||||
"The value 0 is a special case and is not present in any series." );
|
||||
7
pcb_calculator/fusing_current_help.h
Normal file
7
pcb_calculator/fusing_current_help.h
Normal file
@ -0,0 +1,7 @@
|
||||
// Do not edit this file, it is autogenerated by CMake from the .md file
|
||||
_HKI( "You can use this calculator to check if a small track can handle a large current for a short period of time.<br>\n"
|
||||
"This tool allows you to design a track fuse but should be used as an estimate only.\n"
|
||||
"\n"
|
||||
"The calculator estimates the energy required to heat the wire up<br>\n"
|
||||
"to its melting point as well as the energy required for the change of phase.<br>\n"
|
||||
"This energy is then compared to the one dissipated by the wire resistance." );
|
||||
7
pcb_calculator/galvanic_corrosion_help.h
Normal file
7
pcb_calculator/galvanic_corrosion_help.h
Normal file
@ -0,0 +1,7 @@
|
||||
// Do not edit this file, it is autogenerated by CMake from the .md file
|
||||
_HKI( "This table shows the difference in electrochemical potential between various metals and alloys. Galvanic corrosion affects different metals in contact and under certain conditions.<br>\n"
|
||||
"The anode of an electrochemical pair gets oxidized and eaten away, while the cathode gets dissolved metals plated onto it but stays protected.<br>\n"
|
||||
"A positive number indicates that the row is anodic (-) and the column is cathodic (+), cold and warm coloring hues also indicate rows' potential.<br>\n"
|
||||
"EN 50310 suggests a voltage difference below 300mV. Known practices make use of a third interface metal in between the main pair(ie the ENIG surface finish).<br>\n"
|
||||
"Selected cells shown with the default system's coloring choice after a table refill.\n"
|
||||
"" );
|
||||
8
pcb_calculator/iec60664_help.h
Normal file
8
pcb_calculator/iec60664_help.h
Normal file
@ -0,0 +1,8 @@
|
||||
// Do not edit this file, it is autogenerated by CMake from the .md file
|
||||
_HKI( "The goal of the IEC60664-1 is to provide guidance on designing insulation for products that have a connection to mains supply.\n"
|
||||
"\n"
|
||||
"However some cases are not covered by this calculator:\n"
|
||||
"\n"
|
||||
"- For frequencies higher than 30kHz, the dielectric perfomances are degraded. IEC60664-4 covers those cases\n"
|
||||
"- When using a conformal coating or a potting in order to protect for pollution, if all conditions specified by IEC60664-3 are met, the clearance and creepage distances can be reduced. Soldermask is usually not considered as a conformal coating.\n"
|
||||
"- Insulations trough liquids, compressed air or gases other than air are not in the scope of IEC60664" );
|
||||
14
pcb_calculator/r_calculator_help.h
Normal file
14
pcb_calculator/r_calculator_help.h
Normal file
@ -0,0 +1,14 @@
|
||||
// Do not edit this file, it is autogenerated by CMake from the .md file
|
||||
_HKI( "- This calculator finds combinations of standard E-series (between 10Ω and 1MΩ) to create arbitrary values.\n"
|
||||
"- You can enter the required resistance from 0.0025 to 4000 kΩ.\n"
|
||||
"- Solutions using up to 4 components are given.\n"
|
||||
"\n"
|
||||
"The requested value is always excluded from the solution set.<br>\n"
|
||||
"Optionally up to two additional values can be excluded in case of component availability problems.\n"
|
||||
"\n"
|
||||
"Solutions are given in the following formats:\n"
|
||||
"\n"
|
||||
" R1 + R2 +...+ Rn resistors in series\n"
|
||||
" R1 | R2 |...| Rn resistors in parallel\n"
|
||||
" R1 + (R2|R3)... any combination of the above\n"
|
||||
"" );
|
||||
18
pcb_calculator/tracks_width_versus_current_formula.h
Normal file
18
pcb_calculator/tracks_width_versus_current_formula.h
Normal file
@ -0,0 +1,18 @@
|
||||
// Do not edit this file, it is autogenerated by CMake from the .md file
|
||||
_HKI( "If you specify the maximum current, then the track widths will be calculated to suit.\n"
|
||||
"\n"
|
||||
"If you specify one of the track widths, the maximum current it can handle will be calculated. The width for the other track to also handle this current will then be calculated.\n"
|
||||
"\n"
|
||||
"The controlling value is shown in bold.\n"
|
||||
"\n"
|
||||
"The calculations are valid for currents up to 35 A (external) or 17.5 A (internal), temperature rises up to 100 °C, and widths of up to 400 mils (10 mm).\n"
|
||||
"\n"
|
||||
"The formula, from IPC 2221, is\n"
|
||||
"<center>___I = K · ΔT<sup>0.44</sup> · (W · H)<sup>0.725</sup>___</center>\n"
|
||||
"where:<br>\n"
|
||||
"___I___ is maximum current in A<br>\n"
|
||||
"___ΔT___ is temperature rise above ambient in °C<br>\n"
|
||||
"___W___ is width in mils<br>\n"
|
||||
"___H___ is thickness (height) in mils<br>\n"
|
||||
"___K___ is 0.024 for internal tracks or 0.048 for external tracks\n"
|
||||
"" );
|
||||
Loading…
x
Reference in New Issue
Block a user