アップグレードした TinyMCE 4 エディターでアプリをテストする方法
間もなく、TinyMCE バージョン 3 がバージョン 4 にアップグレードされます。アップグレード後のエディターのダーク機能は、Confluence 6.14.0 以降ではデフォルトで有効になっています。
エディターと任意の方法でやり取りするアプリがある場合は、アップグレードされたエディターでのアプリのテストをできるだけ早く開始することを強くおすすめします。
Compatibility
Confluence 6.14 は TinyMCE v3 API との完全な下位互換性があり、当面、互換性は維持される予定です。しかしエディターを直接操作する必要がある場合は、できるだけ TinyMCE 4 API を使用することを推奨します。
必要に応じて editor-v3
または editor-v4
コンテキストのいずれからもエディター リソースを読み込むことができます。ただし、エディターのバージョンを問わず、同じリソースを読み込み、以前と同じエディター コンテキストを使用することをおすすめします。
アプリはエディターを読み込みますか?
ご利用のアプリは自身のビューでエディターを読み込みますか? 読み込む場合、次の操作を行う必要があります。
エディタのコンテキスト
追加の web-resource コンテキスト: editor-v4 を既存のエディターとともに読み込みます。
たとえば、requireResourcesForContext('editor')
を使用している場合、requireResourcesForContext('editor-v4,editor');
を使用する必要があります。
これは frontend.editor.v4
が有効になっている場合にのみ適用されます。技術的には、v3 では requireResourcesForContext('editor-v3,editor');
を使用する必要がありますが、これは一般に必須ではありません。Java の DarkFeaturesManager
または JS の confluence/dark-features
AMD モジュールを使用し、frontend.editor.v4
ダーク機能に基づいて v3 または v4 を読み込み、両方に備えることができます。以下に例を示します。
Java の DarkFeaturesManager
darkFeaturesManager.getDarkFeatures().isFeatureEnabled("frontend.editor.v4") // boolean
JavaScript の confluence/dark-features AMD モジュール
require('confluence/dark-features').isEnabled("frontend.editor.v4") // boolean
エディタの破棄
エディターの破棄も処理する場合、mceRemoveEditor
コマンドを使用するようにします。
// TinyMCE 4 API
tinymce.execCommand('mceRemoveEditor', true, 'wysiwygTextarea');
// TinyMCE 3 API
tinymce.execCommand('mceRemoveControl', true, 'wysiwygTextarea');
TinyMCE 4.x API の活用
3.x API は polyfill TinyMCE プラグインを使用して利用できますが、v4 がデフォルトになった後は、新しい API を使用することをおすすめします。www.tinymce.com/docs を参照してください。
旧バージョンの Confluence を使ったテストの実行
この情報は Confluence 6.14.0-m50 以前のバージョンでのみ必要となります。
手動テスト
アプリをテストするには、通常の Confluence インスタンス (6.8 から 6.13) を稼働し、<confluence-url>/admin/darkfeatures.action
に移動してから、ダーク機能 frontend.editor.v4
を追加します。次に、エディターに移動して、アプリが期待どおり動作していることを確認します。
自動テスト
自動テストの場合は、Confluence の起動に使用する JVM 引数に -Datlassian.darkfeature.frontend.editor.v4=true
を追加することで、V4 エディターを有効にして Confluence を稼働できます。以下に例を示します。
<configuration>
...
<jvmArgs>-Datlassian.darkfeature.frontend.editor.v4=true</jvmArgs>
</configuration>
自動テストでは、v4 がデフォルトになるまでの間は両方のバージョンをテストできるよう、ダーク機能を有効にせずに実行を続け、機能が有効化されたビルドのコピーを追加することをおすすめします。
問題の報告
TinyMCE v4 でアプリに問題が発生した場合、アプリが壊れた原因を調査してから、EAP フィードバック チケットを登録してください。このリンクを使用するには jira.atlassian.com にログインする必要があります。