howToMakePlugin

FrontPage

プラグインの作り方 †

プラグイン名.rbのファイルを作る †

例　作成するプラグイン名をtoolsとすると

tools.rbというファイルを作ります。

プラグインの関数作成 †

def プラグイン名(config, data)
  処理
end

例　作成するプラグイン名をtoolsとすると

def tools(config, data)
  処理
end

※パラメータが必要な場合は

config["パラメータ名"]　で参照します。

パラメータ名はconfig.yamlで指定します。

例

  config:
    filename: data.yaml

この場合config["filename"]　→ "data.yaml"になります。

入力はdataで関数の出力はそのまま次のプラグインのdata引数に渡されます。

pluginフォルダの中に保存します †

例　作成するプラグイン名をtoolsとすると

作成したtools.rbというファイルをpluginフォルダに保存します。

config.yamlから呼び出します。 †

例　作成するプラグイン名をtools

必要なオプションをfilenameとします

config.yaml例

- module: tools
  config:
    filename: data.yaml

上記が処理される時に

tools.rbが呼び出されます。

config["filename"]の値は"data.yaml"になっています。

処理結果を関数の戻り値で返します。