@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

package/dist/tools/powershell/documentation/show-input.md

@@ -0,0 +1,129 @@
+# Show-Input
+
+Shows prompt message box asking user to provide a text string.
+
+## Syntax
+
+Show-Input \[-Prompt\] <String> \[-DefaultValue <String>\] \[-Validation <String>\] \[-ErrorMessage <String>\] \[-MaxLength <Int32>\]
+
+## Detailed Description
+
+Shows prompt message box asking user to provide a text string.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Prompt  <String>
+
+Prompt message to show in the message box shown to a user.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -DefaultValue  <String>
+
+Default value to be provided for the text box.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Validation  <String>
+
+Regex for value validation. If user enters a value that does not validate - en error message defined with the "ErrorMessage" parameter will be shown and user will be asked to enter the value again.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ErrorMessage  <String>
+
+Error message to show when regex validation fails.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -MaxLength  <Int32>
+
+Maximum length of the string returned. If user enters a longer value - en error message will be shown and user will be asked to enter the value again.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* System.String 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Requests that the user provides an email, validates it against a regular expression snd whows an allert if the format is not valid
+
+```powershell
+PS master:\> Show-Input "Please provide your email" -DefaultValue "my@email.com"  -Validation "^[a-zA-Z0-9_-]+(?:\.[a-zA-Z0-9_-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$" -ErrorMessage "Not a proper email!"
+```
+
+### EXAMPLE 2
+
+Uses Show-Input command to request user a new name for the content item validating the proper characters are used and assigns the result to $newName variable \(nothing gets changed\)
+
+```powershell
+PS master:\> $contentItem = get-item master:\content
+PS master:\> $newName = Show-Input "Please provide the new name for the '$($contentItem.Name)' Item" -DefaultValue $contentItem.Name  -Validation "^[\w\*\$][\w\s\-\$]*(\(\d{1,}\)){0,1}$" -ErrorMessage "Invalid characters in the name"
+
+#print new name
+PS master:\> Write-Host "The new name you've chosen is '$($newName)'"
+```
+
+### EXAMPLE 3
+
+Requests that the user provides a string of at most 5 characters
+
+```powershell
+Show-Input "Please provide 5 characters at most" -MaxLength 5
+```
+
+## Related Topics
+
+* [Read-Variable](read-variable.md)
+* [Show-Alert](show-alert.md)
+* [Show-Application](show-application.md)
+* [Show-Confirm](show-confirm.md)
+* [Show-FieldEditor](show-fieldeditor.md)
+* [Show-ListView](show-listview.md)
+* [Show-ModalDialog](show-modaldialog.md)
+* [Show-Result](show-result.md)
+* [Show-YesNoCancel](show-yesnocancel.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/show-listview.md

@@ -0,0 +1,276 @@
+# Show-ListView
+
+Sends output to an interactive table in a separate window.
+
+## Syntax
+
+Show-ListView \[-PageSize <Int32>\] \[-Modal\] \[-ActionData <Object>\] \[-ViewName <String>\] \[-ActionsInSession\] \[-Show <None \| SharedExport \| Filter \| PagingAlways \| SharedActions \| StatusBar \| All>\] \[-InfoTitle <String>\] \[-InfoDescription <String>\] \[-MissingDataMessage <String>\] \[-Icon <String>\] -Data <Object> \[-Property <Object\[\]>\] \[-Title <String>\] \[-Width <Int32>\] \[-Height <Int32>\]
+
+## Detailed Description
+
+The Show-ListView command sends the output from a command to a grid view window where the output is displayed in an interactive table. Because this command requires a user interface, it does not work in a non-interactive scenarios like within web service calls. You can use the following features of the table to examine your data: -- Sort. To sort the data, click a column header. Click again to toggle from ascending to descending order. -- Quick Filter. Use the "Filter" box at the top of the window to search the text in the table. You can search for text in a particular column, search for literals, and search for multiple words. -- Execute actions on selected items. To execute action on the data from Show-ListView, Ctrl+click the items you want to be included in the action and press the desired action in the "Actions" chunk in the ribbon. -- Export contents of the view in XML, CSV, Json, HTML or Excel file and download that onto the user's computer. The downloaded results will take into account current filter and order of the items.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -PageSize  <Int32>
+
+Number of results shown per page.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Modal  <SwitchParameter>
+
+If this parameter is provided Results will show in a new window \(in Sitecore 6.x up till Sitecore 7.1\) or in a modal overlay \(Sitecore 7.2+\)
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ActionData  <Object>
+
+Additional data what will be passed to the view. All actions that are executed from that view window will have that data accessible to them as $actionData variable.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ViewName  <String>
+
+View signature name - this can be used by action commands to determine whether to show an action or not using the Show/Enable rules.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -ActionsInSession  <SwitchParameter>
+
+If this parameter is specified actions will be executed in the same session as the one in which the command is executed.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Show  <ShowListViewFeatures>
+
+Shows UI elements selectively in the results dialog -- All - shows all UI elements automatically - default value -- SharedExport - shows export filters that are not specific to this very `-ViewName report (left-most ribbon panel) -- Filter - shows filter panel -- PagingAlways - shows paging when list is shorter than the page specified -- SharedActions - shows actions that are not specific to this very`-ViewName report \(right-most ribbon panel\) -- StatusBar - shows status bar.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -InfoTitle  <String>
+
+Title on the panel that appears below the ribbon in the results window.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -InfoDescription  <String>
+
+Description that appears on the panel below the ribbon in the results window.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -MissingDataMessage  <String>
+
+If no Items were provided for -Data parameter the message provided in this parameter will be shown in the middle of the List View dialog to notify users of the lack of items to display.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Icon  <String>
+
+Icon of the result window. \(Shows in the top/left corner and on the Sitecore taskbar\).
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Data  <Object>
+
+Data to be displayed in the view.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -Property  <Object\[\]>
+
+Specifies the object properties that appear in the display and the order in which they appear. Type one or more property names \(separated by commas\), or use a hash table to display a calculated property.
+
+The value of the Property parameter can be a new calculated property. To create a calculated, property, use a hash table. Valid keys are: -- Name \(or Label\) <string> -- Expression <string> or <script block>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Title  <String>
+
+Title of the results window.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Width  <Int32>
+
+Width of the results window. Only applicable when also using the `-Modal` switch.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Height  <Int32>
+
+Height of the results window. Only applicable when also using the `-Modal` switch.
+
+| 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.Management.Automation.PSObject 
+
+## Outputs
+
+The output type is the type of the objects that the cmdlet emits.
+
+* System.String 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+This command formats information about Sitecore items in a table. The Get-ChildItem command gets objects representing the items. The pipeline operator \(\|\) passes the object to the Show-ListView command. Show-ListView displays the objects in a table.
+
+```powershell
+PS master:\> Get-Item -path master:\* | Show-ListView -Property Name, DisplayName, ProviderPath, TemplateName, Language
+```
+
+### EXAMPLE 2
+
+This command formats information about Sitecore items in a table. The Get-ItemReferrer command gets all references of the "Sample Item" template. The pipeline operator \(\|\) passes the object to the Show-ListView command. Show-ListView displays the objects in a table. The Properties are not displaying straight properties but use the Name/Expression scheme to provide a nicely named values that like in the case of languages which are aggregarde form the "Languages" property.
+
+```powershell
+PS master:\> Get-ItemReferrer -path 'master:\templates\Sample\Sample Item' | 
+                 Show-ListView -Property `
+                     @{Label="Name"; Expression={$_.DisplayName} }, 
+                     @{Label="Path"; Expression={$_.Paths.Path} }, 
+                     @{Label="Languages"; Expression={$_.Languages | % { $_.Name + ", "} } }
+```
+
+### EXAMPLE 3
+
+The following demonstrates the use of a custom object used in the report. Notice that a custom Icon can be set.
+
+```powershell
+$item = Get-Item -Path "master:\content\home\sample item 1"
+ 
+$customItem = [pscustomobject]@{
+    "ID"=$Item.ID
+    "Icon"=$Item.__Icon
+    "DisplayName"=$Item.DisplayName
+    "ItemPath"=$Item.ItemPath
+    "Version"=$Item.Version
+    "Language"=$Item.Language
+    "__Updated"=$Item.__Updated
+    "__Updated by"=$Item."__Updated by"
+}
+
+$customItem | Show-ListView
+```
+
+## Related Topics
+
+* [Update-ListView](update-listview.md)
+* Out-GridView
+* Format-Table
+* [Read-Variable](read-variable.md)
+* [Show-Alert](show-alert.md)
+* [Show-Application](show-application.md)
+* [Show-Confirm](show-confirm.md)
+* [Show-FieldEditor](show-fieldeditor.md)
+* [Show-Input](show-input.md)
+* [Show-ModalDialog](show-modaldialog.md)
+* [Show-Result](show-result.md)
+* [Show-YesNoCancel](show-yesnocancel.md)
+* [https://blog.najmanowicz.com/2014/10/25/creating-beautiful-sitecore-reports-easily-with-powershell-extensions/](https://blog.najmanowicz.com/2014/10/25/creating-beautiful-sitecore-reports-easily-with-powershell-extensions/) 
+* [https://michaellwest.blogspot.com/2014/04/reports-with-sitecore-powershell.html](https://michaellwest.blogspot.com/2014/04/reports-with-sitecore-powershell.html) 
+* [https://sitecorejunkie.com/2014/05/28/create-a-custom-report-in-sitecore-powershell-extensions/](https://sitecorejunkie.com/2014/05/28/create-a-custom-report-in-sitecore-powershell-extensions/) 
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/show-modaldialog.md

@@ -0,0 +1,137 @@
+# Show-ModalDialog
+
+Shows Sitecore Sheer control as a modal dialog.
+
+## Syntax
+
+Show-ModalDialog -Control <String> \[-Parameters <Hashtable>\] \[-HandleParameters <Hashtable>\] \[-Title <String>\] \[-Width <Int32>\] \[-Height <Int32>\]
+
+Show-ModalDialog -Url <String> \[-HandleParameters <Hashtable>\] \[-Title <String>\] \[-Width <Int32>\] \[-Height <Int32>\]
+
+## Detailed Description
+
+Shows Sitecore Sheer control as a modal dialog. If control returns a value - the value will be passed back as the result of the command execution.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Control  <String>
+
+Name of the Sitecore Sheer control to show
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Url  <String>
+
+A fully formed URL that constitutes a control execution request.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Parameters  <Hashtable>
+
+Hashtable of parameters to pass to the control in the url.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -HandleParameters  <Hashtable>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Title  <String>
+
+Title of the control dialog.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Width  <Int32>
+
+Width of the control dialog.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Height  <Int32>
+
+Height of the control dialog.
+
+| 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.
+
+* System.String 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+PS master:\> Show-ModalDialog -Control "ConfirmChoice" -Parameters @{btn_0="Yes (returns btn_0)"; btn_1="No (returns btn_1)"; btn_2="return btn_2"; te="Message Text"; cp="My Caption"} -Height 120 -Width 400
+```
+
+## Related Topics
+
+* [Read-Variable](read-variable.md)
+* [Show-Alert](show-alert.md)
+* [Show-Application](show-application.md)
+* [Show-Confirm](show-confirm.md)
+* [Show-FieldEditor](show-fieldeditor.md)
+* [Show-Input](show-input.md)
+* [Show-ListView](show-listview.md)
+* [Show-Result](show-result.md)
+* [Show-YesNoCancel](show-yesnocancel.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+

package/dist/tools/powershell/documentation/show-result.md

@@ -0,0 +1,158 @@
+# Show-Result
+
+Shows a Sheer dialog with text results showing the output of the script or another control selected by the user based on either control name or Url to the control.
+
+## Syntax
+
+Show-Result -Control <String> \[-Parameters <String\[\]>\] \[-Title <String>\] \[-Width <Int32>\] \[-Height <Int32>\]
+
+Show-Result -Url <String> \[-Title <String>\] \[-Width <Int32>\] \[-Height <Int32>\]
+
+Show-Result \[-Text\] \[-Title <String>\] \[-Width <Int32>\] \[-Height <Int32>\]
+
+## Detailed Description
+
+Shows a Sheer dialog with text results showing the output of the script or another control selected by the user based on either control name or Url to the control.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Control  <String>
+
+Name of the Sheer control to execute.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Url  <String>
+
+Url to the Sheer control to execute.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Parameters  <String\[\]>
+
+Parameters to be passed to the executed control when executing with the -Control parameter specified.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Text  <SwitchParameter>
+
+Shows the default text dialog.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Title  <String>
+
+Title of the window containing the control.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Width  <Int32>
+
+Width of the window containing the control.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Height  <Int32>
+
+Height of the window containing the control.
+
+| 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.
+
+* System.String 
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE 1
+
+Show results of script executio
+
+```powershell
+PS master:\> Show-Result -Text
+```
+
+### EXAMPLE 2
+
+Show the Control Panel control in a Window of specified size.
+
+```powershell
+PS master:\> Show-Result -Control "ControlPanel" -Width 1024 -Height 640
+```
+
+### EXAMPLE 3
+
+```powershell
+Shows a new instance of ISE
+Show-Result -Url "/sitecore/shell/Applications/PowerShell/PowerShellIse"
+```
+
+## Related Topics
+
+* [Read-Variable](read-variable.md)
+* [Show-Alert](show-alert.md)
+* [Show-Application](show-application.md)
+* [Show-Confirm](show-confirm.md)
+* [Show-FieldEditor](show-fieldeditor.md)
+* [Show-Input](show-input.md)
+* [Show-ListView](show-listview.md)
+* [Show-ModalDialog](show-modaldialog.md)
+* [Show-YesNoCancel](show-yesnocancel.md)
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+