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

:書式|
 #mypluglist

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

-ちなみに、読み取り範囲は一番最初のブロックコメントに限っていますので、fuctionやmethodにphpDocumenterコメントを入れても無視してくれます。-- 2007-10-11 [[token]]
-[[SONOTS PluginDev/Class:http://lsx.sourceforge.jp/?PluginDev%2FClass]]を参考に、クラス変数版に書き直しました。また、メールアドレスの表示可否は、ソースに依存する事にしましたので、プラグイン側で制御するのを止めました。 -- &color(red){2007-11-08 (木) 16:30:31}; [[token]]
-@categoryは未だに意味が怪しいですが、他の部分はfixした感じです。 -- 2007-10-12 [[token]]
--書式について
---@tutorialの後ろではなく、#や&で始まるコメントを取り出す形に変えました。
---空行を無視するようにしました。
--バージョン、ライセンスについて
---$Id$が無くても表示するようにしました。
---ライセンス参照用のURLが無くても表示するようにしました。
--キーワード全般
---キーワードの前後にスペースが2個以上あっても認識するようにしました。
--注意
---コメントにpukiwiki文法は使えません。
---ブロックコメントは各行頭に*が必要です。
---&color(red){phpDocumenterに読ませる予定なら、};~
&color(red){ソースを関数型からクラス型に書き換えないと、};~
&color(red){apidocの表示が不自然になります。-- 2007-11-08 (木) 12:57:22 token};
--TODO
---ブロックコメントやドックコメントが無い場合は無視するように。
---管理者だけ実行できるようにする。
---%%ひょっとすると、emailの表示非表示のオプションは不要かもしれない。%%除去しました
---それよりも、詳細か単純かを変えられれば良いかもしれない。
---$Id$がある場合、CVSとSVNの書式を読み分けないといけない。
---revisionとversionを区別した方が良いかもしれない。~
バージョン管理の上の$Id$はrevision扱いなので、~
利用者側に立つとリリースバージョンとはまた違う意味になりますね。~
全ての情報をソースファイルに詰め込むのは難しいなと思います。

-see: [[phpDocumenter tag manual:http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.pkg.html]]
 <?php
 /** 
  * プラグインリスト一覧
  * ダラダラ2行目
  * ダラダラ3行目
  * ダラダラ4行目
  * #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://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 1.4.7+
  * 
  * $HeadURL: http://opensvn.csie.org/positrium/trunk/mypluglist.inc.php $
  */
出力サンプル(email表示OFF時)は次のようなものです~
-----
**mypluglist.inc.php [#xead29bb]
:概要|プラグインリスト一覧~
ダラダラ2行目~
ダラダラ3行目~
ダラダラ4行目~

:書式([[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です。%% ver1.3から廃止。

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


**ダウンロード [#g1996827]
[[配布ページ(tags):http://svn.sourceforge.jp/svnroot/positrail/tags/mypluglist/]]からどうぞ。

**インストール [#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.088 sec.

OSDN