カスタマイズ済みのサイトとスペース レイアウトのアップグレード
Confluence の進化に伴い、それぞれのページのレンダリングを促す、既定のサイトとスペース レイアウトも進化しています。新しい機能が追加され、現在の機能が変更されると、これらの変更に対応するよう既定レイアウトも変更されます。
以前の Confluence バージョンの既定に基づいたカスタム レイアウトを使用している場合は、機能性が破損したり、優れた新しい機能が失われるリスクがあります。
Confluence の新しいリリースではそれぞれ、新しい既定テンプレートに対して行った変更を再適用してください。
カスタム レイアウトを最適用するために必要なものは、次のとおりです。
- Confluence の現在のバージョンからカスタム レイアウトを取得します。
- カスタマイズを新しいデフォルト レイアウトに再適用します。
ステップ 1.カスタム レイアウトを取得する
各 Confluence サイトまたはスペース レイアウトに適用した各カスタマイズの記録を付けることが理想的です。
そうでない場合、次の方法でカスタマイズを見つけることができます。この方法では、すべてのサイト レベルおよびスペース レベルのレイアウトを Confluence サイトから単一出力として抽出します。この出力から、カスタマイズを特定することができます。
この方法は、次のような場合に便利です。
- スペース レイアウトをカスタマイズした多くのスペースがある。
- サイトまたはスペース レイアウトの個別記録がない。
カスタム レイアウトは、Confluence データベース内の DECORATOR テーブルに保存されます。次のような SQL を使用してレイアウトのソースを SELECT (選択) できます。
mysql> select SPACEKEY,DECORATORNAME,BODY from DECORATOR;
+----------+---------------------+------+
| SPACEKEY | DECORATORNAME | BODY |
+----------+---------------------+------+
| NULL | decorators/main.vmd | ... |
+----------+---------------------+------+
1 row in set (0.03 sec)
この例は、MySQL でテストされましたが、すべての SQL データベースに適用可能です。
ステップ 2. カスタマイズを再適用する
Confluence を別のメジャー リリースの Confluence にアップグレードする際には、サイト全体またはスペース固有のレイアウトへ行ったカスタマイズを再適用する必要があります。別途明記されていない限り、Confluence のマイナー リリース アップグレードを実施した後、カスタマイズを再適用する必要があります。
「メジャー」および「マイナー」リリースとは? メジャー リリースは、アップグレード後に Confluence のバージョン番号の 1 桁目、または小数点第 1 桁目の後 1 番目の桁数が異なるものです (例: Confluence 3.0 から 3.1、または 2.8 から 3.0 へのアップグレードなど)。マイナー リリースは、アップグレード後に Confluence のバージョン番号の 1 桁目、および小数点第 1 位の後の 1 番目の数字が同じとなるものです (例: Confluence 3.0 から 3.0.1 へのアップグレードなど)。
Confluence サイト全体でレイアウトのカスタマイズを行った場合。
- 設定アイコン
を選択し、[一般設定] を選択します。 - 左側のナビゲーション パネルにあるレイアウトを選択します。デコレーターは サイト、コンテンツ および エクスポート レイアウトにグループ化されます。
- すべてのカスタマイズが利用可能になっていることを確認します (できればコピーして貼り付けることができる形式で)。
- カスタマイズを再適用する必要のあるレイアウトの隣にある、既定のリセットをクリックします。
- 同じレイアウトの隣にあるカスタムの作成をクリックし、新しい既定レイアウト内の適切な場所に (コピーして貼り付けることで) カスタマイズを再適用します。
- [保存] ボタンをクリックします。
- カスタマイズを再適用する必要のある各レイアウトに対し、ステップ 4 からこの手順を繰り返します。
スペース固有のレイアウトのカスタマイズを行った場合。
- スペースに移動して、サイドバーの下部から、スペース ツール > ルックアンドフィールを選択します。
- レイアウトを選択します。デコレーターは サイト、コンテンツ および エクスポート レイアウトにグループ化されます。
- すべてのカスタマイズが利用可能になっていることを確認します (できればコピーして貼り付けることができる形式で)。
- カスタマイズを再適用する必要のあるレイアウトの隣にある、既定のリセットをクリックします。
- 同じレイアウトの隣にあるカスタムの作成をクリックし、新しい既定レイアウト内の適切な場所に (コピーして貼り付けることで) カスタマイズを再適用します。
- [保存] ボタンをクリックします。
- カスタマイズを再適用する必要のある各レイアウトに対し、ステップ 5 からこの手順を繰り返します。
ステップ 3.変更を慎重にテストする
変更は、Confluence の今後のバーションで予測できない相互作用を与える場合があります。アップグレードする場合、稼働中のサイトに展開する前に、常にカスタム変更をテストする必要があります。これらの変更のテストとデプロイは、アトラシアン サポートの範囲外です。
キャッシュをオフにする
Velocity はテンプレートをメモリにキャッシュするように設定されています。Confluence 内からページを編集する場合、そのページをディスクからリロードします。ディスク上のページを編集する場合、変更を可視化するには WEB-INF/classes/velocity.properties で Velocity のキャッシングを一時的にオフにするか、サーバを再起動する必要があります。
velocity.properties ファイルは confluence-x.x.x.jar ファイルで利用可能です (x.x.x は Confluence のバージョン番号です)。JAR ファイルは WEB-INF/lib ディレクトリにあります。JAR のファイルを変更したい場合は、次の手順をおすすめします。
- Confluence を停止します。
- JAR ファイルのバックアップ コピーを作成します。
- ファイルを解凍します。
- 変更したい適切なファイルを見つけて編集します。
confluence-x.x.x.jarファイルを再度 jar ファイルにします。- 適切なディレクトリへ JAR ファイルを再配置します。
- Confluence を再起動します。