** mypluglist.inc.php [#z4a5a318]
|RIGHT:100|LEFT:360|c
|~サマリ|プラグイン一覧と情報収集の自動化|
|~リビジョン|1.1|
|~リビジョン|1.2|
|~対応バージョン|1.4.7|
|~投稿者|[[token]]|
|~投稿日|&new{2007-10-09 (火) 12:20:51};|
**基本情報 [#qdf35fd9]
:プラグイン名|
mypluglist

:書式|
 #mypluglist

:概要|
標準プラグイン以外で追加したプラグインを別ページでリスト化したいと思って作りました。というより、他人のpukiwikiで利用されてるプラグインが気になってしまうので、もしこういうページが別途用意されていたら嬉しいなあと思った事が始まりです。versionlist.inc.phpを参考にしてソース中の説明文を取り出して一覧に追記するようにしています。今のところ、以下のフォーマットに対応させてます。

-%%今のところは、phpdoc風のdocコメントにしてますが、存在しないキーワードを書いてる可能性があります。コメントのフォーマットが最大のキモだと思うので、このプラグインはまだ考えるべき問題が多いです。phpDocumentorに合わせようかと考えてます。phpDocumentorに無い部分は何とか違った形で表現できればと考えてます。--2007-10-10 [[token]]%%

-&color(red){phpDocumenter風に作り変えました。キーワードの意味も極力合わせる事にしましたが、@tutorial, @catgory辺りが怪しいです。出力フォーマットは自由に変えてもらうとして、コメントフォーマットはもう少し考える余地がありますね。それに、キーワードが書かれてなかったら説明文にも出さないという様な処理は入れてません。単に該当箇所が空白になるだけです。--2007-10-11 [[token]]};
-%%phpDocumenter風に作り変えました。キーワードの意味も極力合わせる事にしましたが、@tutorial, @catgory辺りが怪しいです。出力フォーマットは自由に変えてもらうとして、コメントフォーマットはもう少し考える余地がありますね。それに、キーワードが書かれてなかったら説明文にも出さないという様な処理は入れてません。単に該当箇所が空白になるだけです。--2007-10-11 [[token]]%%
-ちなみに、読み取り範囲は一番最初のブロックコメントに限っていますので、fuctionやmethodにphpDocumenterコメントを入れても無視してくれます。-- 2007-10-11 [[token]]
-@categoryは未だに意味が怪しいですが、他の部分はfixした感じです。 -- 2007-10-12 [[token]]
--書式について
---@tutorialの後ろではなく、#や&で始まるコメントを取り出す形に変えました。
---空行を無視するようにしました。
--バージョン、ライセンスについて
---$Id$が無くても表示するようにしました。
---ライセンス参照用のURLが無くても表示するようにしました。
--キーワード全般
---キーワードの前後にスペースが2個以上あっても認識するようにしました。
--注意
---コメントにpukiwiki文法は使えません。
---ブロックコメントは各行頭に*が必要です。
--TODO
---ブロックコメントやドックコメントが無い場合は無視するように。
---管理者だけ実行できるようにする。
---ひょっとすると、emailの表示非表示のオプションは不要かもしれない。
---それよりも、詳細か単純かを変えられれば良いかもしれない。
---$Id$がある場合、CVSとSVNの書式を読み分けないといけない。

-see: [[phpDocumenter tag manual:http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.pkg.html]]
 <?php
 /** 
  * プラグインリスト一覧
  * ダラダラ2行目
  * ダラダラ3行目
  * ダラダラ4行目
  * @example http://wiki.positrium.org/index.php?pukiwikiplugins_mypluglist
  * #mypluglist((SHOW_EMAIL=FALSE))
  * &mypluglist((DUMMY))
  * @example http://wiki.positrium.org/index.php?plugin=mypluglist
  * @param boolean SHOW_EMAIL 著作者表示に併せてメールアドレスを表示する
  * @param n/a DUMMY ダミーパラメータ
  * @version $Id: mypluglist.inc.php 38 2007-10-09 03:16:28Z token $
  * @tutorial http://wiki.positrium.org/index.php?pukiwikiplugins_mypluglist #mypluglist((SHOW_EMAIL=FALSE))
  * @tutorial http://pukiwiki.sourceforge.jp/?%E8%87%AA%E4%BD%9C%E3%83%97%E3%83%A9%E3%82%B0%E3%82%A4%E3%83%B3%2Fmypluglist.inc.php
  * @author token <token7{at}gmail{dot}com>
  * @license http://www.gnu.org/licenses/gpl.ja.html GPL
  * @copyright Copyright &copy; 2007, positrium.org
  * @category pukiwiki1.4.7+
  * @category 1.4.7+
  * 
  * $HeadURL: http://opensvn.csie.org/positrium/trunk/mypluglist.inc.php $
  */
出力サンプルは次のようなものです~
出力サンプル(email表示OFF時)は次のようなものです~
-----
**mypluglist2.inc.php [#h6fb59b0]
~
プラグインリスト一覧~
**mypluglist.inc.php [#xead29bb]
:概要|プラグインリスト一覧~
ダラダラ2行目~
ダラダラ3行目~
ダラダラ4行目~
~
-example:http://wiki.positrium.org/index.php?pukiwikiplugins_mypluglist
--param:boolean SHOW_EMAIL 著作者表示に併せてメールアドレスを表示する
--param:n/a DUMMY ダミーパラメータ
-ver:38 2007-10-09 03:16:28Z token 
-tutorial_cmd:
-tutorial:http://wiki.positrium.org/index.php?pukiwikiplugins_mypluglist
-author:token <token7{at}gmail{dot}com> 
-license:[[GPL:http://www.gnu.org/licenses/gpl.ja.html]]
-copyright:Copyright &amp;copy; 2007, positrium.org
-category:pukiwiki1.4.7+
-source:http://opensvn.csie.org/positrium/trunk/mypluglist.inc.php

:書式([[see tutorial:http://pukiwiki.sourceforge.jp/?%E8%87%AA%E4%BD%9C%E3%83%97%E3%83%A9%E3%82%B0%E3%82%A4%E3%83%B3%2Fmypluglist.inc.php]])|
 #mypluglist((SHOW_EMAIL=FALSE))
 &mypluglist((DUMMY))
:引数|boolean ''SHOW_EMAIL'' -- 著作者表示に併せてメールアドレスを表示する~
n/a ''DUMMY'' -- ダミーパラメータ~

:動作サンプル|http://wiki.positrium.org/index.php?plugin=mypluglist

:バージョン|38 2007-10-09 03:16:28Z token( [[source:http://opensvn.csie.org/positrium/trunk/mypluglist.inc.php]] )

:著作者| token 

:著作権表示|Copyright &amp;copy; 2007, positrium.org

:ライセンス|[[GPL:http://www.gnu.org/licenses/gpl.ja.html]]

:対応バージョン|1.4.7+

----
:オプション|
SHOW_EMAIL -- 著作者表示に併せてメールアドレスを表示します。指定方法は、引用符なしでTRUEかFALSE(小文字を入れてもupperしています。)。初期値はFALSEです。

:内部オプション|
ALT_PLUGIN_DIR(プラグインディレクトリを指定する) -- 初期値はalt_pluginと書いてます。標準プラグインディレクトリと同じ階層にあるalt_pluginディレクトリを指す事を想定しています。


**ダウンロード [#g1996827]
[[配布ページ(trunk):http://opensvn.csie.org/positrium/trunk/]]からどうぞ。

**インストール [#v1410a74]
標準プラグインディレクトリに配置するだけです。

**ライセンス [#kb3504e1]
[[GNU General Public License(GPL):http://opensource.org/licenses/gpl-license.php]]

**動作サンプル [#g972fb6a]
[[wiki.positrium.org:http://wiki.positrium.org/index.php?pukiwikiplugins_mypluglist]]

**コメント [#xe889cfd]
-[[コメントはこちらへ:http://d.hatena.ne.jp/token/20071009/1191901618]]

** 関連 [#w2115b6a]
- [[dev:BugTrack/149]]


トップ   新規 一覧 検索 最終更新   ヘルプ   最終更新のRSS
Site admin: PukiWiki Development Team

PukiWiki 1.5.3+ © 2001-2020 PukiWiki Development Team. Powered by PHP 5.6.40-0+deb8u12. HTML convert time: 0.278 sec.

OSDN