@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

package/dist/tools/powershell/documentation/get-itemreferrer.md

@@ -0,0 +1,154 @@
+# Get-ItemReferrer
+
+Returns all the items referring to the specified item.
+
+## Syntax
+
+Get-ItemReferrer -Item <Item>
+
+Get-ItemReferrer -Item <Item> -ItemLink
+
+Get-ItemReferrer -Path <String> \[-Language <String\[\]>\]
+
+Get-ItemReferrer -Path <String> \[-Language <String\[\]>\] -ItemLink
+
+Get-ItemReferrer -Id <String> \[-Database <String>\] \[-Language <String\[\]>\]
+
+Get-ItemReferrer -Id <String> \[-Database <String>\] \[-Language <String\[\]>\] -ItemLink
+
+## Detailed Description
+
+The Get-ItemReferrer command returns all items referring to the specified item. If -ItemLink parameter is used the command will return links rather than items.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Item  <Item>
+
+The item to be analysed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the item to be processed - additionally specify Language parameter to fetch different item language than the current user language.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String>
+
+Id of the the item to be processed - additionally specify Language parameter to fetch different item language than the current user language.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  <String>
+
+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 |
+
+### -Language  <String\[\]>
+
+Language that will be used as source language. If not specified the current user language will be used. Globbing/wildcard supported.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ItemLink  <SwitchParameter>
+
+Return ItemLink that define both source and target of a link rather than items linking to the specified item.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| 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 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Data.Items.Item
+
+  Sitecore.Links.ItemLink
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+```powershell
+PS master:\>Get-ItemReferrer -Path master:\content\home
+
+Name                             Children Languages                Id                                     TemplateName
+----                             -------- ---------                --                                     ------------
+Home                             True     {en, de-DE, es-ES, pt... {110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9} Sample Item
+Form                             False    {en, de-DE, es-ES, pt... {6D3B4E7D-FEF8-4110-804A-B56605688830} Webcontrol
+news                             True     {en, de-DE, es-ES, pt... {DB894F2F-D53F-4A2D-B58F-957BFAC2C848} Article
+learn-about-oms                  False    {en, de-DE, es-ES, pt... {79ECF4DF-9DB7-430F-9BFF-D164978C2333} Link
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\>Get-Item master:\content\home | Get-ItemReferrer -ItemLink
+
+SourceItemLanguage : en
+SourceItemVersion  : 1
+TargetItemLanguage :
+TargetItemVersion  : 0
+SourceDatabaseName : master
+SourceFieldID      : {F685964D-02E1-4DB6-A0A2-BFA59F5F9806}
+SourceItemID       : {110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}
+TargetDatabaseName : master
+TargetItemID       : {110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}
+TargetPath         : /sitecore/content/Home
+```
+
+## Related Topics
+
+* [Get-ItemReference](get-itemreference.md)
+* [Update-ItemReferrer](update-itemreferrer.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/get-itemtemplate.md

@@ -0,0 +1,152 @@
+# Get-ItemTemplate
+
+Returns the item template and its base templates.
+
+## Syntax
+
+Get-ItemTemplate \[-Item\] <Item> \[-Recurse\]
+
+Get-ItemTemplate \[-Path\] <String> \[-Recurse\]
+
+Get-ItemTemplate -Id <String> \[-Database <String>\] \[-Recurse\]
+
+## Detailed Description
+
+The Get-ItemTemplate command returns the item template and its base templates.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Recurse  <SwitchParameter>
+
+Return the template the item is based on and all of its base templates.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  <Item>
+
+The item to be analysed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the item to be analysed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String>
+
+Id of the item to be analysed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  <String>
+
+Database containing the item to be analysed - required if item is specified with Id.
+
+| 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 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Data.Items.TemplateItem 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Get template of /sitecore/conent/home item
+
+```powershell
+PS master:\> Get-ItemTemplate -Path master:\content\home
+
+       BaseTemplates  : {Standard template}
+       Fields         : {__Context Menu, __Display name, __Editor, __Editors...}
+       FullName       : Sample/Sample Item
+       Key            : sample item
+       OwnFields      : {Title, Text, Image, State...}
+       StandardValues : Sitecore.Data.Items.Item
+       Database       : master
+       DisplayName    : Sample Item
+       Icon           : Applications/16x16/document.png
+       ID             : {76036F5E-CBCE-46D1-AF0A-4143F9B557AA}
+       InnerItem      : Sitecore.Data.Items.Item
+       Name           : Sample Item
+```
+
+### EXAMPLE 2
+
+Get template of /sitecore/conent/home item and all of the templates its template is based on then format it to only show the template name, path and Key
+
+```powershell
+PS master:\> Get-Item -Path master:/content/Home | Get-ItemTemplate -Recurse | ft Name, FullName, Key -auto
+
+       Name              FullName                                 Key
+       ----              --------                                 ---
+       Sample Item       Sample/Sample Item                       sample item
+       Standard template System/Templates/Standard template       standard template
+       Advanced          System/Templates/Sections/Advanced       advanced
+       Appearance        System/Templates/Sections/Appearance     appearance
+       Help              System/Templates/Sections/Help           help
+       Layout            System/Templates/Sections/Layout         layout
+       Lifetime          System/Templates/Sections/Lifetime       lifetime
+       Insert Options    System/Templates/Sections/Insert Options insert options
+       Publishing        System/Templates/Sections/Publishing     publishing
+       Security          System/Templates/Sections/Security       security
+       Statistics        System/Templates/Sections/Statistics     statistics
+       Tasks             System/Templates/Sections/Tasks          tasks
+       Validators        System/Templates/Sections/Validators     validators
+       Workflow          System/Templates/Sections/Workflow       workflow
+```
+
+## Related Topics
+
+* [Get-ItemField](get-itemfield.md)
+* [Set-ItemTemplate](set-itemtemplate.md)
+* [Add-BaseTemplate](add-basetemplate.md)
+* [Remove-BaseTemplate](remove-basetemplate.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/get-itemworkflowevent.md

@@ -0,0 +1,133 @@
+# Get-ItemWorkflowEvent
+
+Returns entries from the history store notifying of workflow state change for the specified item.
+
+## Syntax
+
+Get-ItemWorkflowEvent \[-Item\] <Item> \[-Identity <String>\] \[-Language <String\[\]>\]
+
+Get-ItemWorkflowEvent \[-Path\] <String> \[-Identity <String>\] \[-Language <String\[\]>\]
+
+Get-ItemWorkflowEvent -Id <String> \[-Database <String>\] \[-Identity <String>\] \[-Language <String\[\]>\]
+
+## Detailed Description
+
+The Get-ItemWorkflowEvent command returns entries from the history store notifying of workflow state change for the specified item.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Identity  <String>
+
+User that has been associated with the enteries. Wildcards are supported.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Language  <String\[\]>
+
+Language that will be used as source language. If not specified the current user language will be used. Globbing/wildcard supported.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  <Item>
+
+The item to have its history items returned.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Path  <String>
+
+Path to the item to have its history items returned - additionally specify Language parameter to fetch different item language than the current user language.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Id  <String>
+
+Id of the the item to have its history items returned - additionally specify Language parameter to fetch different item language than the current user language.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  <String>
+
+Database containing the item to have its history items returned - 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 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Workflows.WorkflowEvent 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+PS master:\> Get-ItemWorkflowEvent -Path master:\content\home
+Date     : 2014-07-27 14:23:33
+NewState : {190B1C84-F1BE-47ED-AA41-F42193D9C8FC}
+OldState : {46DA5376-10DC-4B66-B464-AFDAA29DE84F}
+Text     : Automated
+User     : sitecore\admin
+
+Date     : 2014-08-01 15:43:29
+NewState : {190B1C84-F1BE-47ED-AA41-F42193D9C8FC}
+OldState : {190B1C84-F1BE-47ED-AA41-F42193D9C8FC}
+Text     : Just leaving a note
+User     : sitecore\admin
+```
+
+## Related Topics
+
+* [New-ItemWorkflowEvent](new-itemworkflowevent.md)
+* Execute-Workflow
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

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

@@ -0,0 +1,142 @@
+# Get-Layout
+
+Returns the layout for the specified item.
+
+## Syntax
+
+```powershell
+Get-Layout [-Item] <Item> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Get-Layout [-Path] <String> [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+
+Get-Layout -Id <String> [-Database <String>] [-Device <DeviceItem>] [-FinalLayout] [-Language <String[]>]
+```
+
+## Detailed Description
+
+The Get-Layout command returns the layout for the specified item.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Device  &lt;DeviceItem&gt;
+
+Layout Device for which the item should be returned. If not specified All layouts used will be returned. If Device is specified but no layout is specified the command will return an error that can be silenced
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -FinalLayout  &lt;SwitchParameter&gt;
+
+Returns the Final Layout. If not provided, the Shared Layout will be returned. 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 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Data.Items.Item 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+The following retrieves the layouts defined on the home item.
+
+```powershell
+Get-Layout -Path "master:{110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}"
+```
+
+## 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)
+* [Set-Layout](set-layout.md)
+* [Reset-Layout](reset-layout.md)
+

package/dist/tools/powershell/documentation/get-layoutdevice.md

@@ -0,0 +1,97 @@
+# Get-LayoutDevice
+
+Returns the layout for the specified device.
+
+## Syntax
+
+```powershell
+Get-LayoutDevice [-Name] <String>
+
+Get-LayoutDevice [-Default]
+```
+
+## Detailed Description
+
+The Get-LayoutDevice command returns the layout for the specified device.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Name  &lt;String&gt;
+
+Name of the device to return.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Default  &lt;SwitchParameter&gt;
+
+Determines that a default system layout device should be returned.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| 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 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Data.Items.DeviceItem 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Get Print device
+
+```powershell
+PS master:\> Get-LayoutDevice "Print"
+```
+
+### EXAMPLE 2
+
+Get default device
+
+```powershell
+PS master:\> Get-LayoutDevice -Default
+```
+
+### EXAMPLE 3
+
+Get all layout devices
+
+```powershell
+PS master:\> Get-LayoutDevice *
+```
+
+## 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)
+* [Remove-Rendering](remove-rendering.md)
+* [Get-Layout](get-layout.md)
+* [Set-Layout](set-layout.md)
+