Naming convention for icons
Work-in-progress started by ace_dent. Please get involved!
We need to update and standardize Icon Themes. Here is just some preliminary thoughts to kickstart the process.
- Icons will be named following the Freedesktop naming standard where possible.
- The name of an image should uniquely convey its purpose, making it easy to locate to avoid duplication and promote standardisation. Names should be in human readable form, i.e. not require further referencing.
- It shall be assumed that American English (en_US) is an acceptable international language, hence the allowable text characters must fall within the US-ASCII character set. As a further restriction, all icon names may only contain the following characters: lower-case letters (“a”-“z”), numbers (“0”-“9”), underscore (“_”), dash (“-”), or period (“.”). The use of lower-case letters is principally to ensure thoughtful naming, e.g. instead of 'OpenReadOnly' we have 'open-readonly'. Image names are to be spelled according to the en_US dictionary, with abbreviations avoided and common words preferred for the benefit of non-native speakers.
- Images should be named to describe function rather than form (which may vary by Theme), avoiding names that may conflict with localization.
- The dash “-” character is used to denote hierarchies and links between images, essentially grouping them when listed alphanumerically. For instance, the generic folder icon is simply “folder”, and “folder-open” specifies an open folder. However, if the more specific item does not exist in the current theme, it gives some indication as to a suitable generic image to keep consistent style.
Structure of icon themes
We will determine a new structure as described here.
The directories of the image archive (“images.zip”) should generally follow the discussed naming conventions. However, when storing large numbers of images in a zip archive, there is an additional overhead for each directory, so shorter names of less than 6 letters are preferred.
The directory structure should be flat rather than deep. In addition to reducing overheads of the .zip archive, it enables the User to locate images with greater ease. The main feature of the directory structure is an easy to locate common 'action' directory, which stores any image required by more than one OOo application (c.f. “//res/commandimagelist/”). This gathers the core OOo images, which will assist creation of Themes, reduce duplication and provide Developers with a central repository.
We need to consider how to best handle localization ...
Localized images are currently stored within the same directory as the default image, (i.e. “/sc_bold.png” and “/zh-CN/sc_bold.png”). A different scheme will be adopted, to collate all localized resources to assist in their management. The high level directory “//locale/” will store localized images, with each locale stored in sub-directores according to ISO code and naming guide (e.g. “//locale/zh-cn/”). Within each locale directory, the sub-directory structure will then be identical to that of the highest directory structure, with directories only existing when they contain a localized image (e.g. “//locale/zh-cn/action/”).
Top level directories
Overview: Icons which are generally used in menus and dialogs for interacting with the user .
Directory: Most icons will fall under the 'action' category. Therefore we drop the directory prefix, to save overheads and all icons will be stored in the top level of the Images directory.
Resources: List of icons can be found here: Icon Themes/Action
Overview: Animated images used to represent loading web sites, or other background processing which may be less suited to more verbose progress reporting in the user interface .
Overview: Icons that describe what an application is, for use in the Programs menu, window decorations, and the task list. These may or may not be generic depending on the application and its purpose. Applications which are to be considered part of the base desktop, such as the calculator or terminal, should use the generic icons specified in this specification, while more advanced applications such as web browsers and office applications should use branded icons which still give the user an idea of what function the application provides .
Overview: Icons that are used for categories in the Programs menu, or the Control Center, for separating applications, preferences, and settings for display to the user .
Overview: Icons for hardware that is contained within or connected to the computing device .
Overview: Icons for tags and properties of files, that are displayed in the file manager. This context contains emblems for such things as “read-only” or “photos” .
Overview: Icons for different types of data, such as audio or image files .
Overview: Icons used to represent locations, either on the local filesystem, or through remote connections. Folders, trash, and workgroups are some examples .
Resources: List of icons can be found here:Icon Themes/Places
Overview: Icons for presenting status to the user. This context contains icons for warning and error dialogs, as well as for the current weather, appointment alarms, and battery status .
Resources: List of icons can be found here: Icon Themes/Status