キーボードショートカットを使う

[ CTRL + 37 /*左*/, 'JustifyLeft' ],
[ CTRL + 38 /*上*/, 'JustifyCenter' ],
[ CTRL + 39 /*右*/, 'JustifyRight' ],
[ CTRL + 40 /*下*/, 'JustifyFull' ]

プラグインを使う

bbcodeプラグイン

definitionlistプラグイン

こんにちわ。 なおとです。

テンプレートの使いこなしテクニックを紹介します。 やや上級向けですが、ぜひ見てください。

xugj_blockとpicoのコンテンツ表示ブロックを組み合わせる例

カスタマイズの例として、2つ取り上げます。

• 目的1 サイトのヘッダー部分をテーマから分離する
• 目的2 D3ブログで、常に表示するコンテンツを追加する

picoのメリット

今回ここで紹介する手法を使わなくても、いくつか別の方法で同じようなことができます。 それに対してpicoを活用する方法によるメリットを、挙げてみましょう。

• Smartyのテンプレート機能を活用できる
• 編集履歴が残る
• 権限管理を細かく設定することができる
• など

このうち権限管理は、主にサイト管理やコンテンツ管理を複数人で行う場合の利点です。

コンテンツのパーツを、picoのあるカテゴリにまとめておきます。 すると「カテゴリーアクセス権限」で特定のグループやユーザーに、編集権限を設定することもできます。 モジュールの管理者権限を渡さずに、つまり管理者メニューにアクセスできなくても、コンテンツを管理できるのです。

xugj_block

カスタマイズの肝になるのは、「xugj_block」の利用です。 xugj_blockについての詳しい説明は今回の趣旨とは外れますが、簡単に言うと「ブロックを自在に表示できるようになるSmartyプラグイン」です。 ただしXOOPSの標準的な機能ではなく、プラグインを追加する必要があります。

• カスタムテンプレート
• テンプレート
• テーマ
• picoのコンテンツ

といった部分を編集する際に使えます。

SourceForge.net function.xugj_block.php

上記のリンクからダウンロードできるほか、ホダ塾ディストリビューションであれば含まれていますので、追加インストールの必要はありません。

自分でインストールする場合は、 xoops_trust_path/libs/smartyplugins/function.xugj_block.php もしくは html/class/smarty/plugins/function.xugj_block.php に配置します。作業前の時点でxoops_trust_path/libsが空であるなら、html/class/smarty/plugins/を使った方が手軽でしょう。

カスタムテンプレート

xugj_blockは非常に「使い出」があり、オプションなどの記述もかなり複雑です。 使うたびに長い記述をするのはミスを招きます。 そのため今回は、「カスタムテンプレート」を使って、簡単に書けるようにします。

<{xugj_block func="b_pico_content_show" options="pico|12||1" file="/modules/pico/blocks/blocks.php"}>

このような記述をするところを、picoのdirnameが標準的な「pico」であるならば、最低限度として、content_idだけ指定すれば動きます。

<{include file="db:_custom_xugj_block_pico.html" content_id="12"}>

こうなります。「db:_custom_xugj_block_pico.html」部分は固定ですので、最後の数字だけ変えればいいことが解かります。

カスタムテンプレート作成

カスタムテンプレートというものが出てきました。 これはALTSYSモジュールを使って作成します。

今回はテンプレート名「_custom_xugj_block_pico.html」として説明します。 実際にはファイルではなく、データベース内にのみ作成されます。なのでファイルを探してもありません。

作成するときは「新規カスタムテンプレート作成」リンクを、既に作成済のテンプレートを編集する場合は、「編集」リンクです。

<{* xugj_block pico.content_block ここから *}>
<{assign var="picoDirname" value=$picoDirname|default:"pico"}>
<{assign var="content_id" value=$content_id|default:"1"}>
<{assign var="this_template" value=$this_template|default:""}>
<{assign var="process_body_yes" value=$process_body_yes|default:"1"}>

<{capture assign="xugj_block_options"}><{strip}>
<{$picoDirname}>|<{$content_id}>|<{$this_template}>|<{$process_body_yes}>
<{/strip}><{/capture}>

<{capture assign="xugj_block_file"}><{strip}>
/modules/<{$picoDirname}>/blocks/blocks.php
<{/strip}><{/capture}>

<{xugj_block func="b_pico_content_show" options=$xugj_block_options file=$xugj_block_file}>
<{* xugj_block pico.content_block ここまで *}>

ここまででまだ、準備も半ばです。

コンテンツの作成

次に、コンテンツの「パーツ」を作成します。

「サイトのヘッダー部分」「D3ブログで、常に表示するコンテンツ」の2つです。

picoの扱いに付いては説明を省きます。 うさぎにもできるXOOPS Cube入門♪ - モジュールを使おうpico編を参考にしてください。

注意点として、オプションで「表示」のチェックを付けてください。 これを忘れると、ゲスト(ログイン前の状態)に対して正常な表示ができません。 ほかに適宜、アクセス権現の設定を見直してください。ゲストにpicoモジュールのアクセスを許可する必要があります。

目的1 サイトのヘッダー部分をテーマから分離する

そして次に、テーマの編集です。 「default」テーマを使っていて、またDBテーマ編集モジュールを使う場合の例を挙げますが、ここは特に決まりはなく、基本的にどのテーマでも可能ですし、直接テーマ・ファイルを修正しても構いません。(その方が手順はシンプルになるかもしれません。)

目的2 D3ブログで、常に表示するコンテンツを追加する

次にD3ブログのテンプレートを修正します。 修正するテンプレート名は「d3blog_inc_header.html」です。(d3blogというdirnameでインストールしている場合)

以上で修正箇所は終わりです。

プラスαの応用編

最後に、プラスαの技を紹介します。 pico側で作成したコンテンツを全て表示する替わりに、「続きを読む」形式で省略表示する方法です。

次の内容でカスタムテンプレートを作成(_custom_pico_short)し、

<{include file="db:_custom_pico_short" content_id="12" truncate_num="100"}>

のように呼び出して使います。

<{* xugj_block pico.content_block ここから *}>
<{assign var="picoDirname" value=$picoDirname|default:"pico"}>
<{assign var="content_id" value=$content_id|default:"1"}>
<{assign var="this_template" value=$this_template|default:""}>
<{assign var="process_body_yes" value=$process_body_yes|default:"1"}>
<{assign var="truncate_num" value=$truncate_num|default:"30"}>

<{capture assign="xugj_block_options"}><{strip}>
<{$picoDirname}>|<{$content_id}>|<{$this_template}>|<{$process_body_yes}>
<{/strip}><{/capture}>

<{capture assign="xugj_block_file"}><{strip}>
/modules/<{$picoDirname}>/blocks/blocks.php
<{/strip}><{/capture}>

<{xugj_block item="xugj_block_pico" func="b_pico_content_show" options=$xugj_block_options file=$xugj_block_file}>
<{$xugj_block_pico.content.body|mb_truncate:$truncate_num}>
<a href="<{$xugj_block_pico.mod_url}>/<{$xugj_block_pico.content.link}>">続きを読む</a>
<{* xugj_block pico.content_block ここまで *}>

ツールバーのカスタマイズ

FCKConfig.ToolbarSets["Default"] = [
	['Source','DocProps','-','Save','NewPage','Preview','-','Templates'],
	['Cut','Copy','Paste','PasteText','PasteWord','-','Print','SpellCheck'],
	['Undo','Redo','-','Find','Replace','-','SelectAll','RemoveFormat'],
	['Form','Checkbox','Radio','TextField','Textarea','Select','Button','ImageButton','HiddenField'],
	'/',
	['Bold','Italic','Underline','StrikeThrough','-','Subscript','Superscript'],
	['OrderedList','UnorderedList','-','Outdent','Indent','Blockquote'],
	['JustifyLeft','JustifyCenter','JustifyRight','JustifyFull'],
	['Link','Unlink','Anchor'],
	['Image','Flash','Table','Rule','Smiley','SpecialChar','PageBreak'],
	'/',
	['Style','FontFormat','FontName','FontSize'],
	['TextColor','BGColor'],
	['FitWindow','ShowBlocks','-','About']		// No comma for the last row.
] ;

FCKConfig.ToolbarSets["Default"] = [
	['Cut','Copy','Paste','PasteText','PasteWord','-','Print','SpellCheck'],
	['Undo','Redo','-','Find','Replace','-','SelectAll','RemoveFormat'],
	'/',
	['Bold','Italic','Underline','StrikeThrough','-','Subscript','Superscript'],
	['OrderedList','UnorderedList','-','Outdent','Indent','Blockquote'],
	['JustifyLeft','JustifyCenter','JustifyRight','JustifyFull'],
	'/',
	['Link','Unlink','Anchor'],
	['Image','Smiley','PageBreak'],
	['TextColor','BGColor'],
] ;

スキンの選択

FCKConfig.SkinPath = FCKConfig.BasePath + 'skins/default/' ;

FCKConfig.SkinPath = FCKConfig.BasePath + 'skins/office2003/' ;

FCKConfig.SkinPath = FCKConfig.BasePath + 'skins/silver/' ;

今日、社内で「開発中にXOOPSのテンプレートを毎回モジュール更新で反映させるのが面倒！！」と言ったら、プログラマ全員からツッコミを受けました。 開発中はthemesの下にファイル置いて開発すると楽だよとか、 自動更新preloadがあるよとか、 コマンドラインでモジュールアップデートするPHPプログラムがあるよとか、 Altsysでそんな機能があるよとか、色々と言われました。

$tplsadmin_autoupdate_dirnames = array('module');
include XOOPS_TRUST_PATH . '/libs/altsys/include/autoupdate_from_module.inc.php';

こんな感じで書いて、全般設定から「themes/ ディレクトリからの自動アップデートを有効にする」をはいにするだけで 特にインストールとか必要なくて楽そうなのでとりあえずAltsysの機能を使ってやってみようと思います。

こんにちわ。なおとです。

XOOPSでなにか開発しているときに、「あれ、どうやって書くのだっけ?」と書き方が咄嗟に出てこないときがあります。 そういった時に役立つのが、チートシートです。
(→XOOPS Cube Legacyでモジュール開発中に手元におきたいチートシート)

元RYUSメンバーのsuinさんが作成したものを使おうと思ったら、残念なことになんとオリジナルはダウンロードできなくなっていているようでした。(※復活しました！詳しくはこの記事のコメントからsuinさんの元記事を見てください。) さいわい印刷済の日本語版と、gusagiさんからもらった英語版のPDFはあったので、これを元にhtmlで再作成しました。

また社内ではテンプレート変数とデータベース操作、特にクライテリアの使いかたについてもチートシートが欲しいという話が持ちあがって、それも作成しました。

基本的には既存の技術情報から参考になる部分を集めて、検証しながら編集しました。
その際に、「XOOPS CUBE LEGACY デベロッパーバイブル」がたいへん参考になりました。 この本は開発者には必携です！実際には参考にしたという以上のものがあります(笑)。

また、テンプレートについてはXOOPS2時代の技術情報から参照しました。
TECH/テーマで使えるテンプレート変数 - xoops2 wiki

Cube Legacyでの実装も調べました。
SourceForge.net: xoopscube » Legacy_Theme_Smarty;ja

こちらのwikiは、ちょうど１年前にRYUSに入社したときに全ページを読んで勉強しました。 ここも重要なことがたくさん書いてあるので必見です。

さて前置きばかりが長くなってしまいましたが、最後に今回作成したバージョンにリンクしておきます。 A4に１枚で収まるように、説明などはほとんど無くて項目の羅列ばかりの内容になっています。 詳細は別途検索するなりして(よろしければ)使ってください。

• XOOPS Cube Legacy 2.x Cheat-sheet 1.0 b (A4縦)
• XCL 共通のテンプレート変数 (A4横)
• XCL Criteria

すい散歩はsuinがXOOPSのソースを散歩するような感覚で読み歩きながらXOOPSの楽しみ方を再発見していくコーナーです。

include_once './passwd.php';
if(INSTALL_USER != '' || INSTALL_PASSWD != ''){
	…中略…
}

<?php
//  If you use HTTP authentication for XOOPS installer,
//  put user name and passward in the define statement below.
define('INSTALL_USER', '');
define('INSTALL_PASSWD', '');
?>

define('INSTALL_USER', 'ユーザー名');
define('INSTALL_PASSWD', 'パスワード');

define('INSTALL_USER', 'suin');
define('INSTALL_PASSWD', 'nius');