From 64068767d0a7ba46c12d0369f5e42368a2a9cf13 Mon Sep 17 00:00:00 2001 From: Przemyslaw Klys Date: Mon, 11 Apr 2022 20:58:55 +0200 Subject: [PATCH] Update docs a bit --- Docs/New-OfficeWordList.md | 34 ++++++++- Docs/New-OfficeWordListItem.md | 127 +++++++++++++++++++++++++++++++- Docs/New-OfficeWordTable.md | 55 ++++++++++++-- Docs/Remove-OfficeWordFooter.md | 4 +- Docs/Remove-OfficeWordHeader.md | 4 +- 5 files changed, 212 insertions(+), 12 deletions(-) diff --git a/Docs/New-OfficeWordList.md b/Docs/New-OfficeWordList.md index 7336385..133931f 100644 --- a/Docs/New-OfficeWordList.md +++ b/Docs/New-OfficeWordList.md @@ -13,7 +13,8 @@ schema: 2.0.0 ## SYNTAX ``` -New-OfficeWordList [[-Content] ] [[-Document] ] [] +New-OfficeWordList [[-Content] ] [[-Document] ] [[-Style] ] + [-Suppress] [] ``` ## DESCRIPTION @@ -60,6 +61,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Style +{{ Fill Style Description }} + +```yaml +Type: WordListStyle +Parameter Sets: (All) +Aliases: +Accepted values: Bulleted, ArticleSections, Headings111, HeadingIA1, Chapters, BulletedChars, Heading1ai, Headings111Shifted + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Suppress +{{ Fill Suppress Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/New-OfficeWordListItem.md b/Docs/New-OfficeWordListItem.md index 165150a..56e69d3 100644 --- a/Docs/New-OfficeWordListItem.md +++ b/Docs/New-OfficeWordListItem.md @@ -13,7 +13,9 @@ schema: 2.0.0 ## SYNTAX ``` -New-OfficeWordListItem [[-Text] ] [] +New-OfficeWordListItem [[-List] ] [[-Level] ] [[-Text] ] [[-Bold] ] + [[-Italic] ] [[-Underline] ] [[-Color] ] + [[-Alignment] ] [-Suppress] [] ``` ## DESCRIPTION @@ -30,6 +32,112 @@ PS C:\> {{ Add example code here }} ## PARAMETERS +### -Alignment +{{ Fill Alignment Description }} + +```yaml +Type: JustificationValues +Parameter Sets: (All) +Aliases: +Accepted values: Left, Start, Center, Right, End, Both, MediumKashida, Distribute, NumTab, HighKashida, LowKashida, ThaiDistribute + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Bold +{{ Fill Bold Description }} + +```yaml +Type: Nullable`1[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Color +{{ Fill Color Description }} + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Italic +{{ Fill Italic Description }} + +```yaml +Type: Nullable`1[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Level +{{ Fill Level Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -List +{{ Fill List Description }} + +```yaml +Type: WordList +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Suppress +{{ Fill Suppress Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Text {{ Fill Text Description }} @@ -39,7 +147,22 @@ Parameter Sets: (All) Aliases: Required: False -Position: 0 +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Underline +{{ Fill Underline Description }} + +```yaml +Type: Nullable`1[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/Docs/New-OfficeWordTable.md b/Docs/New-OfficeWordTable.md index f7683a4..b4492f1 100644 --- a/Docs/New-OfficeWordTable.md +++ b/Docs/New-OfficeWordTable.md @@ -13,8 +13,8 @@ schema: 2.0.0 ## SYNTAX ``` -New-OfficeWordTable [[-DataTable] ] [[-TableLayout] ] [-SkipHeader] - [] +New-OfficeWordTable [[-Document] ] [[-DataTable] ] [[-Style] ] + [[-TableLayout] ] [-SkipHeader] [-Suppress] [] ``` ## DESCRIPTION @@ -39,6 +39,21 @@ Type: Array Parameter Sets: (All) Aliases: +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Document +{{ Fill Document Description }} + +```yaml +Type: WordDocument +Parameter Sets: (All) +Aliases: + Required: False Position: 0 Default value: None @@ -61,17 +76,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Style +{{ Fill Style Description }} + +```yaml +Type: WordTableStyle +Parameter Sets: (All) +Aliases: +Accepted values: TableNormal, TableGrid, PlainTable1, PlainTable2, PlainTable3, PlainTable4, PlainTable5, GridTable1Light, GridTable1LightAccent1, GridTable1LightAccent2, GridTable1LightAccent3, GridTable1LightAccent4, GridTable1LightAccent5, GridTable1LightAccent6, GridTable2, GridTable2Accent1, GridTable2Accent2, GridTable2Accent3, GridTable2Accent4, GridTable2Accent5, GridTable2Accent6, GridTable3, GridTable3Accent1, GridTable3Accent2, GridTable3Accent3, GridTable3Accent4, GridTable3Accent5, GridTable3Accent6, GridTable4, GridTable4Accent1, GridTable4Accent2, GridTable4Accent3, GridTable4Accent4, GridTable4Accent5, GridTable4Accent6, GridTable5Dark, GridTable5DarkAccent1, GridTable5DarkAccent2, GridTable5DarkAccent3, GridTable5DarkAccent4, GridTable5DarkAccent5, GridTable5DarkAccent6, GridTable6Colorful, GridTable6ColorfulAccent1, GridTable6ColorfulAccent2, GridTable6ColorfulAccent3, GridTable6ColorfulAccent4, GridTable6ColorfulAccent5, GridTable6ColorfulAccent6, GridTable7Colorful, GridTable7ColorfulAccent1, GridTable7ColorfulAccent2, GridTable7ColorfulAccent3, GridTable7ColorfulAccent4, GridTable7ColorfulAccent5, GridTable7ColorfulAccent6, ListTable1Light, ListTable1LightAccent1, ListTable1LightAccent2, ListTable1LightAccent3, ListTable1LightAccent4, ListTable1LightAccent5, ListTable1LightAccent6, ListTable2, ListTable2Accent1, ListTable2Accent2, ListTable2Accent3, ListTable2Accent4, ListTable2Accent5, ListTable2Accent6, ListTable3, ListTable3Accent1, ListTable3Accent2, ListTable3Accent3, ListTable3Accent4, ListTable3Accent5, ListTable3Accent6, ListTable4, ListTable4Accent1, ListTable4Accent2, ListTable4Accent3, ListTable4Accent4, ListTable4Accent5, ListTable4Accent6, ListTable5Dark, ListTable5DarkAccent1, ListTable5DarkAccent2, ListTable5DarkAccent3, ListTable5DarkAccent4, ListTable5DarkAccent5, ListTable5DarkAccent6, ListTable6Colorful, ListTable6ColorfulAccent1, ListTable6ColorfulAccent2, ListTable6ColorfulAccent3, ListTable6ColorfulAccent4, ListTable6ColorfulAccent5, ListTable6ColorfulAccent6, ListTable7Colorful, ListTable7ColorfulAccent1, ListTable7ColorfulAccent2, ListTable7ColorfulAccent3, ListTable7ColorfulAccent4, ListTable7ColorfulAccent5, ListTable7ColorfulAccent6 + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Suppress +{{ Fill Suppress Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TableLayout {{ Fill TableLayout Description }} ```yaml -Type: TableLayoutValues +Type: String Parameter Sets: (All) Aliases: -Accepted values: Fixed, Autofit Required: False -Position: 1 +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/Docs/Remove-OfficeWordFooter.md b/Docs/Remove-OfficeWordFooter.md index 09e5a8d..8d36814 100644 --- a/Docs/Remove-OfficeWordFooter.md +++ b/Docs/Remove-OfficeWordFooter.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -Remove-OfficeWordFooter [[-Document] ] [] +Remove-OfficeWordFooter [-Document] [] ``` ## DESCRIPTION @@ -38,7 +38,7 @@ Type: WordDocument Parameter Sets: (All) Aliases: -Required: False +Required: True Position: 0 Default value: None Accept pipeline input: False diff --git a/Docs/Remove-OfficeWordHeader.md b/Docs/Remove-OfficeWordHeader.md index ec1fcca..092a61b 100644 --- a/Docs/Remove-OfficeWordHeader.md +++ b/Docs/Remove-OfficeWordHeader.md @@ -13,7 +13,7 @@ schema: 2.0.0 ## SYNTAX ``` -Remove-OfficeWordHeader [[-Document] ] [] +Remove-OfficeWordHeader [-Document] [] ``` ## DESCRIPTION @@ -38,7 +38,7 @@ Type: WordDocument Parameter Sets: (All) Aliases: -Required: False +Required: True Position: 0 Default value: None Accept pipeline input: False