file-naming.textile

File Naming Style

View and Controller Files

All module files name should be started with an underscore ( _ ).

views/_header.php
controller/_header.php

CSS and JavaScript files

Like views and controller, all files which dedicated to a specific module must be started with a underscore too.

static/_header.js
static/_header.css

Image Files

According to image characteristics, we have following prefix for image files.

• ico_ : Icon images
• bg_ : Background images
• title_ : Title images
• li_ : List item images
• sep_ : Separator images
• sp_ : CSS sprite images
• btn_ : Button Images

Most of images should be PNG 8 because it’s the best image format on web. If you really need to use PNG 24 image, please add _24bit suffix before file extension. For example, the file bg_up_arrow.png should be bg_up_arrow_24bit.png if it’s in PNG 24.

bg_up_arrow.png => bg_up_arrow_24bit.png

The pre-commit hook omits image optimization checking if this suffix is added.

Note: Use _24bit suffix for reason that 256 colors is not enough instead of file size consideration.

Image File Name Grammar

<type>_[module]_[nonu]_[status].png

• Use these words as verb: add, modify, and remove.
• Don’t use these words as verb: create, update, delete, get, and set.
• Examples:
  • ico_folder.png
  • ico_folder_add.png
  • ico_folder_remove.png
  • ico_folder_modify.png
  • ico_home_folder_add.png