kicad-developers team mailing list archive
-
kicad-developers team
-
Mailing list archive
-
Message #12306
[PATH] better kicad and eeschema menu entries and labels
Hello,
I tried to adjust the KiCad and eeschema menu entries and labels following
a little how a gui program normally is. It would be great if this patch
could be reviewed by e native English speaker who is a little familiar with
menu entry usability. (e.g better to say "KiCad User Manual" instead of
"Help" or "Manual")
I have tried to shorten button hints making them more direct and without
articles like "Insert Pin" instead of "Insert a Pin".
If we can find some consensus, I will work on pcbnew and other gui too.
thank you
Fabrizio
PS the accellerator for the kicad and eeschema user manual Ctrl-H does not
seem to work for me (but it might be a linux thing)
=== modified file 'HOW_TO_CONTRIBUTE.txt'
--- HOW_TO_CONTRIBUTE.txt 2013-08-06 23:21:40 +0000
+++ HOW_TO_CONTRIBUTE.txt 2014-02-12 15:31:57 +0000
@@ -11,32 +11,40 @@
2) initialize Bazaar:
bzr whoami "John Doe <john.doe@xxxxxxxxx>"
-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
-
-4) Read coding_style_policy.pdf, in <kicad_sources>/Documentation,
- and other docs.
-
-5) Modify/add source code.
- cd kicad_john
+ bzr branch lp:kicad kicad.bzr
+
+ this should leave you with the folder kicad.bzr
+
+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
-
-7) Repeat step 5 and 6 until satisfied.
-
-8) Create a patch:
- in kicad_john:
- if some files are added: bzr add [FILE...]
+ to build a release version
+ make -j8
+
+8) Repeat step 6 and 7 until satisfied.
+
+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.
=== modified file 'eeschema/help_common_strings.h'
--- eeschema/help_common_strings.h 2013-05-26 04:36:44 +0000
+++ eeschema/help_common_strings.h 2014-02-12 16:55:55 +0000
@@ -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. This label will be seen as 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")
=== modified file 'eeschema/menubar.cpp'
--- eeschema/menubar.cpp 2013-02-23 20:08:28 +0000
+++ eeschema/menubar.cpp 2014-02-12 17:31:59 +0000
@@ -69,15 +69,15 @@
// New
AddMenuItem( fileMenu,
ID_NEW_PROJECT,
- _( "&New" ),
- _( "New schematic project" ),
+ _( "&New Schematic Sheet" ),
+ _( "New schematic 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
@@ -98,19 +98,19 @@
// 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 schematic" ),
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
@@ -134,14 +134,14 @@
AddMenuItem( fileMenu,
ID_SHEET_SET,
_( "Pa&ge Settings" ),
- _( "Settigns for page size and information" ),
+ _( "Setting for sheet size" ),
KiBitmap( sheetset_xpm ) );
// Print
AddMenuItem( fileMenu,
wxID_PRINT,
_( "Pri&nt" ),
- _( "Print schematic" ),
+ _( "Print schematic sheet" ),
KiBitmap( print_button_xpm ) );
#ifdef __WINDOWS__ // __WINDOWS__
@@ -262,8 +262,8 @@
// Hierarchy
AddMenuItem( viewMenu,
ID_HIERARCHY,
- _( "&Hierarchy" ),
- _( "Navigate schematic hierarchy" ),
+ _( "Show &Hierarchical Sheet" ),
+ _( "Navigate hierarchical sheet" ),
KiBitmap( hierarchy_nav_xpm ) );
// Redraw
@@ -402,15 +402,15 @@
// 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)
@@ -420,8 +420,8 @@
#else
AddMenuItem( preferencesMenu,
wxID_PREFERENCES,
- _( "&Options" ),
- _( "Eeschema preferences" ),
+ _( "Schematic Editor &Options" ),
+ _( "Set Eeschema preferences" ),
KiBitmap( preference_xpm ) );
#endif // __WXMAC__
@@ -470,21 +470,21 @@
// 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
@@ -520,14 +520,14 @@
// 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
=== modified file 'kicad/commandframe.cpp'
--- kicad/commandframe.cpp 2014-02-01 18:27:18 +0000
+++ kicad/commandframe.cpp 2014-02-12 15:43:03 +0000
@@ -64,27 +64,27 @@
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 component size, 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" ) );
}
=== modified file 'kicad/menubar.cpp'
--- kicad/menubar.cpp 2014-02-07 19:32:08 +0000
+++ kicad/menubar.cpp 2014-02-12 17:20:03 +0000
@@ -123,8 +123,8 @@
// 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 @@
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 @@
// 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 @@
// 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 @@
// 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 @@
// 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 @@
// 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 @@
// 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 @@
// 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,
Follow ups
