@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

package/dist/tools/powershell/documentation/set-layout.md

@@ -0,0 +1,166 @@
+# Set-Layout
+
+Sets item layout for a device.
+
+## Syntax
+
+```powershell
+Set-Layout [-Item] <Item> -Device <DeviceItem> [-Layout <Item>] [-FinalLayout] [-Language <String[]>]
+
+Set-Layout [-Path] <String> -Device <DeviceItem> [-Layout <Item>] [-FinalLayout] [-Language <String[]>]
+
+Set-Layout -Id <String> [-Database <String>] -Device <DeviceItem> [-Layout <Item>] [-FinalLayout] [-Language <String[]>]
+```
+
+## Detailed Description
+
+Sets item layout for a specific device provided
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Device  &lt;DeviceItem&gt;
+
+Device for which to set layout.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Layout  &lt;Item&gt;
+
+Sitecore item defining the layout.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -FinalLayout  &lt;SwitchParameter&gt;
+
+Targets the Final Layout. If not provided, the Shared Layout will be targeted. Applies to Sitecore 8.0 and higher only.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Language  &lt;String\[\]&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  &lt;Item&gt;
+
+The item to be processed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  &lt;String&gt;
+
+Path to the item to be processed - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  &lt;String&gt;
+
+Id of the item to be processed - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  &lt;String&gt;
+
+Database containing the item to be processed - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+The input type is the type of the objects that you can pipe to the cmdlet.
+
+* Sitecore.Data.Items.Item 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+# where my test page will go
+$path = 'master:\content\Sample'
+
+# wipe and re-create it if exists
+if(Test-Path $path){
+    Remove-Item $path
+}
+$item = New-Item -Path $path -ItemType "Sample/Sample Item"
+
+# select default layout
+$device = Get-LayoutDevice -Default
+
+# and a layout we will change to
+$layout = Get-Item -Path 'master:\layout\Layouts\System\Simulated Device Layout'
+
+# change the layout from what is in Standard values to the new one.
+Set-Layout -Item $item -Device $device -Layout $layout | Out-Null
+
+# verify
+Get-Layout $item  
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Add-Rendering](add-rendering.md)
+* [New-Rendering](new-rendering.md)
+* [Set-Rendering](set-rendering.md)
+* [Get-Rendering](get-rendering.md)
+* [Get-LayoutDevice](get-layoutdevice.md)
+* [Remove-Rendering](remove-rendering.md)
+* [Get-Layout](get-layout.md)
+* [Reset-Layout](reset-layout.md)
+* [#579](https://github.com/SitecorePowerShell/Console/issues/579)
+

package/dist/tools/powershell/documentation/set-rendering.md

@@ -0,0 +1,213 @@
+# Set-Rendering
+
+Updates rendering with new values.
+
+## Syntax
+
+```powershell
+Set-Rendering [-Item] <Item> -Instance <RenderingDefinition> [-Parameter <Hashtable>] [-PlaceHolder <String>] [-DataSource <String>] [-Index <Int32>] [-FinalLayout] [-Device <DeviceItem>] [-Language <String[]>]
+
+Set-Rendering [-Path] <String> -Instance <RenderingDefinition> [-Parameter <Hashtable>] [-PlaceHolder <String>] [-DataSource <String>] [-Index <Int32>] [-FinalLayout] [-Device <DeviceItem>] [-Language <String[]>]
+
+Set-Rendering -Id <String> [-Database <String>] -Instance <RenderingDefinition> [-Parameter <Hashtable>] [-PlaceHolder <String>] [-DataSource <String>] [-Index <Int32>] [-FinalLayout] [-Device <DeviceItem>] [-Language <String[]>]
+```
+
+## Detailed Description
+
+Updates rendering instance with new values. The instance should be earlier obtained using Get-Rendering.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Instance  &lt;RenderingDefinition&gt;
+
+Instance of the Rendering to be updated.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Parameter  &lt;Hashtable&gt;
+
+Rendering Parameters to be overriden on the Rendering that is being updated - if not specified the value provided in rendering definition specified in the Instance parameter will be used.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -PlaceHolder  &lt;String&gt;
+
+Placeholder path the Rendering should be added to - if not specified the value provided in rendering definition specified in the Instance parameter will be used.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -DataSource  &lt;String&gt;
+
+Data source of the Rendering - if not specified the value provided in rendering definition specified in the Instance parameter will be used.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Index  &lt;Int32&gt;
+
+If provided the rendering will be moved to the specified index.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -FinalLayout  &lt;SwitchParameter&gt;
+
+Targets the Final Layout. If not provided, the Shared Layout will be targeted. Applies to Sitecore 8.0 and higher only.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Device  &lt;DeviceItem&gt;
+
+Specifies the target device when applying the rendering changes.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Language  &lt;String\[\]&gt;
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  &lt;Item&gt;
+
+The item to be processed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  &lt;String&gt;
+
+Path to the item to be processed - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  &lt;String&gt;
+
+Id of the item to be processed - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  &lt;String&gt;
+
+Database containing the item to be processed - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+The input type is the type of the objects that you can pipe to the cmdlet.
+
+* Sitecore.Data.Items.Item 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Change all rendering's placeholder from main to footer.
+
+```powershell
+$item = Get-Item -Path master:\content\home
+Get-Rendering -Item $item -PlaceHolder "main" | 
+    Foreach-Object { 
+        $_.Placeholder = "footer"; 
+        Set-Rendering -Item $item -Instance $_
+    }
+```
+
+### EXAMPLE 2
+
+Clear the datasource value for a rendering.
+
+```powershell
+$item = Get-Item -Path master:\content\home
+Get-Rendering -Item $item -PlaceHolder "main" | 
+    Foreach-Object { 
+        $_.DataSource = $null 
+        Set-Rendering -Item $item -Instance $_
+    }
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Add-Rendering](add-rendering.md)
+* [New-Rendering](new-rendering.md)
+* [Get-Rendering](get-rendering.md)
+* [Get-LayoutDevice](get-layoutdevice.md)
+* [Remove-Rendering](remove-rendering.md)
+* [Get-Layout](get-layout.md)
+* [Set-Layout](set-layout.md)
+

package/dist/tools/powershell/documentation/set-renderingparameter.md

@@ -0,0 +1,97 @@
+# Set-RenderingParameter
+
+Adds and updates the specified rendering parameter from the rendering.
+
+## Syntax
+
+```powershell
+Set-RenderingParameter -Instance <RenderingDefinition> -Parameter <IDictionary> [-Overwrite]
+```
+
+## Detailed Description
+
+Adds and updates the specified rendering parameter from the rendering.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Instance  &lt;RenderingDefinition&gt;
+
+Rendering definition containing the rendering parameters.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Parameter  &lt;IDictionary&gt;
+
+The hashtable or dictionary of key/value pairs used to add/update rendering parameters.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Overwrite  &lt;SwitchParameter&gt;
+
+Specifying this parameter will remove all existing rendering parameters and use the new collection provided.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+The input type is the type of the objects that you can pipe to the cmdlet.
+
+* Sitecore.Layouts.RenderingDefinition
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Layouts.RenderingDefinition
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+The following updates the specified rendering parameter and updates the item.
+
+```powershell
+$item = Get-Item -Path "master" -ID "{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}"
+
+# Accepts Hashtable, Ordered Dictionaries, etc.
+$parameters = [ordered]@{"SampleKey2"="SampleValue2"}
+Get-Rendering -Item $item -FinalLayout |
+    Set-RenderingParameter -Parameter $parameters | 
+    Set-Rendering -Item $item -FinalLayout
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [New-Rendering](new-rendering.md)
+* [Set-Rendering](set-rendering.md)
+* [Get-Rendering](get-rendering.md)
+* [Get-LayoutDevice](get-layoutdevice.md)
+* [Remove-Rendering](remove-rendering.md)
+* [Get-Layout](get-layout.md)
+* [Set-Layout](set-layout.md)
+

package/dist/tools/powershell/documentation/set-user.md

@@ -0,0 +1,221 @@
+# Set-User
+
+Sets the Sitecore user properties.
+
+## Syntax
+
+Set-User \[-Identity\] <AccountIdentity> \[-IsAdministrator <Boolean>\] \[-Portrait <String>\] \[-Email <String>\] \[-FullName <String>\] \[-Comment <String>\] \[-ProfileItemId <ID>\] \[-StartUrl <String>\] \[-Enabled\] \[-CustomProperties <Hashtable>\]
+
+Set-User -Instance <User> \[-IsAdministrator <Boolean>\] \[-Portrait <String>\] \[-Email <String>\] \[-FullName <String>\] \[-Comment <String>\] \[-ProfileItemId <ID>\] \[-StartUrl <String>\] \[-Enabled\] \[-CustomProperties <Hashtable>\]
+
+## Detailed Description
+
+The Set-User command sets a user profile properties in Sitecore.
+
+The Identity parameter specifies the Sitecore user to set. You can specify a user by its local name or fully qualified name.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -IsAdministrator  <Boolean>
+
+Specifies whether the Sitecore user should be classified as an Administrator.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Portrait  <String>
+
+Specifies the Sitecore user portrait image.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Identity  <AccountIdentity>
+
+Specifies the Sitecore user by providing one of the following values.
+
+```powershell
+Local Name
+    Example: admin
+
+Fully Qualified Name
+    Example: sitecore\admi
+```
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Instance  <User>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Email  <String>
+
+Specifies the Sitecore user email address. The value is validated for a properly formatted address.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -FullName  <String>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Comment  <String>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ProfileItemId  <ID>
+
+Specifies the profile id to use for the user.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -StartUrl  <String>
+
+Specifies the url to navigate to once the user is logged in. The values are validated with a pretermined set.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Enabled  <SwitchParameter>
+
+Specifies whether the Sitecore user should be enabled.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -CustomProperties  <Hashtable>
+
+Specifies a hashtable of custom properties to assign to the Sitecore user profile.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Inputs
+
+The input type is the type of the objects that you can pipe to the cmdlet.
+
+* System.String
+
+  Represents the identity of a user.
+
+Sitecore.Security.Accounts.User Represents the instance of a user.
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* None. 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\> Set-User -Identity michael -Email michaellwest@gmail.com
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> "michael","adam","mike" | Set-User -Enable $false
+```
+
+### EXAMPLE 3
+
+```powershell
+PS master:\> Get-User -Filter * | Set-User -Comment "Sitecore user"
+```
+
+### EXAMPLE 4
+
+```powershell
+PS master:\> Set-User -Identity michael -CustomProperties @{"Date"=(Get-Date)}
+PS master:\>(Get-User michael).Profile.GetCustomProperty("Date")
+
+7/3/2014 4:40:02 PM
+```
+
+### EXAMPLE 5
+
+```powershell
+PS master:\> Set-User -Identity michael -IsAdministrator $true -CustomProperties @{"HireDate"="03/17/2010"}
+PS master:\>$user = Get-User -Identity michael
+PS master:\>$user.Profile.GetCustomProperty("HireDate")
+
+03/17/2010
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Get-User](get-user.md)
+* [New-User](new-user.md)
+* [Remove-User](remove-user.md)
+* [Unlock-User](unlock-user.md)
+