Alfrescoのカスタム属性（とアスペクト名、タイプ名とか）を日本語化する

こんにちは。大谷です。
今回は「Alfrescoにカスタム属性を追加する - タイプとアスペクト -」に続く形で、カスタムモデル周りの日本語化（多言語化）について紹介したいと思います。基本的にはメッセージリソースの追加方法の説明だと思ってください。

プロパティ名とか変じゃない？

先ほどのリンク先の記事、特に画像を見た人は既にお気づきだと思いますが、追加したプロパティ名やアスペクト名がリソースIDみたいな文字列になっています。まあ頑張れば何を表しているか分からなくもないですが、あまりユーザフレンドリではありません。そこで、今回はこの表示をユーザが分かりやすい文字列に変えてみようと思います。つまり、表示ラベルを設定するようなものです。

まずは英語で表示できるようにしてみる

日本人であれば日本語で表示したいところですが、まずは英語にしてみましょう。日本語に関しては、設定時に一工夫必要なので（まあ大体想像つくと思いますが）、後ほど多言語化の方法と併せて説明することとします。

まずは、プロパティの表示名を設定するために、以下の2ファイルを作成します。custom-model-context.xmlは前回作成してあるので、<property name="labels">タグを追加して読み込むリソースファイル名を指定します。そして、指定したファイル名のリソースファイルを作成します。コンテンツモデル名やプロパティ名の":"を"_"に置き換える形で用い、title（表示名）やdescription（説明）の文言を設定します。

<alf_dir>/tomcat/shared/classes/alfresco/extension/custom-model-context.xml

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE beans PUBLIC '-//SPRING//DTD BEAN//EN' 'http://www.springframework.org/dtd/spring-beans.dtd'>
<beans>
    <!-- Registration of new models -->   
    <bean depends-on="dictionaryBootstrap" id="extension.dictionaryBootstrap" parent="dictionaryModelBootstrap">
        <property name="models">
            <list>
                <value>alfresco/extension/customModel.xml</value>
            </list>
        </property>
        <property name="labels">
            <list>
                <value>alfresco/messages/custom-model</value>
            </list>
        </property>
    </bean>
</beans>

<alf_dir>/tomcat/shared/classes/alfresco/messageｓ/custom-model.properties

custom_customModel.property.custom_reviewer.title=Reviewer
custom_customModel.property.custom_reviewer.description=Reviewer's name
custom_customModel.property.custom_reviewDate.title=Reviewed Date
custom_customModel.property.custom_reviewDate.description=When this item reviewed

次に、アスペクトの表示名を設定するために、以下の2ファイルを作成します。読み込むリソースファイル名を指定するcustom-messages-context.xmlはweb-extension以下に配置します。タイプもこの方法で表示名を設定できます。リソースファイル内でtype.***=***のように設定するだけです。

<alf_dir>/tomcat/shared/classes/alfresco/web-extension/custom-messages-context.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC '-//SPRING//DTD BEAN//EN' 'http://www.springframework.org/dtd/spring-beans.dtd'>
<beans>
   <bean id="custom.resources" class="org.springframework.extensions.surf.util.ResourceBundleBootstrapComponent">
      <property name="resourceBundles">
         <list>
            <value>alfresco.messages.custom-share-messages</value>
         </list>
      </property>
   </bean>
</beans>

<alf_dir>/tomcat/shared/classes/alfresco/messageｓ/custom-share-messages.properties

aspect.custom_reviewable=Reviewable

以上で設定完了です。Alfrescoサーバを再起動し、プロパティ名やアスペクト名が指定した文言になっていることが確認できると思います。先のエントリのスナップショットと比較すると変化が分かりやすいと思います。

日本語表示を追加してみよう

英語でうまく表示できたら、次は日本語表示に進みます。方法としては以下のように2通りの方法があります。

1. 先ほど設定したリソースを日本語の文言に置き換える
2. 先ほどのリソースファイルとは別に日本語用のリソースファイルを用意する

Alfrescoの場合、ブラウザの言語設定によって表示言語が自動的に変更されます。例えばブラウザの言語設定を英語に変更すると、Alfrescoの表示が英語になるはずです。ここで改めて先ほどの2つの方法を見てみると、2.の方法はこの言語切り替えに対応する方法ということになります。もちろんどちらの方法を選択するかは要件によりますが、ここでは2.の方法を紹介したいと思います。

手順は簡単、以下の2ファイルを追加で用意するだけです。追加するファイル名は、既存のリソースファイル名に_jaを付けたものになります。これだけで日本語フランス語のリソースだったら_fr、イタリア語だったら_it、英語だったら_enという感じです。英語のリソースファイルも用意してあげれば、日本語/英語の両方に対応した表示が完成です。何もついてない元のリソースファイルはデフォルトの表示名ということになります。

<alf_dir>/tomcat/shared/classes/alfresco/messageｓ/custom-model_ja.properties

custom_customModel.property.custom_reviewer.title=\u30ec\u30d3\u30e5\u30a2
custom_customModel.property.custom_reviewer.description=\u30ec\u30d3\u30e5\u30fc\u8005\u540d
custom_customModel.property.custom_reviewDate.title=\u30ec\u30d3\u30e5\u30fc\u65e5
custom_customModel.property.custom_reviewDate.description=\u30ec\u30d3\u30e5\u30fc\u65e5

<alf_dir>/tomcat/shared/classes/alfresco/messageｓ/custom-share-messages_ja.properties

aspect.custom_reviewable=\u30ec\u30d3\u30e5\u30fc\u53ef\u80fd

ここでのポイントは、日本語の文言がUnicodeエンコーディングされている点です。JDKに付属するnative2ascii等を利用してエンコーディングする必要があります。もしくは、自動的にエンコーディングしてくれるようなEclipseプラグインを使ってpropertiesファイルを編集するなどの方法があります。

では、Alfrescoサーバを再起動して再度プロパティ名やアスペクト名を確認してみましょう。無事日本語の文言に変わっているはずです。

 
今回はextensionフォルダ側とweb-extensionフォルダ側から計2つのリソースファイルを参照しましたが、役割分担としては、extensionフォルダ側から参照するリソースファイルではカスタムモデルに関するものを、web-extensionフォルダ側から参照するリソースファイルではShare UI上のメッセージに関するものを指定します。


今回の説明は以上になりますが、基本的なメッセージリソースの追加方法はお分かりいただけたかと思います。メッセージの追加が必要になった場合は是非参考にしてください。