ManifestFiler - ぺったんR Wiki - ぺったんR

ManifestFiler@ AboutManifest

記述例

filers = {
  item_name1: {
    symbol: {
      type: 'default',
      args: {
        face: {
          type: 'image',
          args: {
          },
        },
        link: {
          type: 'action'
          args: {
            action_name: 'show',
          },
        },
      },
    },
    caption: {
      type: 'default',
      args: {
        face: {
          type: 'column',
          args: {
            column_name: 'title',
          },
        },
        link: {
          type: 'action'
          args: {
            action_name: 'play',
          },
        },
      },
    },
    summary: {
      type: 'template',
      args: {
        template_name: 'summary',
      },
    },
    edit: {
      type: 'default',
      args: {
      },
    },
  },
  item_name2: {

各アイテム(この場合、item_name1およびitem_name2)に対して、出力に必要なすべてのパラメータを設定する。

• symbol
• caption
• summary
• icon
• date
• edit

ファイラーが表示する項目は上記の7つであった。アイテムごとに各項目の表示スタイルが違うので、これをtype(表示方法)とargs(必要なパラメータ)に分けて設定する。

形式はname > type > argsである

symbol

このアイテムのシンボルに関してhashで設定する。省略したときは空のhashが補充される。

形式はname > type > argsである

type

シンボルの処理タイプを次の中から文字列で設定する。省略したときは'default'が補充される。

• default 表示物とリンクの組み合わせ
• template 個別にカスタマイズされたテンプレート

args

シンボルの処理に必要なオプションを与えるための設定。記述するべき内容はタイプによって違ってくる。

Default

symbol typeでdefaultを選択したときに利用される。

face

このシンボルの表示に関して、hashで設定する。省略したときは空のhashが補充される。

形式はtype > argsである

type

シンボル表示の処理タイプを次の中から文字列で設定する。省略したときはimageが設定される。

• image 固定の画像
• picture コンテンツとして投稿された画像

args

シンボルの表示の処理に必要なオプションを与えるための設定。記述するべき内容はタイプによって違ってくる。

ImageFace

face typeでimageを選択したときに利用される。

url

画像のURLを文字列で設定する。省略したときは'/images/item.png'が補充される。

PictureFace

face typeでpictureを選択したときに利用される。

method_name

アイテムのオブジェクトに定義されているシンボル表示オプションのメソッド名を文字列で設定する。省略したときは'symbol_option'が設定される。 メソッドが呼び出せない場合は白紙のアイコンを表示する。

link

シンボルのクリック処理に関してhashで設定する。省略したときは空のhashが補充される。

形式はtype > argsである

type

シンボルクリックの処理タイプを次の中から文字列で設定する。省略したときはactionが設定される。

• action アイテムの詳細を表示するためのアクション
• none リンクしない
• url_column URLが収められたカラムのカラム名

args

シンボルクリックの処理に必要なオプションを与えるための設定。記述するべき内容はタイプによって違ってくる。

ActionLink

link typeでactionを選択したときに利用される。

• /controller_name/id/action_name

このようなURLを発生させるための仕組み

action_name

アイテムの詳細を表示するアクション名を設定する。省略したときは'show'が設定される。

NoneLink

link typeでnoneを選択したときに利用される。

リンク先のないアイテムの時に使う。

UrlColumnLink

link typeでurl_columnを選択したときに利用される。

ライセンスのように外部サイトへと誘導するためのURLを備えたアイテムで、アイテムに設定されたURLを利用したいときに使う。

column_name

URLが収められたカラムの名称を文字列で設定する。省略した時は'url'が設定される。

Template

symbol typeでtemplateを選択したときに利用される。

形式はtype > valueである

template_name

アイテムに定義されているシンボル表示テンプレートのテンプレート名を文字列で設定する。省略したときは'symbol'が設定される。

caption

このアイテムのキャプションに関してhashで設定する。省略したときは空のhashが補充される。

形式はname > type > argsである

type

キャプションの処理タイプを次の中から文字列で設定する。省略したときは'default'が設定される。

• default 表示物とリンクの組み合わせ
• template 個別にカスタマイズされたテンプレート

args

キャプションの処理に必要なオプションを与えるための設定。記述するべき内容はタイプによって違ってくる。

Default

caption typeでdefaultを選択したときに利用される。

face

このキャプションの表示に関して、hashで設定する。省略したときは空のhashが補充される。

形式はtype > argsである

type

キャプション表示の処理タイプを次の中から文字列で設定する。省略したときは'column'が設定される。

• column アイテムのカラムを表示する
• method アイテムの機能を使って表示する
• none 表示しない

args

キャプション表示の処理に必要なオプションを与えるための設定。記述するべき内容はタイプによって違ってくる。

ColumnFace

face typeでcolumnを選択したときに利用される。

column_name

アイテムのカラム名を設定する。省略したときは'caption'が設定される。 メソッドが呼び出せない場合はを表示する。

MethodFace

face typeでmethodを選択したときに利用される。

method_name

アイテムのオブジェクトに定義されているキャプション表示処理のメソッド名を設定する。省略したときは'caption'が設定される。 メソッドが呼び出せない場合はを表示する。

「第一話:タイトル名」のようにタイトル名だけでなく、何らかの情報を追加した見出しを表示したいときに使う。

NoneFace

face typeでnoneを選択したときに利用される。

link

キャプションのクリック処理に関してhashで設定する。省略したときは空のhashが補充される。

形式はtype > argsである

type

キャプションクリックの処理タイプを次の中から文字列で設定する。省略したときはactionが設定される。

• action アイテムの詳細を表示するためのアクション
• none リンクしない
• url_column URLが収められたカラムのカラム名

クライアント開発者は、キャプションクリックの処理をこれに合わせて実装するように。

args

キャプションクリックの処理に必要なオプションを与えるための設定。記述するべき内容はタイプによって違ってくる。

ActionLink

link typeでactionを選択したときに利用される。

• /controller_name/id/action_name

このようなURLを発生させるための仕組み

action_name

アイテムのカラム名を設定する。省略したときは'show'が設定される。

NoneLink

link typeでnoneを選択したときに利用される。

リンク先のないアイテムの時に使う。

UrlColumnLink

link typeでurl_columnを選択したときに利用される。

ライセンスのように外部サイトへと誘導するためのURLを備えたアイテムで、アイテムに設定されたURLを利用したいときに使う。

column_name

URLが収められたカラムの名称を文字列で設定する。省略した時は'url'が設定される。

summary

このアイテムの要約に関してhashで設定する。省略したときは空のhashが補充される。

形式はtype > argsである

type

要約の処理タイプを次の中から文字列で設定する。省略したときは'template'が設定される。

• template テンプレートを使って表示する
• none 表示しない

args

要約の処理に必要なオプションを与えるための設定。記述するべき内容はタイプによって違ってくる。

Template

summary typeでtemplateを選択したときに利用される。

template_name

要約テンプレートのテンプレート名を文字列で設定する。省略したときは'summary'が設定される。

None

summary typeでnoneを選択したときに利用される。

要約を表示しないときに使う。

icon

このアイテムのアイコンに関してhashで設定する。省略したときは空のhashが補充される。

形式はname > type > argsであるが、マニフェストよって振舞いが変わる事はないので設定する項目がない。

date

このアイテムの日時表示に関してhashで設定する。省略したときは空のhashが補充される。

形式はname > type > argsであるが、マニフェストよって振舞いが変わる事はないので設定する項目がない。

edit

このアイテムのエディットボックスに関してhashで設定する。省略したときは空のhashが補充される。

形式はtype > argsである

type

エディットボックスの処理タイプを次の中から文字列で設定する。省略したときは'default'が設定される。

• default 編集と削除ボタンの付いた一般的なエディットボックス
• account プロフィール編集へと誘導できるコンテンツオーナー向けエディットボックス
• template テンプレートによるカスタマイズされたエディットボックス
• none 表示しない

クライアント開発者は、エディットボックスの処理をこれに合わせて実装するように。

args

エディットボックスの処理に必要なオプションを与えるための設定。記述するべき内容はタイプによって違ってくる。

Default

edit typeでdefaultを選択したときに利用される。

Account

edit typeでaccountを選択したときに利用される。

Template

edit typeでtemplateを選択したときに利用される。

template_name

エディットボックステンプレートのテンプレート名を文字列で設定する。省略したときは'edit'が設定される。

None

edit typeでnoneを選択したときに利用される。