SharePoint アドイン モデルにおけるマスター ページMaster pages in the SharePoint Add-in model

概要Summary

新しい SharePoint アドイン モデルで SharePoint サイトにカスタム マスター ページを実装する方法は、完全信頼コード / ファーム ソリューションの場合とは異なります。一般的な完全信頼コード (FTC) ファーム / ソリューション シナリオでは、カスタム マスター ページはカスタム ブランドを実装するよう作成されます。マスター ページは通常、宣言型コードと FTC / ファーム ソリューションを使用してマスター ページを展開し、それらを SharePoint サイトに登録します。The approach you take to implement custom master pages in SharePoint sites is different in the new SharePoint Add-in model than it was with Full Trust Code / Farm Solutions. In a typical Full Trust Code (FTC) / Farm Solution branding scenario, custom master pages are created to implement a custom brand. The master pages are typically packaged in a feature that uses declarative code and a FTC / Farm Solution to deploy the master pages and register them with the SharePoint site.

SharePoint アドイン モデル ブランド化のシナリオでは、カスタム マスター ページを使用する場合もあります。リモート プロビジョニング パターンを使用して SharePoint サイトでカスタム マスター ページを展開して登録できます。In a SharePoint Add-in model branding scenario, custom master pages may be also be used. You can deploy and register your custom master pages on SharePoint sites via the remote-provisioning pattern.

カスタム マスター ページの基本ガイドラインHigh-level guidelines for custom master pages

カスタム マスター ページについては、大まかに次のような基本ガイドラインが提供されています。As a rule of a thumb, we would like to provide the following high-level guidelines for custom master pages.

  • カスタム マスター ページを使用して SharePoint サイトをカスタマイズすることができますが、長期にわたる追加コストと将来の更新に関する課題が生じることに留意してください。You can customize SharePoint sites using custom master pages, but keep in mind this will cause you additional long-term costs and challenges with future updates.

    • ほとんどの場合、テーマ、構成された外観、および代替 CSS により、一般的なすべてのブランド化シナリオを達成できます。In most cases, you can achieve all common branding scenarios with themes, composed looks and alternate CSS.

      See the Branding SharePoint Sites (SharePoint Add-in Recipe) to learn all about the different branding options you have for SharePoint sites with the SharePoint Add-in model. The recipe will help you consider the short and long-term impact of customization from an operational and a maintenance perspective. You may discover that a custom master page is not required to implement your specific branding requirements.See the Branding SharePoint Sites (SharePoint Add-in Recipe) to learn all about the different branding options you have for SharePoint sites with the SharePoint Add-in model. The recipe will help you consider the short and long-term impact of customization from an operational and a maintenance perspective. You may discover that a custom master page is not required to implement your specific branding requirements.

    • カスタム マスター ページを使用する場合は、Office 365 に主要な機能更新が適用されたときにカスタム マスター ページに変更を適用する準備をしておいてください。If you chose to use custom master pages, be prepared to apply changes to the custom master pages when major functional updates are applied to Office 365.

  • カスタム マスター ページを SharePoint サイトに展開して登録するには、リモート プロビジョニングを使用します。Use remote provisioning to deploy and register custom master pages with SharePoint sites.
  • マスター ページを SharePoint サイトに展開して登録する場合、宣言型コードまたはサンドボックス コードを使用しないでください。Do not use declarative code or sandbox code to deploy and register master pages with SharePoint sites.

チーム サイトと発行サイトTeam sites vs. publishing sites

どのような場合にカスタム マスター ページが必要となるでしょうか。When is a custom master page needed?

SharePoint サイトにカスタム ブランド化を適用するときは、チーム サイトと発行サイトの両方をブランド化する必要があります。一般に、オンプレミスと Office 365 の両方のシナリオで、SharePoint 上に構築されたイントラネットにチーム サイトと発行サイトの組み合わせが使用されます。When applying custom branding to SharePoint sites, you will encounter the need to brand both team sites and publishing sites. Generally speaking, intranets built on SharePoint in both on-premises and Office 365 scenarios use a combination of team sites and publishing sites.

カスタム ブランド化の要件では、テーマや JavaScript 埋め込み手法では実現できない特定のレイアウト変更がしばしば要求されます。Custom branding requirements often times require specific layout changes that themes and JavaScript embedding techniques cannot accomplish.

そのようなシナリオでは、チーム サイトで要求されるカスタム ブランド化は発行サイトの場合ほど多くなく、通常はモバイル デバイス用の標準の SharePoint コンテンポラリ表示でチーム サイト用にのバイル デバイスを十分にサポートできます。そのようなわけで、発行サイトにはカスタム マスター ページだけを使用し、チーム サイトのブランド化には、構成された外観として定義されたカスタム SharePoint テーマ (.spcolor ファイル)、フォント スキーム (.spfont ファイル)、および背景画像を使用することをお勧めします。In such a scenario, team sites usually do not require the amount of custom branding that publishing sites do and the out-of-the-box SharePoint Contemporary View for mobile devices is usually sufficient to support mobile devices for team sites. Since this is the case, it is best to only use custom master pages for publishing sites and to use AlternativeCSS and custom SharePoint themes (.spcolor files), font schemes (.spfont files) and background images defined as composed looks to brand team sites.

展開に関する考慮事項Deployment considerations

通常、カスタム マスター ページはサイトがプロビジョニングされるときに適用されます。リモート プロビジョニング プロセスは、この方法に最適です。通常、Web ブラウザーを使用して SharePoint ブランド化カスタマイズを手動で適用するのは、拡張して他のサイト コレクションやサブサイトを含める計画のない単一の SharePoint サイトを試作または変更するときだけです。Custom master pages are typically applied when a site is provisioned. The remote provisioning process fits very well with this approach. Usually the only time you will use the web browser to manually apply SharePoint branding customization is when you are prototyping or modifying a single SharePoint site that is not planned to grow to include other site collections or sub sites.

SharePoint サイトのカスタム マスター ページおよびページ レイアウトの詳細More details about custom master pages and page layouts for SharePoint sites

カスタム ブランド化の要件を実装する唯一の方法がカスタム マスター ページであるシナリオでは、カスタム マスター ページとページ レイアウトを作成することができます。この記事の冒頭でこのアプローチに関連する長期的なメンテナンス コストに関して述べられた点に注意してください。In scenarios where a custom master page is the only way to implement your custom branding requirements you can create a custom master page and page layouts. Keep in mind the points made at the beginning of this article with regard to the long-term maintenance costs associated with this approach.

  • SharePoint サイト用のカスタム マスター ページを使用すると、最高レベルのカスタマイズ (無制限) を実行できます。Using custom master pages for SharePoint sites provides the ultimate level of customization (unlimited).
  • SharePoint サイト用のカスタム マスター ページを短期および長期間にわたって実装およびメンテナンスするには、大量の時間が必要です。Using custom master pages for SharePoint sites requires the largest amount of time to implement and maintain in the short and long term.
  • サービス更新プログラムに付属する標準のマスター ページへの変更は、カスタム マスター ページには反映されません。Any changes to out-of-the-box master pages that come with service updates will not be reflected in custom master pages.
  • カスタム マスター ページはサイトごとのレベルで適用できます。You can apply custom master pages at a per-site level.
  • カスタム マスター ページを使用する場合、最初は標準のマスター ページをニーズに合わせて変更することをお勧めします。When using a custom master page it is recommended to start with one of the out-of-the-box master pages and modify it to meet your needs.
    • カスタム マスター ページでカスタマイズする量は最小限にしてください。これにより、標準のマスター ページに Office 365 サービスが加えた変更をカスタム マスター ページに複製しなければならない場合に、カスタム マスター ページを容易に更新できます。Try to minimize the amount of customization you make with custom master pages; this will make it easier to update them when Office 365 service changes to out-of-the-box master pages must be replicated to custom master pages.
  • SharePoint マスター ページには必須のコンテンツ プレースホルダーが多数あり、削除するとページでエラーが発生します。必須のコンテンツ プレースホルダーを削除した場合は、展開してそのマスター ページをサイトに割り当てたときにエラーが表示されるため、エラーを把握できます。There are many required content placeholders in SharePoint master pages that must not be removed or they will cause the pages to error. You will know when you have removed a required content placeholder because the minute you deploy it and assign the master page to your site, errors will appear.

SharePoint サイト用のカスタム マスター ページとページ レイアウトが適しているケースWhen are custom master pages and page layouts for a SharePoint site a good fit?

このオプションが適しているのは、ブランド化のニーズが非常に具体的である場合や、発行サイトを使用している場合です。This option works well when your branding needs are very specific or you are using publishing sites.

推奨される展開アプローチRecommended deployment approaches

  • Web ブラウザーを使用してカスタム マスター ページを手動でアップロードし、構成された外観に手動で割り当てることができます。Custom master pages may be uploaded manually via the web browser and manually assigned to composed looks.
  • リモート プロビジョニング パターンを使用してカスタム マスター ページをアップロードし、SharePoint サイトに割り当てることもできます。Custom master pages may be uploaded and assigned to a SharePoint site via the remote provisioning pattern as well.

関連リンクRelated links

関連する PnP サンプルRelated PnP samples

適用対象Applies to

  • Office 365 マルチテナント (MT)Office 365 Multi Tenant (MT)
  • Office 365 専用 (D) 一部Office 365 Dedicated (D) partly
  • SharePoint 2013 オンプレミス - 一部SharePoint 2013 on-premises – partly

専用およびオンプレミスの場合のパターンは SharePoint アドイン モデル手法と同じですが、使用可能なテクノロジは異なる可能性があります。Patterns for dedicated and on-premises are identical with SharePoint Add-in model techniques, but there are differences on the possible technologies that can be used.