Set-RDMEntryDocumentation

    2025-02-17

    Set-RDMEntryDocumentation

    SYNOPSIS

    Save modified documentation pages

    SYNTAX

    __AllParameterSets

    Set-RDMEntryDocumentation [-InputObject] <PSHandbookPage[]> [-Refresh]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Save modified documentation pages. The documentation pages must be fetched by Get-RDMEntryDocumentation. The associated entry must already exists. The data source must support the documentation feature and be online. The user must have the rights to edit the documentation.

    EXAMPLES

    EXAMPLE 1

    PS C:> $defaultPages = Get-RDMEntry -VaultMode Global | Get-RDMEntryDocumentation -Default; foreach ($defaultPage in $defaultPages) { $defaultPage.Default = $false } Set-RDMEntryDocumentation -InputObject $defaultPages

    Remove the default status of the default documentation page of each entries in the system vault.

    EXAMPLE 2

    PS C:> $page = Get-RDMEntry -Name EntryA | Get-RDMEntryDocumentation -Name PageA; $page.Name = 'My New Default Page'; $page.Default = $true; Set-RDMEntryDocumentation -InputObject $page

    Define the documentation page 'PageA' as the new dafault page and rename it to 'My New Default Page'

    PARAMETERS

    -Confirm

    Prompts you for confirmation before running the cmdlet.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
ParameterValue: []
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -ForcePromptAnswer

    Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values:

    • Yes: Accept the prompt. Cover the OK and Automatic value.
    • No: Refuse the yes/no/cancel prompt. Cancel is the fallback option if there is not an option No.
    • Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.
    Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -InputObject

    The documentation pages to update

    Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSHandbookPage[]
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Refresh

    Refresh the entries in the vault. For modification in bulk, use Update-RDMEntries after the modifications instead of this switch.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -WhatIf

    Shows what would happen if the cmdlet runs. The cmdlet is not run.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
ParameterValue: []
Aliases:
- wi
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    CommonParameters

    This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

    INPUTS

    RemoteDesktopManager.PowerShellModule.PSOutputObject.PSHandbookPage

    Documentation pages, obtained from Get-RDMEntryDocumentation, to update.

    OUTPUTS

    NOTES

    For more information, type "Get-Help Set-RDMEntryDocumentation -detailed". For technical information, type "Get-Help Set-RDMEntryDocumentation -full".