サービス内容
Service
命名規則
kanvasで使用している命名規則のガイドラインをご紹介します。
画像ファイルの名前やHTMLのクラス名を、このガイドラインに準拠して制作を行います。
※WordPressでの制作をベースにルールを記載しています。
画像ファイルやid・classの命名規則
ディレクトリの格納ルールや画像ファイル、id・classの命名規則についての内容です。
1.基本ルール
ディレクトリの格納や、画像ファイル名についての基本となるルールです。
1-1.文字入力について
ファイル名、id・classは「半角英数字」のみ使用します。「日本語」「全角文字」「半角カナ」を使用した場合、ブラウザで正常に表示されない場合があります。
1-2.記号について
使用する記号は、半角英数字の[-]ハイフン[_]アンダースコア[.]ドットの3種類です。
1-3.開始文字について
ファイル名は数字や記号から開始せずに命名します。
2.ディレクトリ格納について
画像を格納しておくディレクトリは[theme/img]の中に置き、共通パーツは[common]トップページは[index]下層ページは[lower/スラッグ]の中に格納します。
3.画像ファイル名について
画像のファイル名は[位置]_[種類][連番]_[状態].[拡張子]とします。
4.id・class名について
id・class名に方向を示す「left」「right」や、色を示す「red」「blue」、サイズや長さを示す「mb30」「w300」などの情報は使用しません。
なお、CSS設計のベースルールにSMACSSを使用するので、id・class名は[プレフィックス]-[種類][連番]とします。詳細はHTML・CSSガイドラインのページを参照して下さい。
5.位置
画像を使用する位置の名前を付与します。
| ヘッダー | header |
|---|---|
| フッター | footer |
| サイドナビ | side |
| グローバルナビ | navi |
| コンテンツ | contents |
| 共通パーツ | cmn |
6.種類
画像を使用する種類を付与します。
| テキスト | タイトル | ttl |
|---|---|---|
| テキスト | txt | |
| イメージ | 写真 | img |
| バナー | bnr | |
| アイコン | ico | |
| ロゴ | logo | |
| メイン ビジュアル |
mv | |
| ボタン | btn | |
| ページトップ | pagetop |
7.連番
0から始まる二桁の連番で、1ずつカウントアップして記述します。
8.状態
画像の状態を表す文字列を付与します。
| マウスオン | on |
|---|---|
| マウスオフ | off |
| 背景画像 | bg |
9.画像ファイルの適用例
参考となるディレクトリの格納ルールと、画像ファイルの命名例です。
ヘッダーのロゴ
/img/common/header_logo.png
サイドナビのバナー
/img/common/side_bnr01_off.png
/img/common/side_bnr01_on.png
トップページ内にある2つ目のh2タイトル
/img/index/ttl02.png
ご挨拶(スラッグ名:greeting)ページの1つ目の写真
/img/greeting/img01.jpg
10.id・classの適用例
参考となるid・classへの命名例です。
| レイアウト | ヘッダー | l-header |
|---|---|---|
| フッター | l-footer | |
| サイドナビ | l-side | |
| グローバル ナビ |
l-navi | |
| モジュール | タイトル | m-title |
| 日付 | m-date | |
| サムネイル | m-thumb | |
| 画像 | m-img | |
| ステート | 非表示 | is-hidden |
| アクティブ | is-active |