Index: export_xy/index.html =================================================================== --- export_xy/index.html (nonexistent) +++ export_xy/index.html (revision 16598) @@ -0,0 +1,89 @@ + + + + pcb-rnd user manual + + + + +

pcb-rnd - user manual

+ +

7.x export_xy

+Export_xy is a configurable template based export plugin that prints +text files. The output contains an optional header, then an optional block +for each subcircuit and after each such subcircuit block an optional block +for each terminal in that subcircuit. In pseudo-code: +

+print header_template
+	foreach subc in subcircuits {
+		print subc_template
+		foreach term in s.terminals {
+			print term_template
+		}
+	}
+

+Templates can reference to the current term, the current +subc and global properties (such as board properties). + +

7.x.1. Template configuration

+Each xy export format has an user assigned ID (which is the short name of the format). +There is a list of strings in the config tree under plugins/export_xy/templates; +each item is named as ID.something where something is: +

ID.name: the long name of the format (as shown on the UI); mandatory +
ID.hdr: header template, printed once when the output file is opened; optional +
ID.subc: subcircuit template, printed once when a subcircuit is entered; optional +
ID.term: terminal template, printed once for each terminal within each subcircuit; optional +

+Templates are text strings; they are printed as is, keeping all newlines and +whitespace. Portions in between % signs are substituted, depending on the +context. + +

Substitution keywords

+ +
keyword description +
%UTC% current date and time in UTC +
%author% board author +
%title% board title +
%suffix% coordinate unit (mm or mil) +
%boardw% boward width (unit suffixed coord) +
%boardh% boward height (unit suffixed coord) +
%subc.a.KEY% paste the current subcircuit's attribute value of the attribute whose name matches KEY; print "n/a" for non-existing attributes +
%subc.a.KEY|unk% same as %subc.a.KEY% but print "unknown" instead of "n/a" +
%subc.a.KEY?yes% same as %subc.a.KEY% but print "yes" if attribute value represents true, "n/a" otherwise +
%subc.a.KEY?yes:nope% same as %subc.a.KEY% but print "yes" if attribute value represents true, "nope" otherwise +
%subc.refdes% print the refdes of the current subcircuit +
%subc.refdes_% print the cleaned refdes of the current subcircuit +
%subc.footprint% print the footprint name of the current subcircuit +
%subc.footprint_% print the cleaned footprint name of the current subcircuit +
%subc.value% print the value of the current subcircuit +
%subc.value_% print the cleaned value of the current subcircuit +
%subc.x% print the X coordinate of the origin of the subcircuit (coord with unit suffix) +
%subc.y% print the Y coordinate of the origin of the subcircuit (coord with unit suffix) +
%subc.padx% print the X coordinate calculated from padstacks of the subcircuit (coord with unit suffix) +
%subc.pady% print the Y coordinate calculated from padstacks of the subcircuit (coord with unit suffix) +
%subc.pad_width% print the total width calculated from padstacks of the subcircuit (coord with unit suffix) +
%subc.pad_height% print the total height calculated from padstacks of the subcircuit (coord with unit suffix) +
%subc.pad_width_prerot% print the total width calculated from padstacks of the subcircuit, before applying rotation (coord with unit suffix) +
%subc.pad_height_prerot% print the total height calculated from padstacks of the subcircuit, before applying rotation (coord with unit suffix) +
%subc.rot% print the subc rotation value in degrees +
%subc.siderot% print the subc rotation value in degrees, always looking from the top side, "x-ray mode" (relative to side) +
%subc.270-rot% print the subc rotation value in degrees, subtracted from 270 +
%subc.side270-rot% print the subc rotation value in degrees, always looking from the top side, "x-ray mode", subtracted from 270 (relative to side) +
%subc.side% "top" or "bottom" (determined by subc placement, the subc aux layer) +
%subc.num-side% "1" for top or "2" for bottom (determined by subc placement, the subc aux layer) +
%subc.count% integer value, incremented by one before processing each subcircuit +
%subc.smdvsthru% "SMD" if contains padstacks but no padstack with hole; "PTH" if contains padstack with hole; "0" if neither +
%subc.smdvsthrunum% "2" if contains padstacks but no padstack with hole; "1" if contains padstack with hole; "0" if neither +
%subc.pincout% "pin" or "pad" count. Do not use. +
%term.netname% name of the net the current terminal should be connected to according to the netlist; "NC" for no connection +
+ +

keyword	description +
%UTC%	current date and time in UTC +
%author%	board author +
%title%	board title +
%suffix%	coordinate unit (mm or mil) +
%boardw%	boward width (unit suffixed coord) +
%boardh%	boward height (unit suffixed coord) +
%subc.a.KEY%	paste the current subcircuit's attribute value of the attribute whose name matches KEY; print "n/a" for non-existing attributes +
%subc.a.KEY\|unk%	same as %subc.a.KEY% but print "unknown" instead of "n/a" +
%subc.a.KEY?yes%	same as %subc.a.KEY% but print "yes" if attribute value represents true, "n/a" otherwise +
%subc.a.KEY?yes:nope%	same as %subc.a.KEY% but print "yes" if attribute value represents true, "nope" otherwise +
%subc.refdes%	print the refdes of the current subcircuit +
%subc.refdes_%	print the cleaned refdes of the current subcircuit +
%subc.footprint%	print the footprint name of the current subcircuit +
%subc.footprint_%	print the cleaned footprint name of the current subcircuit +
%subc.value%	print the value of the current subcircuit +
%subc.value_%	print the cleaned value of the current subcircuit +
%subc.x%	print the X coordinate of the origin of the subcircuit (coord with unit suffix) +
%subc.y%	print the Y coordinate of the origin of the subcircuit (coord with unit suffix) +
%subc.padx%	print the X coordinate calculated from padstacks of the subcircuit (coord with unit suffix) +
%subc.pady%	print the Y coordinate calculated from padstacks of the subcircuit (coord with unit suffix) +
%subc.pad_width%	print the total width calculated from padstacks of the subcircuit (coord with unit suffix) +
%subc.pad_height%	print the total height calculated from padstacks of the subcircuit (coord with unit suffix) +
%subc.pad_width_prerot%	print the total width calculated from padstacks of the subcircuit, before applying rotation (coord with unit suffix) +
%subc.pad_height_prerot%	print the total height calculated from padstacks of the subcircuit, before applying rotation (coord with unit suffix) +
%subc.rot%	print the subc rotation value in degrees +
%subc.siderot%	print the subc rotation value in degrees, always looking from the top side, "x-ray mode" (relative to side) +
%subc.270-rot%	print the subc rotation value in degrees, subtracted from 270 +
%subc.side270-rot%	print the subc rotation value in degrees, always looking from the top side, "x-ray mode", subtracted from 270 (relative to side) +
%subc.side%	"top" or "bottom" (determined by subc placement, the subc aux layer) +
%subc.num-side%	"1" for top or "2" for bottom (determined by subc placement, the subc aux layer) +
%subc.count%	integer value, incremented by one before processing each subcircuit +
%subc.smdvsthru%	"SMD" if contains padstacks but no padstack with hole; "PTH" if contains padstack with hole; "0" if neither +
%subc.smdvsthrunum%	"2" if contains padstacks but no padstack with hole; "1" if contains padstack with hole; "0" if neither +
%subc.pincout%	"pin" or "pad" count. Do not use. +
%term.netname%	name of the net the current terminal should be connected to according to the netlist; "NC" for no connection +

+Cleaned means any character that is non-alphanumeric, not "." and not "-" +and not "+" is replaced with "_".