PukiWikiプラグインの作り方

目次

FrontPage
・さくらVPS
・Fedora13
・SuSe10
・Docker
・Ansible
・Java
・Scala
・Python
・Ruby
・Lisp
・Computer
・GIS
・HTML
・Culture
・Random
・Link

訪問者

total: 4500
today: 3
yesterday: 2
now: 9

更新

最新の10件

人気の10件

MenuBar

プラグインの作成方法 †

• Yahoo! の地図共有サービス (http://latlonglab.yahoo.co.jp/) 用のプラグインを作ってみた

  <?php
  function plugin_route_inline(){
    $aryargs = func_get_args();
    return '<script type="text/javascript" encoding="UTF-8" src="http://latlonglab.yahoo.co.jp/route/paste?id=' .
   $aryargs[0] .
   '&width=320&height=480"></script>';
  }
  ?>
  

• プラグインの置き場
  • /var/www/html/pukiwiki/plugin
• プラグインのファイル名
  • {プラグイン名}.inc.php
• 呼び出される関数

  初期化	function plugin_{プラグイン名}_init()
  ブロック型で呼び出される	function plugin_{プラグイン名}_convert()
  インライン型で呼び出される	function plugin_{プラグイン名}_inline()

  • 必要な関数のみでOK
• パラメータの取得

  パラメータ配列	func_get_args()
  パラメータ数	func_num_args()

• 返値がページに埋め込まれる (HTMLとして出力される)

プラグインの使い方 †

ルートIDを引数にして、Pukiwiki に次のように記述すればよい

&route(91d77cdc5f1fb99291550adc714ee9d4);

添付ファイルの使い方 †

<?php
function plugin_js_inline(){
  global $vars;

  $aryargs = func_get_args();
  $arylength = func_num_args();

  $attach_file = '/pukiwiki/index.php?plugin=attach&pcmd=open&file=' . urlencode($aryargs[0]) . '&refer=' . urlencode($vars['page']);

  $size = '';
  if ($arylength == 3) {
    $size = ' width="' . $aryargs[1] . '" height="' . $aryargs[2] . '"';
  }

  return '<iframe src="' . $attach_file . '"' . $size . ' style="border:solid"></iframe>';
}
?>

ページ名は グローバル変数 $vars に 'page' をキーに格納されている

&js(sample.html,320,240);

Youtube †

<?php
function plugin_youtube_inline(){
  $aryargs = func_get_args();
  $arylength = func_num_args();
  
  $videoId = $aryargs[0];
  $width = 512;
  $height = 384;

  if (func_num_args() > 2){
    if ($aryargs[1] == '4:3s') {
      $width = 256;
      $height = 192;
    } else if ($aryargs[1] == '4:3') {
      $width = 512;
      $height = 384;    
    } else if ($aryargs[1] == '16:9s') {
      $width = 320;
      $height = 192;    
    } else if ($aryargs[1] == '16:9') {
      $width = 640;
      $height = 384;    
    } 
  }

  return '<object width="' . $width . '" height="' . $height . '">'
         . '<param name="movie" value="http://www.youtube.com/v/' . $videoId . '"></param>'
         . '<embed src="http://www.youtube.com/v/' . $videoId . '" '
         . ' type="application/x-shockwave-flash"'
         . ' wmode="transparent" width="'. $width . '" height="' . $height . '"></embed>'
         . '</object>'; 
}
?>

Google Docs †

<?php
function plugin_gdoc_inline(){
  global $vars;

  $aryargs = func_get_args();
  $arylength = func_num_args();
  
  $size = ''; 
  if ($arylength == 5) {
    $size = ' width="' . $aryargs[2] . '" height="' . $aryargs[3] . '"';
  }

  if ($aryargs[0] == 'spreadsheet'){
    return '<iframe src="https://spreadsheets.google.com/spreadsheet/ccc?key='
      . $aryargs[1] 
      . '&hl=ja&ui=2&rm=demo&chrome=false#gid=0" style="border:solid" ' . $size . '>'
      . '</iframe>';
  }
}
?>

• 最初から全画面表示にする URL パラメータは、
  http://www.google.com/support/forum/p/Google%20Docs/thread?tid=1ab5b23e69801528&hl=en
• とりあえず 1 Sheet の Spread Sheet のみ対応。必要があれば、他の文書にも対応する。
  • if ($aryargs[0] == 'spreadsheet') の下に
  • else if ($aryargs[0] == 'pdf') ... などを追加すればいい

Google Chart API で数式 †

• 使用例。すばらしい (Google Chart API がすばらしい)
  • 例:変換行列

    \(\left( \begin{array}{c} x' \\ y' \\ 1 \end{array} \right) = \left( \begin{array}{ccc} m_{11} & m_{21} & d_{x} \\ m_{12} & m_{22} & d_{y} \\ 0 & 0 & 1 \end{array} \right) \left( \begin{array}{c} x \\ y \\ 1 \end{array} \right) \)

  • 例: オイラーの公式( \(e^{i\theta} = \cos(\theta) + i\sin(\theta)\) )は、電気工学でよく使われます
• ソースコード

  <?php
  function plugin_tex_inline(){
    $aryargs = func_get_args();
    $tex = $aryargs[0];
    $tex = str_replace(array("\r\n","\r","\n"), '', $tex);
    $tex = str_replace(' $' , '$' , $tex);
    $tex = str_replace(' \\', '\\', $tex);
    return '<img src="http://chart.apis.google.com/chart?cht=tx&chf=bg,s,00000000&chl='
      . rawurlencode($tex) . '"/>';
  }
  function plugin_tex_convert(){
    $aryargs = func_get_args();
    $tex = $aryargs[0];
    $tex = str_replace(array("\r\n","\r","\n"), '', $tex);
    $tex = str_replace(' $' , '$' , $tex);
    $tex = str_replace(' \\', '\\', $tex);
    return '<img src="http://chart.apis.google.com/chart?cht=tx&chf=bg,s,00000000&chl='
      . rawurlencode($tex) . '"/>';
  }
  ?>
  

• 使い方

  #tex(){{
  \left( 
  \begin{array}{c}
  x' \\
  y' \\
  1
  \end{array} 
  \right) 
  =
  \left( 
  \begin{array}{ccc} 
  m_{11} & m_{21} & d_{x} \\
  m_{12} & m_{22} & d_{y} \\
  0 & 0 & 1
  \end{array} 
  \right)
  \left( 
  \begin{array}{c}
  x \\
  y \\
  1
  \end{array} 
  \right)
  }}
  オイラーの公式( &tex(e^{i\theta} = \cos(\theta) + i\sin(\theta)); )は、電気工学でよく使われます

• 留意点
  • 数式を URL エンコードしたときの長さが 200文字以上だと Google から数式の画像が返ってきません(規格上)。 実際には 350 文字くらいまで大丈夫っぽい
  • 一応、不要な改行とスペースを削ってます

経過日を表示する †

• 光陰矢のごとし。今年ももう何パーセント過ぎました plugin
• ソースコード

  <?php
  function plugin_ispent_inline(){
    $args = func_get_args();
    return plugin_ispent();
  }
  function plugin_ispent_convert(){
    $args = func_get_args();
    return '<br/>' . plugin_ispent() . '<br/>';
  }
  function plugin_ispent(){
    $html = '<fieldset style="border:dotted 2px lightgray">';
    $html = $html . '<legend>' . date('Y-m-d') . '</legend>';
  
    $html = $html . plugin_ispent_make_meter(
      date('Y')
      , strtotime(date('Y-01-01'))
      , strtotime(date('Y-01-01', strtotime(date('Y-01-01') . '+1 year')))
      , 86400);
  
    $html = $html . '<br/>' . plugin_ispent_make_meter(
      date('F')
      , strtotime(date('Y-m-01'))
      , strtotime(date('Y-m-01', strtotime(date('Y-m-01') . '+1 month')))
      , 86400);
    
    if(strcmp(date('D'),'Mon') === 0) {
      $html = $html . '<br/>' . plugin_ispent_make_meter(
        'Week ' . date('W')
        , strtotime('today')
        , strtotime('next monday')
        , 86400);
    } else { 
      $html = $html . '<br/>' . plugin_ispent_make_meter(
        'Week ' . date('W')
        , strtotime('previous monday')
        , strtotime('next monday')
        , 86400);
    }
    
    $html = $html . '<br/>' . plugin_ispent_make_meter(
      'Day ' . date('d D')
      , strtotime('today')
      , strtotime('tomorrow')
      , 3600);
   
    $html = $html . '</fieldset>'; 
    return $html;
  }
  
  function plugin_ispent_make_meter($title, $start, $end, $unit) {
  
    $all = ($end - $start) / $unit;
    $spent = (time() - $start) / $unit;
    $low = $all / 3.0;
    $optimum = $all / 2.0;
    $high = $low * 2.0;
    
    $progress = (floor(1000.0 * $spent / $all) / 10.0) . "% ("
      . (floor(10.0 * $spent) / 10.0) . '/' . floor($all) . ")";
  
    return $title . '<br/>' 
      . '<meter value="' . $spent . '"'
      . ' min="0" max="' . $all . '"'
      . ' title="' . $progress . '" style="width:75px">' . $progress . '</meter>';
  }
  ?>
  

• 使い方

  #ispent

  
  
  2017-08-18

  2017
  62.8% (229.4/365)
  August
  56.4% (17.4/31)
  Week 33
  64.2% (4.4/7)
  Day 18 Fri
  49.6% (11.9/24)
  
  
• strtotime() の '+1 month' は要注意
  • 1月30日 +1 month = 2月30日 = 3月2日
  • 次の月を知りたければ、01日に戻してから +1 month する必要がある
  • http://1kb.jp/blog/archives/204

?.jpg.to †

• ?.jpg.to は、? に関する適当な画像を返してくれるサービス。これを呼び出すためのプラグイン
• ソースコード

  <?php
  function plugin_jpg_inline(){
    $args = func_get_args();
    return jpgto($args[0]);
  }
  function plugin_jpg_convert(){
    $args = func_get_args();
    return jpgto($args[0]);
  }
  function jpgto($keyword){
    return '<br/><img src="http://' . $keyword . '.jpg.to/" height="240" alt="' . $keyword . '">';
  }
  ?>
  

• 使い方

  #jpg(逃げて)

  

Graphviz †

#graphviz{{{
digraph {
node [shape = box, fontname = "sans-serif", fontsize = 8];
"オブジェクト型"->"コンテナ型"
"オブジェクト型"->"None"
"オブジェクト型"->"数値型"
"数値型"->"bool"
"数値型"->"int"
"数値型"->"float"
"数値型"->"Complex\n(複素数)"
"コンテナ型"->"シーケンス型"
"シーケンス型"->"list"
"シーケンス型"->"tuple\n(変更不可list)"
"シーケンス型"->"文字列"
"シーケンス型"->"range"
"コンテナ型"->"集合型"
"集合型"->"set"
"集合型"->"frozenset\n(変更不可set)"
"コンテナ型"->"マップ型"
"マップ型"->"Dictionary"
"iteratable"->"list"
"iteratable"->"tuple\n(変更不可list)"
"iteratable"->"文字列"
"iteratable"->"range"
"iteratable"->"set"
"iteratable"->"frozenset\n(変更不可set)"
"iteratable"->"Dictionary"
}
}}}

FrontPage