Skip to content

Commit

Permalink
Removed [] from mandatory parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
@PowershellScripts
PowershellScripts authored Apr 13, 2024
1 parent 9f38d1c commit 4c18c79
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 31 deletions.
6 changes: 3 additions & 3 deletions documentation/Set-PnPMinimalDownloadStrategy.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Set-PnPMinimalDownloadStrategy [-Off] [-Force] [-Connection <PnPConnection>]
```

## DESCRIPTION
Activates or deactivates the minimal download strategy feature of a site
Activates or deactivates the minimal download strategy feature of a site.

## EXAMPLES

Expand Down Expand Up @@ -76,7 +76,7 @@ Accept wildcard characters: False
```
### -Off
Turn minimal download strategy off
Turn minimal download strategy off.
```yaml
Type: SwitchParameter
Expand All @@ -90,7 +90,7 @@ Accept wildcard characters: False
```
### -On
Turn minimal download strategy on
Turn minimal download strategy on.
```yaml
Type: SwitchParameter
Expand Down
42 changes: 21 additions & 21 deletions documentation/Set-PnPPage.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ online version: https://pnp.github.io/powershell/cmdlets/Set-PnPPage.html
# Set-PnPPage

## SYNOPSIS
Sets parameters of a page
Sets parameters of a page.

## SYNTAX

```powershell
Set-PnPPage [-Identity] <PagePipeBind> [-Name <String>] [-Title <String>]
Set-PnPPage -Identity <PagePipeBind> [-Name <String>] [-Title <String>]
[-LayoutType <PageLayoutType>] [-PromoteAs <PagePromoteType>] [-CommentsEnabled]
[-Publish] [-HeaderType <PageHeaderType>] [-HeaderLayoutType <PageHeaderLayoutType>] [-ScheduledPublishDate <DateTime>]
[-RemoveScheduledPublish] [-ContentType <ContentTypePipeBind>] [-ThumbnailUrl <String>] [-ShowPublishDate <Boolean>]
Expand All @@ -34,49 +34,49 @@ Sets parameters of a page. All pages must be located inside the Site Pages libra
Set-PnPPage -Identity "MyPage" -LayoutType Home -Title "My Page"
```

Updates the properties of the page named 'MyPage'
Updates the properties of the page named 'MyPage'.

### EXAMPLE 2
```powershell
Set-PnPPage -Identity "MyPage" -CommentsEnabled
```

Enables the comments on the page named 'MyPage'
Enables the comments on the page named 'MyPage'.

### EXAMPLE 3
```powershell
Set-PnPPage -Identity "MyPage" -CommentsEnabled:$false
```

Disables the comments on the page named 'MyPage'
Disables the comments on the page named 'MyPage'.

### EXAMPLE 4
```powershell
Set-PnPPage -Identity "hr/MyPage" -HeaderType Default
```

Sets the header of the page called MyPage located in the folder hr inside the Site Pages library to the default header
Sets the header of the page called MyPage located in the folder hr inside the Site Pages library to the default header.

### EXAMPLE 5
```powershell
Set-PnPPage -Identity "MyPage" -HeaderType None
```

Removes the header of the page
Removes the header of the page.

### EXAMPLE 6
```powershell
Set-PnPPage -Identity "MyPage" -HeaderType Custom -ServerRelativeImageUrl "/sites/demo1/assets/myimage.png" -TranslateX 10.5 -TranslateY 11.0
```

Sets the header of the page to custom header, using the specified image and translates the location of the image in the header given the values specified
Sets the header of the page to custom header, using the specified image and translates the location of the image in the header given the values specified.

### EXAMPLE 7
```powershell
Set-PnPPage -Identity "MyPage" -ScheduledPublishDate (Get-Date).AddHours(1)
```

Schedules the page "MyPage" to be published in one hour from now
Schedules the page "MyPage" to be published in one hour from now.

### EXAMPLE 8
```powershell
Expand All @@ -103,24 +103,24 @@ Creates the necessary translated page for the specified languages in the site co
```powershell
Set-PnPPage -Identity "MyPage" -ShowPublishDate $true -Publish
```
Display the date when the page was published in the header section of the page
Display the date when the page was published in the header section of the page.

### EXAMPLE 12
```powershell
Set-PnPPage -Identity "MyPage.aspx" -Like
```
Likes the page
Likes the page.

### EXAMPLE 11
```powershell
Set-PnPPage -Identity "MyPage.aspx" -Like:$false
```
Unlikes the page
Unlikes the page.

## PARAMETERS

### -CommentsEnabled
Enables or Disables the comments on the page
Enables or disables the comments on the page.

```yaml
Type: SwitchParameter
Expand Down Expand Up @@ -162,7 +162,7 @@ Accept wildcard characters: False
```
### -DemoteNewsArticle
Demotes an existing news post to a regular page
Demotes an existing news post to a regular page.
```yaml
Type: SwitchParameter
Expand All @@ -176,7 +176,7 @@ Accept wildcard characters: False
```
### -HeaderType
Sets the page header type
Sets the page header type.
```yaml
Type: PageHeaderType
Expand All @@ -191,7 +191,7 @@ Accept wildcard characters: False
```
### -HeaderLayoutType
Sets the page header layout type
Sets the page header layout type.
```yaml
Type: PageHeaderLayoutType
Expand Down Expand Up @@ -249,7 +249,7 @@ Accept wildcard characters: False
```
### -PromoteAs
Allows to promote the page for a specific purpose (None | HomePage | NewsArticle | Template)
Allows to promote the page for a specific purpose (None | HomePage | NewsArticle | Template).
```yaml
Type: PagePromoteType
Expand Down Expand Up @@ -278,7 +278,7 @@ Accept wildcard characters: False
```
### -ThumbnailUrl
Thumbnail Url
Specifies the URL of a thumbnail image.
```yaml
Type: String
Expand All @@ -292,7 +292,7 @@ Accept wildcard characters: False
```
### -ShowPublishDate
Show Published Date in Header
Shows Published Date in the header.
```yaml
Type: Boolean
Expand Down Expand Up @@ -348,7 +348,7 @@ Accept wildcard characters: False
```
### -Translate
Creates multilingual pages for all the languages specified in the site collection
Creates multilingual pages for all the languages specified in the site collection.
```yaml
Type: SwitchParameter
Expand Down Expand Up @@ -376,7 +376,7 @@ Accept wildcard characters: False
```
### -Like
Likes the page, if parameter is set to false then it Unlikes the page
Likes the page, if parameter is set to false then it Unlikes the page.
```yaml
Type: SwitchParameter
Expand Down
12 changes: 6 additions & 6 deletions documentation/Set-PnPPageTextPart.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ online version: https://pnp.github.io/powershell/cmdlets/Set-PnPPageTextPart.htm
# Set-PnPPageTextPart

## SYNOPSIS
Set text part properties
Sets text part properties.

## SYNTAX

```powershell
Set-PnPPageTextPart [-Page] <PagePipeBind> -InstanceId <Guid> -Text <String>
Set-PnPPageTextPart -Page <PagePipeBind> -InstanceId <Guid> -Text <String>
[-Connection <PnPConnection>]
```

## DESCRIPTION
Sets the rendered text in existing client side text component
Sets the rendered text in existing client side text component.

## EXAMPLES

Expand Down Expand Up @@ -48,7 +48,7 @@ Accept wildcard characters: False
```
### -InstanceId
The instance id of the text component
The instance id of the text component.
```yaml
Type: Guid
Expand All @@ -62,7 +62,7 @@ Accept wildcard characters: False
```
### -Page
The name of the page
The name of the page.
```yaml
Type: PagePipeBind
Expand All @@ -76,7 +76,7 @@ Accept wildcard characters: False
```
### -Text
Text to set
Text to set.
```yaml
Type: String
Expand Down
2 changes: 1 addition & 1 deletion documentation/Set-PnPPageWebPart.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ online version: https://pnp.github.io/powershell/cmdlets/Set-PnPPageWebPart.html
# Set-PnPPageWebPart

## SYNOPSIS
Sets Web Part properties.
Sets web part properties.

## SYNTAX

Expand Down

0 comments on commit 4c18c79

Please sign in to comment.