diff --git a/.bzrignore b/.bzrignore index 2e96f18ee3..61e1b52445 100644 --- a/.bzrignore +++ b/.bzrignore @@ -1,5 +1,6 @@ boost_root .downloads-by-cmake +Build common/netlist_keywords.* common/netlist_lexer.h common/pcb_plot_params_lexer.h diff --git a/HOW_TO_CONTRIBUTE.txt b/Documentation/HOW_TO_CONTRIBUTE.txt similarity index 56% rename from HOW_TO_CONTRIBUTE.txt rename to Documentation/HOW_TO_CONTRIBUTE.txt index 510c49e6c1..d042329528 100644 --- a/HOW_TO_CONTRIBUTE.txt +++ b/Documentation/HOW_TO_CONTRIBUTE.txt @@ -11,32 +11,40 @@ Contribute to KiCad (under Linux) 2) initialize Bazaar: bzr whoami "John Doe " -3) get LATEST KiCad source tree and name it, for instance, "kicad_john": +3) get latest KiCad source tree: cd ~/ - bzr branch lp:kicad kicad_john + bzr branch lp:kicad kicad.bzr -4) Read coding_style_policy.pdf, in /Documentation, - and other docs. + this should leave you with the folder kicad.bzr -5) Modify/add source code. - cd kicad_john +4) Read coding_style_policy.pdf, in kicad.bzr/Documentation, + and other docs. + +5) create a local (branch) copy of the KiCad project + bzr branch ./kicad.bzr ./kicad.my_contrib + +6) Modify/add source code in + cd kicad.my_contrib gedit ....... + if you need to create and add the file foo.cpp do so and: + bzr add foo.cpp + if you need to delete files: + bzr rm foo.cpp -6) Compile: - cd kicad_john +7) Compile: + cd kicad.my_contrib mkdir build; cd build cmake ../ -DCMAKE_BUILD_TYPE=Debug - to build a debug version - or + to build a debug version + or cmake ../ -DCMAKE_BUILD_TYPE=Release - to build a release version - make + to build a release version + make -j8 -7) Repeat step 5 and 6 until satisfied. +8) Repeat step 6 and 7 until satisfied. -8) Create a patch: - in kicad_john: - if some files are added: bzr add [FILE...] +9) Create a patch file: + cd kicad.my_contrib bzr diff > my_changes.patch 9) Send the patch file "my_changes.patch" to the KiCad developers mailing list. diff --git a/eeschema/help_common_strings.h b/eeschema/help_common_strings.h index 0ad221015c..c3290c6faf 100644 --- a/eeschema/help_common_strings.h +++ b/eeschema/help_common_strings.h @@ -13,55 +13,54 @@ */ // Common to schematic editor and component editor -#define HELP_UNDO _( "Undo last edition" ) -#define HELP_REDO _( "Redo the last undo command" ) +#define HELP_UNDO _( "Undo last command" ) +#define HELP_REDO _( "Redo last command" ) #define HELP_ZOOM_IN _( "Zoom in" ) #define HELP_ZOOM_OUT _( "Zoom out" ) -#define HELP_ZOOM_FIT _( "Fit the schematic sheet on the screen" ) -#define HELP_ZOOM_REDRAW _( "Redraw the schematic view" ) +#define HELP_ZOOM_FIT _( "Fit schematic sheet on screen" ) +#define HELP_ZOOM_REDRAW _( "Redraw schematic view" ) -#define HELP_DELETE_ITEMS _( "Delete items" ) +#define HELP_DELETE_ITEMS _( "Delete item" ) // Schematic editor: -#define HELP_FIND _( "Find components and texts" ) +#define HELP_FIND _( "Find components and text" ) #define HELP_REPLACE _( "Find and replace text in schematic items" ) -#define HELP_PLACE_COMPONENTS _( "Place a component" ) -#define HELP_PLACE_POWERPORT _( "Place a power port" ) -#define HELP_PLACE_WIRE _( "Place a wire" ) -#define HELP_PLACE_BUS _( "Place a bus" ) -#define HELP_PLACE_WIRE2BUS_ENTRY _( "Place a wire to bus entry" ) -#define HELP_PLACE_BUS2BUS_ENTRY _( "Place a bus to bus entry" ) -#define HELP_PLACE_NC_FLAG _( "Place a no connect flag" ) +#define HELP_PLACE_COMPONENTS _( "Place component" ) +#define HELP_PLACE_POWERPORT _( "Place power port" ) +#define HELP_PLACE_WIRE _( "Place wire" ) +#define HELP_PLACE_BUS _( "Place bus" ) +#define HELP_PLACE_WIRE2BUS_ENTRY _( "Place wire to bus entry" ) +#define HELP_PLACE_BUS2BUS_ENTRY _( "Place bus to bus entry" ) +#define HELP_PLACE_NC_FLAG _( "Place not-connected flag" ) -#define HELP_PLACE_NETLABEL _( "Place a net name (local label)" ) +#define HELP_PLACE_NETLABEL _( "Place net name - local label" ) #define HELP_PLACE_GLOBALLABEL \ _(\ - "Place a global label.\nWarning: all global labels with the same name are connected in whole hierarchy" ) + "Place global label.\nWarning: inside global hierarchy , all global labels with same name are connected" ) #define HELP_PLACE_HIER_LABEL \ - _( "Place a hierarchical label. This label will be seen as a hierarchical pin in the sheet symbol" ) + _( "Place a hierarchical label. Label will be seen as a hierarchical pin in the sheet symbol" ) -#define HELP_PLACE_JUNCTION _( "Place a junction" ) -#define HELP_PLACE_SHEET _( "Create a hierarchical sheet" ) +#define HELP_PLACE_JUNCTION _( "Place junction" ) +#define HELP_PLACE_SHEET _( "Create hierarchical sheet" ) #define HELP_IMPORT_SHEETPIN _( \ - "Place a hierarchical pin imported from the corresponding hierarchical label in sheet" ) -#define HELP_PLACE_SHEETPIN _( "Place a hierarchical pin in sheet" ) + "Place hierarchical pin imported from the corresponding hierarchical label" ) +#define HELP_PLACE_SHEETPIN _( "Place hierarchical pin in sheet" ) #define HELP_PLACE_GRAPHICLINES _( "Place graphic lines or polygons" ) -#define HELP_PLACE_GRAPHICTEXTS _( "Place graphic text (comment)" ) +#define HELP_PLACE_GRAPHICTEXTS _( "Place graphic text/comment" ) -#define HELP_ANNOTATE _( "Annotate the components in the schematic" ) -#define HELP_RUN_LIB_EDITOR _( "Library editor - Create and edit components" ) -#define HELP_RUN_LIB_VIEWER _( "Library browser - Browse components" ) +#define HELP_ANNOTATE _( "Annotate schematic components" ) +#define HELP_RUN_LIB_EDITOR _( "Library Editor - Create/edit components" ) +#define HELP_RUN_LIB_VIEWER _( "Library Browser - Browse components" ) #define HELP_GENERATE_BOM _( "Generate bill of materials and/or cross references" ) #define HELP_IMPORT_FOOTPRINTS \ - _( "Import the footprint selection from CvPcb (the .cmp file)\n\ -in component footprint fields" ) + _( "Back-import component footprint fields via CvPcb .cmp file" ) // Component editor: -#define HELP_ADD_PIN _( "Add pins to the component" ) -#define HELP_ADD_BODYTEXT _( "Add graphic texts to the component body" ) -#define HELP_ADD_BODYRECT _( "Add graphic rectangles to the component body" ) -#define HELP_ADD_BODYCIRCLE _( "Add circles to the component body" ) -#define HELP_ADD_BODYARC _( "Add arcs to the component body" ) -#define HELP_ADD_BODYPOLYGON _( "Add lines and polygons to the component body" ) -#define HELP_PLACE_GRAPHICIMAGES _("Add a bitmap image") +#define HELP_ADD_PIN _( "Add pins to component" ) +#define HELP_ADD_BODYTEXT _( "Add text to component body" ) +#define HELP_ADD_BODYRECT _( "Add graphic rectangle to component body" ) +#define HELP_ADD_BODYCIRCLE _( "Add circles to component body" ) +#define HELP_ADD_BODYARC _( "Add arcs to component body" ) +#define HELP_ADD_BODYPOLYGON _( "Add lines and polygons to component body" ) +#define HELP_PLACE_GRAPHICIMAGES _("Add bitmap image") diff --git a/eeschema/menubar.cpp b/eeschema/menubar.cpp index 291f3b5af3..412d8b27d0 100644 --- a/eeschema/menubar.cpp +++ b/eeschema/menubar.cpp @@ -1,9 +1,9 @@ /* * This program source code file is part of KiCad, a free EDA CAD application. * - * Copyright (C) 2007 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com - * Copyright (C) 2009-2011 Wayne Stambaugh - * Copyright (C) 1992-2011 KiCad Developers, see AUTHORS.txt for contributors. + * Copyright (C) 2014 Jean-Pierre Charras, jp.charras at wanadoo.fr + * Copyright (C) 2009-2014 Wayne Stambaugh + * Copyright (C) 1992-2014 KiCad Developers, see AUTHORS.txt for contributors. * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License @@ -66,15 +66,15 @@ void SCH_EDIT_FRAME::ReCreateMenuBar() // New AddMenuItem( fileMenu, ID_NEW_PROJECT, - _( "&New" ), - _( "New schematic project" ), + _( "&New Schematic Project" ), + _( "Clear current schematic hierarchy and start a new schematic root sheet" ), KiBitmap( new_xpm ) ); // Open - text = AddHotkeyName( _( "&Open" ), s_Schematic_Hokeys_Descr, HK_LOAD_SCH ); + text = AddHotkeyName( _( "&Open Schematic Sheet" ), s_Schematic_Hokeys_Descr, HK_LOAD_SCH ); AddMenuItem( fileMenu, ID_LOAD_PROJECT, text, - _( "Open an existing schematic project" ), + _( "Open an existing schematic sheet" ), KiBitmap( open_document_xpm ) ); // Open Recent submenu @@ -95,19 +95,19 @@ void SCH_EDIT_FRAME::ReCreateMenuBar() // Import AddMenuItem( fileMenu, - ID_APPEND_PROJECT, _( "&Append Schematic" ), - _( "Append another schematic project to the current loaded schematic" ), + ID_APPEND_PROJECT, _( "&Append Schematic Sheet" ), + _( "Append schematic sheet to current project" ), KiBitmap( open_document_xpm ) ); // Separator fileMenu->AppendSeparator(); // Save schematic project - text = AddHotkeyName( _( "&Save Whole Schematic Project" ), + text = AddHotkeyName( _( "&Save Schematic Project" ), s_Schematic_Hokeys_Descr, HK_SAVE_SCH ); AddMenuItem( fileMenu, ID_SAVE_PROJECT, text, - _( "Save all sheets in the schematic project" ), + _( "Save all sheets in schematic project" ), KiBitmap( save_project_xpm ) ); // Save current sheet @@ -131,14 +131,14 @@ void SCH_EDIT_FRAME::ReCreateMenuBar() AddMenuItem( fileMenu, ID_SHEET_SET, _( "Pa&ge Settings" ), - _( "Settigns for page size and information" ), + _( "Setting for sheet size and frame references" ), KiBitmap( sheetset_xpm ) ); // Print AddMenuItem( fileMenu, wxID_PRINT, _( "Pri&nt" ), - _( "Print schematic" ), + _( "Print schematic sheet" ), KiBitmap( print_button_xpm ) ); #ifdef __WINDOWS__ // __WINDOWS__ @@ -259,8 +259,8 @@ void SCH_EDIT_FRAME::ReCreateMenuBar() // Hierarchy AddMenuItem( viewMenu, ID_HIERARCHY, - _( "&Hierarchy" ), - _( "Navigate schematic hierarchy" ), + _( "Show &Hierarchical Navigator" ), + _( "Navigate hierarchical sheets" ), KiBitmap( hierarchy_nav_xpm ) ); // Redraw @@ -399,15 +399,15 @@ void SCH_EDIT_FRAME::ReCreateMenuBar() // Library AddMenuItem( preferencesMenu, ID_CONFIG_REQ, - _( "&Library" ), - _( "Library preferences" ), + _( "Set &Library Path" ), + _( "Set library preferences" ), KiBitmap( library_xpm ) ); // Colors AddMenuItem( preferencesMenu, ID_COLORS_SETUP, - _( "&Colors" ), - _( "Color preferences" ), + _( "Set &Colors Scheme" ), + _( "Set color preferences" ), KiBitmap( palette_xpm ) ); // Options (Preferences on WXMAC) @@ -417,8 +417,8 @@ void SCH_EDIT_FRAME::ReCreateMenuBar() #else AddMenuItem( preferencesMenu, wxID_PREFERENCES, - _( "&Options" ), - _( "Eeschema preferences" ), + _( "Schematic Editor &Options" ), + _( "Set Eeschema preferences" ), KiBitmap( preference_xpm ) ); #endif // __WXMAC__ @@ -467,21 +467,21 @@ void SCH_EDIT_FRAME::ReCreateMenuBar() // Annotate AddMenuItem( toolsMenu, ID_GET_ANNOTATE, - _( "&Annotate" ), HELP_ANNOTATE, + _( "&Annotate Schematic" ), HELP_ANNOTATE, KiBitmap( annotate_xpm ) ); // ERC AddMenuItem( toolsMenu, ID_GET_ERC, - _( "ER&C" ), + _( "Electric Rules &Checker" ), _( "Perform electrical rule check" ), KiBitmap( erc_xpm ) ); // Generate netlist AddMenuItem( toolsMenu, ID_GET_NETLIST, - _( "Generate &Netlist" ), - _( "Generate the component netlist" ), + _( "Generate &Netlist File" ), + _( "Generate the component netlist file" ), KiBitmap( netlist_xpm ) ); // Generate bill of materials @@ -517,14 +517,14 @@ void SCH_EDIT_FRAME::ReCreateMenuBar() // Contents AddMenuItem( helpMenu, wxID_HELP, - _( "&Contents" ), - _( "Open the Eeschema handbook" ), + _( "Eesc&hema Manual" ), + _( "Open Eeschema manual" ), KiBitmap( online_help_xpm ) ); AddMenuItem( helpMenu, wxID_INDEX, _( "&Getting Started in KiCad" ), - _( "Open the \"Getting Started in KiCad\" guide for beginners" ), + _( "Open \"Getting Started in KiCad\" guide for beginners" ), KiBitmap( help_xpm ) ); // About Eeschema diff --git a/kicad/commandframe.cpp b/kicad/commandframe.cpp index 0ad97f7eac..c49e90ed84 100644 --- a/kicad/commandframe.cpp +++ b/kicad/commandframe.cpp @@ -64,27 +64,27 @@ void LAUNCHER_PANEL::CreateCommandToolbar( void ) wxBitmapButton* btn; btn = AddBitmapButton( ID_TO_EESCHEMA, KiBitmap( icon_eeschema_xpm ) ); - btn->SetToolTip( _( "Eeschema (Schematic editor)" ) ); + btn->SetToolTip( _( "Eeschema - Electronic schematic editor" ) ); btn = AddBitmapButton( ID_TO_CVPCB, KiBitmap( icon_cvpcb_xpm ) ); - btn->SetToolTip( _( "CvPcb (Components to modules)" ) ); + btn->SetToolTip( _( "CvPcb - Associate footprint to components" ) ); btn = AddBitmapButton( ID_TO_PCB, KiBitmap( icon_pcbnew_xpm ) ); - btn->SetToolTip( _( "Pcbnew (PCB editor)" ) ); + btn->SetToolTip( _( "Pcbnew - Printed circuit board editor" ) ); btn = AddBitmapButton( ID_TO_GERBVIEW, KiBitmap( icon_gerbview_xpm ) ); - btn->SetToolTip( _( "GerbView (Gerber viewer)" ) ); + btn->SetToolTip( _( "GerbView - Gerber viewer" ) ); btn = AddBitmapButton( ID_TO_BITMAP_CONVERTER, KiBitmap( icon_bitmap2component_xpm ) ); btn->SetToolTip( _( - "Bitmap2Component (a tool to build a logo from a bitmap)\n\ -Creates a component (for Eeschema) or a footprint (for Pcbnew) that shows a B&W picture" ) ); + "Bitmap2Component - Convert bitmap images to Eeschema\n" + "or Pcbnew elements." ) ); btn = AddBitmapButton( ID_TO_PCB_CALCULATOR, KiBitmap( icon_pcbcalculator_xpm ) ); - btn->SetToolTip( _( "Pcb calculator, the Swiss army knife..." ) ); + btn->SetToolTip( _( "Pcb calculator - Calculator for components, track width, etc." ) ); btn = AddBitmapButton( ID_TO_PL_EDITOR, KiBitmap( icon_pagelayout_editor_xpm ) ); - btn->SetToolTip( _( "pl_editor, the page layout and title block shape editor" ) ); + btn->SetToolTip( _( "Pl editor - Worksheet layout editor" ) ); } diff --git a/kicad/menubar.cpp b/kicad/menubar.cpp index 674c972d41..62cf7a321e 100644 --- a/kicad/menubar.cpp +++ b/kicad/menubar.cpp @@ -123,8 +123,8 @@ void KICAD_MANAGER_FRAME::ReCreateMenuBar() // Open AddMenuItem( fileMenu, ID_LOAD_PROJECT, - _( "&Open\tCtrl+O" ), - _( "Open an existing project" ), + _( "&Open Project\tCtrl+O" ), + _( "Open existing project" ), KiBitmap( open_project_xpm ) ); // File history @@ -134,25 +134,25 @@ void KICAD_MANAGER_FRAME::ReCreateMenuBar() AddMenuItem( fileMenu, openRecentMenu, wxID_ANY, _( "Open &Recent" ), - _( "Open a recent opened schematic project" ), + _( "Open recent schematic project" ), KiBitmap( open_project_xpm ) ); // New wxMenu* newMenu = new wxMenu(); AddMenuItem( newMenu, ID_NEW_PROJECT, - _( "&Blank\tCtrl+N" ), - _( "Start a blank project" ), + _( "&Blank Project\tCtrl+N" ), + _( "Create blank project" ), KiBitmap( new_project_xpm ) ); AddMenuItem( newMenu, ID_NEW_PROJECT_FROM_TEMPLATE, - _( "New from &Template\tCtrl+T" ), - _( "Start a new project from a template" ), + _( "Project from &Template\tCtrl+T" ), + _( "Create new project from template" ), KiBitmap( new_project_with_template_xpm ) ); AddMenuItem( fileMenu, newMenu, wxID_ANY, _( "New" ), - _( "Start a new project" ), + _( "Create new project" ), KiBitmap( new_project_xpm ) ); // Save @@ -193,15 +193,15 @@ void KICAD_MANAGER_FRAME::ReCreateMenuBar() // Text editor AddMenuItem( browseMenu, ID_TO_EDITOR, - _( "Text E&ditor" ), + _( "Open Text E&ditor" ), _( "Launch preferred text editor" ), KiBitmap( editor_xpm ) ); // View file AddMenuItem( browseMenu, ID_BROWSE_AN_SELECT_FILE, - _( "&View File" ), - _( "View, read or edit file with a text editor" ), + _( "&Open Local File" ), + _( "Edit local file" ), KiBitmap( browse_files_xpm ) ); // Menu Preferences: @@ -210,8 +210,8 @@ void KICAD_MANAGER_FRAME::ReCreateMenuBar() // Text editor AddMenuItem( preferencesMenu, ID_SELECT_PREFERED_EDITOR, - _( "&Text Editor" ), - _( "Select your preferred text editor" ), + _( "&Set Text Editor" ), + _( "Set your preferred text editor" ), KiBitmap( editor_xpm ) ); // PDF Viewer submenu:System browser or user defined checkbox @@ -219,8 +219,8 @@ void KICAD_MANAGER_FRAME::ReCreateMenuBar() // Default AddMenuItem( SubMenuPdfBrowserChoice, ID_SELECT_DEFAULT_PDF_BROWSER, - _( "&Default" ), - _( "Use system default PDF viewer used to browse datasheets" ), + _( "System &Default PDF Viewer" ), + _( "Use system default PDF viewer" ), KiBitmap( datasheet_xpm ), wxITEM_CHECK ); SubMenuPdfBrowserChoice->Check( ID_SELECT_DEFAULT_PDF_BROWSER, @@ -228,8 +228,8 @@ void KICAD_MANAGER_FRAME::ReCreateMenuBar() // Favourite AddMenuItem( SubMenuPdfBrowserChoice, ID_SELECT_PREFERED_PDF_BROWSER, - _( "&Favourite" ), - _( "Use your favourite PDF viewer used to browse datasheets" ), + _( "&Favourite PDF Viewer" ), + _( "Use favourite PDF viewer" ), KiBitmap( datasheet_xpm ), wxITEM_CHECK ); SubMenuPdfBrowserChoice->Check( ID_SELECT_PREFERED_PDF_BROWSER, @@ -239,8 +239,8 @@ void KICAD_MANAGER_FRAME::ReCreateMenuBar() // Append PDF Viewer submenu to preferences AddMenuItem( SubMenuPdfBrowserChoice, ID_SELECT_PREFERED_PDF_BROWSER_NAME, - _( "Select &PDF Viewer" ), - _( "Select your favourite PDF viewer used to browse datasheets" ), + _( "Set &PDF Viewer" ), + _( "Set favourite PDF viewer" ), KiBitmap( datasheet_xpm ) ); // PDF viewer submenu @@ -261,13 +261,13 @@ void KICAD_MANAGER_FRAME::ReCreateMenuBar() // Contents AddMenuItem( helpMenu, wxID_HELP, - _( "&Contents" ), - _( "Open the KiCad handbook" ), + _( "KiCad Manual" ), + _( "Open KiCad user manual" ), KiBitmap( online_help_xpm ) ); AddMenuItem( helpMenu, wxID_INDEX, _( "&Getting Started in KiCad" ), - _( "Open the \"Getting Started in KiCad\" guide for beginners" ), + _( "Open \"Getting Started in KiCad\" guide for beginners" ), KiBitmap( help_xpm ) ); // Separator @@ -311,16 +311,16 @@ void KICAD_MANAGER_FRAME::RecreateBaseHToolbar() // New m_mainToolBar->AddTool( ID_NEW_PROJECT, wxEmptyString, KiBitmap( new_project_xpm ), - _( "Start a new project" ) ); + _( "Create new project" ) ); m_mainToolBar->AddTool( ID_NEW_PROJECT_FROM_TEMPLATE, wxEmptyString, KiBitmap( new_project_with_template_xpm ), - _( "Start a new project from a template" ) ); + _( "Create new project from template" ) ); // Load m_mainToolBar->AddTool( ID_LOAD_PROJECT, wxEmptyString, KiBitmap( open_project_xpm ), - _( "Load existing project" ) ); + _( "Open existing project" ) ); // Save m_mainToolBar->AddTool( ID_SAVE_PROJECT, wxEmptyString,