Index: bomtool/plan.txt =================================================================== --- bomtool/plan.txt (revision 39653) +++ bomtool/plan.txt (nonexistent) @@ -1,36 +0,0 @@ -1. overview - -The bom tool has a per vendor (shop, p&p fab) database of parts. - -Before ordering parts or uploading the bom file for p&p, instead of directly -exporting the bom from pcb-rnd, the user runs the bom tool with a config file. -The config file consists of: - - instructions on which database (vendor) to use - - mods: local edits and choices and tunings - - output attribs - - output bom format - -The bom tool automatically calls pcb-rnd to export the bom in a file -format that's easy to parse. This is the intermediate bom. After parsing -this file, it matches up each bom part with a part from the vendor -database according to the conf. The choice is affected by mods. - -The output of the process is a set of new attributes per refdes, as -controlled by the output attribs in the config file. This typically includes -some vendor-specific part number or identifier. The bom tool now runs pcb-rnd -again (in the background) to load the board, change subcircuit attributes -according to the output list extracted above then exports the board into the -final bom file using the configured output bom format. - -2. mods - -A mod contain 3 parts: - - input expressions that are matched against input attributes of subcircuits - - vendor expressions to find the best entry in the vendor-database - - instructions to create output attributes (using static text, input - attributes and vendor attributes) - -Configured mods are executed on each entry in the intermediate bom; the -instructions of the best match is then executed so new subcircuit attributes -are created. - Index: bomtool/plan5.txt =================================================================== --- bomtool/plan5.txt (revision 39653) +++ bomtool/plan5.txt (nonexistent) @@ -1,30 +0,0 @@ -1. overview: bommap data - -There are bommap files in a bommap library. A bommap file is identified by -its name and contains an arbitrary number of attribute edit instructions, -typically adding vendor-specific attributes (such as part numbers or -ordering numbers). The file may also contain tags that are not added -in the output but helps in GUI-searching bommap files. - -Bommap files may be automatically generated and/or updated by 3rd party -(user provided) scripts downloading and processing vendor databases. - -In sch-rnd the bommap symbol attribute is loaded with the file name of -a bommap file. There may be gui plugins to help the user search the -bommap library. - -2. overview: bommap mechanism - -Before ordering parts or uploading the bom file for p&p, instead of directly -exporting the bom from pcb-rnd, the user runs the bom tool naming a bom -export template. - -The bom tool automatically calls pcb-rnd to export the bom in a file -format that's easy to parse. This is the intermediate bom. Optionally -the bom tool also loads a list of refdes->bommap overrides from a text file. -After parsing the intermediate bom and the override file, it looks up the -bommap file for each refdes. Then it runs pcb-rnd again (in the background) -to load the board, change subcircuit attributes as instructed by the bommaps -then exports the board into the final bom file using the output bom format -specified on the command line. -