@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

package/dist/tools/powershell/documentation/new-itemsource.md

@@ -0,0 +1,171 @@
+# New-ItemSource
+
+Creates new Item source that can be added to a Sitecore package.
+
+## Syntax
+
+New-ItemSource \[-Item <Item>\] \[-Name\] <String> \[\[-SkipVersions\]\] \[\[-Database\] <String>\] \[\[-Root\] <String>\] \[-InstallMode <Undefined \| Overwrite \| Merge \| Skip \| SideBySide>\] \[-MergeMode <Undefined \| Clear \| Append \| Merge>\]
+
+## Detailed Description
+
+Creates new Item source that can be added to a Sitecore package. Item provided to it is added as well as its subitems.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Item  <Item>
+
+The item to be added as the root of the source.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue, ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Name  <String>
+
+Name of the item source.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -SkipVersions  <SwitchParameter>
+
+Add this parameter if you want to skip versions of the item from being included in the source and only include the version provided.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | 2 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Database  <String>
+
+Database containing the item to be added - can work with Language parameter to narrow the publication scope.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | 3 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -Root  <String>
+
+You can provide the Root as sitecore native path instead of specifying it through. Do not include Item in such case as Item will take priority over Root.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | 4 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -InstallMode  <InstallMode>
+
+Specifies what installer should do if the item already exists. Possible values:
+
+* Undefined - User will have to choose one of the below. But they probably don't really know what should be done so not a preferable option.
+* Overwrite - All versions of the old item are removed and replaced with all versions of the new item. This option basically replaces the old item with new one.
+* Merge - merge with existing item. How the item will be merged is defined with MergeMode parameter
+  * Skip - All versions remains unchanged. Other languages remains unchanged. All children remains unchanged.
+* SideBySide - all new item will be created. 
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -MergeMode  <MergeMode>
+
+Specifies what installer should do if the item already exists and InstallMode is specified as Merge. Possible values:
+
+* Undefined - User will have to choose one of the below. But they probably don't really know what should be done so not a preferable option.
+* Clear - All versions of the old item are removed and replaced with all versions of the new item. This option basically replaces the old item with new one. Other language versions \(those which are not in the package\) are removed but only for items which are in the package. All child items which are not in the package keep other language versions. All child items which are in the package are changed.
+* Append - All versions of the new item are added on top of versions of the previous item. This option allows for further manual merge because all history is preserved, so user can see what was changed. Other languages remains unchanged. All child items which are not in the package keep other language versions. All child items which are in the package are changed.
+* Merge - All versions with the same number in both packages are replaced with versions from installed package. All versions which are in the package but not in the target are added. All versions which are not in the package but are in the target remains unchanged. This option also preserves history, however it might overwrite some of the changes. Other languages remains unchanged. All child items which are in the package are changed. 
+
+| 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.Install.Items.ItemSource 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+Following example creates a new package, adds content/home item to it and saves it in the Sitecore Package folder+ gives you an option to download the saved package.
+
+```powershell
+# Create package
+$package = New-Package "Packing in Powerful Ways";
+
+# Set package metadata
+$package.Sources.Clear();
+
+$package.Metadata.Author = "Adam Najmanowicz, Michael West";
+$package.Metadata.Publisher = "Powerful Ways";
+$package.Metadata.Version = "1.0";
+$package.Metadata.Readme = 'This text will be visible to people installing your package'
+
+# Add contnet/home to the package
+$source = Get-Item 'master:\content\home' | New-ItemSource -Name 'Home Page' -InstallMode Overwrite
+$package.Sources.Add($source);
+
+# Save package
+Export-Package -Project $package -Path "$($package.Name)-$($package.Metadata.Version).zip" -Zip
+
+# Offer the user to download the package
+Download-File "$SitecorePackageFolder\$($package.Name)-$($package.Metadata.Version).zip"
+```
+
+## Related Topics
+
+* [Export-Package](export-package.md)
+* [Get-Package](get-package.md)
+* Import-Package
+* [Install-UpdatePackage](install-updatepackage.md)
+* [New-ExplicitFileSource](new-explicitfilesource.md)
+* [New-ExplicitItemSource](new-explicititemsource.md)
+* [New-FileSource](new-filesource.md)
+* [New-Package](new-package.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [https://blog.najmanowicz.com/2011/12/19/continuous-deployment-in-sitecore-with-powershell/](https://blog.najmanowicz.com/2011/12/19/continuous-deployment-in-sitecore-with-powershell/) 
+* [https://gist.github.com/AdamNaj/f4251cb2645a1bfcddae](https://gist.github.com/AdamNaj/f4251cb2645a1bfcddae) 
+* [https://www.youtube.com/watch?v=60BGRDNONo0&list=PLph7ZchYd\_nCypVZSNkudGwPFRqf1na0b&index=7](https://www.youtube.com/watch?v=60BGRDNONo0&list=PLph7ZchYd_nCypVZSNkudGwPFRqf1na0b&index=7) 
+

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

@@ -0,0 +1,140 @@
+# New-ItemWorkflowEvent
+
+Creates new entry in the history store notifying of workflow state change.
+
+## Syntax
+
+New-ItemWorkflowEvent \[-Item\] <Item> \[-OldState <String>\] \[-NewState <String>\] \[-Text <String>\] \[-Language <String\[\]>\]
+
+New-ItemWorkflowEvent \[-Path\] <String> \[-OldState <String>\] \[-NewState <String>\] \[-Text <String>\] \[-Language <String\[\]>\]
+
+New-ItemWorkflowEvent -Id <String> \[-Database <String>\] \[-OldState <String>\] \[-NewState <String>\] \[-Text <String>\] \[-Language <String\[\]>\]
+
+## Detailed Description
+
+Creates new entry in the history store notifying of workflow state change.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -OldState  <String>
+
+Id of the old state. If not provided - current item workflow state will be used.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -NewState  <String>
+
+Id of the old state. If not provided - current item workflow state will be used.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Text  <String>
+
+Action comment.
+
+| 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 the history event attached.
+
+| 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 the history event attached - 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 the history event attached - 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 the history event attached - 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
+
+```powershell
+PS master:\> New-ItemWorkflowEvent -Path master:\content\home -lanuage "en" -Text "Just leaving a note"
+```
+
+## Related Topics
+
+* [Get-ItemWorkflowEvent](get-itemworkflowevent.md)
+* Execute-Workflow
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/new-package.md

@@ -0,0 +1,81 @@
+# New-Package
+
+Creates a new Sitecore install package object.
+
+## Syntax
+
+New-Package \[-Name\] <String>
+
+## Detailed Description
+
+Creates a new Sitecore install package object that allows for further addition of items and files & further export to file.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Name  <String>
+
+Package name
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* Sitecore.Install.PackageProject 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+Following example creates a new package, adds content/home item to it and saves it in the Sitecore Package folder+ gives you an option to download the saved package.
+
+```powershell
+$package = New-Package "Packing in Powerful Ways";
+
+# Set package metadata
+$package.Sources.Clear();
+
+$package.Metadata.Author = "Adam Najmanowicz, Michael West";
+$package.Metadata.Publisher = "Powerful Ways";
+$package.Metadata.Version = "1.0";
+$package.Metadata.Readme = 'This text will be visible to people installing your package'
+
+# Add contnet/home to the package
+$source = Get-Item 'master:\content\home' | New-ItemSource -Name 'Home Page' -InstallMode Overwrite
+$package.Sources.Add($source);
+
+# Save package
+Export-Package -Project $package -Path "$($package.Name)-$($package.Metadata.Version).zip" -Zip
+
+# Offer the user to download the package
+Download-File "$SitecorePackageFolder\$($package.Name)-$($package.Metadata.Version).zip"
+```
+
+## Related Topics
+
+* [Export-Package](export-package.md)
+* [Get-Package](get-package.md)
+* Import-Package
+* [New-ExplicitFileSource](new-explicitfilesource.md)
+* [New-ExplicitItemSource](new-explicititemsource.md)
+* [New-FileSource](new-filesource.md)
+* [New-ItemSource](new-itemsource.md)
+* [Install-UpdatePackage](install-updatepackage.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [https://blog.najmanowicz.com/2011/12/19/continuous-deployment-in-sitecore-with-powershell/](https://blog.najmanowicz.com/2011/12/19/continuous-deployment-in-sitecore-with-powershell/) 
+* [https://gist.github.com/AdamNaj/f4251cb2645a1bfcddae](https://gist.github.com/AdamNaj/f4251cb2645a1bfcddae) 
+* [https://www.youtube.com/watch?v=60BGRDNONo0&list=PLph7ZchYd\_nCypVZSNkudGwPFRqf1na0b&index=7](https://www.youtube.com/watch?v=60BGRDNONo0&list=PLph7ZchYd_nCypVZSNkudGwPFRqf1na0b&index=7) 
+

package/dist/tools/powershell/documentation/new-placeholdersetting.md

@@ -0,0 +1,255 @@
+# New-PlaceholderSetting 
+ 
+Creates new placeholder setting definition that can later be added to an item. 
+ 
+## Syntax 
+ 
+```powershell
+New-PlaceholderSetting [-Item] <Item> [-Key <string>] [-Language <string[]>]
+
+New-PlaceholderSetting [-Path] <string> [-Key <string>] [-Language <string[]>]
+
+New-PlaceholderSetting -Id <string> [-Key <string>] [-Language <string[]>] [-Database <string>]
+```
+ 
+## Detailed Description 
+ 
+Creates new placeholder setting definition that can later be added to an item. Most parameters can later be overriden when calling Add-PlaceholderSetting. 
+ 
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions 
+
+## Parameters 
+ 
+### -Database&nbsp; &lt;string&gt; 
+ 
+Database containing the item to be processed - can work with Language parameter to narrow the publication scope. 
+ 
+<table>
+    <thead></thead>
+    <tbody>
+        <tr>
+            <td>Aliases</td>
+            <td>None</td>
+        </tr>
+        <tr>
+            <td>Required?</td>
+            <td>false</td>
+        </tr>
+        <tr>
+            <td>Position?</td>
+            <td>Named</td>
+        </tr>
+        <tr>
+            <td>Default Value</td>
+            <td></td>
+        </tr>
+        <tr>
+            <td>Accept Pipeline Input?</td>
+            <td>false</td>
+        </tr>
+        <tr>
+            <td>Accept Wildcard Characters?</td>
+            <td>false</td>
+        </tr>
+    </tbody>
+</table> 
+ 
+### -Id&nbsp; &lt;string&gt; 
+ 
+Id of the item to be processed - can work with Language parameter to narrow the publication scope. 
+ 
+<table>
+    <thead></thead>
+    <tbody>
+        <tr>
+            <td>Aliases</td>
+            <td>None</td>
+        </tr>
+        <tr>
+            <td>Required?</td>
+            <td>true</td>
+        </tr>
+        <tr>
+            <td>Position?</td>
+            <td>Named</td>
+        </tr>
+        <tr>
+            <td>Default Value</td>
+            <td></td>
+        </tr>
+        <tr>
+            <td>Accept Pipeline Input?</td>
+            <td>false</td>
+        </tr>
+        <tr>
+            <td>Accept Wildcard Characters?</td>
+            <td>false</td>
+        </tr>
+    </tbody>
+</table> 
+ 
+### -Item&nbsp; &lt;Item&gt; 
+ 
+The item to be processed.
+ 
+<table>
+    <thead></thead>
+    <tbody>
+        <tr>
+            <td>Aliases</td>
+            <td>None</td>
+        </tr>
+        <tr>
+            <td>Required?</td>
+            <td>true</td>
+        </tr>
+        <tr>
+            <td>Position?</td>
+            <td>0</td>
+        </tr>
+        <tr>
+            <td>Default Value</td>
+            <td></td>
+        </tr>
+        <tr>
+            <td>Accept Pipeline Input?</td>
+            <td>true (ByValue, ByPropertyName)</td>
+        </tr>
+        <tr>
+            <td>Accept Wildcard Characters?</td>
+            <td>false</td>
+        </tr>
+    </tbody>
+</table> 
+ 
+### -Key&nbsp; &lt;string&gt; 
+ 
+The key for this placeholder setting.
+ 
+<table>
+    <thead></thead>
+    <tbody>
+        <tr>
+            <td>Aliases</td>
+            <td>None</td>
+        </tr>
+        <tr>
+            <td>Required?</td>
+            <td>false</td>
+        </tr>
+        <tr>
+            <td>Position?</td>
+            <td>Named</td>
+        </tr>
+        <tr>
+            <td>Default Value</td>
+            <td></td>
+        </tr>
+        <tr>
+            <td>Accept Pipeline Input?</td>
+            <td>false</td>
+        </tr>
+        <tr>
+            <td>Accept Wildcard Characters?</td>
+            <td>false</td>
+        </tr>
+    </tbody>
+</table> 
+ 
+### -Language&nbsp; &lt;string[]&gt; 
+ 
+Language that will be used as source language. If not specified the current user language will be used. Globbing/wildcard supported.
+ 
+<table>
+    <thead></thead>
+    <tbody>
+        <tr>
+            <td>Aliases</td>
+            <td>Languages</td>
+        </tr>
+        <tr>
+            <td>Required?</td>
+            <td>false</td>
+        </tr>
+        <tr>
+            <td>Position?</td>
+            <td>Named</td>
+        </tr>
+        <tr>
+            <td>Default Value</td>
+            <td></td>
+        </tr>
+        <tr>
+            <td>Accept Pipeline Input?</td>
+            <td>false</td>
+        </tr>
+        <tr>
+            <td>Accept Wildcard Characters?</td>
+            <td>false</td>
+        </tr>
+    </tbody>
+</table> 
+ 
+### -Path&nbsp; &lt;string&gt; 
+ 
+Path to the item to be processed - can work with Language parameter to narrow the publication scope.  
+ 
+<table>
+    <thead></thead>
+    <tbody>
+        <tr>
+            <td>Aliases</td>
+            <td>FullName, FileName</td>
+        </tr>
+        <tr>
+            <td>Required?</td>
+            <td>true</td>
+        </tr>
+        <tr>
+            <td>Position?</td>
+            <td>0</td>
+        </tr>
+        <tr>
+            <td>Default Value</td>
+            <td></td>
+        </tr>
+        <tr>
+            <td>Accept Pipeline Input?</td>
+            <td>false</td>
+        </tr>
+        <tr>
+            <td>Accept Wildcard Characters?</td>
+            <td>false</td>
+        </tr>
+    </tbody>
+</table> 
+ 
+## 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.Layouts.PlaceholderDefinition
+
+## Examples 
+ 
+### EXAMPLE 1
+ 
+Create item defining placeholder setting
+ 
+```powershell
+$placeholderSetting = gi "master:\layout\Placeholder Settings\content" | New-PlaceholderSetting -Key "content"
+```
+
+## Related Topics 
+ 
+
+* <a href='https://github.com/SitecorePowerShell/Console/' target='_blank'>https://github.com/SitecorePowerShell/Console/</a><br/>
+* [Add-PlaceholderSetting](add-placeholdersetting.md)
+* [Get-PlaceholderSetting](get-placeholdersetting.md)
+* [Remove-PlaceholderSetting](remove-placeholdersetting.md)