カスタムモジュールの追加

はじめに

ONLYOFFICE用の独自モジュールを作成し、ONLYOFFICE Workspaceに追加したい場合、今では簡単にそれが可能です。サンプルプロジェクトはこちらで利用できます：https://github.com/ONLYOFFICE/CommunityServer/tree/master/web/studio/ASC.Web.Studio/Products/Sample

このサンプルを修正するか、それを基に新しいカスタムモジュールを作成できます。必要なコンポーネントが指定されたフォルダにあり、特定のコード行が指定されたファイルに追加されていることを確認してください。以下に説明します。

動作の仕組み

1. ONLYOFFICE Community Serverをhttps://github.com/ONLYOFFICE/CommunityServerから取得します。
2. SampleプロジェクトはProductsフォルダにあります：

   https://github.com/ONLYOFFICE/CommunityServer/tree/master/web/studio/ASC.Web.Studio/Products

3. ASC.Api.SampleはASC.Apiフォルダにあります：

   https://github.com/ONLYOFFICE/CommunityServer/tree/master/module/ASC.Api

4. 以下のコード行がhttps://github.com/ONLYOFFICE/CommunityServer/blob/master/build/msbuild/build.projファイルに追加されます：

   <!-- Sample -->
   <ProjectToBuild Include="$(ASCDir)web\studio\ASC.Web.Studio\Products\Sample\ASC.Web.Sample.csproj"/>

   および

   <ProjectToBuild Include="$(ASCDir)module\ASC.Api\ASC.Api.Sample\ASC.Api.Sample.csproj"/>

   他の既存プロジェクトを参照して、これらの行をどこに追加すべきかを確認できます。

   注意してください！ 行を入力する順序は非常に重要です。
5. ASC.Api.Sample.SampleApiはweb\studio\ASC.Web.Studio\web.autofac.configファイルに次のように追加されます：

   <component
             type="ASC.Api.Sample.SampleApi, ASC.Api.Sample"
             service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"
             name="sample"/>

6. Build.batファイルはここで実行できます：

   https://github.com/ONLYOFFICE/CommunityServer/blob/master/build/Build.bat

ONLYOFFICE用の独自モジュールを作成する方法

1. ASP.NET Web Application（ASC.Web.Sample）プロジェクトを作成し、...web\studio\ASC.Web.Studio\Products\Sampleフォルダに配置します。
   重要！！！ 出力dllファイル名は「ASC.Web.*.dll」でなければなりません。
2. ...\web\studio\ASC.Web.Studio\bin\から必要な参照を接続します：

   ASC.Common.dll
   ASC.Core.Common.dll
   ASC.Data.Storage.dll
   ASC.Web.Core.dll
   ASC.Web.Studio.dll

3. ProductEntryPoint.csファイルでIProductインターフェースを実装します。
   重要！！！ ProductIDは一意のGuidでなければなりません（VS2012ではTOOLS -> GUID -> New GUIDで生成されます）。
4. 次の行をAssemblyInfo.csファイルに追加します：

   [assembly: Product(typeof(ASC.Web.Sample.Configuration.ProductEntryPoint))]

5. Masterをweb\studio\ASC.Web.Studio\Masters\BaseTemplate.masterから継承します。
6. プロジェクトプロパティで出力パスを次のように設定します：

   <OutputPath>..\..\bin\</OutputPath>

   これにより、ビルドはweb\studio\ASC.Web.Studio\binフォルダに作成されます。

7. プロジェクトは手動でまたはビルダーを使用してビルドできます。後者の場合、次の行をbuild\msbuild\build.projファイルに追加します：

   <ProjectToBuild Include="$(ASCDir)web\studio\ASC.Web.Studio\Products\Sample\ASC.Web.Sample.csproj"/>

   そしてbuild\Build.batファイルを実行します。

8. ビルド後、localhost:portアドレスでウェブサイトを実行し、「モジュールとツール」設定ページ（http://localhost:port/management.aspx?type=2）に移動して新しいSampleモジュールを有効にします。それはその後、ポータルヘッダードロップダウンメニューまたは直接リンクを使用して利用可能になります：http://localhost:port/products/sample/default.aspx

これで、こちらの指示に従って独自のモジュール用のAPIを作成できます。