Touka Leaves

• About
• License
• Members

Tools

• WShare Plugin

概要

Touka Leaves: WShare Plugin は，Eclipse ワークスペースの設定情報を複数の環境間で共有することを支援するツールです。

ファイルの文字エンコーディングや改行コードの基本設定やプラグインの設定など，ワークスペース毎に設定しなければならない情報をワークスペース情報設定ファイルに記述し，それを WShare Plugin が提供する Import ウィザードで取り込むことで，簡単に個々のワークスペースで共通の設定を行うことができます。

1. ワークスペース設定ファイル
   • 基本的な使い方
   • 高度な使い方
2. Importウィザード
3. Exportウィザード
4. 注意事項

ワークスペース設定ファイル

基本

ワークスペースの設定は，Eclipse に含まれる Plugin の設定として記述します。

• 記述例[1]

  01: <?xml version="1.0" encoding="UTF-8"?>
  02: <workspace-preferences xmlns="http://tsukuba-bunko.org/ns/touka/leaves/wshare" restart="true">
  03:   <plugin-preferences name="org.eclipse.core.runtime">
  04:     <preferences name="content-types">
  05:       <preferences name="org.eclipse.core.runtime.text">
  06:         <value key="charset">UTF-8</value>
  07:       </preferences>
  08:     </preferences>
  09:     <value key="line.separator">&#x000D;&#x000A;</value>
  10:   </plugin-preferences>
  11:   <plugin-preferences name="org.eclipse.core.resources">
  12:     <value key="encoding">UTF-8</value>
  13:   </plugin-preferences>
  14: </workspace-preferences>
  

ワークスペース設定ファイルは XML ファイルです。workspace-preferneces 要素をルート要素とし，プラグインの設定を plugin-preferences 要素として列挙する形式になっています。どのプラグインについての設定であるかは name 属性にプラグインIDを記述することで定義します。

プラグインの個々の設定項目は value 要素として記述します。項目名は key 属性，設定値は value 要素のコンテンツにそれぞれ記述します。

Eclipse プラグインの設定情報は階層をもったデータ構造になっている場合があります。その場合，設定情報のノードは preferences 要素として記述します。preferences 要素に記述できる内容は plugin-preferences と同一です。

設定項目によっては、変更を反映するのにワークスペースの再起動が必要になるものもあります。そのような場合は、workspace-preferences 要素の restart 属性に true を設定します。省略した場合は false となり再起動は行われません(デフォルト)。

ワークスペース設定ファイルの詳細な構造については，W3C XMLSchema スキーマを参照してください。

記述例[1]は，「ファイルの文字エンコーディングを UTF-8 に，改行コードを CRLF にする」場合の設定内容を記述したものです。

この場合，以下のような設定を行う事になります。

• org.eclipse.core.resources プラグインを以下のように設定する (L.11～L.13)
  • encoding を UTF-8 に設定 (L.12)
• org.eclipse.core.runtime プラグインを以下のように設定する (L.3～L.10)
  • content-types/org.eclipse.core.runtime.text を UTF-8 に設定 (L.4～8)
  • line.sparator を \r\n に設定 (L.9)
• 設定完了後、ワークスペースを再起動 (L.2)

ワークスペースにどのようなプラグインの設定情報が保存されているかについては，Exportウィザードを使用してワークスペースの設定情報をワークスペース設定ファイルに保存し，その内容を参照することで参考になると思います。

高度な使い方

ワークスペース設定ファイルでは、プラグインの設定値として変数の値を埋め込むことができます。

変数は以下のような場合に使用します。

• 環境ごとに異なる設定値を使用する必要がある場合
• 同一の値を複数のプラグイン設定値として使用する必要がある場合

• 記述例[2]

  01: <?xml version="1.0" encoding="UTF-8"?>
  02: <workspace-preferences xmlns="http://tsukuba-bunko.org/ns/touka/leaves/wshare" restart="true">
  03:   <variables>
  04:     <variable name="MavenRepository" type="folder" description="Mavenローカルリポジトリの場所"
  05:       >${user.home}${file.separator}.m2${file.separator}repository</variable>
  06:     <variable name="FileEncoding" type="text" editable="false">UTF-8</variable>
  07:     <variable name="FormatterConfig" type="file" editable="false">codeformatter.xml</variable>
  08:   </variables>
  09:   <plugin-preferences name="org.eclipse.core.runtime">
  10:     <preferences name="content-types">
  11:       <preferences name="org.eclipse.core.runtime.text">
  12:         <value key="charset">${FileEncoding}</value>
  13:       </preferences>
  14:     </preferences>
  15:     <value key="line.separator">&#x000D;&#x000A;</value>
  16:   </plugin-preferences>
  17:   <plugin-preferences name="org.eclipse.core.resources">
  18:     <value key="encoding">${FileEncoding}</value>
  19:   </plugin-preferences>
  20:   <plugin-preferences name="org.eclipse.jdt.core">
  21:     <value key="org.eclipse.jdt.core.classpathVariable.MAVEN_REPO">${maven_repo}</value>
  22:   </plugin-preferences>
  23:   <plugin-preferences name="org.eclipse.jdt.launching">
  24:     <value key="org.eclipse.jdt.launching.PREF_VM_XML">${vmconfig$contents()}</value>
  25:   </plugin-preferences>
  26:   <plugin-preferences name="org.eclipse.jdt.ui">
  27:     <value key="formatter_profile">_TBAS-Standards</value>
  28:     <value key="org.eclipse.jdt.ui.formatterprofiles">${FormatterConfig$contents()}</value>
  29:   </plugin-preferences>
  30: </workspace-preferences>
  

変数は variable 要素として記述します。

• name - [xsd:string:必須] 変数名。置換時にはこの変数名で埋め込む変数を識別します。
• type - [xsd:string:必須] 変数のデータ型。以下のデータ型の何れかを指定します。
  • file - ファイル型。変数はファイルへのパスを値として保持します。
  • folder - フォルダ型。変数はファイルフォルダへのパスを値として保持します。
  • text - テキスト型。変数は任意の文字列を値として保持します。
• editable - [xsd:boolean] 編集が可能かどうか。省略した場合 true になります。
• optional - [xsd:boolean] 変数値が未設定でも良いかどうか。省略した場合 false になります。

変数値は variable 要素のコンテンツとしてテキストで記述します。

宣言した変数は、その変数の値で置換したい場所に ${変数名} の形式で埋め込みます。

以下の箇所で変数埋め込みが可能です。

• プラグイン設定項目の値 (value要素の内容)
• 変数の値 (variable要素の内容)

変数のデータ型が file である場合、その変数値によって指定されたファイルの内容を埋め込むこともできます。

ファイル内容の埋め込みには ${変数名$contents()} の形式を使用します。ファイルの内容はテキストである必要があります。デフォルトでは文字エンコーディングとして UTF-8 を使用して読み込みますが、他のエンコーディングを使用する場合は ${変数名$contents(encoding=エンコーディング名)} の形式で指定してください。

変数の値をワークスペース設定をImportする環境ごとに変更したい場合は、editable 属性を true に設定します。

editable 属性が true である変数が1個以上ある場合、Importウィザード で設定を Import する際に，ウィザードの画面で変数値を個別に設定することができます。

Importウィザード

WShare Pluginが提供するImportウィザードを使うことで、ワークスペース設定ファイルをワークスペースにImportし、設定ファイル内に記述された内容をワークスペース設定に反映させることができます。

使用方法

1. Importウィザードを起動します。
   • Eclipseワークベンチのメニューバー [File]-[Import...] を選択するか、Navigator View や Package Explorer View などの右クリックメニューから [Import...] を選択します。
   • [Touka Leaves]/[Workspace Preferences] をマウスでダブルクリック、または、選択した状態で [Next]をクリックします。
     
     _[拡大]
     
     
2. 最初の画面で、Importするワークスペース設定ファイルを選択します。
   • テキストフィールドに直接ワークスペース設定ファイルのファイルパスを入力するか、[Browse...] ボタンをクリックしてファイル選択ダイアログを使用して選択します。
     
     _[拡大]
     
     
   • 以前Importウィザードを使用してワークスペース設定をImportしたことがあるのであれば、過去にImportしたワークスペース設定ファイルが履歴としてコンボボックスに表示されますので、そこから選択することもできます。
     
     _[拡大]
     
     
   • ファイルを選択したら、[Next] ボタンをクリックします。
     
     _[拡大]
     
     
3. 次の画面で、変数の値を設定します。
   • 変数の値を設定するには、変更したい変数を選択した状態で [編集] ボタンをクリックします。
     
     _[拡大]
     
     
   • 変数のデータ型に応じた入力ダイアログが表示されますので、適切な値を入力してください。
     • file型 - ファイル選択ダイアログ
     • folder型 - フォルダ選択ダイアログ
     • text型 - テキスト入力ダイアログ
4. 最後に [Finish] をクリックするとImport処理が開始します。
   
   _[拡大]
   
   
5. ワークスペース設定ファイルで再起動が指定されている場合、ワークスペースの再起動を求める確認ダイアログが表示されます。
   
   _[拡大]
   
   

Exportウィザード

WShare Pluginが提供するExportウィザードを使うことで、ワークスペースの設定をワークスペース設定ファイルの形式で書き出すことができます。

使用方法

1. Exportウィザードを起動します。
   • Eclipseワークベンチのメニューバー [File]-[Export...] を選択するか、Navigator View や Package Explorer View などの右クリックメニューから [Export...] を選択します。
   • [Touka Leaves]/[Workspace Preferences] をマウスでダブルクリック、または、選択した状態で [Next]をクリックします。
     
     _[拡大]
     
     
2. 最初の画面で、Export先のファイルを選択します。
   • テキストフィールドにファイルパスを入力するか、[Browse...] ボタンをクリックしてファイル選択ダイアログを使用して選択します。
     
     _[拡大]
     
     
   • 以前Importウィザードを使用してワークスペース設定をExportしたことがあるのであれば、過去にExportしたファイルが履歴としてコンボボックスに表示されますので、そこから選択することもできます。
     
     _[拡大]
     
     
   • ファイルを選択したら、[Finish] ボタンをクリックします。
     
     _[拡大]
     
     

注意事項

• 現在、WShare Pluginが使用しているXMLパーザの仕様の問題で、ExportウィザードでExportした設定ファイルをImportウィザードでImportできません。Exportしたワークスペース設定ファイルをImportするには、ワークスペース設定ファイルから以下の設定項目を削除してください。
  • Plugin ID - org.eclipse.jdt.ui
  • 設定項目名 - content_assist_disabled_computers
• Export時、ファイルの上書き確認を行いませんので注意してください。