ゲームランキングプラグインの設計書です。

{{outline}}

!!!ディレクトリ構成

!!!ページ仕様

!!管理ページ

!共通設定

*ユーザ名入力の必須／任意
*ユーザ名入力が任意のときの表示名
*同タイトル、同ステージにおける、同じユーザ名による多重登録の許可数（0:限界なし）
*コメント欄の有無
*コメント欄入力の必須／任意
*特定URLからのみの許可（追加／削除／編集）

!タイトル編集

*タイトルの追加／削除／編集
*一覧表示したときの表示順序

!ステージ編集

*ステージの追加／削除／編集
*一覧表示したときの表示順序

!ステージ別設定

*項目の表示順序
*ランキングの最大数
*スコアの順序（昇順／降順）
*スコアの表示形式（そのまま／時間に置き換え）
*スコアを時間表記するときのフォーマット
*登録時間の表示形式（そのまま／フォーマット指定）
*登録時間のフォーマット

!!ランキング登録

!登録ページ

下記データをフォームデータで保持
,データ名,データ形式,必須／任意,備考
,タイトル,文字列,必須,非表示
,ステージ,文字列,必須,非表示
,スコア,数値,必須,非表示
,登録時刻,数値,任意,非表示、クライアント側の時間、無い場合はサーバ側の時間
,ユーザ名,文字列,必須／任意,空文字あり
,コメント,文字列,必須／任意,空文字あり、未定義あり

!!ランキング表示ページ

!一覧表示
全てのタイトル、全てのステージのランキングを表示

!タイトル別表示
特定のタイトル内の、全てのステージのランキングを表示

!ステージ別表示
特定のタイトル内の、特定のステージのランキングを表示

!ユーザ名別表示
ランキングのランキングを、ユーザごとに表示

!!!ファイル仕様

!設定ファイル

「gamerank_setting.dat」に保存

,データ名,データ形式,備考
,バージョン,数値,１以上
,ユーザ名必須／任意,Boolean,1:必須、0:任意
,ユーザ名表示,文字列,ユーザ名が任意のときに使用する表示ユーザ名、タブ文字は空白に置き換え
,多重登録許可数,数値,0以上
,コメント欄の有無,Boolean,1:あり、0:なし
,コメント入力の必須／任意,Boolean,1:必須、0:任意、コメント欄ありの時だけ参照
,URL制限,文字列,タブ区切りのURL、空文字あり

!ゲーム情報

「gamerank_info.dat」に保存

タブ区切りで下記データが１つのレコード
表示順にソート済み

,データ名,データ形式,備考
,タイトル名,文字列,タブ文字は空白に置き換え
,ステージ情報,下記参照,表示順にソート済み

!ステージ情報

,データ名,データ形式,備考
,ステージ名,文字列,空文字あり、タブは空白に置き換え
,ランキング最大数,数値,1以上
,スコアの表示順序,Boolean,1:昇順、0:降順
,スコアの表示形式,Boolean,1:時間形式、0:そのまま
,スコア時間形式のフォーマット,文字列,空文字あり、タブは空白に置き換え、下記参照
,登録時間の表示形式,Boolean,1:フォーマット指定あり、0:フォーマット指定なし
,登録時間のフォーマット,文字列,空文字あり、タブは空白に置き換え、下記参照

!時間のフォーマット

,文字,意味,表示例
,yyyy,西暦を４桁で表示,2004
,yy,西暦を２桁で表示,04
,mm,月を数字２桁で表示,01
,m,月を数字で表示,1
,dd,日を２桁で表示,01
,d,日を表示,1
,dddd,曜日を日本語表示,月曜日
,ddd,曜日の略字を日本語表示,月
,dddde,曜日を英語表示,Monday
,ddde,曜日の略字を英語表示,Mon
,hh,時を２桁で表示,01、23
,h,時を表示,1、23
,nn,分を２桁で表示,01
,n,分を表示,1
,ss,秒を２桁で表示,01
,s,秒を表示,1
,tt,午前か午後かを表示,午前
,tte,AMかPMかを表示,AM
,\n,改行,　
,'''"〜"''','''" "'''で囲まれた文字はそのまま表示,　
,\",ダブルクォーテーション,　
,\\,\文字,　

!ステージ別ランキングデータ

「gamerank_<タイトル>_<ステージ>.log」に保存
タブ区切りで下記データが１つのレコード

,データ名,データ形式,備考
,ユーザ名,文字列,前方空白／後方空白削除済み、空文字もあり、特殊文字は置き換え
,スコア,数値,空文字なし
,登録日時,数値,空文字なし、クライアント／サーバ側の時間
,コメント,文字列,前方空白／後方空白削除済み、空文字もあり、特殊文字は置き換え