Minor developer's documentation fixes.

Fix duplicate table of content links.

Fix heading level issues in version 6 road map.

Add new Python action menu options to compiling document.
This commit is contained in:
Wayne Stambaugh 2017-01-24 10:14:27 -05:00
parent 1a05c8a5a8
commit 0b6147ed05
3 changed files with 16 additions and 10 deletions

View File

@ -12,7 +12,7 @@ Dick Hollenbeck \<<dick@softplc.com>\>
[TOC] [TOC]
# 1. Introduction # {#intro} # 1. Introduction # {#csp_intro}
The purpose of this document is to provide a reference guide for KiCad The purpose of this document is to provide a reference guide for KiCad
developers about how source code should be styled and formatted in developers about how source code should be styled and formatted in
KiCad. It is not a comprehensive programming guide because it does not KiCad. It is not a comprehensive programming guide because it does not

View File

@ -174,6 +174,12 @@ whether install them or not with the KICAD_INSTALL_DEMOS option. You can also se
install them with the KICAD_DEMOS variable. On Linux the demos are installed in install them with the KICAD_DEMOS variable. On Linux the demos are installed in
$PREFIX/share/kicad/demos by default. $PREFIX/share/kicad/demos by default.
## Python Scripting Action Menu Support ## {#python_action_menu_opt}
The KICAD_SCRIPTING_ACTION_MENU option allows Python scripts to be added directly to the Pcbnew
menu. This option is disabled by default. Please note that this option is highly experimental
and can cause Pcbnew to crash if Python scripts create an invalid object state within Pcbnew.
## Setting the Build Version and Repository Name ## {#build_version_opt} ## Setting the Build Version and Repository Name ## {#build_version_opt}
The KiCad version string is defined by the three CMake variables KICAD_VERSION, KICAD_BRANCH_NAME, The KiCad version string is defined by the three CMake variables KICAD_VERSION, KICAD_BRANCH_NAME,

View File

@ -93,7 +93,7 @@ Improve the coverage and usability of the electrical rules checker (ERC).
**Status:** **Status:**
- No progress. - No progress.
# Implement GAL and New Tool Framework ## {#v6_sch_gal} ## Implement GAL and New Tool Framework ## {#v6_sch_gal}
**Goal:** **Goal:**
Implement the GAL and the tool framework used by Pcbnew in Eechema to Implement the GAL and the tool framework used by Pcbnew in Eechema to
@ -109,7 +109,7 @@ provide advanced graphics and tool capabilities.
**Status:** **Status:**
- Initial Discussion.. - Initial Discussion..
# Port Editing Tools ## {#v6_sch_tool_framework} ## Port Editing Tools ## {#v6_sch_tool_framework}
**Goal:** **Goal:**
Convert all editing tool to new tool framework. Convert all editing tool to new tool framework.
@ -157,7 +157,7 @@ representations easier.
**Status:** **Status:**
- No progress. - No progress.
## Allow Use of System Fonts ## {#sch_sys_fonts} ## Allow Use of System Fonts ## {#v6_sch_sys_fonts}
**Goal:** **Goal:**
Currently the schematic editor uses the stroke drawn fonts which aren't really Currently the schematic editor uses the stroke drawn fonts which aren't really
@ -294,7 +294,7 @@ Add support for keepout zones on boards and footprints.
**Progress:** **Progress:**
- Planning - Planning
## Clipboard Support ## {#fp_edit_clipboard} ## Clipboard Support ## {#v6_fp_edit_clipboard}
**Goal:** **Goal:**
Provide clipboard cut and paste for footprints. Provide clipboard cut and paste for footprints.
@ -309,7 +309,7 @@ Provide clipboard cut and paste for footprints.
**Status:** **Status:**
- No progress. - No progress.
## Net Highlighting ## {#pcb_net_highlight} ## Net Highlighting ## {#v6_pcb_net_highlight}
**Goal:** **Goal:**
Highlight rats nest links and/or traces when corresponding net in Eeschema is selected. Highlight rats nest links and/or traces when corresponding net in Eeschema is selected.
@ -325,7 +325,7 @@ Highlight rats nest links and/or traces when corresponding net in Eeschema is se
**Status:** **Status:**
- No progress. - No progress.
## Hatched Zone Filling ## {#pcb_hatched_zones} ## Hatched Zone Filling ## {#v6_pcb_hatched_zones}
**Goal:** **Goal:**
Currently Pcbnew only supports solid zone files. Add option to fill zones Currently Pcbnew only supports solid zone files. Add option to fill zones
@ -341,7 +341,7 @@ with hatching.
**Status:** **Status:**
- No progress. - No progress.
## Board Stack Up Impedance Calculator ## {#pcb_impedance_calc} ## Board Stack Up Impedance Calculator ## {#v6_pcb_impedance_calc}
**Goal:** **Goal:**
Provide a calculator to compute trace impedances using a full board stackup. Provide a calculator to compute trace impedances using a full board stackup.
@ -356,7 +356,7 @@ Maybe this should be included in the PCB calculator application.
**Status:** **Status:**
- No progress. - No progress.
## Net Class Improvements ## {#pcb_net_class_improvements} ## Net Class Improvements ## {#v6_pcb_net_class_improvements}
**Goal:** **Goal:**
Add support for route impedance, color selection, etc in net class object. Add support for route impedance, color selection, etc in net class object.
@ -375,7 +375,7 @@ Add support for route impedance, color selection, etc in net class object.
**Status:** **Status:**
- No progress. - No progress.
## Ratsnest Improvements ## {#pcb_ratsnest_improvements} ## Ratsnest Improvements ## {#v6_pcb_ratsnest_improvements}
**Goal:** **Goal:**
Add support for per net color and visibility settings. Add support for per net color and visibility settings.