@antonytm/mcp-sitecore-server 1.0.0 → 1.2.0

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

@@ -0,0 +1,109 @@
+# Set-UserPassword
+
+Sets the Sitecore user password.
+
+## Syntax
+
+Set-UserPassword \[-Identity\] <AccountIdentity> -OldPassword <String> \[-NewPassword <String>\]
+
+Set-UserPassword \[-Identity\] <AccountIdentity> -Reset \[-NewPassword <String>\]
+
+## Detailed Description
+
+The Set-UserPassword command resets or changes a user password.
+
+The Identity parameter specifies the Sitecore user to remove. 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
+
+### -Identity  <AccountIdentity>
+
+Specifies the Sitecore user by providing one of the following values.
+
+```powershell
+Local Name
+    Example: admin
+Fully Qualified Name
+    Example: sitecore\admin
+```
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+### -NewPassword  <String>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByPropertyName\) |
+| Accept Wildcard Characters? | false |
+
+### -OldPassword  <String>
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Reset  <SwitchParameter>
+
+| 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.
+
+* 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-UserPassword -Identity michael -NewPassword pass123 -OldPassword b
+```
+
+### EXAMPLE 2
+
+```powershell
+PS master:\> "michael","adam","mike" | Set-UserPassword -NewPassword b -Reset
+```
+
+## Related Topics
+
+* [https://github.com/SitecorePowerShell/Console/](https://github.com/SitecorePowerShell/Console/) 
+* [Get-User](get-user.md)
+* [Set-User](set-user.md)
+

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

@@ -0,0 +1,53 @@
+# Show-Alert
+
+Pauses the script and shows an alert to the user.
+
+## Syntax
+
+Show-Alert \[-Title\] <String>
+
+## Detailed Description
+
+Pauses the script and shows an alert specified in the -Title to the user. Once user clicks the OK button - script execution resumes.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Title  <String>
+
+Text to show the user in the alert dialog.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| Accept Wildcard Characters? | false |
+
+## Notes
+
+Help Author: Adam Najmanowicz, Michael West
+
+## Examples
+
+### EXAMPLE
+
+```powershell
+PS master:\> Show-Alert "Hello world."
+```
+
+## Related Topics
+
+* [Read-Variable](read-variable.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-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-application.md

@@ -0,0 +1,150 @@
+# Show-Application
+
+Executes Sitecore Sheer application.
+
+## Syntax
+
+Show-Application \[-Application\] <String> \[\[-Parameter\] <Hashtable>\] \[-Icon <String>\] \[-Modal\] \[-Title <String>\] \[-Width <Int32>\] \[-Height <Int32>\]
+
+## Detailed Description
+
+Executes Sitecore Sheer application, allows for passing additional parameters, launching it on desktop in cooperative or in Modal mode.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Application  <String>
+
+Name of the Application to be executed. Application must be defined in the Core databse.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Parameter  <Hashtable>
+
+Additional parameters passed to the application.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | 2 |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Icon  <String>
+
+Icon of the executed application \(used for titlebar and in the Sitecore taskbar on the desktop\)
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Modal  <SwitchParameter>
+
+Causes the application to show in new browser modal window or modal overlay if used in Sitecore 7.2 or later.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Title  <String>
+
+Title of the window the app opens in.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Width  <Int32>
+
+Width of the modal window.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Height  <Int32>
+
+Height of the modal window.
+
+| 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
+
+Show Content Editor in new window \(or as an overlay in modal mode in Sitecore 7.2+\) with "/sitecore/templates" item selected.
+
+```powershell
+$item = gi master:\templates
+
+Show-Application `
+    -Application "Content Editor" `
+    -Parameter @{id ="$($item.ID)"; fo="$($item.ID)";la="$($item.Language.Name)"; vs="$($item.Version.Number)";sc_content="$($item.Database.Name)"} `
+    -Modal -Width 1600 -Height 800
+```
+
+### EXAMPLE 2
+
+Show Content Editor as a new application on desktop with "/sitecore/content/home" item selected.
+
+```powershell
+$item = gi master:\content\home
+
+Show-Application `
+    -Application "Content Editor" `
+    -Parameter @{id ="$($item.ID)"; fo="$($item.ID)";la="$($item.Language.Name)"; vs="$($item.Version.Number)";sc_content="$($item.Database.Name)"} `
+```
+
+## Related Topics
+
+* [Read-Variable](read-variable.md)
+* [Show-Alert](show-alert.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-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-confirm.md

@@ -0,0 +1,61 @@
+# Show-Confirm
+
+Shows a user a confirmation request message box.
+
+## Syntax
+
+Show-Confirm \[-Title\] <String>
+
+## Detailed Description
+
+Shows a user a confirmation request message box. Returns "yes" or "no" based on user's response. The buttons that are shown to the user are "OK" and "Cancel".
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Title  <String>
+
+Text to show the user in the dialog.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | 1 |
+| Default Value |  |
+| Accept Pipeline Input? | true \(ByValue\) |
+| 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
+
+```powershell
+PS master:\> Show-Confirm -Title "Do you like Sitecore PowerShell Extensions?"
+
+yes
+```
+
+## Related Topics
+
+* [Read-Variable](read-variable.md)
+* [Show-Alert](show-alert.md)
+* [Show-Application](show-application.md)
+* [Show-FieldEditor](show-fieldeditor.md)
+* [Show-Input](show-input.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-fieldeditor.md

@@ -0,0 +1,231 @@
+# Show-FieldEditor
+
+Shows Field editor for a provided item.
+
+## Syntax
+
+Show-FieldEditor -Item <Item> -PreserveSections \[-Name <String\[\]>\] \[-Title <String>\] \[-Width <Int32>\] \[-Height <Int32>\] \[-IncludeStandardFields\]
+
+Show-FieldEditor -Item <Item> \[-SectionTitle <String>\] \[-SectionIcon <String>\] \[-Name <String\[\]>\] \[-Title <String>\] \[-Width <Int32>\] \[-Height <Int32>\] \[-IncludeStandardFields\]
+
+Show-FieldEditor -Path <String> \[-Language <String\[\]>\] -PreserveSections \[-Name <String\[\]>\] \[-Title <String>\] \[-Width <Int32>\] \[-Height <Int32>\] \[-IncludeStandardFields\]
+
+Show-FieldEditor -Path <String> \[-Language <String\[\]>\] \[-SectionTitle <String>\] \[-SectionIcon <String>\] \[-Name <String\[\]>\] \[-Title <String>\] \[-Width <Int32>\] \[-Height <Int32>\] \[-IncludeStandardFields\]
+
+Show-FieldEditor -Id <String> \[-Database <String>\] \[-Language <String\[\]>\] -PreserveSections \[-Name <String\[\]>\] \[-Title <String>\] \[-Width <Int32>\] \[-Height <Int32>\] \[-IncludeStandardFields\]
+
+Show-FieldEditor -Id <String> \[-Database <String>\] \[-Language <String\[\]>\] \[-SectionTitle <String>\] \[-SectionIcon <String>\] \[-Name <String\[\]>\] \[-Title <String>\] \[-Width <Int32>\] \[-Height <Int32>\] \[-IncludeStandardFields\]
+
+## Detailed Description
+
+Shows Field editor for a provided item allows for editing all or selected list of fields. If user closes the dialog by pressing the "OK" button "ok" string will be returned. Otherwise "cancel" will be returned.
+
+© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
+
+## Parameters
+
+### -Name  <String\[\]>
+
+Array of names of the fields to be edited.
+
+This parameter supports globbing so you can simply use "_" to allow editing of all fields. If a field is prefixed with a dash - this field will be excluded from the list of fields. e.g. the following will display all fields except title from Show-FieldEditor -Path "master:\content\home" -Name "_", "-Title"
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Title  <String>
+
+Title of the dialog containing the field editor.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Width  <Int32>
+
+Width of the dialog containing the field editor.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Height  <Int32>
+
+Height of the dialog containing the field editor.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -IncludeStandardFields  <SwitchParameter>
+
+Add this parameter to add standard fields to the list that is being considered to be displayed
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -Item  <Item>
+
+The item to be edited.
+
+| 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 edited - 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 edited - 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 edited - 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 edited. 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 |
+
+### -PreserveSections  <SwitchParameter>
+
+If added this parameter tells editor to preserve the original item field sections, otherwise all fields are placed in a single section Named by SectionTitle parameter and having the SectionIcon icon.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | true |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -SectionTitle  <String>
+
+If PreserveSections is not added to parameters - this parameter provides a title for the global section all fields are placed under.
+
+| Aliases |  |
+| :--- | :--- |
+| Required? | false |
+| Position? | named |
+| Default Value |  |
+| Accept Pipeline Input? | false |
+| Accept Wildcard Characters? | false |
+
+### -SectionIcon  <String>
+
+If PreserveSections is not added to parameters - this parameter provides a iconfor the global section all fields are placed under.
+
+| 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 field editor that shows all non-standard fields on sitecore/content/home item except for field "title" The dialog will be titled "My Home Item" all fields inside will be in single section.
+
+```powershell
+PS master:\> Show-FieldEditor -Path master:\content\home -Name "*" , "-Title" -Title "My Home Item"
+```
+
+### EXAMPLE 2
+
+Show field editor that shows all fields including standard fields on sitecore/content/home The dialog will preserve the item sections.
+
+```powershell
+PS master:\> Get-Item "master:\content\home" | Show-FieldEditor -Name "*" -IncludeStandardFields -PreserveSections
+```
+
+## Related Topics
+
+* [Read-Variable](read-variable.md)
+* [Show-Alert](show-alert.md)
+* [Show-Application](show-application.md)
+* [Show-Confirm](show-confirm.md)
+* [Show-Input](show-input.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/) 
+