Added resource names

raulraja · raulraja · commit 5cef8017d733 · 2012-09-04T15:54:59.000+02:00
diff --git a/java/android/README.md b/java/android/README.md
@@ -8,7 +8,7 @@ This document, expected to be followed by any developers at 47 Degrees, is a sub
 
 Developers should pay special attention to these naming conventions as they differ from those in the standard Java Coding Conventions.
 
-## 1.1. Resource Files
+## 1.1. Common Resource Files
 
 The folder *values* will have different files that will store information for our project. 
 Some of the most common files and their name are
@@ -20,15 +20,37 @@ Some of the most common files and their name are
 * **plurals.xml**: Plurals. Contains references to strings.xml
 * **arrays.xml**: Arrays. Contains references to strings.xml 
 
-## 1.3. Java Packages & Class Names
+## 1.2. Java Packages & Class Names
 
 An android App should generally follow the following package structure
 
-* com.company.product.android
+* **com.company.product.android**
 	- **activities**: All Activities with the word Activity pre-fixed by the Activity name: *[Name]*Activity e.g. MainActivity
 	- **adapters**: All Adapters with the word Adapter pre-fixed by the Adapter name: *[Name]*Adapter e.g. UserListAdapter
 	- **services**: All Services including API clients and other persistence related services e.g. UserService
 	- **components**: All reusable components utilized in Activity and Fragments e.g. UserProfileComponent
 	- **dialogs**: All Fragment Dialogs with the word Dialog pre-fixed by the dialog name: *[Name]*Dialog e.g. DeleteAccountConfirmationDialog
 	- **fragments**: All Fragments with the word Fragment pre-fixed by the Fragment name: *[Name]*Fragment e.g. UserMapLocationFragment
-	- **utils**: All cross package utilities with the word Utils pre-fixed by the Utility name: *[Name]*Utils e.g. StringUtils
+	- **utils**: All cross package utilities with the word Utils pre-fixed by the Utility name: *[Name]*Utils e.g. StringUtils
+
+## 1.3. Resource Names
+
+The following structure should be followed when naming images in order to find and reuse resources fast and efficiently and avoid duplication across different layouts and components.
+
+GROUP      TYPE      NAME      [STATE]      [SUFFIX]
+
+* **Group**: Application area or screen. If the resource is used in different parts of applications 'common' should be used instead. e.g. actionbar, menu, media, popup, footer, audio, etc.
+* **Type**: Resource Type. e.g. background, icon, button, textfield, list, menuitem, radiobutton, checkbox, tab, dialog, title, etc.
+* **Name**: Descriptive name as to what the resource is about. e.g. play, stop.
+* **State** (Optional): The optional state of a parent resource. e.g. A button could be in 'normal', 'pressed', 'disabled' and 'selected'. A checkbox could be 'on' or 'off'. These resources should NEVER be used directly in layout but rather as state selectors.
+* **Suffix** (Optional): An arbitrary suffix that helps to further identify a property of the resource. Ex: bright, dark, opaque, layer, etc.
+
+Below are some examples of properly named resources.
+
+* common_background_app
+* audio_icon_play_on
+* common_icon_preferences
+* actionbar_button_send (XML resource)
+	- action_button_send_normal
+	- action_button_send_pressed
+	- action_button_send_disabled
