mypluglist.inc.php

サマリプラグイン一覧と情報収集の自動化
リビジョン1.8
対応バージョン1.4.7
投稿者token
投稿日2007-10-09 (火) 12:20:51

基本情報

プラグイン名
mypluglist
書式
#mypluglist
概要
自作プラグインからのみ*1、docコメント*2を読み取って、一覧にします。一覧は動的生成ではなく、通常のページとして書き込まれるので、参照時の負荷が少なくなっています。
参考
versionlist.inc.php
SONOTS PluginDev/Class
see: phpDocumenter tag manual
依存
Config2

読み取り範囲

ファイル先頭のdocコメントに限定しています。その為、fuctionやmethodにキーワードを入れても無視されますし、だたのブロックコメントも無視します。

phpDocumentorとの互換性

頻出キーワードは意味レベルでの互換性がありますが、比較的使われにくいキーワードは予約キーワード扱いにしてしまっています。@category等の意味合いがphpDocumentorと違っているのはその為です。

コメントの書式について

プラグイン呼び出し例(usage)について

#や&で始まるコメントを呼び出し例に使います。

バージョン、ライセンス、ヘッドURLについて

  • $Id$が無くても表示します。
  • ライセンス参照用のURLが無くても表示します。
  • $HeadURL$が無いとソース取得元が表示出来ません。

注意、その他

  • キーワードの前後にスペースが2個以上あっても認識します。
  • 空行は無視します。
  • コメントにpukiwiki文法は使えません。
  • コメントは各行頭に*が必要です。

記入例

/** 
* 説明
* #hoge([foo][,bar,...]) 説明
* &hoge(); 説明
* @example サンプル用URL
* @param type 説明の中の変数名 変数の説明
* @version $Id$
* @tutorial 詳細説明用URL
* @author 著者
* @license http://www.gnu.org/licenses/gpl.ja.html GPL
* @copyright 著作権表記
* $HeadURL$
* @uses モジュール名 モジュールが取得可能なURL
* @package パッケージ名(プラグインはpluginが妥当)
* @subpackage サブパッケージ名(種別を書くといいんだけど、今のところ範囲が無い)
*/

動作サンプル

lab01.positrium.org

利用者が他に出来る事

:config/plugin/mypluglistに無視したいプラグインファイル名を書く事によって出力を任意に抑制できます。

また、このリストを自動生成するにあたって、本家には提出していないConfig2に依存しています。

履歴

rev説明
v1.8* いくつか可読フォーマットに変更を加えた。
* @packageを有効にした。
* @subpackageを有効にした。
* @tutorialの代わりに@linkを使えるようにした。
* 項目「書式」のフォーマットを変更した。⇒&hoge(@foo)[半角スペース]説明。これによって、出力側の見せ方も変更。要注意は、[半角スペース]がセパレータ扱い。
* @tutorialがhttp://で始まらない場合は、出力を抑制するように変更した。
* @categoryは無効にした。
* @usesを有効にした。⇒module[半角スペース]source_url のフォーマットが有効。
* action()を止め、convert()だけで実装。
* inline()の改造基盤を作成してある。
v1.5* 別ディレクトリではなく標準プラグインディレクトリを参照。
* また、内容物を標準プラグインリストと比較して、一致しなかったものだけをリストアップする形に。
* :config/plugin/mypluglistの自動生成に絡んで依存性が一つ増えました。本家には提出していないConfig2に依存しています。
* :config/plugin/mypluglistに無視したいプラグインファイル名を書く事によって出力を任意に抑制できます。
v1.3Eメール表示をoff

ダウンロード

配布ページ(tags)からどうぞ。上記の履歴の注意書きを読んでください。

インストール

標準プラグインディレクトリに配置するだけです。

ライセンス

GNU General Public License(GPL)

コメント

最新の10件を表示しています。 コメントページを参照

  • trackerの様に、templateを:configから取得したいけど、結構難しかった。 -- token 2007-12-03 (月) 00:23:49
お名前:

投票

簡易表示するなら何を残したいですか?

選択肢 投票
概要 2  
書式 1  
引数 1  
動作サンプル 0  
バージョン 0  
著作権 0  
著作権表示 0  
ライセンス 0  
対応バージョン 0  
依存性 0  

バグトラック

関連


*1 プラグインヘルプに載っているpukiwiki付属のプラグインを除く
*2 リビジョンや使用法、コピーライト、ソース取得元

トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2011-05-05 (木) 17:19:10
Site admin: PukiWiki Development Team

PukiWiki 1.5.2+ © 2001-2019 PukiWiki Development Team. Powered by PHP 5.6.40-0+deb8u7. HTML convert time: 0.801 sec.

OSDN