Updated docs for the March release

Author: jansenbe

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

@@ -1,3 +1,11 @@
+---
+title: Page Transformation Functions and Selectors
+description: Page Transformation Functions and Selectors
+ms.date: 03/06/2019
+ms.prod: sharepoint
+localization_priority: Normal
+---
+
 # Page Transformation Functions and Selectors
 
 ## Summary
@@ -129,22 +137,38 @@ Name|Description
 Name|Description
 :-----|:----------
 {CleanedText}|Html compliant with client side text part
-### TextCleanUpSummaryLinks
+### ContainsScript
 
-**Description:** Rewrites summarylinks web part html to be compliant with the html supported by the client side text part.
+**Description:** Checks if the provided html contains JavaScript
 
-**Example:** `{CleanedText} = TextCleanUpSummaryLinks({Text})`
+**Example:** `{HasScript} = ContainsScript({Text})`
 
 #### Input parameters
 
 Name|Description
 :-----|:----------
-{Text}|Original wiki html content
+{Text}|Html content to check
 #### Output parameters
 
 Name|Description
 :-----|:----------
-{CleanedText}|Html compliant with client side text part
+{HasScript}|True is the html contains script, false otherwise
+### ListCrossSiteCheck
+
+**Description:** Returns the cross site collection save list id.
+
+**Example:** `{ListId} = ListCrossSiteCheck({ListId})`
+
+#### Input parameters
+
+Name|Description
+:-----|:----------
+{ListId}|Guid of the list to use
+#### Output parameters
+
+Name|Description
+:-----|:----------
+{ListId}|Cross site collection safe list id
 ### ListAddServerRelativeUrl
 
 **Description:** Returns the server relative url of a list.
@@ -177,6 +201,22 @@ Name|Description
 Name|Description
 :-----|:----------
 {ListWebRelativeUrl}|Web relative url of the list
+### ListHideToolBar
+
+**Description:** Checks if an XSLTListView web part has a hidden toolbar.
+
+**Example:** `{HideToolBar} = ListHideToolBar({XmlDefinition})`
+
+#### Input parameters
+
+Name|Description
+:-----|:----------
+{XmlDefinition}|XmlDefinition attribute of the XSLTListViewWebPart
+#### Output parameters
+
+Name|Description
+:-----|:----------
+{HideToolBar}|Boolean indicating if the toolbar should be hidden
 ### ListDetectUsedView
 
 **Description:** Detects the list view id that was used by the webpart by mapping the web part xmldefinition to the list views. If no view found the list default view id is returned.
@@ -211,6 +251,22 @@ Name|Description
 :-----|:----------
 {ImageListId}|Id of the list holding the file
 {ImageUniqueId}|UniqueId of the file
+### ReturnCrossSiteRelativePath
+
+**Description:** Transforms the incoming path into a server relative path. If the page is located on another page the asset is transferred and url updated. Any failures keep to the original value.
+
+**Example:** `{ServerRelativeFileName} = ReturnCrossSiteRelativePath({ImageLink})`
+
+#### Input parameters
+
+Name|Description
+:-----|:----------
+{ImageLink}|Original value for the image link
+#### Output parameters
+
+Name|Description
+:-----|:----------
+{ServerRelativeFileName}|New target ___location for the asset if transferred.
 ### ExtractWebpartProperties
 
 **Description:** Extracts the client side web part properties so they can be reused.
@@ -246,11 +302,65 @@ Name|Description
 {DocumentUniqueId}|UniqueId of the file
 {DocumentAuthor}|User principal name of the document author
 {DocumentAuthorName}|Name of the file author
+### ContentEmbedCrossSiteCheck
+
+**Description:** Throws an exception when link to .aspx file.
+
+**Example:** `{Temp} = ContentEmbedCrossSiteCheck({ContentLink})`
+
+#### Input parameters
+
+Name|Description
+:-----|:----------
+{ContentLink}|Link value if set
+#### Output parameters
+
+Name|Description
+:-----|:----------
+{Temp}|Unused variable
+### LoadContentFromFile
+
+**Description:** Loads contents of a file as a string.
+
+**Example:** `{FileContents} = LoadContentFromFile({ContentLink})`
+
+#### Input parameters
+
+Name|Description
+:-----|:----------
+{ContentLink}|Server relative url to the file to load
+#### Output parameters
+
+Name|Description
+:-----|:----------
+{FileContents}|Text content of the file. Return empty string if file was not found
+### 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
+
+**Example:** `ContentBySearchToHighlightedContentProperties({DataProviderJSON}, {SelectedPropertiesJson}, {ResultsPerPage}, {RenderTemplateId})`
+
+#### Input parameters
+
+Name|Description
+:-----|:----------
+{DataProviderJson}|
+{SelectedPropertiesJson}|
+{ResultsPerPage}|
+{RenderTemplateId}|
+#### 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
 ### ContentByQueryToHighlightedContentProperties
 
-**Description:** Maps content by query web part data into a properties collection for the contentrollup (= Highlighted Content) web part
+**Description:** Maps content by query web part data into a properties collection and supporting serverProcessedContent nodes for the content rollup (= Highlighted Content) web part
 
-**Example:** `{JsonProperties} = ContentByQueryToHighlightedContentProperties({WebUrl},{ListGuid},{ListName},{ServerTemplate},{ContentTypeBeginsWithId},{FilterField1},{Filter1ChainingOperator},{FilterDisplayValue1},{FilterOperator1},{FilterField2},{Filter2ChainingOperator},{FilterDisplayValue2},{FilterOperator2},{FilterField3},{FilterDisplayValue3},{FilterOperator3},{SortBy},{SortByDirection},{GroupBy},{GroupByDirection},{ItemLimit},{DisplayColumns},{DataMappings})`
+**Example:** `ContentByQueryToHighlightedContentProperties({WebUrl},{ListGuid},{ListName},{ServerTemplate},{ContentTypeBeginsWithId},{FilterField1},{Filter1ChainingOperator},{FilterDisplayValue1},{FilterOperator1},{FilterField2},{Filter2ChainingOperator},{FilterDisplayValue2},{FilterOperator2},{FilterField3},{FilterDisplayValue3},{FilterOperator3},{SortBy},{SortByDirection},{GroupBy},{GroupByDirection},{ItemLimit},{DisplayColumns},{DataMappings})`
 
 #### Input parameters
 
@@ -284,6 +394,66 @@ Name|Description
 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
+### TextCleanUpSummaryLinks
+
+**Description:** Rewrites summarylinks web part html to be compliant with the html supported by the client side text part.
+
+**Example:** `{CleanedText} = TextCleanUpSummaryLinks({Text})`
+
+#### Input parameters
+
+Name|Description
+:-----|:----------
+{Text}|Original wiki html content
+#### Output parameters
+
+Name|Description
+:-----|:----------
+{CleanedText}|Html compliant with client side text part
+### SummaryLinksToQuickLinksProperties
+
+**Description:** Maps summarylinks web part data into a properties collection and supporting serverProcessedContent nodes for the quicklinks web part
+
+**Example:** `SummaryLinksToQuickLinksProperties({Text})`
+
+#### Input parameters
+
+Name|Description
+:-----|:----------
+{Text}|Original wiki html content
+#### Output parameters
+
+Name|Description
+:-----|:----------
+{JsonProperties}|Properties collection for the quicklinks 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
+### LookupPerson
+
+**Description:** Looks up a person from the UserInfo list and returns the needed details
+
+**Example:** `LookupPerson({ContactLoginName})`
+
+#### Input parameters
+
+Name|Description
+:-----|:----------
+{ContactLoginName}|User account to lookup (in i:0#.f|membership|[email protected] format)
+#### Output parameters
+
+Name|Description
+:-----|:----------
+{PersonName}|Name of the user
+{PersonEmail}|User's email
+{PersonUPN}|UPN of the user
+{PersonRole}|Role of the user
+{PersonDepartment}|User's department
+{PersonPhone}|Phone number of the user
+{PersonSip}|SIP address of the user
 ## Selectors
 ### TextSelector
 
@@ -344,21 +514,29 @@ WebPage|The embedded content is a page
 ServerFolderOrFile|The embedded content points to a server folder or file
 ### ContentEmbedSelectorContentLink
 
-**Description:** If ContentLink is set (content editor) then return Link, otherwise return Content.
+**Description:** Content editor can be transformed in various ways depending on whether a link was used, what file type was used, if script is used or not...
 
-**Example:** `ContentEmbedSelectorContentLink({ContentLink})`
+**Example:** `ContentEmbedSelectorContentLink({ContentLink}, {Content}, {FileContents}, {UseCommunityScriptEditor})`
 
 #### Input parameters
 
 Name|Description
 :-----|:----------
 {ContentLink}|Link value if set
+{Content}|Content embedded inside the web part
+{FileContents}|Text content of the file. Return empty string if file was not found
+{UseCommunityScriptEditor}|The UseCommunityScriptEditor mapping property provided via the PageTransformationInformation instance
 #### Output values
 
 Name|Description
 :-----|:----------
-Link|If the link was not empty
-Content|If no link was specified
+Link|If the link was not empty and it was an aspx file
+NonASPXLink|If the link was not empty and it was not an aspx file but the file contents did contain JavaScript
+NonASPXLinkNoScript|If the link was not empty and it was not an aspx file and the contents did not contain JavaScript
+NonASPXUseCommunityScriptEditor|Use the community script editor to host the content
+Content|If no link was specified but content was embedded and it contains JavaScript
+ContentNoScript|If no link was specified and the embedded content and it does not contain JavaScript
+ContentUseCommunityScriptEditor|Use the community script editor to host the content
 ### ContentByQuerySelector
 
 **Description:** Analyzes a list and returns if the list can be transformed.
@@ -377,3 +555,54 @@ Name|Description
 :-----|:----------
 Default|Transform the list
 NoTransformation|Don't transform the list
+### SummaryLinkSelector
+
+**Description:** Uses the SummaryLinksToQuickLinks mapping property provided via the PageTransformationInformation instance to determine the mapping
+
+**Example:** `SummaryLinkSelector({SummaryLinksToQuickLinks})`
+
+#### Input parameters
+
+Name|Description
+:-----|:----------
+{SummaryLinksToQuickLinks}|The SummaryLinksToQuickLinks mapping property provided via the PageTransformationInformation instance
+#### Output values
+
+Name|Description
+:-----|:----------
+UseQuickLinks|Transform to the QuickLinks web part
+UseText|Transform to the formatted text
+### ScriptEditorSelector
+
+**Description:** Uses the UseCommunityScriptEditor mapping property provided via the PageTransformationInformation instance to determine the mapping
+
+**Example:** `ScriptEditorSelector({UseCommunityScriptEditor})`
+
+#### Input parameters
+
+Name|Description
+:-----|:----------
+{UseCommunityScriptEditor}|The UseCommunityScriptEditor mapping property provided via the PageTransformationInformation instance
+#### Output values
+
+Name|Description
+:-----|:----------
+UseCommunityScriptEditor|Transform to the community script editor web part
+NoScriptEditor|Don't transform as there's no script editor
+### UserExistsSelector
+
+**Description:** Checks if the passed value is a user or not
+
+**Example:** `UserExistsSelector({PersonEmail})`
+
+#### Input parameters
+
+Name|Description
+:-----|:----------
+{PersonEmail}|Account of the user
+#### Output values
+
+Name|Description
+:-----|:----------
+InvalidUser|User is invalid
+ValidUser|User info is valid

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

@@ -1,7 +1,7 @@
 ---
 title: Options to control the page transformation process
 description: Explains how to configure the page transformation process
-ms.date: 01/30/2019
+ms.date: 03/06/2019
 ms.prod: sharepoint
 localization_priority: Normal
 ---
@@ -140,6 +140,41 @@ PageTransformationInformation pti = new PageTransformationInformation(page)
 };
 ```
 
+## RemoveEmptySectionsAndColumns option (as of March 2019 release)
+
+Type | Default value if not specified
+-----|----
+Bool | true
+
+The default behavior is to remove all empty sections and columns (e.g. you transform from a 3 column layout and only have one web part in the middle column) as that will result in better use of the screen real estate, if you don't want this then set this option to false
+
+```Csharp
+PageTransformationInformation pti = new PageTransformationInformation(page)
+{
+    RemoveEmptySectionsAndColumns = false,
+};
+```
+
+## MappingProperties dictionary (as of March 2019 release)
+
+Type | Default value if not specified
+-----|----
+Dictionary<string,string> | empty
+
+The default mapping file can be configured by setting mapping properties
+
+```csharp
+PageTransformationInformation pti = new PageTransformationInformation(page)
+{
+    // If target page exists, then overwrite it
+    Overwrite = true,
+};
+
+pti.MappingProperties["SummaryLinksToQuickLinks"] = "false";
+
+pageTransformator.Transform(pti);
+```
+
 ## HandleWikiImagesAndVideos option
 
 Type | Default value if not specified