Customize page layouts for a catalog-based site in SharePoint
Learn how to create and customize category page and catalog-item page layouts for a SharePoint cross-site publishing site.
Prerequisites for creating and customizing page layouts for a catalog-based site
To follow the steps in this example, you must have the following:
An HTML editor
A SharePoint cross-site publishing environment
For information about how to set up a SharePoint cross-site publishing environment, see Configure cross-site publishing in SharePoint.
Core concepts to know for creating and customizing page layouts for a catalog-based site
Table 1 lists useful articles that can help you understand the concepts and steps that are involved in creating and customizing page layouts for a catalog-based site.
Table 1. Core concepts for creating and customizing page layouts for a catalog-based site
| Article title | Description |
|---|---|
| Overview of cross-site publishing in SharePoint |
Learn about how to use cross-site publishing and Search web parts to create adaptive SharePoint Internet, intranet, and extranet sites. |
| How to: Create a page layout in SharePoint |
Learn about how to create page layouts in SharePoint. |
| How to: Resolve errors and warnings when previewing a page in SharePoint |
Learn about how to resolve any issues that prevent the server-side preview from rendering your page. |
| SharePoint Design Manager snippets |
Learn about how to use snippets to add SharePoint functionality to your HTML master page or page layout. |
Introduction to category page layouts and catalog item page layouts
Category pages and catalog item pages are page layouts that you can use to show structured catalog content consistently across a site. By default, SharePoint can automatically create one category page layout and one catalog item page layout per catalog connection. Pages based on these layouts are created in the Pages library of a publishing site when you connect the site to a catalog. For more information about page layouts, see How to: Create a page layout in SharePoint. For more information about features that are specific to category page layouts and catalog item page layouts, see Overview of cross-site publishing in SharePoint.
By default, category page layouts and catalog item page layouts are created automatically when you connect a publishing site to a catalog. You can also use Design Manager to create category page layouts and catalog item page layouts that you can select when you connect a publishing site to a catalog, or when you configure the navigation term set on a publishing site.
Create a category page layout
Before you can create or customize a category page layout, we recommend that you create a mapped network drive that points to the Master Page Gallery. For more information, see How to: Map a network drive to the SharePoint Master Page Gallery.
The simplest way to create a category page layout is to let SharePoint create the page layout automatically when you connect the publishing site to a catalog, and then customize the existing category page layout to change the markup as required by the page design. Alternatively, you can create a new category page layout from scratch by using Design Manager.
To customize an existing category page layout that was created automatically by SharePoint
Using Windows Explorer, open the mapped network drive to the Master Page Gallery.
To customize a category page layout, edit the HTML file that resides directly on the server by using an HTML editor to open and edit the HTML file in the mapped drive. Each time that you save the HTML file, any changes are synched to the associated .aspx file.
Replace the markup inside the content placeholder that has id="PlaceHolderMain" with the markup that you want to use in the page layout.
Important: You must keep the Content Search Snippet markup so that the category page can display search results.
To configure and copy the HTML for any snippets you want to add to the page, follow step 1 through step 11 in the "Insert a snippet from the Snippet Gallery" section of SharePoint Design Manager snippets.
Make any other required changes to the markup, and then save the file.
Follow step 9 through step 11 in the "Create a page layout" section of How to: Create a page layout in SharePoint to check the status of the file, preview the page layout, and fix any errors.
To create a category page layout by using Design Manager
Follow step 1 through step 6 in the "Create a page layout" section of How to: Create a page layout in SharePoint.
In step 7, choose the Article Page content type.
Choose OK.
At this point, SharePoint creates an HTML file and an .aspx file that has the same name.
In Design Manager, your HTML file now appears with a Status column that shows one of two statuses:
Warnings and Errors
Conversion successful
Using Windows Explorer, open the mapped network drive to the Master Page Gallery.
To customize the category page layout, edit the HTML file that resides directly on the server by using an HTML editor to open and edit the HTML file in the mapped drive. Each time that you save the HTML file, any changes are synched to the associated .aspx file.
In the <head> tag, replace the content placeholder that has id="PlaceHolderPageTitle" with:
<!--MS:<asp:ContentPlaceHolder id="PlaceHolderPageTitle" runat="server">-->
<!--CS: Start Taxonomy TermProperty Snippet-->
<!--SPM:<%@Register Tagprefix="Taxonomy" Namespace="Microsoft.SharePoint.Taxonomy" Assembly="Microsoft.SharePoint.Taxonomy, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>-->
<!--MS:<Taxonomy:TermProperty Property="Name" runat="server">-->
<!--ME:</Taxonomy:TermProperty>-->
<!--ME:</asp:ContentPlaceHolder>-->
- Find the content placeholder that has the id="PlaceHolderPageTitleInTitleArea" and replace it with:
<!--MS:<asp:ContentPlaceHolder id="PlaceHolderPageTitleInTitleArea" runat="server">-->
<!--SPM:<asp:SiteMapPath runat="server" ParentLevelsDisplayed="1" SiteMapProvider="CurrentNavigationSwitchableProvider"/>-->
<!--ME:</asp:ContentPlaceHolder>-->
Replace the markup inside the content placeholder that has id="PlaceHolderMain" with the markup that you want to use in the page layout.
To configure and copy the HTML for the Content Search Snippet and any other snippets you want to add to the page, follow step 1 through step 11 in the "Insert a snippet from the Snippet Gallery" section of SharePoint Design Manager snippets.
Note
When you add the Content Search Snippet to the page layout, be sure to change the query to use the result source that was created when you connected the publishing site to a catalog. For more information, see Configure result sources for web content management in SharePoint.
Make any other required changes to the markup, and then save the file.
Follow step 9 through step 11 in the "Create a page layout" section of How to: Create a page layout in SharePoint to check the status of the file, preview the page layout, and fix any errors.
Understanding the markup in the HTML category page layout
When you create a page layout, an .aspx file is created that SharePoint uses, and some HTML markup is added to the HTML version of the page layout. Category page layouts have markup components that are added to the page layout based on the Cross-Site Collection Publishing feature, and that are unique to category page layouts. When you edit the HTML category page layout in your HTML editor, it might be helpful to understand some of this markup.
Browser window page title
The component that appears inside the content placeholder with id="PlaceHolderPageTitle" contains markup that tells SharePoint to use a term property as the page title in the browser window, instead of using the standard page field value. The following code shows the markup for the browser window page title.
<!--CS: Start Taxonomy TermProperty Snippet-->
<!--SPM:<%@Register Tagprefix="Taxonomy" Namespace="Microsoft.SharePoint.Taxonomy" Assembly="Microsoft.SharePoint.Taxonomy, Version=15.0.0.0, Culture=neutral,
PublicKeyToken=71e9bce111e9429c" %>-->
<!--MS:<Taxonomy:TermProperty Property="Name" runat="server">-->
<!--ME:</Taxonomy:TermProperty>-->
Page title
The component that appears inside the content placeholder with id="PlaceHolderPageTitleInTitleArea" contains markup that tells SharePoint to use a term property as the page title on the page, instead of using the SPTitleBreadcrumb snippet and the standard page title field value. The following code shows the markup for the page title.
<!--SPM:<asp:SiteMapPath runat="server" ParentLevelsDisplayed="1" SiteMapProvider="CurrentNavigationSwitchableProvider"/>-->"
Content Search Snippet
The components that appear after the page content snippet, inside the content placeholder with id="PlaceHolderMain", contain markup for a web part Zone Snippet that contains four web part zones. The first web part zone contains a Content Search Snippet that displays a Content Search web part on the page. This snippet also contains information that helps the Content Search web part query a result source and show the results on the page. The last three web part zones are empty. If you choose to create your own category page layout, you must include the markup for the Content Search Snippet in the HTML file for your page layout. The following code shows the markup for the Content Search snippet. Replace ResultSourceID with the GUID of the result source, and replace CatalogURL with the URL of the catalog.
Note
The GUIDs for ID and __WebPartId are randomly generated by SharePoint when the snippets are added to the page layout.
<!--
CS: Start Content Search Snippet-->
<!--SPM:<%@Register Tagprefix="a781102493" Namespace="Microsoft.Office.Server.Search.WebControls" Assembly="Microsoft.Office.Server.Search, Version=15.0.0.0, Culture=neutral,
PublicKeyToken=71e9bce111e9429c"%>-->
<!--MS:<a781102493:ContentBySearchWebPart runat="server" DataProviderJSON="{&#34;QueryTemplate&#34;:&#34;&#34;,&#34;SourceID&#34;
:&#34;ResultSourceID&#34;,&#34;PropertiesJson&#34;:&#34;
{'Tag':'{Term.IDWithChildren}','Scope':'CatalogURL'}&#34;}" ResultsPerPage="3" RenderTemplateId="~sitecollection/_catalogs/masterpage/Display Templates/Content Web Parts/Control_ListWithPaging.js"
ItemTemplateId="~sitecollection/_catalogs/masterpage/Display Templates/Content Web Parts/Item_PictureOnTop.js" SelectedPropertiesJson="[&#34;WorkId&#34;,&#34;Rank&#34;,&#34;Title&#34;,&#34;Author&#34;,&#34;
Size&#34;,&#34;Path&#34;,&#34;Description&#34;,&#34;Write&#34;,&#34;CollapsingStatus&#34;,&#34;
HitHighlightedSummary&#34;,&#34;HitHighlightedProperties&#34;,&#34;ContentClass&#34;,&#34;
PictureThumbnailURL&#34;,&#34;ServerRedirectedURL&#34;,&#34;ServerRedirectedEmbedURL&#34;,&#34;
ServerRedirectedPreviewURL&#34;,&#34;FileExtension&#34;,&#34;ContentTypeId&#34;,&#34;ParentLink&#34;,&#34;
ViewsLifeTime&#34;,&#34;ViewsRecent&#34;,&#34;SectionNames&#34;,&#34;SectionIndexes&#34;,&#34;
SiteLogo&#34;,&#34;SiteDescription&#34;,&#34;deeplinks&#34;,&#34;importance&#34;]" ShouldHideControlWhenEmpty="True" FrameType="None" SuppressWebPartChrome="False" Description="$Resources:Microsoft.Office.Server.Search,CBS_Description;" IsIncluded="True"
ZoneID="" PartOrder="0" FrameState="Normal" AllowRemove="True" AllowZoneChange="True"
AllowMinimize="True" AllowConnect="True" AllowEdit="True" AllowHide="True" IsVisible="True"
DetailLink="" HelpLink="" HelpMode="Modeless" Dir="Default" PartImageSmall="" IsIncludedFilter="" ExportControlledProperties="True" ConnectionID="00000000-0000-0000-0000-000000000000" ID="g_54e35103_6f29_4dd9_b93b_8d4c863834af" ChromeType="None" ExportMode="All" __MarkupType="vsattributemarkup" __WebPartId="54e35103-6f29-4dd9-b93b-8d4c863834af"
WebPart="true" Height="" Width="" Title="$Resources:cms,WebPartZoneTitle_Dynamic;">-->
<!--ME:</a781102493:ContentBySearchWebPart>-->
<!--CE: End Content Search Snippet-->
Create a catalog item page layout
Before you can create or customize a catalog item page layout, we recommend that you create a mapped network drive that points to the Master Page Gallery. For more information, see How to: Map a network drive to the SharePoint Master Page Gallery.
As with the category page layout, the simplest way to create a catalog item page layout is to let SharePoint create the page layout automatically when you connect the publishing site to a catalog, and then customize the existing catalog item page layout to add any additional markup required by the page design. Alternatively, you can create a catalog item page layout from scratch by using Design Manager.
To customize an existing catalog item page layout that was created automatically by SharePoint
Using Windows Explorer, open the mapped network drive to the Master Page Gallery.
To customize a catalog item page layout, edit the HTML file that resides directly on the server by using an HTML editor to open and edit the HTML file in the mapped drive. Each time that you save the HTML file, any changes are synched to the associated .aspx file.
Inside the content placeholder that has id="PlaceHolderMain", add the markup that you want to use in the page layout.
Delete any snippets that you do not want to use in the page layout, and move the remaining snippets to places in the markup where you want the property values to appear.
Caution: By default, a web part Zone Snippet that contains a Catalog-Item Reuse Snippet is added to the page layout. This snippet contains the data provider that returns query results that are used by all other snippets on the page. We recommend that you keep the Catalog-Item Reuse Snippet in this default web part Zone Snippet. (You can move the Catalog-Item Reuse Snippet outside the web part Zone, and you can change the property that it displays. But, you must keep the Catalog-Item Reuse Snippet in the page layout.) For more information, see Page fields, later in this article.
To configure and copy the HTML snippet for any snippets you want to use in the page, follow step 1 through step 11 in the "Insert a snippet from the Snippet Gallery" section of SharePoint Design Manager snippets.
Make any other required changes to the markup, and then save the file.
Follow step 9 through step 11 in the "Create a page layout" section of How to: Create a page layout in SharePoint to check the status of the file, preview the page layout, and fix any errors.
To create a catalog item page layout by using Design Manager
Follow step 1 through step 6 in the "Create a page layout" section of How to: Create a page layout in SharePoint.
In step 7, choose Remote Catalog, and then choose the catalog that contains the data to appear on the page.
Choose OK.
At this point, SharePoint creates an HTML file and an .aspx file that has the same name.
In Design Manager, your HTML file now appears with a Status column that shows one of two statuses:
Warnings and Errors
Conversion successful
Using Windows Explorer, open the mapped network drive to the Master Page Gallery.
To customize the catalog item page layout, edit the HTML file that resides directly on the server by using an HTML editor to open and edit the HTML file in the mapped drive. Each time that you save the HTML file, any changes are synched to the associated .aspx file.
Inside the content placeholder that has id="PlaceHolderMain", add the markup that you want to use in the page layout.
Delete any snippets that you do not want to use in the page layout, and move the remaining snippets to places in the markup where you want the property values to appear.
Caution: By default, a web part Zone Snippet that contains a Catalog-Item Reuse Snippet is added to the page layout. This snippet contains the data provider that returns query results that are used by all other snippets on the page. We recommend that you keep the Catalog-Item Reuse Snippet in this default web part Zone Snippet. (You can move the Catalog-Item Reuse Snippet outside the web part Zone, and you can change the property that it displays. But, you must keep the Catalog-Item Reuse Snippet in the page layout.) For more information, see Page fields, later in this article.
To configure and copy the HTML snippet for any snippets you want to use in the page, follow step 1 through step 11 in the "Insert a snippet from the Snippet Gallery" section of SharePoint Design Manager snippets.
Make any other required changes to the markup, and then save the file.
Follow step 9 through step 11 in the "Create a page layout" section of How to: Create a page layout in SharePoint to check the status of the file, preview the page layout, and fix any errors.
Understanding the markup in the HTML catalog item page layout
When you create a page layout, an .aspx file is created that SharePoint uses, and some HTML markup is added to the HTML version of the page layout. Catalog item page layouts have markup components that are added to the page layout based on the Cross-Site Collection Publishing feature, and that are unique to catalog item page layouts. When you edit the HTML catalog item page layout in your HTML editor, it might be helpful to understand some of this markup.
Browser window page title
The component that appears inside the content placeholder with id="PlaceHolderPageTitle" contains a Catalog-Item Reuse Snippet that tells SharePoint to use the name of the catalog item as the page title in the browser window, instead of using the standard page title field value. The following code shows the markup for the browser window page title.
Note
The GUIDs for ID and __WebPartId are randomly generated by SharePoint when the snippets are added to the page layout.
<!--CS: [Title] Start Catalog-Item Reuse Snippet-->
<!--SPM:<cc1:CatalogItemReuseWebPart runat="server" UseServerSideRenderFormat="True" ResultType="" NumberOfItems="1" UseSharedDataProvider="True" OverwriteResultPath="False" ResultsPerPage="1" SelectedPropertiesJson="[&#34;Title&#34;]"
Title="$Resources:Microsoft.Office.Server.Search,CBSItem_Title;" Description="$Resources:Microsoft.Office.Server.Search,CBSItem_Description;"
MissingAssembly="Cannot import this web part." ID="g_863912c1_c849_46dc_8781_2920ee2bc83f" __WebPartId="{863912c1-c849-46dc-8781-2920ee2bc83f}">-->
<!--SPM:<RenderFormat>-->
<!--DC:Renders value from search without any additional formatting.-->
<!--SPM:</RenderFormat>-->
<!--SPM:</cc1:CatalogItemReuseWebPart>-->
<!--CE:End Catalog-Item Reuse Snippet-->
Page fields
The components that appear inside the content placeholder with id="PlaceHolderMain" contain snippets for the Title, Page Content, and Catalog-Item URL fields. You may delete any of these snippets from the page layout. The following code shows the markup for these page fields.
<div>
<!--CS: Start Page Field: Title Snippet-->
<!--SPM:<%@Register Tagprefix="PageFieldTextField" Namespace="Microsoft.SharePoint.WebControls" Assembly="Microsoft.SharePoint,
Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c"%>-->
<!--SPM:<%@Register Tagprefix="Publishing" Namespace="Microsoft.SharePoint.Publishing.WebControls" Assembly="Microsoft.SharePoint.Publishing, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c"%>-->
<!--MS:<Publishing:EditModePanel runat="server" CssClass="edit-mode-panel">-->
<!--MS:<PageFieldTextField:TextField FieldName="fa564e0f-0c70-4ab9-b863-0177e6ddd247"
runat="server">-->
<!--ME:</PageFieldTextField:TextField>-->
<!--ME:</Publishing:EditModePanel>-->
<!--CE: End Page Field: Title Snippet-->
</div>
<div>
<!--CS: Start Page Field: Page Content Snippet-->
<!--SPM:<%@Register Tagprefix="PageFieldRichHtmlField" Namespace="Microsoft.SharePoint.Publishing.WebControls" Assembly="Microsoft.SharePoint.Publishing, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c"%>-->
<!--MS:<PageFieldRichHtmlField:RichHtmlField FieldName="f55c4d88-1f2e-4ad9-aaa8-819af4ee7ee8" runat="server">-->
<!--PS: Start of READ-ONLY PREVIEW (do not modify)-->
<div id="ctl02_label" style="display:none">Page Content</div>
<div id="ctl02__ControlWrapper_RichHtmlField" class="ms-rtestate-field" style="display:inline" aria-labelledby="ctl02_label">
<div align="left" class="ms-formfieldcontainer">
<div class="ms-formfieldlabelcontainer" nowrap="nowrap">
<span class="ms-formfieldlabel" nowrap="nowrap">Page Content</span>
</div>
<div class="ms-formfieldvaluecontainer">
<div class="ms-rtestate-field">Page Content field value. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</div>
</div>
</div>
</div>
<!--PE: End of READ-ONLY PREVIEW-->
<!--ME:</PageFieldRichHtmlField:RichHtmlField>-->
<!--CE: End Page Field: Page Content Snippet-->
</div>
<div>
<!--CS: Start Page Field: Catalog-Item URL Snippet-->
<!--SPM:<%@Register Tagprefix="PageFieldCatalogSourceFieldControl" Namespace="Microsoft.SharePoint.Publishing.WebControls" Assembly="Microsoft.SharePoint.Publishing, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c"%>-->
<!--MS:<PageFieldCatalogSourceFieldControl:CatalogSourceFieldControl FieldName="75772bbf-0c25-4710-b52c-7b78344ad136" runat="server">-->
<!--PS: Start of READ-ONLY PREVIEW (do not modify)-->
<div align="left" class="ms-formfieldcontainer">
<div class="ms-formfieldlabelcontainer" nowrap="nowrap">
<span class="ms-formfieldlabel" nowrap="nowrap">Catalog-Item URL</span>
</div>
<div class="ms-formfieldvaluecontainer">
<a href="http://www.example.com">Link to sample web site.</a>
</div>
</div>
<!--PE: End of READ-ONLY PREVIEW-->
<!--ME:</PageFieldCatalogSourceFieldControl:CatalogSourceFieldControl>-->
<!--CE: End Page Field: Catalog-Item URL Snippet-->
</div>
If the catalog item page layout was created automatically when the publishing site was connected to a catalog, or was created by selecting a remote catalog during page layout creation, the page layout also contains a web part Zone Snippet that contains a Catalog-Item Reuse Snippet that registers a data provider for the page. The Catalog-Item Reuse Snippet contains a UseSharedDataProvider property, which is set to False. The web part Zone Snippet can be deleted from the page layout. But, the Catalog-Item Reuse Snippet must be kept in the page layout markup for the page to display catalog items. When you create a page that uses this page layout, you can configure the web part so that it is hidden when a user views the page.
Important: If you create a new catalog item page layout, and you choose a content type instead of a remote catalog, you must include a Catalog-Item Reuse Snippet in the page layout. The following code shows the markup for the Catalog-Item Reuse Snippet as it appears inside the web part Zone Snippet. Replace ManagedPropertyName with the name of the managed property to display, replace ResultSourceID with the GUID of the result source, and replace CatalogURL with the URL of the catalog.
<div>
<!--CS: Start web part Zone Snippet-->
<!--SPM:<%@Register Tagprefix="WebPartPages" Namespace="Microsoft.SharePoint.WebPartPages" Assembly="Microsoft.SharePoint,
Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c"%>-->
<!--SPM:<%@Register Tagprefix="cc1" Namespace="Microsoft.Office.Server.Search.WebControls" Assembly="Microsoft.Office.Server.Search, Version=15.0.0.0, Culture=neutral,
PublicKeyToken=71e9bce111e9429c" %>-->
<!--MS:<WebPartPages:WebPartZone runat="server" Title="&#60;%$Resources:cms,WebPartZoneTitle_Body%&#62;" AllowPersonalization="False" FrameType="TitleBarOnly" ID="Body" Orientation="Vertical">-->
<!--MS:<ZoneTemplate>-->
<!--CS: [ManagedPropertyName] Start Catalog-Item Reuse Snippet-->
<!--DC:To render the search property using a rendering template, change the "UseServerSideRenderFormat" property to "False".-->
<!--SPM:<cc1:CatalogItemReuseWebPart runat="server" UseServerSideRenderFormat="True"
ResultType="" NumberOfItems="1" AddSEOPropertiesFromSearch="True" LogAnalyticsViewEvent="True" UseSharedDataProvider="False" OverwriteResultPath="False" DataProviderJSON="{&#34;QueryTemplate&#34;:&#34;ListItemID:{URLTOKEN.1}&#34;,&#34;SourceID&#34;:&#34; ResultSourceID&#34;,&#34;PropertiesJson&#34;:&#34;{&#39;Scope&#39;:&#39; CatalogURL&#39;,&#39;Tag&#39;:&#39;{Term}&#39;}&#34;}" ResultsPerPage="1" SelectedPropertiesJson="[&#34;ManagedPropertyName&#34;]" Title="$Resources:Microsoft.Office.Server.Search,CBSItem_Title;" Description="$Resources:Microsoft.Office.Server.Search,CBSItem_Description;" MissingAssembly="Cannot import this web part." ID="g_d63eebe7_207f_4e8c_9566_7381acc80cc7" __WebPartId="{d63eebe7-207f-4e8c-9566-7381acc80cc7}">-->
<!--SPM:<RenderFormat>-->
<!--DC:Renders value from search without any additional formatting.-->
<!--SPM:</RenderFormat>-->
<!--SPM:</cc1:CatalogItemReuseWebPart>-->
<!--ME:</ZoneTemplate>-->
<!--ME:</WebPartPages:WebPartZone>-->
<!--CE:End Catalog-Item Reuse Snippet-->
</div>
If the catalog item page layout was created automatically when the publishing site was connected to a catalog, or was created by selecting a remote catalog during page layout creation, the rest of the page contains Catalog-Item Reuse Snippets that correspond to managed properties from the catalog on the authoring site. These managed properties display the details for the specific catalog item that is displayed by using the catalog item page layout. These Catalog-Item Reuse Snippets appear outside the web part zone, and are rendered directly on the page when an item is chosen on a category page. Table 2 lists the managed properties that are automatically included in the catalog item page layout.
Note
Some managed properties are included only if the catalog is a Pages library. The Used by column in Table 2 indicates which managed properties are used by both a Pages library and a list, and which from a Pages library only.
Table 2. Default managed properties Catalog-Item Reuse Snippets
| Managed property | Description | Used by |
|---|---|---|
| AuthorOWSUSER |
The name of the user who created the page. |
Pages library only |
| CreatedOWSDATE |
The date the page or list item was created. |
Pages library and list |
| EditorOWSUSER |
The name of the user who last changed the page or list item. |
Pages library and list |
| ListItemID |
The ID for the page or list item. |
Pages library and list |
| ModifiedOWSDATE |
The date the page or list item was last changed. |
Pages library and list |
| PublishingContactOWSUSER |
Contact is a site column created by the Publishing feature. It is used on the Page Content Type as the person or group who is the contact person for the page. |
Pages library only |
| PublishingIsFurlPageOWSBOOL |
A Boolean value that indicates whether the page is associated with a friendly URL. |
Pages library only |
| PublishingPageContentOWSHTML |
The HTML content of the page. |
Pages library only |
| PublishingPageLayoutOWSURLH |
The URL to the page layout that was used to create the page. |
Pages library only |
| Title |
The title of the page or list item. |
Pages library and list |
The managed properties for custom columns that you add to the Pages library or list are also included in Catalog-Item Reuse Snippets. The managed property name will vary, based on the site column type that you use when you create the site column. For more information, see Automatically created managed properties in SharePoint, and Overview of the search schema in SharePoint.
Important: The Page Image site column in a Pages library is mapped to the PublishingImage managed property. But, the PublishingImage managed property is not automatically included in the category-item page layout. To include the image in your page layout, you must add a Catalog-Item Reuse Snippet for the PublishingImage managed property. Use the following HTML to add a Catalog-Item Reuse Snippet to display the value of the PublishingImage managed property in your page layout. Replace UniqueID with a GUID that is unique to each instance of the snippet.
<div>
<!--CS: [PublishingImage] Start Catalog-Item Reuse Snippet-->
<!--SPM:<cc1:CatalogItemReuseWebPart runat="server" UseServerSideRenderFormat="True"
ResultType="" NumberOfItems="1" UseSharedDataProvider="True" OverwriteResultPath="False"
ResultsPerPage="1" SelectedPropertiesJson="[&#34;PublishingImage&#34;]"
Title="$Resources:Microsoft.Office.Server.Search,CBSItem_Title;"
Description="$Resources:Microsoft.Office.Server.Search,CBSItem_Description;"
MissingAssembly="Cannot import this web part." ID="g_UniqueID" __WebPartId="{UniqueID}">-->
<!--SPM:<RenderFormat>-->
<!--SPM:<Format Type="HTML"> -->
<!--SPM:<Picture>-->True<!--SPM:</Picture>-->
<!--SPM:</Format> -->
<!--SPM:</RenderFormat>-->
<!--SPM:</cc1:CatalogItemReuseWebPart>-->
<!--CE:End Catalog-Item Reuse Snippet-->
</div>
If you create a new catalog item page layout by using Design Manager, and you choose a content type instead of a remote catalog, you can add Catalog-Item Reuse Snippets to the page by using the Snippet Gallery. The following code shows the markup for the Catalog-Item Reuse Snippets for the Title, PublishingPageContentOWSHTML, CreatedOWSDATE, and owstaxIdPageCategory managed properties.
Note
The GUIDs for ID and __WebPartId are randomly generated by SharePoint when the snippets are added to the page layout.
<div>
<!--CS: [Title] Start Catalog-Item Reuse Snippet-->
<!--SPM:<cc1:CatalogItemReuseWebPart runat="server" UseServerSideRenderFormat="True"
ResultType="" NumberOfItems="1" UseSharedDataProvider="True" OverwriteResultPath="False"
ResultsPerPage="1" SelectedPropertiesJson="[&#34;Title&#34;]"
Title="$Resources:Microsoft.Office.Server.Search,CBSItem_Title;"
Description="$Resources:Microsoft.Office.Server.Search,CBSItem_Description;"
MissingAssembly="Cannot import this web part." ID="g_0dc23bb8_8d34_4f9f_8085_5a6ac286cb9e"
__WebPartId="{0dc23bb8-8d34-4f9f-8085-5a6ac286cb9e}">-->
<!--SPM:<RenderFormat>-->
<!--DC:Renders value from search without any additional formatting.-->
<!--SPM:</RenderFormat>-->
<!--SPM:</cc1:CatalogItemReuseWebPart>-->
<!--CE:End Catalog-Item Reuse Snippet-->
</div>
<div>
<!--CS: [PublishingPageContentOWSHTML] Start Catalog-Item Reuse Snippet-->
<!--SPM:<cc1:CatalogItemReuseWebPart runat="server" UseServerSideRenderFormat="True"
ResultType="" NumberOfItems="1" UseSharedDataProvider="True" OverwriteResultPath="False"
ResultsPerPage="1" SelectedPropertiesJson="[&#34;PublishingPageContentOWSHTML&#34;]"
Title="$Resources:Microsoft.Office.Server.Search,CBSItem_Title;"
Description="$Resources:Microsoft.Office.Server.Search,CBSItem_Description;"
MissingAssembly="Cannot import this web part." ID="g_25253a49_a9a6_4277_bf9d_416961024cee"
__WebPartId="{25253a49-a9a6-4277-bf9d-416961024cee}">-->
<!--SPM:<RenderFormat>-->
<!--DC:Renders value from search without any additional formatting.-->
<!--SPM:</RenderFormat>-->
<!--SPM:</cc1:CatalogItemReuseWebPart>-->
<!--CE:End Catalog-Item Reuse Snippet-->
</div>
<div>
<!--CS: [CreatedOWSDATE] Start Catalog-Item Reuse Snippet-->
<!--SPM:<cc1:CatalogItemReuseWebPart runat="server" UseServerSideRenderFormat="True"
ResultType="" NumberOfItems="1" UseSharedDataProvider="True" OverwriteResultPath="False"
ResultsPerPage="1" SelectedPropertiesJson="[&#34;CreatedOWSDATE&#34;]"
Title="$Resources:Microsoft.Office.Server.Search,CBSItem_Title;"
Description="$Resources:Microsoft.Office.Server.Search,CBSItem_Description;"
MissingAssembly="Cannot import this web part."
ID="g_4e1f180b_12f8_4e50_84d7_c72b0ee3793f"
__WebPartId="{4e1f180b-12f8-4e50-84d7-c72b0ee3793f}">-->
<!--SPM:<RenderFormat>-->
<!--SPM:<Format Type="DateTime"> -->
<!--DC:To render Date and Time, change this value to False.-->
<!--SPM:<DateOnly>-->True<!--SPM:</DateOnly>-->
<!--SPM:</Format> -->
<!--SPM:</RenderFormat>-->
<!--SPM:</cc1:CatalogItemReuseWebPart>-->
<!--CE:End Catalog-Item Reuse Snippet-->
</div>
<div>
<!--CS: [owstaxIdPageCategory] Start Catalog-Item Reuse Snippet-->
<!--SPM:<cc1:CatalogItemReuseWebPart runat="server" UseServerSideRenderFormat="True"
ResultType="" NumberOfItems="1" UseSharedDataProvider="True" OverwriteResultPath="False"
ResultsPerPage="1" SelectedPropertiesJson="[&#34;owstaxIdPageCategory&#34;]"
Title="$Resources:Microsoft.Office.Server.Search,CBSItem_Title;"
Description="$Resources:Microsoft.Office.Server.Search,CBSItem_Description;"
MissingAssembly="Cannot import this web part." ID="g_22e39e9d_1b25_42c7_bf2a_7ebca37616d4"
__WebPartId="{22e39e9d-1b25-42c7-bf2a-7ebca37616d4}">-->
<!--SPM:<RenderFormat>-->
<!--DC:Renders value from search without any additional formatting.-->
<!--SPM:</RenderFormat>-->
<!--SPM:</cc1:CatalogItemReuseWebPart>-->
<!--CE:End Catalog-Item Reuse Snippet-->
</div>