Actions

JDOC

Difference between revisions of "Image naming guidelines"

From Joomla! Documentation

m (Tom Hutchison moved page JDOC:Image naming convention to JDOC:Image naming guidelines: not a hard and strict, just a guide)
m (updates, saving to preserve edits)
Line 1: Line 1:
{{notice|The information on this page is out-of-date and in the process of being updated. {{Last edited by}}|title=Please Note!}}
+
The image naming guidelines are to give documentation contributors a set guidelines about naming an uploaded image file '''not used''' by Joomla! [[Help screens]]. These guidelines are not absolute but for informative purposes. They should only be used as a reference for helping contributors form a good image file name. Naming an image for use in Joomla documentation is not difficult once you understand how the images are processed and stored. Some of the benefits of Mediawiki's method of image storage are an image history, extra image data, and easy image updating.
  
It is quite simple to upload an image on the wiki - once you are familiar with the image naming convention click on 'Toolbox' in the left hand menu bar, then click on 'Upload File'.
+
==Naming an Uploaded Image==
 +
The Mediawiki software allows uploaded images to be named by [[Help:Image_uploading|two methods]].
  
The image naming convention aims to:
+
# Uploading an image directly, not referenced in a page but will be used. The default name of the image will be the "local" (name in your file system) but it may be changed before the actual upload.
* Reduce the likelihood of image name clashes; and
+
# Clicking on a red link, referenced in a page already with an image link such as <nowiki>[[Image:Name of the image.png]]</nowiki>
* Increase the likelihood that images are re-used.
+
  
Image names should consist of an underscore-separated list of pre-defined tags, detailed below. Tags are generally in order of least specific to most specific and the date on which the image is created or uploaded is appended.  Additional tags can be defined as required.  Some typical image names are:
+
Of the two methods, the later method is the easiest method to use.
 +
 
 +
==Naming Pattern Suggestions==
 +
Image names should consist of an underscore or hyphenated separated list of descriptive words. Think of them as a summary description of the image.  Some typical image names examples:
 +
 
 +
A screenshot of Joomla 3.x or 2.5 administrator's view of the article manager could be written as:
 
<pre>
 
<pre>
screenshot_content_article_manager_full_20090117.png
+
j3x_admin_content_article_manager_articles.png
screenshot_site_global_config_seo_settings_annotated_20090117.png
+
j25-admin-content-article-manager-articles.png
 
</pre>
 
</pre>
The format is defined as:
+
 
 +
 
 +
A suggested format is defined as:
 
<pre>
 
<pre>
<filename> ::= <tag-list>_<yyyy><mm><dd>.<extension>
+
<jver>-<admin>-<view>.<extension('png' | 'jpg' | 'jpeg' | 'gif')>
<tag-list> ::= <tag> | <tag>_<tag-list>
+
<yyyy> ::= 4-digit year number
+
<mm> ::= 2-digit month number
+
<dd> ::= 2-digit day number
+
<extension> ::= 'png' | 'jpg' | 'jpeg' | 'gif'
+
 
</pre>
 
</pre>
  
To further promote image re-use, all image tags have a corresponding category on this wiki and care should be taken to ensure that images are correctly assigned to their relevant categories as defined below.
 
==Top-level Tags==
 
{| class="wikitable"
 
|-
 
!Tag
 
!Description
 
!Category
 
|-
 
|screenshot
 
|Image is a screenshot of the Joomla package.  See below for subsidiary tags.
 
|[[:Category:Joomla screenshots]]
 
|-
 
|eclipse
 
|Image is a screenshot of the Eclipse package.
 
|[[:Category:Eclipse screenshots]]
 
|-
 
|phpmyadmin
 
|Image is a screenshot of the phpMyAdmin package.
 
|[[:Category:PhpMyAdmin screenshots]]
 
|-
 
|diagram
 
|Image is a diagram.
 
|[[:Category:Diagrams]]
 
|-
 
|chart
 
|Image is a chart.
 
|[[:Category:Charts]]
 
|}
 
 
===Joomla screenshots Tags===
 
These tags are defined as subsidiary to the ''screenshot'' tag.  They mostly correspond to the top-level menus in the Administrator, plus the template names for screenshots of the front-end.
 
{| class="wikitable"
 
|-
 
!Tag
 
!Description
 
!Category
 
|-
 
|site
 
|Site menu.  See below for subsidiary tags.
 
|[[:Category:Site screenshots]]
 
|-
 
|menus
 
|Menus menu.  See below for subsidiary tags.
 
|[[:Category:Menus screenshots]]
 
|-
 
|content
 
|Content menu.  See below for subsidiary tags.
 
|[[:Category:Content screenshots]]
 
|-
 
|components
 
|Components menu.  See below for subsidiary tags.
 
|[[:Category:Component screenshots]]
 
|-
 
|extensions
 
|Extensions menu.  See below for subsidiary tags.
 
|[[:Category:Extensions screenshots]]
 
|-
 
|tools
 
|Tools menu.  See below for subsidiary tags.
 
|[[:Category:Tools screenshots]]
 
|-
 
|help
 
|Help menu.  See below for subsidiary tags.
 
|[[:Category:Help screenshots]]
 
|-
 
|milky_way
 
|Screenshots of the Milky Way template.
 
|[[:Category:Milky Way screenshots]]
 
|-
 
|beez
 
|Screenshots of the Beez template.
 
|[[:Category:Beez screenshots]]
 
|-
 
|ja_purity
 
|Screenshots of the JA_Purity template.
 
|[[:Category:Ja_purity screenshots]]
 
|-
 
|installation
 
|Screenshots of Joomla installation.
 
|[[:Category:Installation screenshots]]
 
|-
 
|parameter
 
|Screenshots of generic parameters.
 
|[[:Category:Parameters screenshots]]
 
|}
 
 
====Site screenshots Tags====
 
These tags are defined as subsidiary to the ''screenshot'' and ''site'' tags.  They correspond to sub-menu items under the ''Site'' menu in the Administrator.
 
{| class="wikitable"
 
|-
 
!Tag
 
!Description
 
!Category
 
|-
 
|control_panel
 
|Screenshots of '''Site -> Control Panel'''.
 
|[[:Category:Control panel screenshots]]
 
|-
 
|user_manager
 
|Screenshots of '''Site -> User Manager'''.
 
|[[:Category:User manager screenshots]]
 
|-
 
|media_manager
 
|Screenshots of '''Site -> Media Manager'''.
 
|[[:Category:Media manager screenshots]]
 
|-
 
|global_config
 
|Screenshots of '''Site -> Global Configuration'''.
 
|[[:Category:Global configuration screenshots]]
 
|}
 
 
====Menus screenshots Tags====
 
These tags are defined as subsidiary to the ''screenshot'' and ''menus'' tags.  They correspond to sub-menu items under the ''Menus'' menu in the Administrator.
 
{| class="wikitable"
 
|-
 
!Tag
 
!Description
 
!Category
 
|-
 
|menu_manager
 
|Screenshots of '''Menus -> Menu Manager'''.
 
|[[:Category:Menu manager screenshots]]
 
|-
 
|menu_trash
 
|Screenshots of '''Menus -> Menu Trash'''.
 
|[[:Category:Menu trash screenshots]]
 
|-
 
|main_menu
 
|Screenshots of the sample content Main Menu.
 
|[[:Category:Main menu screenshots]]
 
|}
 
 
====Content screenshots Tags====
 
These tags are defined as subsidiary to the ''screenshot'' and ''content'' tags.  They correspond to sub-menu items under the ''Content'' menu in the Administrator.
 
{| class="wikitable"
 
|-
 
!Tag
 
!Description
 
!Category
 
|-
 
|article_manager
 
|Screenshots of '''Content -> Article Manager'''.
 
|[[:Category:Article manager screenshots]]
 
|-
 
|article_trash
 
|Screenshots of '''Content -> Article trash'''.
 
|[[:Category:Article trash screenshots]]
 
|-
 
|section_manager
 
|Screenshots of '''Content -> Section Manager'''.
 
|[[:Category:Section manager screenshots]]
 
|-
 
|category_manager
 
|Screenshots of '''Content -> Category Manager'''.
 
|[[:Category:Category manager screenshots]]
 
|-
 
|front_page_manager
 
|Screenshots of '''Content -> Front Page Manager'''.
 
|[[:Category:Front page manager screenshots]]
 
|}
 
 
====Components screenshots Tags====
 
These tags are defined as subsidiary to the ''screenshot'' and ''components'' tags.  They correspond to sub-menu items under the ''Components'' menu in the Administrator.
 
{| class="wikitable"
 
|-
 
!Tag
 
!Description
 
!Category
 
|-
 
|banner_banners
 
|Screenshots of '''Components -> Banners -> Banners'''.
 
|[[:Category:Banners banners screenshots]]
 
|-
 
|banner_clients
 
|Screenshots of '''Components -> Banners -> Clients'''.
 
|[[:Category:Banners clients screenshots]]
 
|-
 
|banner_categories
 
|Screenshots of '''Components -> Banners -> Categories'''.
 
|[[:Category:Banners categories screenshots]]
 
|-
 
|contacts_contacts
 
|Screenshots of '''Components -> Contact -> Contacts'''.
 
|[[:Category:Contacts contacts screenshots]]
 
|-
 
|contacts_categories
 
|Screenshots of '''Components -> Contact -> Categories'''.
 
|[[:Category:Contacts categories screenshots]]
 
|-
 
|news_feeds_feeds
 
|Screenshots of '''Components -> News feeds -> Feeds'''.
 
|[[:Category:News feeds feeds screenshots]]
 
|-
 
|news_feeds_categories
 
|Screenshots of '''Components -> News feeds -> Categories'''.
 
|[[:Category:News feeds categories screenshots]]
 
|-
 
|polls
 
|Screenshots of '''Components -> Polls'''.
 
|[[:Category:Polls screenshots]]
 
|-
 
|search
 
|Screenshots of '''Components -> Search'''.
 
|[[:Category:Search screenshots]]
 
|-
 
|web_links_links
 
|Screenshots of '''Components -> Web links -> Links'''.
 
|[[:Category:Web links links screenshots]]
 
|-
 
|web_links_categories
 
|Screenshots of '''Components -> Web links -> Categories'''.
 
|[[:Category:Web links categories screenshots]]
 
|}
 
 
====Extensions screenshots Tags====
 
These tags are defined as subsidiary to the ''screenshot'' and ''extensions'' tags.  They correspond to sub-menu items under the ''Extensions'' menu in the Administrator.
 
{| class="wikitable"
 
|-
 
!Tag
 
!Description
 
!Category
 
|-
 
|install
 
|Screenshots of '''Extensions -> install/uninstall'''.
 
|[[:Category:Extensions install screenshots]]
 
|-
 
|module_manager
 
|Screenshots of '''Extensions -> Module Manager'''.
 
|[[:Category:Module manager screenshots]]
 
|-
 
|plugin_manager
 
|Screenshots of '''Extensions -> Plugin Manager'''.
 
|[[:Category:Plugin manager screenshots]]
 
|-
 
|template_manager
 
|Screenshots of '''Extensions -> Template Manager'''.
 
|[[:Category:Template manager screenshots]]
 
|-
 
|language_manager
 
|Screenshots of '''Extensions -> Language Manager'''.
 
|[[:Category:Language manager screenshots]]
 
|}
 
 
====Tools screenshots Tags====
 
These tags are defined as subsidiary to the ''screenshot'' and ''tools'' tags.  They correspond to sub-menu items under the ''Tools'' menu in the Administrator.
 
{| class="wikitable"
 
|-
 
!Tag
 
!Description
 
!Category
 
|-
 
|read_messages
 
|Screenshots of the '''Tools -> Read messages''' screen.
 
|[[:Category:Read messages screenshots]]
 
|-
 
|write_message
 
|Screenshots of the '''Tools -> Write message''' screen.
 
|[[:Category:Write message screenshots]]
 
|-
 
|mass_mail
 
|Screenshots of the '''Tools -> Mass mail''' screen.
 
|[[:Category:Mass mail screenshots]]
 
|-
 
|global_check-in
 
|Screenshots of the '''Tools -> Global check-in''' screen.
 
|[[:Category:Global check-in screenshots]]
 
|-
 
|clean_cache
 
|Screenshots of the '''Tools -> Clean cache''' screen.
 
|[[:Category:Clean cache screenshots]]
 
|}
 
 
====Help screenshots Tags====
 
These tags are defined as subsidiary to the ''screenshot'' and ''help'' tags.  They correspond to sub-menu items under the ''Help'' menu in the Administrator.
 
{| class="wikitable"
 
|-
 
!Tag
 
!Description
 
!Category
 
|-
 
|joomla_help
 
|Screenshots of the '''Help -> Joomla help''' screen.
 
|[[:Category:Joomla help screenshots]]
 
|-
 
|system_info
 
|Screenshots of the '''Help -> System info''' screen.
 
|[[:Category:System info screenshots]]
 
|}
 
  
==Other tags==
 
A number of other tags may be used to give further information about an image.
 
{| class="wikitable"
 
|-
 
!Tag
 
!Description
 
!Category
 
|-
 
|full
 
|Full-page screenshot.
 
|[[:Category:Full page screenshots]]
 
|-
 
|annotated
 
|Screenshot with annotations or other information superimposed.
 
|[[:Category:Annotated screenshots]]
 
|}
 
 
<noinclude>[[Category:Documentation Wiki Information]]</noinclude>
 
<noinclude>[[Category:Documentation Wiki Information]]</noinclude>

Revision as of 11:48, 7 February 2014

The image naming guidelines are to give documentation contributors a set guidelines about naming an uploaded image file not used by Joomla! Help screens. These guidelines are not absolute but for informative purposes. They should only be used as a reference for helping contributors form a good image file name. Naming an image for use in Joomla documentation is not difficult once you understand how the images are processed and stored. Some of the benefits of Mediawiki's method of image storage are an image history, extra image data, and easy image updating.

Naming an Uploaded Image

The Mediawiki software allows uploaded images to be named by two methods.

  1. Uploading an image directly, not referenced in a page but will be used. The default name of the image will be the "local" (name in your file system) but it may be changed before the actual upload.
  2. Clicking on a red link, referenced in a page already with an image link such as [[Image:Name of the image.png]]

Of the two methods, the later method is the easiest method to use.

Naming Pattern Suggestions

Image names should consist of an underscore or hyphenated separated list of descriptive words. Think of them as a summary description of the image. Some typical image names examples:

A screenshot of Joomla 3.x or 2.5 administrator's view of the article manager could be written as:

j3x_admin_content_article_manager_articles.png
j25-admin-content-article-manager-articles.png


A suggested format is defined as:

<jver>-<admin>-<view>.<extension('png' | 'jpg' | 'jpeg' | 'gif')>