カスタマイズ方法

このエントリーをはてなブックマークに追加
Pocket

iroha Board のソースを直接編集することでもカスタマイズ可能ですが、パッケージ本体をアップデートしやすくするため、カスタマイズ対象のソースを、Custom ディレクトリにコピーしてから編集することをお勧めいたします。

例えばログイン画面をカスタマイズしたい場合は、View/User/login.ctp を Custom/View/User にコピーします。独自の共通スタイルシートを追加したい場合は、webroot/css/custom.css に記述します。データベースへカスタマイズ用のフィールドの追加などを行いたい場合には、Custom/Config/custom.sql にSQL文を記述し、ブラウザで /update を実行してください。

但しカスタマイズしたソースとパッケージのソースの互換性を保証するものではございません。カスタマイズしたソースの修正部分は以下のようなコメントを追加し、明確に分かるようにし、いつでもパッケージのソースとマージできるようにしておくことお勧めいたします。

// custom 〇〇〇機能を追加
カスタマイズしたコード
// custom end

<!--custom マニュアルへのリンクを追加 -->
カスタマイズしたHTML
<!--custom end-->

※ カスタマイズには PHP, CakePHP (2.x), HTML, CSS, JavaScript, MySQL 等の知識が必要となります。 具体的なカスタマイズ方法やトラブルシューティングについてはサポートしておりません。

CakePHP 2.x の概要
https://book.cakephp.org/2/ja/contents.html

カスタマイズした箇所の確認方法

Custom ディレクトリにソースをコピーしてカスタマイズした場合、Diffツールを使用することでカスタマイズ個所を視覚的に確認することが可能です。WinMerge を使用する場合は以下の手順で確認します。

  1. WinMerge を起動します。
  2. [ファイル]メニューの開くを選択します。
  3. 上の入力項目に iroha Board の [app] ディレクトリを、下の入力項目に、[app/Custom]ディレクトリを指定し、[比較]ボタンをクリックします。
  4. 差分のあるファイルをダブルクリックすると、カスタマイズした箇所を確認することができます。