自作プラグイン/step

2022-02-19 (土) 02:10:06

カテゴリ:プラグイン 自作 追加

step.jpg

縦型のステップフローを作成するプラグイン

step.inc.php
製作者kanateko
ライセンスGPLv3
バージョン0.6
動作確認PukiWiki 1.5.3 ~
最終更新2022-02-19

手順などを説明を行うためのステップフローを作成・表示するプラグイン。
番号部分の表示を変えたり、一部のデザインを変えたりすることもできる。

このプラグインでできること
  • 縦型のステップフローを作成できる
    • 各フローはタイトルとコンテンツに分かれている
      • 両方でPukiWiki記法が使える
      • タイトルを非表示にすることも可能
    • 入れ子でプラグインを使用することもできる
    • ラベル (番号部分) の文字列を変更したり、数字の前に任意の数字などを加えたりできる
    • ラベル横のマーカーのスタイルをある程度変更可能

ダウンロード

最新: GitHub

日付バージョン備考
2022-02-190.6
  • マーカー関連オプションの処理を最適化
  • マーカーのスタイル指定のエラー処理を厳格化
2022-02-180.5
  • マルチライン部分がない場合のエラーを追加
  • 同じタイトルがある場合に表示が崩れる問題を修正
0.4
  • タイトルを非表示にする機能を追加
0.3
  • マーカーのスタイルを変更する機能を追加
0.2
  • ラベルを変更する機能を追加
2022-02-170.1
  • 初版作成

インストール

  1. STEP1
    ファイルのダウンロード

    GitHubからplugin-stepフォルダにある「step.inc.php」をダウンロードしてpluginフォルダに入れる

  2. STEP2
    CSSの編集
    1. STEP2-1

      skin/pukiwiki.cssに以下の内容を追加する

      コードを表示
    2. STEP2-2

      サイトに合わせてデザインを調整する

  3. STEP3
    マルチラインプラグインを有効にする

    pukiwiki.ini.phpを編集してマルチラインプラグインを有効化する

     define('PKWKEXP_DISABLE_MULTILINE_PLUGIN_HACK', 0); // 1 = Disabled
    

プラグインの設定

STEP_LABEL_STRING
ラベルの文字列。デフォルトは "STEP"
STEP_LIST_TAG
コンテナのHTMLタグ。デフォルトは "ol"
STEP_MARKER_DEFAULT
マーカーのデフォルトスタイル。デフォルトは "border"

使用方法

#step([オプション]){{
#:[タイトル]
<コンテンツ>
︙ (タイトルとコンテンツの繰り返し)
}}

タイトルが無い場合はタイトル部分が非表示になる。

オプション

label=<文字列>
ラベルの文字列を変更する
pre=<文字列>
番号の直前に文字を挿入する。実際の表示は <文字列>-番号 と間にハイフンが入る。主に入れ子で使用する場合に用いる
marker=<border/double/solid>
マーカーのスタイルを変更する
mcolor=<色指定>
マーカーの色を変更する。CSSと同じ記法で指定できる

使用例

  1. その1
    ラベルの変更

    STEP から その に変更してみる

  2. その2
    入れ子

    入れ子も可能。タイトルの記入がない場合はタイトルを非表示に。

    1. その2-1

      番号の前に 2 を追加してみる

    2. その2-2

      マーカーのスタイルを solid (塗りつぶし) に変更してみる

    3. その2-3

      マーカーの色を tomato に変更してみる

  3. その3
    タイトルでPukiWiki記法も使える

    タイトルにmarkerプラグインを使用している。

#step(label=その){{{
#:ラベルの変更
''STEP'' から ''その'' に変更してみる
#:入れ子
入れ子も可能。タイトルの記入がない場合はタイトルを非表示に。
#step(label=その,pre=2,marker=solid,mcolor=tomato){{
#:
番号の前に ''2'' を追加してみる
#:
マーカーのスタイルを ''solid'' (塗りつぶし) に変更してみる
#:
マーカーの色を ''tomato'' に変更してみる
}}
#:&marker{タイトルでPukiWiki記法も使える};
タイトルに[[markerプラグイン>../marker]]を使用している。
}}}

追加したい機能

  • いくつかの箇所のスタイルを変更できるようにする

コメント

コメントはありません。 コメント/自作プラグイン/step