haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Developer documentation clean up. 

* Remove push and shove router documentation which is maintained in the
  user documentation.
* Remove coding_style_policy.pdf since it is know automatically generated
  with the developers documentation and linked on the KiCad website.
* Merge the contents of rules_for_capitalization_in_Kicad_UI.txt into
  UIPolicy.txt.
* Remove rules_for_capitalization_in_Kicad_UI.txt.
This commit is contained in:
Wayne Stambaugh 2016-01-03 16:53:20 -05:00
parent c751bf60bc
commit bd436aa6a7
9 changed files with 48 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
Documentation/coding_style_policy.pdf
View File

Binary file not shown.

48
Documentation/guidelines/UIpolicies.txt
View File

@ -15,6 +15,53 @@ Capitalization:
idea use this capitalization in source code comments as well to prevent
confusion of new contributors.
Two styles of capitalization are used in GNOME user interface elements:
Header capitalization
Capitalize all words in the element, with the following exceptions:
Articles: a, an, the.
Conjunctions: and, but, for, not, so, yet ...
Prepositions of three or fewer letters: at, for, by, in, to ...
Sentence capitalization
Capitalize the first letter of the first word, and any other words
normally capitalized in sentences,such as application names.
The following table indicates the capitalization style to use for each
type of user interface element.
Table 8-3 Capitalization Style Guidelines for User Interface Elements
Element Style
Check box labels Sentence
Command button labels Header
Column heading labels Header
Desktop background object labels Header
Dialog messages Sentence
Drop-down combination box labels Sentence
Drop-down list box labels Sentence
Field labels Sentence
Filenames Sentence
Graphic equivalent text:
for example, Alt text on web pages Sentence
Group box or frame labels Header
Items in drop-down combination boxes,
drop-down list boxes, and list boxes Sentence
List box labels Sentence
Menu items Header
Menu items in applications Header
Menu titles in applications Header
Radio button labels Sentence
Slider labels Sentence
Spin box labels Sentence
Tabbed section titles Header
Text box labels Sentence
Titlebar labels Header
Toolbar button labels Header
Tooltips Sentence
Webpage titles and navigational elements Header
Dialogs:
@ -73,6 +120,7 @@ Dialogs:
within the dialog, but for testing purposes please do not exceed this dialog
size should the user have selected a font size of 13 points.
Quoting:
Filenames, paths or other text should be with single quotes ''. e.g.:
'filename.kicad_pcb'

5
Documentation/interactive_router/build.sh
View File

@ -1,5 +0,0 @@
#!/bin/bash
pandoc -f markdown_mmd -t html interactive_router.mmd > interactive_router.html
pandoc -f markdown_mmd -t latex interactive_router.mmd > tmp.tex
pdflatex interactive_router.tex

73
Documentation/interactive_router/interactive_router.mmd
View File

@ -1,73 +0,0 @@
# Interactive Router #
The Interactive Router lets you quickly and efficient route your PCBs by shoving off or walking around items on the PCB that collide with the trace you are currently drawing.
Following modes are supported:
- **Shove**, attempting to push and shove all items colliding with the currently routed track.
- **Walk around**, trying to avoid obstacles by hugging/walking around them.
- **Highlight collisions** which highlights all violating objects with a nice, shiny green color and shows violating clearance regions.
## Setting up ##
Before using the Interactive Router, please set up these two things:
- Clearance settings. To set the clearances, open the *Design Rules* dialog and make sure at least the default clearance
value looks sensible.
- Enable OpenGL mode by selecting *View->Switch canvas to OpenGL* menu option or pressing **F11**.
![Screenshot](pictures/opengl_menu.png)
## Laying out tracks ##
To activate the router tool press the *Interactive Router* button ![Interactive Router Button](pictures/route_icon.png) or the **X** key.
The cursor will turn into a cross and the tool name, will appear in the status bar.
To start a track, click on any item (a pad, track or a via) or press the **X** key again hovering the mouse over that item.
The new track will use the net of the starting item. Clicking or pressing **X** on empty PCB space starts a track with no net assigned.
Move the mouse to define shape of the track. The router will try to follow mouse trail, hugging unmovable obstacles
(such as pads) and shoving colliding traces/vias, depending on the mode. Retreating mouse cursor will cause the shoved items to spring back
to their former locations.
Clicking on a pad/track/via in the same net finishes routing. Clicking in empty space fixes the segments routed so far and continues routing the trace.
In order to stop routing and undo all changes (shoved items, etc.), simply press **Esc**.
Pressing **V** or selecting *Place Through Via* from the context menu while routing a track attaches a via at the end of the trace being routed.
Pressing **V** again disables via placement. Clicking in any spot establishes the via and continues routing.
Pressing **/** or selecting *Switch Track Posture* from the context menu toggles the direction of the initial track segment between straight or diagonal.
**Note**: By default, the router snaps to centers/axes of the items. Snapping can be disabled by holding **Shift** while routing or selecting items.
## Setting track widths and via sizes ##
There are several ways to pre-select a track width/via size or to change it during routing:
- Use standard Kicad shortcuts.
- Press **W** or select *Custom Track Width* from the context menu to type in a custom width/via size.
- Pick a predefined width from the *Select Track Width* sub-menu of the context menu.
- Select *Use the starting track width* in the *Select Track Width* menu to pick the width from the start item (or the traces already connected to it).
## Dragging ##
The router can drag track segments, corners and vias. To drag an item, click on it with **Ctrl** key pressed, hover the mouse and press **G** or select *Drag Track/Via* from the context menu.
Finish dragging by clicking again or abort by pressing *Esc*.
## Options ##
The router behavior be configured by pressing *E* or selecting *Routing Options* from the context menu. It opens a window like the one below:
![Screenshot](pictures/router_options.png)
The options are:
- **Mode** - select how the router handles DRC violation (shoving, walking around, etc.)
- **Shove vias** - when disabled, vias are treated as un-movable objects and hugged instead of shoved.
- **Jump over obstacles** - when enabled, the router tries to move colliding traces behind solid obstacles (e.g. pads) instead of "reflecting" back the collision
- **Remove redundant tracks** - removes loops while routing (e.g. if the new track ensures same connectivity as an already existing one, the old track is removed). Loop removal works locally (only between the start and end of the currently routed trace).
- **Automatic neckdown** - when enabled, the router tries to break out pads/vias in a clean way, avoiding acute angles and jagged breakout traces.
- **Smooth dragged segments** - when enabled, the router attempts to merge several jagged segments into a single straight one (dragging mode).
- **Allow DRC violations** (*Highlight collisions* mode only) - allows to establish a track even if is violating the DRC rules.
- **Optimizer effort** - defines how much time the router shall spend optimizing the routed/shoved traces. More effort means cleaner routing (but slower), less effort means faster routing but somewhat jagged traces.

BIN
Documentation/interactive_router/pictures/opengl_menu.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 43 KiB

BIN
Documentation/interactive_router/pictures/route_icon.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 547 B

BIN
Documentation/interactive_router/pictures/router_options.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 37 KiB

BIN
Documentation/interactive_router/pictures/rules_editor.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 58 KiB

48
Documentation/rules_for_capitalization_in_Kicad_UI.txt
View File

@ -1,48 +0,0 @@
Gnome rules, used in Kicad:
8.3.2. Capitalization
Two styles of capitalization are used in GNOME user interface elements:
Header capitalization
Capitalize all words in the element, with the following exceptions:
Articles: a, an, the.
Conjunctions: and, but, for, not, so, yet ...
Prepositions of three or fewer letters: at, for, by, in, to ...
Sentence capitalization
Capitalize the first letter of the first word, and any other words normally capitalized in sentences,
such as application names.
The following table indicates the capitalization style to use for each type of user interface element.
Table 8-3 Capitalization Style Guidelines for User Interface Elements
Element Style
Check box labels Sentence
Command button labels Header
Column heading labels Header
Desktop background object labels Header
Dialog messages Sentence
Drop-down combination box labels Sentence
Drop-down list box labels Sentence
Field labels Sentence
Filenames Sentence
Graphic equivalent text:
for example, Alt text on web pages Sentence
Group box or frame labels Header
Items in drop-down combination boxes,
drop-down list boxes, and list boxes Sentence
List box labels Sentence
Menu items Header
Menu items in applications Header
Menu titles in applications Header
Radio button labels Sentence
Slider labels Sentence
Spin box labels Sentence
Tabbed section titles Header
Text box labels Sentence
Titlebar labels Header
Toolbar button labels Header
Tooltips Sentence
Webpage titles and navigational elements Header