Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "UIGraphicsImplementationNamingConventions"
Line 1: | Line 1: | ||
Return to the main '''[[UI_Best_Practices_v3.x#UI_Graphics|UI Graphics]]''' section on the UI Best Practices page. | Return to the main '''[[UI_Best_Practices_v3.x#UI_Graphics|UI Graphics]]''' section on the UI Best Practices page. | ||
+ | |||
==Naming Conventions== | ==Naming Conventions== |
Revision as of 10:35, 18 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 |
|
*_exec | Invokes an executable file |
|
*_edit | Represents an icon located in an editor |
|
*_nav | Represents an icon located in a navigator view |
|
*_misc | Represents an icon that does not fit into any of the other categories |
|
*_tsk | Represents tasks that a user can do |
|
*_mode | Toggles the working mode of the view |
|
*_menu | Represents an icon located in a menu |
|
*_ps | Represents an icon located in a property sheet |
|
*_obj | Represents a model object |
|
*_pal | Represents a model object on an object palette |
|
*_co | Represents a command that engages the system, such as build command |
|
*_tbl | Represents an icon located in a table |
|