docs/wiki/geda-pcb_funding_sow.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html>
   4 <head>
   5   <link rel="stylesheet" media="screen" type="text/css" href="./style.css" />
   6   <link rel="stylesheet" media="screen" type="text/css" href="./design.css" />
   7   <link rel="stylesheet" media="print" type="text/css" href="./print.css" />
   8
   9   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  10 </head>
  11 <body>
  12
  13 <p>
  14 <strong>Statement of work:  Improving PCB&#039;s usability within the gEDA Suite framework</strong>
  15 </p>
  16
  17 <h2 class="sectionedit1" id="background_and_motivation">Background and motivation</h2>
  18 <div class="level2">
  19
  20 <p>
  21 The open-source layout tool <a href="http://pcb.geda-project.org/" class="urlextern" title="http://pcb.geda-project.org/" rel="nofollow">PCB</a> has been a member of the gEDA Project for many
  22 years.  It is an essential part of the end-to-end design flow offered by the
  23 gEDA tool set.  That is, although gschem/gnetlist can (in principle) support
  24 many back-end PCB layout tools, the most advanced forward annotation tools
  25 have been developed for PCB, and the vast majority (if not all) of the gEDA
  26 Project&#039;s user base uses PCB as their layout tool.  PCB is a core part of the
  27 gEDA Project&#039;s software offerings.
  28 </p>
  29
  30 <p>
  31 For a variety of reasons, many electronics designers find PCB&#039;s user interface
  32 difficult to master.  Many tasks are best performed using PCB&#039;s internal
  33 command line (instead of menus or buttons), dropping to the unix shell, or
  34 even hand-editing design files using scripts or emacs.  Some specific
  35 shortcomings of PCB have been widely noted on the geda-* e-mail lists, along
  36 with reasonable solutions.   A list of the biggest issues includes:
  37 </p>
  38 <ul>
  39 <li class="level1"><div class="li"> <strong>Forward annotation:</strong>  Difficulty forward annotating designs from gschem/gnetlist.  A separate command-line tool is used to carry the design from gschem to PCB.  This tool can produce design files out of synch with PCB.  Also, many electronics designers are unfamiliar with using the unix command line.</div>
  40 </li>
  41 </ul>
  42 <ul>
  43 <li class="level1 node"><div class="li"> <strong><abbr title="Graphical User Interface">GUI</abbr>:</strong>  PCB&#039;s <abbr title="Graphical User Interface">GUI</abbr> shows its age.  It has the following infelicitous properties:</div>
  44 <ul>
  45 <li class="level2"><div class="li"> It uses a mixture of noun/verb and verb/noun actions.  (Modern <abbr title="Graphical User Interface">GUI</abbr> programs are noun/verb only.)</div>
  46 </li>
  47 <li class="level2"><div class="li"> Incomplete menu/button coverage of possible editing actions.  For example, arbitrary rotation and component refdes renumbering are available only through the pop-up command entry window.</div>
  48 </li>
  49 <li class="level2"><div class="li"> There is a lack of <abbr title="Graphical User Interface">GUI</abbr> controls for exact, CAD-like editing. Examples for these desirable actions: Give the position of an object by typing its coordinates. Rotate an object by a given angle. Move objects by an exact amount. Do a multi copy of objects.</div>
  50 </li>
  51 <li class="level2"><div class="li"> Unlike many other graphical GUIs a dialog to edit properties of an object is missing in pcb. Properties to be edited might be layer, thickness, connected flag, polygon clearance, the net it belongs to, position, orientation, etc.</div>
  52 </li>
  53 <li class="level2"><div class="li"> Underlying the user interface, there is strong belief amongst PCB&#039;s developers that the supporting datastructures and methods are inadequate, and require upgrade as part of any <abbr title="Graphical User Interface">GUI</abbr> upgrade.</div>
  54 </li>
  55 </ul>
  56 </li>
  57 </ul>
  58 <ul>
  59 <li class="level1"><div class="li"> <strong>Footprint creation/editing:</strong>  Creating/editing footprints using PCB is difficult.  Most power users have created perl scripts to automate this process, but new users tend to be flummoxed by this approach.</div>
  60 </li>
  61 </ul>
  62 <ul>
  63 <li class="level1"><div class="li"> <strong>Layers and design objects:</strong>  Although PCB can handle any arbitrary number of metal layers, it does not fully support other design layers as independent objects.  For example, it lacks full support for common layout layers like: keepout, DRC, outline, etc.  Also, the concept of padstacks is missing from PCB.  Finally, PCB does not provide the full DRC functionality expected of a modern layout program.</div>
  64 </li>
  65 </ul>
  66 <ul>
  67 <li class="level1"><div class="li"> <strong>DRC:</strong>  The existing mechanism to find DRCs is clumsy.  Also, a separate DRC layer which may be turned on or off (typical of modern layout programs) is missing.</div>
  68 </li>
  69 </ul>
  70
  71 <p>
  72 We envision that addressing the above problems will provide a significant,
  73 powerful benefit to PCB&#039;s usability within the larger framework of the gEDA
  74 toolkit.  Addressing the usability issues will bring the following specific
  75 benefits to the gEDA Project:
  76 </p>
  77 <ul>
  78 <li class="level1"><div class="li"> <strong>Adoption:</strong> Making PCB easier to use will lead to greater uptake of the entire gEDA electronic design toolkit by practicing engineers, including those working in commercial organizations.</div>
  79 </li>
  80 </ul>
  81 <ul>
  82 <li class="level1"><div class="li"> <strong>Contribution:</strong>  More users implies more contributors.   In the context of the gEDA Project, this means not only software developers, but also people who will contribute schematic symbols, PCB footprints, utility scripts, and other collateral necessary to a thriving design environment.  (A strong focal point for contributors is – and will remain – the <a href="http://www.gedasymbols.org" class="urlextern" title="http://www.gedasymbols.org" rel="nofollow">www.gedasymbols.org</a> website.)</div>
  83 </li>
  84 </ul>
  85 <ul>
  86 <li class="level1"><div class="li"> <strong>Support:</strong>  Engineers using the gEDA tools in a company context might be positioned to help organize funding for ongoing development of the gEDA Suite, thereby closing the circle from developers to users back to developers.  This would go a long way towards raising the gEDA Project above its current “advanced hobby hacker” status, a beneficial result for the entire gEDA ecosystem.</div>
  87 </li>
  88 </ul>
  89
  90 <p>
  91 Therefore, the purpose of this document is to specify modifications to PCB
  92 which we hope will bring about a renaissance in the gEDA Project itself by
  93 making the critical tool PCB more accessible to the ordinary electronics
  94 engineer.
  95 </p>
  96
  97 </div>
  98 <!-- EDIT1 SECTION "Background and motivation" [86-4751] -->
  99 <h2 class="sectionedit2" id="statement_of_work">Statement of work</h2>
 100 <div class="level2">
 101
 102 <p>
 103 This section provides descriptions of what work is desired in each area of PCB&#039;s functionality.  This is not a full specification;  it is assumed that the person chosen to perform this work is familiar enough with the concepts associated with PCB design and the internals of PCB that this statement of work provides sufficient guidance about what to do.
 104 </p>
 105 <hr />
 106
 107 </div>
 108 <!-- EDIT2 SECTION "Statement of work" [4752-5141] -->
 109 <h3 class="sectionedit3" id="general_guidelines">General guidelines</h3>
 110 <div class="level3">
 111
 112 </div>
 113
 114 <h4 id="gtk_hid">GTK HID</h4>
 115 <div class="level4">
 116
 117 <p>
 118 PCB supports several HIDs.  The HID is the interface layer which the user interacts with.  The two major HIDs provided for interactive use are based upon 1) the GTK <abbr title="Graphical User Interface">GUI</abbr> widget set, and 2) The X/Motif <abbr title="Graphical User Interface">GUI</abbr> widget set.  <strong>The work called out for this project shall be targeted at the GTK HID.</strong>  The reason for this is simple:  The rest of gEDA uses GTK.  A primary goal the renovation work in PCB is to more tightly bind PCB into the entire gEDA workflow.  More to the point:  the gEDA tool chain should present a more uniform interface to the user.  Users expect to see the same “look and feel” in all the tools they use.
 119 However, any changes made as part of this work shall not break any feature present in any other HID, including the Motif HID.
 120 </p>
 121
 122 </div>
 123
 124 <h4 id="code_clarity">Code clarity</h4>
 125 <div class="level4">
 126
 127 <p>
 128 Many other changes are desirable in PCB.  However, they are outside the scope of this work.  The idea behind the changes specified here is that they create a launching point for other developers to come in afterward and continue improving PCB.  Therefore, <strong>the developer must strive to make his code clear and well commented.</strong>  Do not use hard to understand code tricks, obfuscating macros, or other devices which will hamper any follow-on work by other developers.
 129 </p>
 130
 131 </div>
 132
 133 <h4 id="doxygen">Doxygen</h4>
 134 <div class="level4">
 135
 136 <p>
 137 The developer should place Doxygen comments into the header of any new function he writes.  Fully doxygenating PCB is outside the scope of this project, but <strong>the developer should at least use doxygen for the changes he makes.</strong>
 138 </p>
 139
 140 </div>
 141
 142 <h4 id="platforms">Platforms</h4>
 143 <div class="level4">
 144
 145 <p>
 146 The upgrades to PCB must work on the usual platforms supported by the gEDA Project.  Specifically:
 147 </p>
 148 <ul>
 149 <li class="level1"><div class="li"> Linux, BSD, Sun.</div>
 150 </li>
 151 <li class="level1"><div class="li"> GTK version 2.18 or later</div>
 152 </li>
 153 </ul>
 154
 155 <p>
 156 Hooks for support on Windows systems are outside the scope of this project.  However, any Windows features present currently in PCB should not break as a result of these changes.
 157 </p>
 158
 159 </div>
 160
 161 <h4 id="backwards_compatibility">Backwards compatibility</h4>
 162 <div class="level4">
 163
 164 <p>
 165 <strong>Any changes made to PCB should not break the ability of PCB to import existing
 166 .pcb files.</strong>  It <strong>is</strong> allowed to break import of .new.pcb files (i.e. the output
 167 of gsch2pcb).
 168 </p>
 169 <hr />
 170
 171 </div>
 172 <!-- EDIT3 SECTION "General guidelines" [5142-7229] -->
 173 <h3 class="sectionedit4" id="forward_annotation_upgrade">Forward annotation upgrade</h3>
 174 <div class="level3">
 175
 176 <p>
 177 <a href="geda-pcb_funding_sow-fwdann_ideas.html" class="wikilink1" title="geda-pcb_funding_sow-fwdann_ideas.html">Ideas, commentary, and examples from users</a>
 178 </p>
 179
 180 </div>
 181
 182 <h4 id="feature_description">Feature description</h4>
 183 <div class="level4">
 184
 185 <p>
 186 The goal of forward annotation is to read the design information output from
 187 e.g. a netlister, and use it to import all information required into PCB,
 188 ready for use in creating or modifying a layout.  Reading the following
 189 information is a required part of creating a PCB layout:
 190 </p>
 191 <ul>
 192 <li class="level1"><div class="li"> Footprints with associated refdeses and their associated layers (if assigned).</div>
 193 </li>
 194 </ul>
 195 <ul>
 196 <li class="level1"><div class="li"> Graphical elements (pads, tracks, polygons, holes, etc)  (usually imported from a previous design iteration).</div>
 197 </li>
 198 </ul>
 199 <ul>
 200 <li class="level1"><div class="li"> Electronic connectivity (netlist).</div>
 201 </li>
 202 </ul>
 203 <ul>
 204 <li class="level1"><div class="li"> Any global design information such as routing constraints.  (Currently unsupported by PCB).</div>
 205 </li>
 206 </ul>
 207
 208 <p>
 209 The scheme currently used by PCB is to read a file – already in PCB format –
 210 containing the actual footprints embedded within it.  The netlist is read in
 211 using a separate step.
 212 </p>
 213
 214 <p>
 215 The new scheme would read a file containing a list of actions.  Each line in
 216 the file would correspond to a separate action.  The file would be generated
 217 by a forward annotation tool (e.g. gsch2pcb).  The actions would correspond to
 218 the atomic actions performed by PCB itself when it finds a footprint by
 219 searching its footprint library.
 220 </p>
 221
 222 <p>
 223 For example, one line in the forward annotation file might say
 224 “(load-element-data SOT-23 U6)”.  This would make PCB look for an SOT-23
 225 package in its footprint library (using PCB&#039;s $FOOTPRINT_PATH), place it in a
 226 waiting position on the PCB, and give it the refdes “U6”.  Another action
 227 might say “(add-line &lt;layer&gt; &lt;X1&gt; &lt;Y1&gt; &lt;X2&gt; &lt;Y2&gt; &lt;width&gt; &lt;flags&gt;)”, which
 228 would add a straight line segment onto layer &lt;layer&gt; from position (X1, Y1) to
 229 position (X2, Y2) having width &lt;width&gt; and flags &lt;flags&gt;.  (The flags would
 230 specify things like whether the line ends are round or square, along with the
 231 other properties of a line.)
 232 </p>
 233
 234 <p>
 235 Besides importing footprint and graphical information, the new PCB forward
 236 annotation facility should import the netlist at the same time as the rest of
 237 the layout information.  (This is currently a separate step, which is
 238 inconsistent with the goal of ease-of-use.)
 239 </p>
 240
 241 <p>
 242 Note that the above descriptions of the actions are meant to provide examples
 243 of how PCB should be modified.  The details of each action are to be
 244 determined by the developer and the architecture of PCB itself.
 245 </p>
 246
 247 </div>
 248
 249 <h4 id="use_cases">Use cases</h4>
 250 <div class="level4">
 251
 252 <p>
 253 Once the forward annotation changes are complete, the following use cases should apply:
 254 </p>
 255
 256 <p>
 257 <strong>New PCB</strong>
 258 </p>
 259 <ol>
 260 <li class="level1"><div class="li"> The user creates his design using gschem.  </div>
 261 </li>
 262 <li class="level1"><div class="li"> He creates a forward annotation file by running the .sch files through gsch2pcb, which creates a single .pfa (PCB forward annotation) file.</div>
 263 </li>
 264 <li class="level1"><div class="li"> The user starts PCB.</div>
 265 </li>
 266 <li class="level1"><div class="li"> He clicks “File → new PCB”.  A window pops up, providing a place to enter the new board&#039;s layer count and size.  The window may also provide a way to specify common board templates (PC-104, 3U Eurocard, etc.)</div>
 267 </li>
 268 <li class="level1"><div class="li"> The new board is shown in PCB&#039;s main window as a white area on a darker background (as currently implemented).</div>
 269 </li>
 270 <li class="level1"><div class="li"> The user clicks “File → Import forward annotation file”.</div>
 271 </li>
 272 <li class="level1"><div class="li"> A file selection window pops up.  The user clicks on his .pfa file and clicks OK.</div>
 273 </li>
 274 <li class="level1"><div class="li"> PCB reads each action in the forward annotation file, and does the corresponding thing.  </div>
 275 </li>
 276 <li class="level1"><div class="li"> The PCB netlist is also imported during this activity.  No separate netlist readin step is required.</div>
 277 </li>
 278 <li class="level1"><div class="li"> At the end of the file&#039;s read-in, the footprints should be present on the board (*not* in the paste buffer), ready to be disbursed and placed.</div>
 279 </li>
 280 </ol>
 281
 282 <p>
 283 <strong>Existing PCB</strong>
 284 </p>
 285 <ol>
 286 <li class="level1"><div class="li"> The user has a pre-existing .pcb file for the design under consideration.  He makes changes to his design using e.g. gschem or gattrib.  </div>
 287 </li>
 288 <li class="level1"><div class="li"> The creates a forward annotation file by running the .sch files through gsch2pcb, which creates a single .pfa (PCB forward annotation) file.  </div>
 289 </li>
 290 <li class="level1"><div class="li"> The user starts PCB (or re-activates an existing PCB session running in its window).</div>
 291 </li>
 292 <li class="level1"><div class="li"> The user clicks “File → Import forward annotation file”.</div>
 293 </li>
 294 <li class="level1"><div class="li"> A file selection window pops up.  The user clicks on his .pfa file and clicks OK.</div>
 295 </li>
 296 <li class="level1"><div class="li"> PCB reads each action in the forward annotation file, and does the corresponding thing. Using the refdes, the importer looks to see if the component in the forward annotation file is already placed in PCB, and if so, it ignores the action.  </div>
 297 </li>
 298 <li class="level1"><div class="li"> The netlist is also read in and updated at this stage.  No separate netlist readin step is required.</div>
 299 </li>
 300 <li class="level1"><div class="li"> Once this action is complete, the user is ready to continue editing his board. </div>
 301 </li>
 302 </ol>
 303
 304 </div>
 305
 306 <h4 id="other_ideas">Other Ideas</h4>
 307 <div class="level4">
 308 <ul>
 309 <li class="level1"><div class="li"> Besides a menu option, there should be a toolbar button to sync changes</div>
 310 </li>
 311 <li class="level1"><div class="li"> Alternately, a thread running a file change monitor can spot the new annotation file when it appears</div>
 312 </li>
 313 <li class="level1"><div class="li"> Finally, the project manager (gsch2pcb / xgsch2pcb / geda_manager) can invoke readin of a forward annotation file via IPC</div>
 314 </li>
 315 </ul>
 316
 317 </div>
 318
 319 <h4 id="work_required">Work required</h4>
 320 <div class="level4">
 321
 322 <p>
 323 Some of the support for forward annotation already exists.  Specifically, many
 324 actions are already supported.  Therefore, this project involves:
 325 </p>
 326 <ol>
 327 <li class="level1"><div class="li"> Creating the missing actions required for full forward annotation.</div>
 328 </li>
 329 <li class="level1"><div class="li"> Creating a method for reading in an action script.</div>
 330 </li>
 331 <li class="level1"><div class="li"> Integrating the new script-based forward annotation into PCB&#039;s <abbr title="Graphical User Interface">GUI</abbr>.</div>
 332 </li>
 333 <li class="level1"><div class="li"> Testing and bug cleanup.</div>
 334 </li>
 335 </ol>
 336 <hr />
 337
 338 </div>
 339 <!-- EDIT4 SECTION "Forward annotation upgrade" [7230-12503] -->
 340 <h3 class="sectionedit5" id="gui_modernization">GUI modernization</h3>
 341 <div class="level3">
 342
 343 <p>
 344 <a href="geda-pcb_funding_sow-gui_ideas.html" class="wikilink1" title="geda-pcb_funding_sow-gui_ideas.html">Ideas, commentary, and examples from users</a>
 345 </p>
 346
 347 <p>
 348 The basic goal is to make the upgraded PCB behave exactly as an inexperienced
 349 user might expect, based upon his familiarity with modern <abbr title="Graphical User Interface">GUI</abbr>-based tools like
 350 OpenOffice.  This means:
 351 </p>
 352 <ul>
 353 <li class="level1"><div class="li"> PCB should support all the “normal” keystrokes which have become defacto standards for <abbr title="Graphical User Interface">GUI</abbr> programs.  Examples include &lt;ctrl&gt;-c for copy, &lt;ctrl&gt;-x for delete, etc.  PCB may continue to support the old key strokes to maintain backward compatibility for those who are already experienced with the program, but in the event that one of PCB&#039;s current keystrokes conflicts with the “defacto standard”, the defacto standard shall be implemented.</div>
 354 </li>
 355 </ul>
 356 <ul>
 357 <li class="level1"><div class="li"> PCB should support all actions using “noun/verb” syntax.  Details of this upgrade are presented in the “actions” section below.</div>
 358 </li>
 359 </ul>
 360 <ul>
 361 <li class="level1"><div class="li"> PCB should support normal selection modes (i.e. ways to select an object for editing or modification).    Details of this upgrade are presented in the “selection methods” section below.</div>
 362 </li>
 363 </ul>
 364 <ul>
 365 <li class="level1"><div class="li"> PCB&#039;s internals should be upgraded to easily support enhanced menus and button bars.  This means upgraded callbacks and possibly also a resource file which specifies things like menu layout, menu options available, and keybindings.</div>
 366 </li>
 367 </ul>
 368
 369 <p>
 370 If the descriptions in this specification are ambiguous or unclear, use the behaviors implemented in gschem as the preferred example.
 371 </p>
 372
 373 </div>
 374
 375 <h4 id="actions">Actions</h4>
 376 <div class="level4">
 377
 378 <p>
 379 The following actions should be modified to support a “noun/verb” actions,
 380 if they do not support it already.  Where possible, support for the current
 381 “verb/noun” actions should not be dropped to maintain compatibility for
 382 users who have learned the old actions.  However, if there is a conflict
 383 between the new noun/verb and the old verb/noun actions, the new noun/verb
 384 actions take presidence.
 385 </p>
 386 <ul>
 387 <li class="level1"><div class="li"> <strong>select/delete</strong>  Using any of: menu item, &lt;ctrl&gt;-x.  Delete should move the deleted object(s) from the layout into the copy buffer, so the user may place them elsewhere with a subsequent action.  (NOTE:  The copy buffer should probably be implemented separately from the existing “element buffer”.)</div>
 388 </li>
 389 </ul>
 390 <ul>
 391 <li class="level1"><div class="li"> <strong>select/remove</strong>  Using any of menu item, &lt;del&gt;, character d.  Remove should permanently remove the selected item.</div>
 392 </li>
 393 </ul>
 394 <ul>
 395 <li class="level1"><div class="li"> <strong>select/move</strong>  Using: left mouse button down and drag.  Also:  Select, then use arrow keys to move the selected objects some small quantum of motion (perhaps the grid spacing) in the direction specified by the arrow.  </div>
 396 </li>
 397 </ul>
 398 <ul>
 399 <li class="level1"><div class="li"> <strong>select/copy</strong>  Using any of: menu item, copy button, character c. &lt;ctrl&gt;-c.  This should copy the selected items into the copy buffer so the user may place them elsewhere in a subsequent action.  (NOTE:  The copy buffer should probably be implemented separately from the existing “element buffer”.)</div>
 400 </li>
 401 </ul>
 402 <ul>
 403 <li class="level1"><div class="li"> <strong>paste</strong>  Using any of: menu item, paste button, &lt;ctrl&gt;-v.  This will bring the contents of the copy buffer into action at the cursor.  When the user clicks on the design, then the elements will be placed on the layout where the user clicks.  Refer to the behavior of gschem to see exactly how this should work.</div>
 404 </li>
 405 </ul>
 406 <ul>
 407 <li class="level1"><div class="li"> <strong>select/move selection to current layer</strong>  Using menu item, </div>
 408 </li>
 409 </ul>
 410 <ul>
 411 <li class="level1"><div class="li"> <strong>select/move object to opposite layer</strong> Using menu item, &lt;shift&gt;-c.</div>
 412 </li>
 413 </ul>
 414 <ul>
 415 <li class="level1"><div class="li"> <strong>select/report object properties</strong>  Using menu item or &lt;ctrl&gt;-r.</div>
 416 </li>
 417 </ul>
 418 <ul>
 419 <li class="level1"><div class="li"> <strong>select/edit object properties</strong>  Using menu item or double click on single object.  This is a new action.<br/>
 420 If the selected object is a graphical primitive (line, arc, etc), PCB will open up a window displaying the object properties in an editable window, allowing for the user to modify the object&#039;s properties.  For example double clicking on a Cu track should open up the edit window, showing the track&#039;s width, current layer, end type (round vs. square), and its beginning and end coordinates.<br/>
 421 If the selected object is a footprint, PCB will open up a window allowing the user to select a different footprint name.  Some type of footprint browsing window with previewing should be presented to the user for this.  The footprints should be found by looking through PCB&#039;s footprint search path.  Recommendation: steal the symbol browser window from gschem for this task.  (Question:  how to back annotate this info into the .sch files?)<br/>
 422 If the selected object is text, then PCB should open up the text edit dialog box, allow the user to edit his text, click OK, and the text on the layout should be updated.</div>
 423 </li>
 424 </ul>
 425 <ul>
 426 <li class="level1"><div class="li"> <strong>Select/rotate</strong>  Using menu item or &lt;ctrl&gt;-r.  This is a new window (the action already exists).  This will open a window asking the user to type in a rotation angle.  The user will type in the angle (in degrees), click OK, and the selected item will be rotated.  Ideally, the rotation would apply globally to a selected set of items; it is up to the developer to determine if this is feasible. If not, then rotate should apply to only one item.</div>
 427 </li>
 428 </ul>
 429
 430 </div>
 431
 432 <h4 id="selection_modes">Selection modes</h4>
 433 <div class="level4">
 434
 435 <p>
 436 The following selection modes must be supported:
 437 </p>
 438 <ul>
 439 <li class="level1"><div class="li"> mouse click on single object.</div>
 440 </li>
 441 <li class="level1"><div class="li"> &lt;ctrl&gt;-click on multiple objects.  (Example:  &lt;ctrl&gt;-click this 1, &lt;ctrl&gt;-click this 2, &lt;ctrl&gt;-click this 3, etc.)</div>
 442 </li>
 443 <li class="level1"><div class="li"> Click and drag to select objects within a rectangular area.</div>
 444 </li>
 445 <li class="level1"><div class="li"> &lt;esc&gt; clears all selections</div>
 446 </li>
 447 <li class="level1"><div class="li"> &lt;ctrl&gt;-a selects all objects in the design.</div>
 448 </li>
 449 <li class="level1"><div class="li"> &lt;ctrl&gt;-A selects all connected objects.  (Question:  What is this selection mode useful for?)</div>
 450 </li>
 451 </ul>
 452
 453 </div>
 454
 455 <h4 id="work_required1">Work required</h4>
 456 <div class="level4">
 457
 458 <p>
 459 This project involves:
 460 </p>
 461 <ol>
 462 <li class="level1"><div class="li"> Refactoring and upgrade of program internals to support noun/verb actions.  </div>
 463 </li>
 464 <li class="level1"><div class="li"> Create new windows (e.g. object editor, move, rotate, etc.).  </div>
 465 </li>
 466 <li class="level1"><div class="li"> Refactoring and upgrade of program internals to support selection modes.</div>
 467 </li>
 468 <li class="level1"><div class="li"> Implementation of <abbr title="Graphical User Interface">GUI</abbr> resource file which is read in upon program start to configure user interface.</div>
 469 </li>
 470 <li class="level1"><div class="li"> <abbr title="Graphical User Interface">GUI</abbr> upgrade.  Specifically, hook up the callbacks to the menu items and buttons defined in the <abbr title="Graphical User Interface">GUI</abbr> resource file.</div>
 471 </li>
 472 <li class="level1"><div class="li"> Testing and bug cleanup.</div>
 473 </li>
 474 </ol>
 475 <hr />
 476
 477 </div>
 478 <!-- EDIT5 SECTION "GUI modernization" [12504-18439] -->
 479 <h3 class="sectionedit6" id="footprint_editor_implementation">Footprint editor implementation</h3>
 480 <div class="level3">
 481
 482 <p>
 483 Incorporating a good footprint editor into PCB is a common request from users.
 484 It is important for PCB to clearly distinguish between editing a footprint and
 485 editing an entire PCB design.  Here are two possible methods to accomplish
 486 this:
 487 </p>
 488 <ol>
 489 <li class="level1"><div class="li"> Although it is not optimal, the symbol editing mode present in gschem provides a reference for how this might be implemented.  Specifically, editing a footprint may be implemented as a “mode”, in which the user drills down into the footprint, and is placed into a special mode of the standard PCB editing window which is reserved for editing footprints.  </div>
 490 </li>
 491 <li class="level1"><div class="li"> Another way to implement a footprint editor is to have a pop-up window with its own drawing pane along with editing widgets specialized for creating and modifying footprints.</div>
 492 </li>
 493 </ol>
 494
 495 <p>
 496 Optionally, features involving editing footprints via the buffer will be removed.  Alternately, retain the option allowing the user to draw in the main window, select, then invoke some menu option to convert the selection to a footprint.  This option may exist <strong>alongside</strong> the new footprint editor.
 497 </p>
 498
 499 </div>
 500
 501 <h4 id="invocation">Invocation</h4>
 502 <div class="level4">
 503
 504 <p>
 505 There are two ways to invoke the footprint editor:
 506 </p>
 507 <ol>
 508 <li class="level1"><div class="li"> Create a new footprint.  In this case the user will have no object selected on the PCB drawing window.  He will then choose an option from the menu, like “tools → down footprint”.  This will place the user into the footprint editor, and the drawing area will be empty</div>
 509 </li>
 510 <li class="level2"><div class="li"> Edit an existing footprint.  In this case, the user will select a footprint present on the board by clicking on it.  Then he will select an option from the menu, like “tools → down footprint”.  This will place the user into the footprint editor, and the drawing area will hold a copy of the selected footprint, ready for editing.</div>
 511 </li>
 512 </ol>
 513
 514 <p>
 515 As a third possibility, the user should be able to do “tools → create new footprint”, go into the editor, and then do “file → open” and select a footprint from the library to edit.
 516 </p>
 517
 518 <p>
 519 As a fourth possibility, allow a mode similar to gschem, where a library browser is used to select and place primitive objects.  That would save the user from needing to know where the library files are hidden.
 520 </p>
 521
 522 </div>
 523
 524 <h4 id="editing">Editing</h4>
 525 <div class="level4">
 526
 527 <p>
 528 The footprint editor should be a graphical drawing environment similar to that presented by PCB for layout editing.
 529 </p>
 530 <ul>
 531 <li class="level1"><div class="li"> Buttons and menus.  The footprint editor should have all the same menus and buttons as are available from the PCB editor.  Those menu items and buttons which are not useful for footprint editing should be greyed out.</div>
 532 </li>
 533 </ul>
 534 <ul>
 535 <li class="level1"><div class="li"> Look and feel.  Once the user is placed in the footprint editor, the PCB window should change in some way to reflect that the user is in a different mode.  For example, the title bar must say “footprint mode”.  Also, the drawing field background color might be changed a little bit to emphasize the change in mode.</div>
 536 </li>
 537 </ul>
 538
 539 <p>
 540 The design choice of which environment is better is left to the developer to decide based upon factors including input from the community, ease of implementation, etc.
 541 </p>
 542
 543 </div>
 544
 545 <h4 id="saving">Saving</h4>
 546 <div class="level4">
 547
 548 <p>
 549 Once the user has edited his footprint, he will want to save it out.  This is
 550 a problematic action, since it&#039;s not a good idea to allow the user to
 551 overwrite a footprint living in the footprint libraries.  Moreover, the user
 552 may not have write access to the library directories.
 553 </p>
 554
 555 <p>
 556 Therefore, when the user is done editing his footprint, there should be only
 557 one save action available under the file menu:  “file → save footprint as”.
 558 This will call up the file save dialog, which will default to sticking the
 559 footprint in the current working directory (or the last directory he saved a
 560 footprint into during this session).  The user will then be required to browse
 561 to his preferred save directory, and save the footprint there.
 562 </p>
 563
 564 </div>
 565
 566 <h4 id="leaving">Leaving</h4>
 567 <div class="level4">
 568
 569 <p>
 570 Once the footprint editing session is done, the user may leave the editor and
 571 return to his main PCB editing session.  This may be accomplished using a menu
 572 item like “tools → up to layout”.  If any unsaved changes remain in the
 573 footprint, then the user should be prompted to either save or discard his
 574 changes before leaving the footprint editor.
 575 </p>
 576
 577 </div>
 578
 579 <h4 id="updating_a_footprint_placed_on_the_board">Updating a footprint placed on the board</h4>
 580 <div class="level4">
 581
 582 <p>
 583 After editing a footprint and saving it out, the user will often want to
 584 update a footprint already present on the PCB.  Here is the preferred method
 585 (use case) to do this:
 586 </p>
 587 <ol>
 588 <li class="level1"><div class="li"> User selects footprint to update.</div>
 589 </li>
 590 <li class="level1"><div class="li"> From menu, user selects “tools → update footprint”.  A keystroke to start this action may also be provided.</div>
 591 </li>
 592 <li class="level1"><div class="li"> A pop-up window opens, giving the user the footprint browser (as described above).  The window will have has default footprint the name of the currently selected footprint.  </div>
 593 </li>
 594 <li class="level1"><div class="li"> The user will either accept the default footprint presented, or he may search for a different footprint.  When he is done, he will click OK.</div>
 595 </li>
 596 <li class="level1"><div class="li"> PCB will load the specified footprint from its library.  Note:  For this to work after editing a footprint, the user must place his local directory first on the footprint search path.</div>
 597 </li>
 598 <li class="level1"><div class="li"> PCB will then replace the old footprint on the board with the one pulled from the library.  The old footprint (currently written into the .pcb file) will go away, and the new one will take its place.</div>
 599 </li>
 600 </ol>
 601
 602 </div>
 603
 604 <h4 id="work_required2">Work required</h4>
 605 <div class="level4">
 606
 607 <p>
 608 This project involves:
 609 </p>
 610 <ol>
 611 <li class="level1"><div class="li"> Create internal structures and methods needed to support a separate footprint editor.</div>
 612 </li>
 613 <li class="level1"><div class="li"> Create footprint editing window (if the separate window approach is adopted).</div>
 614 </li>
 615 <li class="level1"><div class="li"> Integrate access to footprint editor into main PCB <abbr title="Graphical User Interface">GUI</abbr>.</div>
 616 </li>
 617 <li class="level1"><div class="li"> Testing and bug cleanup.</div>
 618 </li>
 619 </ol>
 620 <hr />
 621
 622 </div>
 623 <!-- EDIT6 SECTION "Footprint editor implementation" [18440-24028] -->
 624 <h3 class="sectionedit7" id="upgrade_of_layer_and_design_objects">Upgrade of layer and design objects</h3>
 625 <div class="level3">
 626
 627 </div>
 628
 629 <h4 id="feature_description1">Feature Description</h4>
 630 <div class="level4">
 631
 632 <p>
 633 Currently, PCB&#039;s internal data structures only “know” about metal and silk
 634 layers.  Other layers commonly used in PCB design are either missing (e.g. DRC
 635 layer, outline layer), or are simply derived from the metal layer (solder
 636 mask).  This task involves implementing full support for layers of arbitrary
 637 type and layer count.  Also, support for other design objects is part of this
 638 upgrade.  Specific features required are:
 639 </p>
 640 <ul>
 641 <li class="level1"><div class="li"> Upgrade of existing datastructures to support layers of arbitrary type including: DRC, mechanical outline, annotation, solder mask, paste mask, plated through-hole, unplated through-hole, metal, silk.  The upgrade must also provide support for an arbitrary number of layers.  Also, allowing for per-layer clearance settings is an important feature for inclusion here.</div>
 642 </li>
 643 </ul>
 644 <ul>
 645 <li class="level1"><div class="li"> Implement window widget allowing for easy selection/configuration of layer stack-up.  Parameters to configure include:  layer count, layer type, layer polarity, layer visibility, layer color.  The window will also allow the user to re-order the layers (from front to back), and to add or subtract an arbitrary number of layers.  The layer window presented in “gerbv” is a reasonable example of what this window should support.</div>
 646 </li>
 647 </ul>
 648 <ul>
 649 <li class="level1"><div class="li"> Implement a new datastructure representing a pad stack.</div>
 650 </li>
 651 </ul>
 652 <ul>
 653 <li class="level1"><div class="li"> Implement a window widget allowing for easy editing of the pad stack&#039;s properties, including: metal annulus outer diameter (per layer), solder mask diameter (per layer), paste mask diameter (per layer), clearance width (per layer), hole diameter.</div>
 654 </li>
 655 </ul>
 656 <ul>
 657 <li class="level1"><div class="li"> Consider how the data-structures could allow support for blind or burried vias in the future.</div>
 658 </li>
 659 </ul>
 660
 661 </div>
 662
 663 <h4 id="work_required3">Work required</h4>
 664 <div class="level4">
 665
 666 <p>
 667 This project involves:
 668 </p>
 669 <ol>
 670 <li class="level1"><div class="li"> Upgrade internal structures and methods to enable full layer support.</div>
 671 </li>
 672 <li class="level1"><div class="li"> Create layer configuration window.</div>
 673 </li>
 674 <li class="level1"><div class="li"> Create internal datastructures and methods to support padstacks.</div>
 675 </li>
 676 <li class="level1"><div class="li"> Create padstack configuration window.</div>
 677 </li>
 678 <li class="level1"><div class="li"> Testing and bug cleanup.</div>
 679 </li>
 680 </ol>
 681 <hr />
 682
 683 </div>
 684 <!-- EDIT7 SECTION "Upgrade of layer and design objects" [24029-26054] -->
 685 <h3 class="sectionedit8" id="design_rule_checking_upgrade">Design Rule Checking Upgrade</h3>
 686 <div class="level3">
 687
 688 </div>
 689
 690 <h4 id="feature_description2">Feature Description</h4>
 691 <div class="level4">
 692
 693 <p>
 694 The goal of design rule checking (DRC) is to insure that a printed circuit
 695 board layout conforms to a set of design rules.  Design rules will consist of
 696 specifications like minimum copper line width, minimum copper spacing,
 697 etc. Generating a manufacturable PCB layout without DRC is tedious at best
 698 </p>
 699
 700 <p>
 701 The current PCB DRC steps through design rule violations one by one using a
 702 dialog box that reports the error, the coordinate position of the error and
 703 places the cursor at the error. Bouncing back and forth between the layout and
 704 the dialog box is time consuming. Knowing all of the errors prior to starting
 705 error correction is usually more productive.
 706 </p>
 707
 708 <p>
 709 A preferred method of reporting DRC violations would be to graphically
 710 indicate all errors on the layout. With this method all errors are quickly
 711 visible. DJ has suggested a layer for displaying DRC errors.  The user should
 712 be able to turn the layer visibility on and off.
 713 </p>
 714
 715 <p>
 716 A useful option for DRC would be to have it run periodically.  A proactive DRC
 717 should help novices avoid creating multiple similar errors.  Threaded operation,
 718 or a DRC which works in packets of time where the
 719 mainloop hits idle would be possibilities here. Both have their merits
 720 and draw-backs. If the operation is slow, we&#039;ll need some way to queue
 721 the work such that updates to the board in the mean time queue updates
 722 for new DRC checking.
 723 </p>
 724
 725 <p>
 726 Similarly, we&#039;d need to ensure that removing or
 727 changing objects on the board doesn&#039;t crash the DRC code - if it is
 728 running in a thread.
 729 </p>
 730
 731 </div>
 732
 733 <h4 id="use_cases1">Use Cases</h4>
 734 <div class="level4">
 735
 736 <p>
 737 <strong>Manual DRC</strong>
 738 </p>
 739 <ol>
 740 <li class="level1"><div class="li"> The user runs DRC using either a hot-key or menu item. An unobtrusive DRC status indicator is displayed. Perhaps the phrase “DRC Check” in yellow text in the top bar.</div>
 741 </li>
 742 <li class="level1"><div class="li"> DRC violation marks are displayed on the DRC layer or on the PCB the layout.</div>
 743 </li>
 744 <li class="level1"><div class="li"> An unobtrusive DRC status indicator is displayed.  Perhaps the phrases “DRC PASS” in green text and “DRC FAIL” in red text in the top bar.</div>
 745 </li>
 746 <li class="level1"><div class="li"> If there are DRC failures the user can step to the next error manually or by using a hot-key. After changes are made the DRC can be run manually to verify the fix.</div>
 747 </li>
 748 </ol>
 749
 750 <p>
 751 <strong>Automatic DRC</strong>
 752 </p>
 753 <ol>
 754 <li class="level1"><div class="li"> Using a menu item the user can set the appropriate time interval for running DRC. A default value is used if a new value is not set.</div>
 755 </li>
 756 <li class="level1"><div class="li"> The user enables automatic DRC mode.</div>
 757 </li>
 758 <li class="level1"><div class="li"> After the DRC idle period has elapsed DRC runs.  An unobtrusive DRC status indicator is displayed. Perhaps the phrase “DRC Check” in yellow text in the top bar.</div>
 759 </li>
 760 <li class="level1"><div class="li"> DRC violation marks are displayed on the DRC layer or on the PCB layout.</div>
 761 </li>
 762 <li class="level1"><div class="li"> An unobtrusive DRC status indicator is displayed.  Perhaps the phrase “DRC PASS” in green text and “DRC FAIL” in red text in the top bar.</div>
 763 </li>
 764 <li class="level1"><div class="li"> If there are DRC failures the user can step to the next error manually or by using a hot-key. After changes are made the DRC can be run manually to verify the fix.</div>
 765 </li>
 766 </ol>
 767
 768 </div>
 769
 770 <h4 id="work_required4">Work required</h4>
 771 <div class="level4">
 772
 773 <p>
 774 This project involves:
 775 </p>
 776 <ol>
 777 <li class="level1"><div class="li"> Implementation of DRC layer (part of work called out in “DRC Upgrade” section).</div>
 778 </li>
 779 <li class="level1"><div class="li"> Upgrade existing DRC checker with new DRC layer.</div>
 780 </li>
 781 <li class="level1"><div class="li"> Update <abbr title="Graphical User Interface">GUI</abbr> to use upgraded DRC checker.</div>
 782 </li>
 783 <li class="level1"><div class="li"> Testing and bug cleanup.</div>
 784 </li>
 785 </ol>
 786 <hr />
 787
 788 </div>
 789 <!-- EDIT8 SECTION "Design Rule Checking Upgrade" [26055-29240] -->
 790 <h3 class="sectionedit9" id="project_milestones_duration_and_budget_estimates">Project milestones, duration, and budget estimates</h3>
 791 <div class="level3">
 792
 793 <p>
 794 Although they are intertwined, the major focus areas are scoped independently
 795 here.  Ordinarily, a project manager would put a Gantt chart here, but that
 796 level of detail is probably too fine for the purposes of an open source
 797 project.  Therefore, I simply call out an estimated time required for each
 798 subtask.  The project duration times are SWAGs based upon my limited experience in estimating software projects.  They are based upon 8 hour work days (i.e. this work is performed
 799 as a full-time job) at a nominal billing rate of $50/hour.  <strong>It is up to the developer to
 800 validate these estimations and negotiate his own billing rate before he agrees to perform this work.</strong>
 801 </p>
 802
 803 </div>
 804
 805 <h4 id="forward_annotation_upgrade1">Forward annotation upgrade</h4>
 806 <div class="level4">
 807 <ol>
 808 <li class="level1"><div class="li"> Determine which actions remain to be scripted so that forward annotation of any board is possible using an action list.  (2 days).</div>
 809 </li>
 810 <li class="level1"><div class="li"> Define syntax for remaining actions, and document full syntax (2 days).  This document will be used to update gsch2pcb (outside the scope of this project).</div>
 811 </li>
 812 <li class="level1"><div class="li"> Write sample action scripts for testing purposes (1 day).</div>
 813 </li>
 814 <li class="level1"><div class="li"> Creating the missing actions required for full forward annotation (3 days).</div>
 815 </li>
 816 <li class="level1"><div class="li"> Creating a method for reading in an action script (2 days)</div>
 817 </li>
 818 <li class="level1"><div class="li"> Integrating the new script-based forward annotation into PCB&#039;s <abbr title="Graphical User Interface">GUI</abbr> (1 day)</div>
 819 </li>
 820 <li class="level1"><div class="li"> Testing and bug cleanup (5 days).</div>
 821 </li>
 822 </ol>
 823
 824 <p>
 825 Total duration:  16 days = 128 hours.
 826 Cost: $6400
 827 </p>
 828
 829 </div>
 830
 831 <h4 id="gui_modernization1">GUI modernization</h4>
 832 <div class="level4">
 833 <ol>
 834 <li class="level1"><div class="li"> Refactoring and upgrade of program internals to support noun/verb actions (5 days)</div>
 835 </li>
 836 <li class="level1"><div class="li"> Create new windows (e.g. object editor, move, rotate, etc.) (5 days).  </div>
 837 </li>
 838 <li class="level1"><div class="li"> Refactoring and upgrade of program internals to support selection modes (5 days).</div>
 839 </li>
 840 <li class="level1"><div class="li"> Implementation of <abbr title="Graphical User Interface">GUI</abbr> resource file which is read in upon program start to configure user interface (3 days).</div>
 841 </li>
 842 <li class="level1"><div class="li"> <abbr title="Graphical User Interface">GUI</abbr> upgrade.  Specifically, hook up the callbacks to the menu items and buttons defined in the <abbr title="Graphical User Interface">GUI</abbr> resource file (3 days).</div>
 843 </li>
 844 <li class="level1"><div class="li"> Testing and bug cleanup (5 days).</div>
 845 </li>
 846 </ol>
 847
 848 <p>
 849 Total duration: 26 days = 208 hours
 850 Cost: $10400
 851 </p>
 852
 853 </div>
 854
 855 <h4 id="footprint_editor_implementation1">Footprint editor implementation</h4>
 856 <div class="level4">
 857 <ol>
 858 <li class="level1"><div class="li"> Create internal structures and methods needed to support a separate footprint editor (4 days).</div>
 859 </li>
 860 <li class="level1"><div class="li"> Create footprint editing window (if the separate window approach is adopted) (3 days).</div>
 861 </li>
 862 <li class="level1"><div class="li"> Integrate access to footprint editor into main PCB <abbr title="Graphical User Interface">GUI</abbr> (2 days).</div>
 863 </li>
 864 <li class="level1"><div class="li"> Testing and bug cleanup (5 days).</div>
 865 </li>
 866 </ol>
 867
 868 <p>
 869 Total duration: 14 days = 112 hours.
 870 Cost: $5600
 871 </p>
 872
 873 </div>
 874
 875 <h4 id="layer_design_object_upgrade">Layer/design object upgrade</h4>
 876 <div class="level4">
 877 <ol>
 878 <li class="level1"><div class="li"> Upgrade internal structures and methods to enable full layer support (5 days).</div>
 879 </li>
 880 <li class="level1"><div class="li"> Create layer configuration window (3 days).</div>
 881 </li>
 882 <li class="level1"><div class="li"> Create internal datastructures and methods to support padstacks (4 days).</div>
 883 </li>
 884 <li class="level1"><div class="li"> Create padstack configuration window (3 days).</div>
 885 </li>
 886 <li class="level1"><div class="li"> Testing and bug cleanup (5 days).</div>
 887 </li>
 888 </ol>
 889
 890 <p>
 891 Total duration: 20 days = 160 hours.
 892 Cost: $8000
 893 </p>
 894
 895 </div>
 896
 897 <h4 id="design_rule_checking_upgrade1">Design Rule Checking Upgrade</h4>
 898 <div class="level4">
 899 <ol>
 900 <li class="level1"><div class="li"> Implementation of DRC layer (part of work called out in “DRC Upgrade” section) (0 days, assuming layer upgrade is complete).</div>
 901 </li>
 902 <li class="level1"><div class="li"> Upgrade existing DRC checker with new DRC layer (3 days).</div>
 903 </li>
 904 <li class="level1"><div class="li"> Update <abbr title="Graphical User Interface">GUI</abbr> to use upgraded DRC checker (2 days).</div>
 905 </li>
 906 <li class="level1"><div class="li"> Testing and bug cleanup (5 days).</div>
 907 </li>
 908 </ol>
 909
 910 <p>
 911 Total duration: 10 days = 80 hours.
 912 Cost: $4000
 913 </p>
 914
 915 </div>
 916 <!-- EDIT9 SECTION "Project milestones, duration, and budget estimates" [29241-] --></body>
 917 </html>