Difference between revisions of "UIGraphicsImplementationNamingConventions"

From Eclipsepedia

Jump to: navigation, search
Line 22: Line 22:
 
 
 
===Graphic format extension===
 
===Graphic format extension===
Since all images are transparent GIFs, unless otherwise stated in the [http://mds.torolab.ibm.com/rational/guidelines/uigraphics/specifications/formats.html Graphic Formats] page, they have to be saved in GIF format for cross platform compliance and will have *.gif file extension in the name.
+
Since all images are transparent GIFs, unless otherwise stated in the [http://wiki.eclipse.org/UIGraphicsImplementationNamingConventions#Graphic_format_extension Graphic Formats] page, they have to be saved in GIF format for cross platform compliance and will have *.gif file extension in the name.
 
 
 
===Multiple sizes===
 
===Multiple sizes===

Revision as of 14:12, 19 July 2007

Return to the main UI Graphics section on the UI Best Practices page.


Contents

Naming Conventions

The following section describes the Eclipse standard for file naming and guidelines for using suffixes that will help others quickly identify the graphic type or function.

We recommend that you work with your development contact to establish file names for each graphic before you begin design work, using the following guidelines:

Abbreviations

The file name should be an abbreviation of the full icon name, for example, the name for the Create DTD Wizard icon might be abbreviated to "CrtDTD".

Case

All file names must be in lower case, for example, CrtDTD becomes "crtdtd".

Character length

File names should be 10 characters or less whenever possible. Underscores count as a character.

Suffixes

The file name should end with a suffix that describes its location or function in the user interface, for example, "crtdtd_wiz.gif". See the table below for suffix suggestions.

Graphic format extension

Since all images are transparent GIFs, unless otherwise stated in the Graphic Formats page, they have to be saved in GIF format for cross platform compliance and will have *.gif file extension in the name.

Multiple sizes

Icons that have multiple sizes within one folder, such as multiple palette icon sizes, are differentiated by adding the icon size to the suffix. For example, file_pal.gif, file_pal24.gif, file_pal32.gif, where *_pal represents the default 16 x 16 pixel size and the *_pal24 and *_pal32 represent larger sizes of the same icon.


Suggestions for File Naming Suffixes

Filename Suffix Use Icon Type and Location
*_wiz Represents a wizard graphic or an icon that invokes a wizard
  • Wizard banner graphics used in wizard dialog windows
  • Wizard icons used on wizard toolbars
*_exec Invokes an executable file
  • Toolbar icons used in cascading menus, and global toolbars
*_edit Represents an icon located in an editor
  • Toolbar icons used in cascading menus, and global toolbars
*_nav Represents an icon located in a navigator view
  • Toolbar icons used in cascading menus, and global toolbars
  • Local toolbar icons found on the far right of the title area of a view
  • View and perspective icons found in the top, left corner of a view
*_misc Represents an icon that does not fit into any of the other categories
  • Toolbar icons used in cascading menus, and global toolbars.
  • View and perspective icons found in the top, left corner of a view.
*_tsk Represents tasks that a user can do
  • Local toolbar icons found on the far right of the title area of a view
  • Overlay icons placed on top of a model object icon to indicate a change in condition
  • Model object icons used in the tree view, list view, and properties view
  • View and perspective icons found in the top, left corner of a view
*_mode Toggles the working mode of the view
  • Local toolbar icons found on the far right of the title area of a view
*_menu Represents an icon located in a menu
  • Local toolbar icons found on the far right of the title area of a view
*_ps Represents an icon located in a property sheet
  • Local toolbar icons found on the far right of the title area of a view
  • View and perspective icons: found in the top, left corner of a view
*_obj Represents a model object
  • Model object icons used in the tree view, list view, and properties view
*_pal Represents a model object on an object palette
  • Model object icons used in the tree view, list view, and properties view
*_co Represents a command that engages the system, such as build command
  • Toolbar icons used in cascading menus, and global toolbars
  • Local toolbar icons found on the far right of the title area of a view
*_tbl Represents an icon located in a table
  • Model object icons used in a table or properties view