永遠剣・入力命名規則メモ
タイトル通り、当サイトにおいて可読性向上の為に行っている
入力命名規則の管理人用マニュアル…のようなメモ。
管理上出来る限り守りたい規則ではあるが、
古いページなどは反映しきれていない。
■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
【命名規則】ディレクトリ名とファイル名
■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
最大の目的は「管理人が個人的に管理しやすいように」という点と、
「ブランクを経て細かい事を自分で忘れた」としても
見ただけで思い出せるようにという点を実現する事。
ディレクトリ名とディレクトリ構成、
ファイル名は当然「URLにそのまま反映される」ので、
URL単体でも可読性や見栄えを多少気にしている。
--------------------------------------------------------------------------------
●ファイル全般の拡張子名
例えば「gif」等、大文字と小文字の両方が存在する拡張子は
現在は全て小文字に統一している。
また、「htm」と「html」等の複数種の表記が存在する拡張子は
「おそらく主流と思われるもの」を選択して統一している。
具体的には「htm」と「html」では後者「html」を、
「jpg」と「jpeg」では前者「jpg」を選択している。
--------------------------------------------------------------------------------
●ディレクトリ名とhtml名の基本法則
固有名詞と日本語発祥の単語以外は、基本的に英語。
日本語発祥の単語は、「同人」(doujin)等が該当。
分かる範囲で英語のウェブサイト用語や慣用句をある程度選んでいるが、
正式に書くとファイル名が長すぎる場合は、更にそれらしく略した。
文字数が多めな場合は、いくつかの単語を半角ハイフン「-」で区切っている。
また、
【ディレクトリ名とhtml名はある程度一致させる】ようにしている。
二重表記のようだが、これは単体でどのようなファイルか判断しやすくする為。
--------------------------------------------------------------------------------
●画像ファイル全般の命名時基本ルールと理由
詳細ルールは後述するが、画像ファイル名の基本ルールは
【大文字のアルファベットを使用しない】
【単語の区切りは半角スペース「 」ではなく半角アンダーバー「_」を使用する】
【記号を半角アンダーバー「_」と半角ハイフン「-」以外使用しない】
という、上記の3点。
また、厳密なルールではないが上記に加え
【画像ファイル名が長くなりすぎないようにする】
という点も注意している。
小文字アルファベット縛りは「管理人の趣味」以上の理由は無いのだが、
記号絡みはOSやソフトウェアによっては特定記号使用時に
動作制限や不具合が発生する…というケースを、
管理人が経験している事が理由。
また、ファイル名が長すぎる場合等の不具合も経験しているので、
当サイトのソースやデータや各種ファイルの保守性を高める事が目的。
--------------------------------------------------------------------------------
●イラストに付ける画像ファイル名の詳細
当サイトにて公開している画像ファイルの中で、最も多いのが
イラストや同人のサンプルといった、管理人の創作物。
ファイル名に対する命名規則が適当だと管理しきれなくなってしまう為、
基本的には規則を設け、管理人である村上ネビ自身が
個人的に管理を行いやすいようにしている。
【作成年月日_分類略称2文字_絵の概要.拡張子】
という規則で現在は統一している。
作成年月日は「YYYYMMDD」の8桁で表記し、
月と日が10未満なら10の位に0を入れる。
分類略称はイラストの企画や分類毎に統一しており、
例えば筆者オリジナル企画『満点はなまる先生』のイラストでは「hs」、
『薄紅戦車』のイラストでは「ub」、
といった記載を行っている。
絵の概要は適当に付けているが、二次創作イラストの場合は
【元ネタの作品名やキャラ名についての概要を判別可能な範囲で入れる】
というルールを設け、当該ギャラリーのキャプション無しでも
多少は何のネタだったかを分かるようにしている。
また、差分等の理由でほぼ同一内容のイラストがシリーズの様に連続する場合は
「1」から始まる数字や「a」から始まる小文字アルファベットを組み合わせ、
擬似的に「バージョン名」のように命名する事でソートに対応させている。
--------------------------------------------------------------------------------
●イラストの画像ファイル名ルールに付随する細かな点
これも現状では厳密なルールではないのだが、数点。
【乗算記号を使いたい場合は小文字エックス「x」で代用表現】
【jpeg画像は保存時設定の「クオリティのパーセント数」を併記】
【スキャン画像を使用したイラストは可能な限り「dpi数」を併記】
ファイル名だけで解像度やサイズ等の情報も区別出来れば
管理上のミスが減らせるかと考えての対応。
--------------------------------------------------------------------------------
●イラスト以外の画像ファイル名や画像以外のファイル名
イラスト以外の画像ファイルは、件数が少ないので命名規則は適当。
【ゲーム攻略記事等で「資料として使う為の画像」には日付を入れない】
【記録や写真には日付を入れる】
【ファイル名だけでどんなファイルか大まかに判別可能にする】
程度の軽い内容。
件数が大きく増えるような事が今後あるようだったら、
イラスト同様に色々と細かい命名規則を決めてリネームするかも？
--------------------------------------------------------------------------------
●ファイル数が多いディレクトリの運用
命名規則に間接的に影響する点。
【ファイル数が多い場合は複数階層ディレクトリにファイルを分散させる】
という運用にしている。
同一ディレクトリ内にファイル数が多すぎると、単純に管理しづらくなる為だ。
ただしイラストは例外で、意図的に
「企画単位以上のディレクトリ分け」を現状行っていない。
「同一企画内における新旧イラストの違い」を
「イラストのファイル名の日付」を元に即座に判断出来る様にする事と、
「手元のデータを閲覧する際の操作の手間を省く」事が目的。
今後イラストの数が膨大になるようであれば、
リニューアルを行って管理方法を変更する可能性もある。
例えば同一企画内で年単位の子ディレクトリを設ける等。
--------------------------------------------------------------------------------
■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
【入力規則】各htmlファイルのテキスト
■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
当サイト各htmlファイルの編集方法は、
原則として「テキストエディターによるHTML直打ち」。
サイト開設から約13年間は、
サイト制作エディター「Microsoft FrontPage Express 2.0」と、
「テキストエディターによるHTML直打ち」を場合により使い分けて
HTML3のソースコードを記述していた。
しかし「Microsoft FrontPage Express 2.0」で
生成されるHTMLソースがインデントや改行の挙動が
極めて不安定な代物だった為に使用を止めている。
2024年06月16日(日)にHTML3としてのソースコード整備完了。
その後全ページのソースコードを
HTML5+CSS3にリファクタリングしている。
2024年10月19日(土)作業完了。
--------------------------------------------------------------------------------
●各htmlファイルはそれなりに単純なHTML構造
当サイトの各htmlファイルの構造自体は、
HTML5+CSS3の使用に留めたかなり単純な構造。
JavaScript等の「HTMLとCSSの域を超える機能」は使用していない。
使用するHTMLタグも、おそらく必要最小限と思われる範囲に抑えてあり、
「フォント」、「リンク」、「画像」、「表」、など程度。
この点は、入力ルールや制限作りというよりは
管理人の個人的な「ソース記述難度を下げる」意味合いが強い。
--------------------------------------------------------------------------------
●各htmlファイルのカラーコードは英語を大文字で統一
掲題の通り。
カラーコード中の16進数の「9」より大きな数値である、
アルファベット「A」(10)～「F」(15)は大文字で統一。
「HTMLの記述方法」としては大文字でも小文字でも通る為、
ルールは無いらしいが個人的な分かりやすさ重視で大文字統一。
調べた範囲では、大文字の方が多いようだが。
--------------------------------------------------------------------------------
●テキスト本文中の項目毎の区切り
本文中のコーナーは、規模が大きいものから
【黒四角「■」40個2行で挟んだ3行の大項目表題】
【黒丸「●」1個を頭に付けた中項目表題】
【黒逆三角「▼」1個を頭に付けた小項目表題】
の順で分けている。
長文になる場合等は、区切りになる場所に
【半角ハイフン「-」80個(全角40文字分)】
を挟む事で、文章の可読性を上げている。
この全角40文字分は、「A4縦のビジネス文書」を参考にした。
以前は黒逆三角「▼」前後4個ずつの項目表題を
黒四角「■」40個2行の子として扱っていた事もあったが、
これに関しては廃止。
--------------------------------------------------------------------------------
●機種依存文字を避ける
可能な限り、機種依存文字の使用は避けている。
代表的なものを挙げると、「半角カタカナ」や「ローマ数字」等。
文字化けしたりすると面倒なので。
--------------------------------------------------------------------------------
●全角と半角の取り扱い
単純に文章を書く場合、まず英数は基本的に「半角英数」(ASCII文字)で統一。
ただし、「ゲームで表示されるテキストの再現」等の明確な目的があるならば
「全角英数」(全角版ASCII文字)を使用する場合もある。
全角と半角の両方が存在する記号については、
「日本語で文章を書いていると普通は全角で書く記号」全般を全角で書いている。
当サイトでは「！」「？」「％」「＆」「：」「＋」を、前述の記号としている。
「英語の文章や名称」の場合は、英語という事で該当部分のみ半角で統一。
--------------------------------------------------------------------------------
●カッコ全般の取り扱い
特定の作品タイトルは二重鉤括弧「『』」を、
セリフなどは通常の鉤括弧「「」」を、
注釈は半角括弧「()」(半角ASCII文字)を可能な限り使用。
テキスト毎の区切り等に
分類名強調などで隅付き括弧「【】」を使う場合もある。
また、不等号記号「＜」「＞」は、
カッコ代わりとしても不等号としても基本的に大文字の方を使用。
英語で記載している文節や、半角数字のみの文節場合は、
半角の不等号記号を使用する場合もあるかも。
--------------------------------------------------------------------------------
●日付表記
当サイトでは日付を入れる前提の日記や更新履歴の他に、
ギャラリーの各イラストや、
ゲーム攻略記事の更新日時等にも日付を入れている。
いずれも、「いつのイラストや情報なのか」を
一目で判断可能にする事が目的。
ファイル名への日付記入と若干異なるが、
【テキスト中での表記は「YYYY年MM月DD日(曜)」で統一】
という運用ルールにしている。
順次更新が必要なファイルについては、
テキスト中やキャプション中に「作成日付」と「最終更新日付」を入れている。
--------------------------------------------------------------------------------
●ページ作成：2015年08月07日(金)
●最終更新：2024年10月26日(土)