Updates for April release

Author: jansenbe

docs/transform/modernize-userinterface-site-pages-api.md

@@ -1,7 +1,7 @@
 ---
 title: Page Transformation Functions and Selectors
 description: Page Transformation Functions and Selectors
-ms.date: 03/06/2019
+ms.date: 04/04/2019
 ms.prod: sharepoint
 localization_priority: Normal
 ---
@@ -334,6 +334,20 @@ Name|Description
 Name|Description
 :-----|:----------
 {FileContents}|Text content of the file. Return empty string if file was not found
+### UserDocumentsToHighlightedContentProperties
+
+**Description:** Maps the user documents web part data into a properties collection and supporting serverProcessedContent nodes for the content rollup (= Highlighted Content) web part
+
+**Example:** `SiteDocumentsToHighlightedContentProperties()`
+
+#### Output parameters
+
+Name|Description
+:-----|:----------
+{JsonProperties}|Properties collection for the contentrollup (= Highlighted Content) web part
+{SearchablePlainTexts}|SearchablePlainTexts nodes to be added in the serverProcessedContent node
+{Links}|Links nodes to be added in the serverProcessedContent node
+{ImageSources}|ImageSources nodes to be added in the serverProcessedContent node
 ### ContentBySearchToHighlightedContentProperties
 
 **Description:** Maps content by search web part data into a properties collection and supporting serverProcessedContent nodes for the content rollup (= Highlighted Content) web part
@@ -454,6 +468,49 @@ Name|Description
 {PersonDepartment}|User's department
 {PersonPhone}|Phone number of the user
 {PersonSip}|SIP address of the user
+### EmptyString
+
+**Description:** Returns an empty string
+
+**Example:** `EmptyString()`
+
+#### Output parameters
+
+Name|Description
+:-----|:----------
+{return value}|Empty string
+### ToImageUrl
+
+**Description:** Returns the server relative image url of a Publishing Image field value.
+
+**Example:** `ToImageUrl({PublishingPageImage})`
+
+#### Input parameters
+
+Name|Description
+:-----|:----------
+{PublishingPageImage}|Publishing Image field value
+#### Output parameters
+
+Name|Description
+:-----|:----------
+{return value}|Server relative image url
+### ToImageAltText
+
+**Description:** Returns the image alternate text of a Publishing Image field value.
+
+**Example:** `ToImageAltText({PublishingPageImage})`
+
+#### Input parameters
+
+Name|Description
+:-----|:----------
+{PublishingPageImage}|Publishing Image field value
+#### Output parameters
+
+Name|Description
+:-----|:----------
+{return value}|Image alternate text
 ## Selectors
 ### TextSelector
 

docs/transform/modernize-userinterface-site-pages-configuration.md

@@ -1,14 +1,14 @@
 ---
 title: Options to control the page transformation process
 description: Explains how to configure the page transformation process
-ms.date: 03/06/2019
+ms.date: 04/04/2019
 ms.prod: sharepoint
 localization_priority: Normal
 ---
 
 # Page transformation configuration options
 
-When you use the page transformation framework you do have a lot of control on how the page transformation is done. The model to control this is by specifying the correct configuration as part of the `PageTransformationInformation` instance that you use to launch page transformation. In this article you'll learn more about the available options.
+When you use the page transformation framework you do have a lot of control on how the page transformation is done. The model to control this is by specifying the correct configuration as part of the `PageTransformationInformation` instance for wiki and web part pages or a `PublishingPageTransformationInformation` instance for publishing pages. The created transformation instance is what you use to launch page transformation. In this article you'll learn more about the available options.
 
 > [!IMPORTANT]
 > The SharePoint PnP Modernization framework is continuously evolving, checkout [the release notes](https://github.com/SharePoint/sp-dev-modernization/tree/master/Tools/SharePoint.Modernization/Modernization%20Framework%20release%20notes.md) to stay up to date on the latest changes. If you encounter problems please file an issue in the [sp-dev-modernization GitHub issue list](https://github.com/SharePoint/sp-dev-modernization/issues).
@@ -28,6 +28,13 @@ PageTransformationInformation pti = new PageTransformationInformation(page)
 };
 ```
 
+```Csharp
+PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
+{
+    Overwrite = true,
+};
+```
+
 ## AddPageAcceptBanner option
 
 Type | Default value if not specified
@@ -47,6 +54,9 @@ PageTransformationInformation pti = new PageTransformationInformation(page)
 };
 ```
 
+> [!NOTE]
+> This option is not available for publishing page transformation.
+
 ## TargetPagePrefix option
 
 Type | Default value if not specified
@@ -62,6 +72,9 @@ PageTransformationInformation pti = new PageTransformationInformation(page)
 };
 ```
 
+> [!NOTE]
+> This option is not available for publishing page transformation.
+
 ## TargetPageTakesSourcePageName option
 
 Type | Default value if not specified
@@ -80,6 +93,10 @@ PageTransformationInformation pti = new PageTransformationInformation(page)
 > [!IMPORTANT]
 > During the rename of the original page to a page starting with the Previous_ prefix the version history of the original page is not retained.
 
+
+> [!NOTE]
+> This option is not available for publishing page transformation.
+
 ## SourcePagePrefix option
 
 Type | Default value if not specified
@@ -95,6 +112,9 @@ PageTransformationInformation pti = new PageTransformationInformation(page)
 };
 ```
 
+> [!NOTE]
+> This option is not available for publishing page transformation.
+
 ## ReplaceHomePageWithDefaultHomePage option
 
 Type | Default value if not specified
@@ -110,6 +130,9 @@ PageTransformationInformation pti = new PageTransformationInformation(page)
 };
 ```
 
+> [!NOTE]
+> This option is not available for publishing page transformation.
+
 ## KeepPageSpecificPermissions option
 
 Type | Default value if not specified
@@ -125,6 +148,13 @@ PageTransformationInformation pti = new PageTransformationInformation(page)
 };
 ```
 
+```Csharp
+PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
+{
+    KeepPageSpecificPermissions = false,
+};
+```
+
 ## CopyPageMetadata option (as of February 2019 release)
 
 Type | Default value if not specified
@@ -140,6 +170,9 @@ PageTransformationInformation pti = new PageTransformationInformation(page)
 };
 ```
 
+> [!NOTE]
+> This option is not available for publishing page transformation. Use the publishing page layout mapping model to define if metadata needs to be copied and how that needs to happen.
+
 ## RemoveEmptySectionsAndColumns option (as of March 2019 release)
 
 Type | Default value if not specified
@@ -155,6 +188,13 @@ PageTransformationInformation pti = new PageTransformationInformation(page)
 };
 ```
 
+```Csharp
+PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
+{
+    RemoveEmptySectionsAndColumns = false,
+};
+```
+
 ## MappingProperties dictionary (as of March 2019 release)
 
 Type | Default value if not specified
@@ -175,6 +215,62 @@ pti.MappingProperties["SummaryLinksToQuickLinks"] = "false";
 pageTransformator.Transform(pti);
 ```
 
+```csharp
+PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
+{
+    // If target page exists, then overwrite it
+    Overwrite = true,
+};
+
+pti.MappingProperties["SummaryLinksToQuickLinks"] = "false";
+
+pageTransformator.Transform(pti);
+```
+
+## PublishCreatedPage option (as of April 2019 release)
+
+Type | Default value if not specified
+-----|----
+Bool | true
+
+The default behavior is to publish the created modern page, use this option if you want to prevent that.
+
+```Csharp
+PageTransformationInformation pti = new PageTransformationInformation(page)
+{
+    PublishCreatedPage = false,
+};
+```
+
+```Csharp
+PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
+{
+    PublishCreatedPage = false,
+};
+```
+
+## DisablePageComments option (as of April 2019 release)
+
+Type | Default value if not specified
+-----|----
+Bool | false
+
+The default behavior is to leave page comments enabled, use this option if you want to create a page with disabled page comments
+
+```Csharp
+PageTransformationInformation pti = new PageTransformationInformation(page)
+{
+    DisablePageComments = true,
+};
+```
+
+```Csharp
+PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
+{
+    DisablePageComments = true,
+};
+```
+
 ## HandleWikiImagesAndVideos option
 
 Type | Default value if not specified
@@ -190,6 +286,13 @@ PageTransformationInformation pti = new PageTransformationInformation(page)
 };
 ```
 
+```Csharp
+PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
+{
+    HandleWikiImagesAndVideos = false,
+};
+```
+
 ## PageHeader option
 
 Type | Default value if not specified
@@ -205,6 +308,9 @@ PageTransformationInformation pti = new PageTransformationInformation(page)
 };
 ```
 
+> [!NOTE]
+> This option is not available for publishing page transformation. Use the page layout mapping model to determine how the page header must be constructed.
+
 ## PageTitleOverride option
 
 Type | Default value if not specified
@@ -226,6 +332,19 @@ PageTransformationInformation pti = new PageTransformationInformation(page)
 };
 ```
 
+```Csharp
+// Local functions
+string titleOverride(string title)
+{
+    return $"{title}_1";
+}
+
+PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page)
+{
+    PageTitleOverride = titleOverride,
+};
+```
+
 ## LayoutTransformatorOverride option
 
 Type | Default value if not specified

docs/transform/modernize-userinterface-site-pages-dotnet.md

@@ -1,7 +1,7 @@
 ---
 title: Transform classic pages to modern client-side pages using .Net
 description: Explains how to transform classic wiki and web part pages into modern client side pages using the SharePoint .Net
-ms.date: 03/06/2019
+ms.date: 04/04/2019
 ms.prod: sharepoint
 localization_priority: Normal
 ---
@@ -113,6 +113,46 @@ using (var cc = am.GetSharePointOnlineAuthenticatedContextTenant(siteUrl, userNa
 > [!Note]
 > Not all web parts lend themselves well for a cross site transfer, check the **Cross site support** column in [web part transformation list](modernize-userinterface-site-pages-webparts.md) to learn more.
 
+### I want to transform publishing pages (as of April 2019 release, version 1.0.1904.*)
+
+Publishing page transformation always will be a cross site transformation as mixing modern client side pages with publishing pages is unsupported. Below sample shows how all publishing pages starting with an "a" are transformed to client side pages in the https://contoso.sharepoint.com/sites/mycommunicationsite site. This sample also shows how to provide a custom page layout mapping file.
+
+```csharp
+string siteUrl = "https://contoso.sharepoint.com/sites/mytestportal";
+string targetSiteUrl = "https://contoso.sharepoint.com/sites/mycommunicationsite";
+string userName = "[email protected]";
+AuthenticationManager am = new AuthenticationManager();
+using (var cc = am.GetSharePointOnlineAuthenticatedContextTenant(siteUrl, userName, GetSecureString("Password")))
+{
+    using (var ccTarget = cc.Clone(targetSiteUrl))
+    {  
+      var pageTransformator = new PublishingPageTransformator(cc, ccTarget, "C:\\temp\\custompagelayoutmapping.xml");
+      var pages = cc.Web.GetPagesFromList("Pages");
+      foreach (var page in pages)
+      {
+          PublishingPageTransformationInformation pti = new PublishingPageTransformationInformation(page, "a")
+          {
+              // If target page exists, then overwrite it
+              Overwrite = true,
+          };
+
+          try
+          {
+              Console.WriteLine($"Transforming publishing page {page.FieldValues["FileLeafRef"]}");
+              pageTransformator.Transform(pti);
+          }
+          catch(ArgumentException ex)
+          {
+              Console.WriteLine($"Page {page.FieldValues["FileLeafRef"]} could not be transformed: {ex.Message}");
+          }
+      }
+    }
+}
+```
+
+> [!Note]
+> Not all web parts lend themselves well for a cross site transfer, check the **Cross site support** column in [web part transformation list](modernize-userinterface-site-pages-webparts.md) to learn more.
+
 ### I choose the "AddPageAcceptBanner" option but don't see the banner web part on the created pages
 
 In order to make the banner webpart work there are 2 requirements that have to be met:

docs/transform/modernize-userinterface-site-pages-layout.md

@@ -1,7 +1,7 @@
 ---
 title: Understanding how wiki and web part page layouts are mapped to modern page layouts
 description: Provides detailed information on the mapping of layouts between source pages and target modern client side pages
-ms.date: 07/13/2018
+ms.date: 04/04/2019
 ms.prod: sharepoint
 localization_priority: Priority
 ---
@@ -36,6 +36,14 @@ Source page layout|Target page layout
 ![header, 3 columns](media/modernize/layout_wiki_h3c.png)|1 column row + 3 column row
 ![header, 3 columns, footer](media/modernize/layout_wiki_hf3c.png)|1 column row + 3 column row + 1 column row
 
+## Publishing page layout mapping
+
+As publishing pages do not have a fixed layout the default layout manager used by the publishing page transformator does work differently: it generates the needed rows and columns based upon the position of the web parts as defined in the used page layout mapping file. This layout behavior is defined in the mapping file using the `PageLayoutTemplate` attribute, which defaults to `AutoDetect`. If for some reason you don't like the automatic layout generation you can also use the earlier described wiki page layout types.
+
+```XML
+<PageLayout Name="WelcomeLinks" AssociatedContentType="" PageLayoutTemplate="AutoDetect" PageHeader="Custom">
+```
+
 ## Overriding the default layout transformation
 
 If for some reason you want to transform layouts differently then you can plug in your own layout transformation component as is shown in below snippet: