@@ -9,40 +9,50 @@ schema: 2.0.0
9
9
# New-ExternalHelpCab
10
10
11
11
## SYNOPSIS
12
- Generates a .cab file.
12
+ Generates a ` .cab ` file.
13
13
14
14
## SYNTAX
15
15
16
16
```
17
- New-ExternalHelpCab -CabFilesFolder <String> -LandingPagePath <String> -OutputFolder <String>
17
+ New-ExternalHelpCab -CabFilesFolder <String> -LandingPagePath <String>
18
+ -OutputFolder <String>
18
19
[-IncrementHelpVersion] [<CommonParameters>]
19
20
```
20
21
21
22
## DESCRIPTION
22
23
23
- The ` New-ExternalHelpCab ` cmdlet generates a .cab file that contains all the non-recursive content
24
+ The ` New-ExternalHelpCab ` cmdlet generates a ` .cab ` file that contains all the non-recursive content
24
25
in a folder. This cmdlet compresses the provided files.
25
26
27
+ > [ !NOTE]
28
+ > This cmdlet depends on the ` MakeCab.exe ` native command, which is only available on Windows. This
29
+ > cmdlet raises an error if used on non-Windows machines.
30
+
26
31
We recommend that you provide as content only about_ topics and the output from the
27
32
[ New-ExternalHelp] ( New-ExternalHelp.md ) cmdlet to this cmdlet.
28
33
29
- This cmdlet uses metadata stored in the module markdown file to name your .cab file. This naming
30
- matches the pattern that the Windows PowerShell help system requires for use as updatable help. This
34
+ This cmdlet uses metadata stored in the module markdown file to name your ` .cab ` file. This naming
35
+ matches the pattern that the PowerShell help system requires for use as updatable help. This
31
36
metadata is part of the module file created using the [ New-MarkdownHelp] ( New-MarkdownHelp.md )
32
37
cmdlet with the ** WithModulePage** parameter.
33
38
34
39
This cmdlet also generates or updates an existing ` helpinfo.xml ` file. That file provides versioning
35
- and locale details to the Windows PowerShell help system.
40
+ and locale details to the PowerShell help system.
36
41
37
42
## EXAMPLES
38
43
39
44
### Example 1: Create a CAB file
40
45
41
46
``` powershell
42
- New-ExternalHelpCab -CabFilesFolder 'C:\Module\ExternalHelpContent' -LandingPagePath 'C:\Module\ModuleName.md' -OutputPath 'C:\Module\Cab\'
47
+ $params = @{
48
+ CabFilesFolder = 'C:\Module\ExternalHelpContent'
49
+ LandingPagePath = 'C:\Module\ModuleName.md'
50
+ OutputPath = 'C:\Module\Cab\'
51
+ }
52
+ New-ExternalHelpCab @params
43
53
```
44
54
45
- This commmand creates a ` .cab ` file that contains the content folder files. The ` .cab ` file is named
55
+ The cmdlet creates a ` .cab ` file that contains the content folder files. The ` .cab ` file is named
46
56
for updatable help based on metadata. The command places the ` .cab ` file in the output folder.
47
57
48
58
## PARAMETERS
@@ -65,8 +75,8 @@ Accept wildcard characters: False
65
75
66
76
### -LandingPagePath
67
77
68
- Specifies the full path of the Module Markdown file that contains all the metadata required to name
69
- the .cab file. For the required metadata, run ` New-MarkdownHelp` with the **WithLandingPage**
78
+ Specifies the full path of the module Markdown file that contains all the metadata required to name
79
+ the ` .cab` file. For the required metadata, run `New-MarkdownHelp` with the **WithLandingPage**
70
80
parameter.
71
81
72
82
` ` ` yaml
@@ -99,7 +109,7 @@ Accept wildcard characters: False
99
109
100
110
# ## -IncrementHelpVersion
101
111
102
- Automatically increment the help version in the module markdown file.
112
+ Automatically increment the help version in the module Markdown file.
103
113
104
114
` ` ` yaml
105
115
Type: SwitchParameter
0 commit comments