開発ドキュメントの整備について

[kilica]

XOOPS Cube Legacy ドキュメント整備担当になりました氷川です(^ ^)。
今後、以下のような方針でドキュメント整備を進めていきたいと思いますので、みなさんご協力よろしくお願いいたします。

■ドキュメント化の対象と目的
XOOPS（XCL）に寄与したい人（モジュール作者、テーマ作者、翻訳者（言語ファイル）など）のためのドキュメントを整備する。
利用者向けのドキュメントは、既に各コミュニティや有志の方々が優れたサイトを作られていますので扱いません。

ドキュメントの整備によって「感動した。ぜひ自分も XOOPS Cube に寄与したい」と思った人がモジュールを作ったり、テーマを作ったりとスムースに入ってこれるような環境を整えることを目的とします。

■現状
XCL開発関係のドキュメントの整備状況は芳しくありません。一目瞭然です。
http://xoopscube.wiki.sourceforge.net/Japanese

さらに、この半年でメンテナンスをしてた人は、0人です・・・。

このため、XOOPS Cube に興味を持ってドキュメントの在り処を聞いてきてくれた数少ない開発者を逃すことになってしまっています（現実に、発生してます）。
逆にこの状況を改善できれば、集まってきた開発者による新しいモジュール、魅力的なテーマが増えていくことを期待できます。

■達成目標
「現状」で見たとおり、マンパワーが足りないのは明らかです。
そこでまずは、以下のような二つの具体的で手近な目標に絞って整備を進めていきます。

・テーマの作り方
- シンプルなテーマを例にとったテーマの作り方解説
- XOOPS 特有の CSS クラスの解説
- Smarty 解説
-- XOOPS における Smarty の役割
-- Smarty を理解するためのリンク集
-- XOOPS 特有の Smarty 関数・修飾子解説

・モジュールの作り方
- シンプルなモジュールを例にとったモジュールの作り方解説
-- Hello World モジュール
-- XCL スタイルのモジュール（Cubson のコードをベースに）
-- D3（or 複製可能）モジュール
- モジュールづくりの基本
-- ディレクトリ構成と必須ファイル
--- テンプレート
--- 言語ファイル
--- SQL
--- ブロック
--- 管理画面

■スケジュール
2009年3月末を目標に進めます。
この時点で進捗がどうにも芳しくなければ、進め方を再考するか、責任者をリストラしませう。

■進め方
最終的な成果物は、sourceforge.net の wiki に掲載します。その中間成果物は、以下のいずれかの形でご協力をお願いしたいと思います。

（1）sf.net の wiki を直接編集する。トップドキュメンターが推奨する最良の方法です。

（2）自サイト（あるいはローカルのコミュニティなど）で作成したドキュメントを本ドキュメントに提供していただく。ご連絡いただければ、sourceforge.net への転載作業を行います。サイトが無い、という方でも、今では Google Docs や @wiki などのサービスを利用すれば今日にでも始めることが出来るでしょう。
いきなり sf.net の wiki を触るのは気が引ける、という方に向いた方法です。
http://docs.google.com/
http://atwiki.jp/

（3）既存のドキュメントで、XOOPS Cube プロジェクトに提供してもよい、というものがありましたらぜひご連絡ください。一部が使えそう、というものでも結構です。

なお、XOOPS Cube プロジェクトで整備するドキュメントは原則として Creative Commons Attribution-ShareAlike 2.5 ライセンスを採用します。ご協力いただける方は、あらかじめご承知おきください。

[minahito]

kilica さん、さっそくの活動開始ありがとうございます。
ドキュメントのコントリビュートに関してですが、原則として僕のサイトにある記事はすべて .org Wiki を経て sf.net Wiki に投稿されているはずですが、「これは使える」というものがありましたら、自由に使ってください。
あとで自分で過去ログを漁る機会を持ちたいと思っていますが、少しお待ちください。

[beabo]

資料的に使っているのですが、作りかけの用語辞典があります。自分しか使わないのですが、年内に整理してみます。
どこかで共通で管理しても良いと思いますが、まずはたたき台ってことで宣言します。

[kilica]

ありがとうございます、beabo さん。
インデクスには挙げてないですが、用語集はあるとないとでは大違いですから、大歓迎です(^ ^)。

[kilica]

さっそく beabo さんが協力を申し出てくれましたが、さらに協力者を募集します。
どんなドキュメントを揃えたいかは先の書き込みの通りですが、特に次のような協力者を募集します。

（1）　XOOPS 特有の Smarty の関数・修飾子の解説
下記 Wiki ページにひとつ（xoops_user）だけ載せてありますが、これにならって整備してくれる方を募集してます。
http://xoopscube.wiki.sourceforge.net/L ... _Smarty;ja

といっても、たいした知識は必要なくて、以下に元ネタがありますので、これをせっせと Wiki に移していただければOK。
もちろん、使用例や用法を追記して充実させていただけるなら言うことありません(^ ^)。
なお、転載の許可は Tom_G3X さんよりいただいております。
http://xc-tokai.net/modules/smartsectio ... ?itemid=35
http://xc-tokai.net/modules/smartsectio ... p?itemid=1
上記元ネタはXOOPS2用とXCL用に分かれていますが、Wiki では分ける必要はありませんので、まとめて記載してください。
暇を見てどんどん追記していってください。お願いします。

（2）　XOOPS テーマの作り方ガイド
http://xoopscube.wiki.sourceforge.net/L ... rstStep;ja
テーマの作り方を解説した22ページの PDF を Wiki に転記してくれる方を募集します。
こちらは、あの伝説のテーマ作者 matchan さんが記した秘伝書です。転記が終わる頃には、テーマ制作の知識が一通り身についていること間違いなし。どっかで2万円も出してセミナー受けている場合じゃありませんね。こんなありがたい作業をなんと無料で受けることが出来ます。今すぐご応募を！（この掲示板に書いてください）

ぜひご参加ください！

[tohokuaiki]

XOOPSブロックの作り方なんですが、ワタシ以外誰もcl::使っている人がいないという事実に今気づきました。
Ref: http://xoops.peak.ne.jp/md/d3forum/inde ... st_id10975
（だれか公開してる人でいます？）

つーことで、cl::使ってブロック作る方法を書きます。

これ、良いんですよ。。ホント。。ロジックを再記述しなくていいし、関数ベースじゃないから管理楽だし。

追記：書きました。
http://xoopscube.wiki.sourceforge.net/L ... Style%3Bja

[kilica]

XOOPSブロックの作り方なんですが、ワタシ以外誰もcl::使っている人がいないという事実に今気づきました。
Ref: http://xoops.peak.ne.jp/md/d3forum/inde ... st_id10975
（だれか公開してる人でいます？）

つーことで、cl::使ってブロック作る方法を書きます。

丁寧な解説ありがとうございます。
だいたいブロックを作る頃には面倒になってきて、既存のコードをコピペして作っていたので(^ ^;、個人的にも大変参考になります(^ ^)。

[beabo]

用語集ですが、人に説明する文章を書くのが苦手で、チラシの裏に近いのですが・・・作りかけてます。
http://beabo.dip.jp/hackers/こちらです。

記事とか内容は、古いものやメモ的なので参考にならないかも知れなけど、誰かの参考になるかも？という程度です。
自分が調べたら書いてるので、まとまりもなくてすみません。もう少しドキュメントとして使えるように、まとめたいと思います。

[kilica]

用語集ですが、人に説明する文章を書くのが苦手で、チラシの裏に近いのですが・・・作りかけてます。
http://beabo.dip.jp/hackers/こちらです。

ありがとうございます、beabo さん。

しかしこれは・・・用語集モジュールを使っていますが、中身はそれにとどまらず、コードも付いてたっぷりあるじゃないですか（笑）
これはうまく使わせていただければ、一気に内容が充実しますね(^ ^)。
ある程度整理が付きましたらぜひ使わせてください m(__)m

[imath3]

（2）　XOOPS テーマの作り方ガイド
http://xoopscube.wiki.sourceforge.net/L ... rstStep;ja
テーマの作り方を解説した22ページの PDF を Wiki に転記してくれる方を募集します。
こちらは、あの伝説のテーマ作者 matchan さんが記した秘伝書です。転記が終わる頃には、テーマ制作の知識が一通り身についていること間違いなし。どっかで2万円も出してセミナー受けている場合じゃありませんね。こんなありがたい作業をなんと無料で受けることが出来ます。今すぐご応募を！（この掲示板に書いてください）

もしよろしければ、この作業に協力させてください。sf.netにアカウントを作成したのも、この募集をみてからという新参者ですので、作業に手間取ることもあるかもしれませんが、よろしければぜひ協力させてください。

よろしくお願いいたします。