Skip to content

Commit 90480e1

Browse files
authored
Add include file pointing to PlatyPS docs (#10266)
* Add include file pointing to PlatyPS docs * fix typo in URL
1 parent 7c9b896 commit 90480e1

File tree

41 files changed

+626
-545
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+626
-545
lines changed
Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,47 @@
11
---
22
description: Autogenerated Elements of Comment-Based Help
3-
ms.date: 09/12/2016
3+
ms.date: 07/10/2023
44
ms.topic: reference
55
title: Autogenerated Elements of Comment-Based Help
66
---
77
# Autogenerated Elements of Comment-Based Help
88

99
The `Get-Help` cmdlet automatically generates several elements of a comment-based topic. These
10-
autogenerated elements make comment-based help look very much like the help that is generated from
10+
autogenerated elements make comment-based help look very much like the help that's generated from
1111
XML files.
1212

1313
## Autogenerated Elements
1414

15-
The `Get-Help` cmdlet automatically generates the following elements of a help topic. You cannot
16-
edit these elements directly, but in many cases you can change the results by changing the source of
17-
the element.
15+
The `Get-Help` cmdlet automatically generates the following elements of a help topic. You can't edit
16+
these elements directly, but you can change the results by changing the source of the element.
1817

1918
### Name
2019

2120
The Name section of a function Help topic is taken from the function name in the function
22-
definition. The Name of a script Help topic is taken from the script filename. To change the name
23-
or its capitalization, change the function definition or the script filename.
21+
definition. The Name of a script Help topic is taken from the script filename. To change the name or
22+
its capitalization, change the function definition or the script filename.
2423

2524
### Syntax
2625

2726
The Syntax section of the Help topic is generated from the parameter list in the Param statement of
2827
the function or script. To add detail to the Help topic syntax, such as the .NET type of a
29-
parameter, add the detail to the parameter list. If you do not specify a parameter type, the
28+
parameter, add the detail to the parameter list. If you don't specify a parameter type, the
3029
**Object** type is inserted as the default value.
3130

3231
### Parameter List
3332

3433
The Parameters section of the Help topic is generated from the parameter list in the function or
35-
script and from the descriptions that you add by using the `.Parameters` keyword or comments in the
34+
script and from the descriptions that you add using the `.Parameters` keyword or comments in the
3635
parameter list.
3736

3837
Parameters appear in the Parameters section in the same order that they appear in the parameter
3938
list. The spelling and capitalization of parameter names is also taken from the parameter list; it
40-
is not affected by the parameter name specified by the `.Parameter` keyword.
39+
isn't affected by the parameter name specified by the `.Parameter` keyword.
4140

4241
### Common Parameters
4342

4443
The common parameters are added to the syntax and parameter list of the Help topic, even if they
45-
have no effect. For more information about the common parameters, see
46-
[about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
44+
have no effect. For more information about the common parameters, see [about_CommonParameters][01].
4745

4846
### Parameter Attribute Table
4947

@@ -54,4 +52,7 @@ value attributes is taken from the function or script syntax.
5452
### Remarks
5553

5654
The Remarks section of the Help topic is automatically generated from the function or script name.
57-
You cannot change or affect its content.
55+
You can't change or affect its content.
56+
57+
<!-- link references -->
58+
[01]: /powershell/module/microsoft.powershell.core/about/about_commonparameters

reference/docs-conceptual/developer/help/comment-based-help-keywords.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Comment-Based Help Keywords
3-
ms.date: 02/03/2022
3+
ms.date: 07/10/2023
44
ms.topic: reference
55
no-loc: [FAQ, Function, General, Glossary, Provider, Component, Functionality, Role]
66
title: Comment-Based Help Keywords
@@ -11,14 +11,13 @@ This topic lists and describes the keywords in comment-based help.
1111

1212
## Keywords in Comment-Based Help
1313

14-
The following are valid comment-based Help keywords. They are listed in the order in which they
14+
The following are valid comment-based Help keywords. They're listed in the order in which they
1515
typically appear in a Help topic along with their intended use. These keywords can appear in any
16-
order in the comment-based Help, and they are not case-sensitive.
16+
order in the comment-based Help, and they're not case-sensitive.
1717

1818
Note that the `.EXTERNALHELP` keyword takes precedence over all other comment-based help keywords.
19-
When `.EXTERNALHELP` is present, the
20-
[Get-Help](/powershell/module/Microsoft.PowerShell.Core/Get-Help) cmdlet does not display
21-
comment-based help, even when it cannot find a help file that matches the value of the keyword.
19+
When `.EXTERNALHELP` is present, the [Get-Help][02] cmdlet doesn't display comment-based help, even
20+
when it can't find a help file that matches the value of the keyword.
2221

2322
## `.SYNOPSIS`
2423

@@ -73,7 +72,7 @@ version of the same Help topic. The online version opens when you use the `Onlin
7372

7473
## `.COMPONENT`
7574

76-
The name of the technology or feature that the function or script uses, or to which it is related.
75+
The name of the technology or feature that the function or script uses, or to which it's related.
7776
The **Component** parameter of `Get-Help` uses this value to filter the search results returned by
7877
`Get-Help`.
7978

@@ -121,27 +120,28 @@ keyword is used by the `Export-PSSession` cmdlet to find the Help topics for the
121120

122121
Specifies the path and/or name of an XML-based Help file for the script or function.
123122

124-
The `.EXTERNALHELP` keyword tells the
125-
[Get-Help](/powershell/module/Microsoft.PowerShell.Core/Get-Help) cmdlet to get help for the script
126-
or function in an XML-based file. The `.EXTERNALHELP` keyword is required when using an XML-based
127-
help file for a script or function. Without it, `Get-Help` will not find a help file for the
128-
function or script.
123+
The `.EXTERNALHELP` keyword tells the [Get-Help][02] cmdlet to get help for the script or function
124+
in an XML-based file. The `.EXTERNALHELP` keyword is required when using an XML-based help file for
125+
a script or function. Without it, `Get-Help` will not find a help file for the function or script.
129126

130127
The `.EXTERNALHELP` keyword takes precedence over all other comment-based help keywords. When
131-
`.EXTERNALHELP` is present, the [Get-Help](/powershell/module/Microsoft.PowerShell.Core/Get-Help)
132-
cmdlet does not display comment-based help, even when it cannot find a help file that matches the
133-
value of the keyword.
128+
`.EXTERNALHELP` is present, the [Get-Help][02] cmdlet doesn't display comment-based help, even when
129+
it can't find a help file that matches the value of the keyword.
134130

135131
When the function is exported by a script module, the value of `.EXTERNALHELP` should be a filename
136132
without a path. `Get-Help` looks for the file in a locale-specific subdirectory of the module
137133
directory. There are no requirements for the filename, but a best practice is to use the following
138134
filename format: `<ScriptModule>.psm1-help.xml`.
139135

140-
When the function is not associated with a module, include a path and filename in the value of the
136+
When the function isn't associated with a module, include a path and filename in the value of the
141137
`.EXTERNALHELP` keyword. If the specified path to the XML file contains UI-culture-specific
142138
subdirectories, `Get-Help` searches the subdirectories recursively for an XML file with the name of
143139
the script or function in accordance with the language fallback standards established for Windows,
144140
just as it does for all XML-based Help topics.
145141

146142
For more information about the cmdlet Help XML-based Help file format, see
147-
[Writing Windows PowerShell Cmdlet Help](./writing-help-for-windows-powershell-cmdlets.md).
143+
[Writing Windows PowerShell Cmdlet Help][01].
144+
145+
<!-- link references -->
146+
[01]: ./writing-help-for-windows-powershell-cmdlets.md
147+
[02]: /powershell/module/Microsoft.PowerShell.Core/Get-Help

reference/docs-conceptual/developer/help/examples-of-comment-based-help.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Examples of Comment-Based Help
3-
ms.date: 01/11/2021
3+
ms.date: 07/10/2023
44
ms.topic: reference
55
title: Examples of Comment-Based Help
66
---
@@ -36,7 +36,7 @@ function Add-Extension
3636
Specifies the extension. "Txt" is the default.
3737
3838
.INPUTS
39-
None. You cannot pipe objects to Add-Extension.
39+
None. You can't pipe objects to Add-Extension.
4040
4141
.OUTPUTS
4242
System.String. Add-Extension returns a string with the extension or file name.
@@ -108,7 +108,7 @@ PS> Get-Help Add-Extension -full
108108
"get-help about_commonparameters".
109109
110110
INPUTS
111-
None. You cannot pipe objects to Add-Extension.
111+
None. You can't pipe objects to Add-Extension.
112112
113113
OUTPUTS
114114
System.String. Add-Extension returns a string with the extension or file name.
@@ -137,10 +137,10 @@ PS> Get-Help Add-Extension -full
137137

138138
The following sample function includes comment-based Help.
139139

140-
Notice the blank lines between the closing **#>** and the `Param` statement. In a script that does
141-
not have a `Param` statement, there must be at least two blank lines between the final comment in
142-
the Help topic and the first function declaration. Without these blank lines, `Get-Help` associates
143-
the Help topic with the function, instead of the script.
140+
Notice the blank lines between the closing `#>` and the `Param` statement. In a script that does not
141+
have a `Param` statement, there must be at least two blank lines between the final comment in the
142+
Help topic and the first function declaration. Without these blank lines, `Get-Help` associates the
143+
Help topic with the function, instead of the script.
144144

145145
```powershell
146146
<#
@@ -160,10 +160,10 @@ the Help topic with the function, instead of the script.
160160
saves the output in the local directory.
161161
162162
.INPUTS
163-
None. You cannot pipe objects to Update-Month.ps1.
163+
None. You can't pipe objects to Update-Month.ps1.
164164
165165
.OUTPUTS
166-
None. Update-Month.ps1 does not generate any output.
166+
None. Update-Month.ps1 doesn't generate any output.
167167
168168
.EXAMPLE
169169
PS> .\Update-Month.ps1
@@ -180,8 +180,8 @@ param ([string]$InputPath, [string]$OutPutPath)
180180
function Get-Data { }
181181
```
182182

183-
The following command gets the script Help. Because the script is not in a directory that is listed
184-
in the Path environment variable, the `Get-Help` command that gets the script Help must specify the
183+
The following command gets the script Help. Because the script isn't in a directory that's listed in
184+
the Path environment variable, the `Get-Help` command that gets the script Help must specify the
185185
script path.
186186

187187
```powershell
@@ -231,10 +231,10 @@ PS> Get-Help c:\ps-test\update-month.ps1 -full
231231
"get-help about_commonparameters".
232232
233233
INPUTS
234-
None. You cannot pipe objects to Update-Month.ps1.
234+
None. You can't pipe objects to Update-Month.ps1.
235235
236236
OUTPUTS
237-
None. Update-Month.ps1 does not generate any output.
237+
None. Update-Month.ps1 doesn't generate any output.
238238
239239
-------------------------- EXAMPLE 1 --------------------------
240240
Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
11
---
22
description: File Types Permitted in an Updatable Help CAB File
3-
ms.date: 03/22/2012
3+
ms.date: 07/10/2023
44
ms.topic: reference
55
title: File Types Permitted in an Updatable Help CAB File
66
---
77
# File Types Permitted in an Updatable Help CAB File
88

99
Uncompressed CAB file content is limited to 1 GB by default. To bypass this limit, users have to use
10-
the **Force** parameter of the
11-
[Update-Help](/powershell/module/Microsoft.PowerShell.Core/Update-Help) and
12-
[Save-Help](/powershell/module/Microsoft.PowerShell.Core/Save-Help) cmdlets.
10+
the **Force** parameter of the [Update-Help][02] and [Save-Help][01] cmdlets.
1311

1412
To assure the security of help files that are downloaded from the internet, an Updatable Help CAB
15-
file can include only the file types listed below. The
16-
[Update-Help](/powershell/module/Microsoft.PowerShell.Core/Update-Help) cmdlet validates all files
17-
against the help topic schemas. If the `Update-Help` cmdlet encounters a file that is invalid or is
18-
not a permitted type, it does not install the invalid file and stops installing files from the CAB
19-
on the user's computer.
13+
file can include only the file types listed below. The [Update-Help][02] cmdlet validates all files
14+
against the help topic schemas. If the `Update-Help` cmdlet encounters a file that's invalid or is
15+
not a permitted type, it doesn't install the invalid file and stops installing files from the CAB on
16+
the user's computer.
2017

2118
- XML-based help topics for cmdlets.
2219
- XML-based help topics for scripts and functions.
2320
- XML-based help topics for PowerShell providers.
2421
- Text-based help topics, such as About topics.
2522

26-
The [Update-Help](/powershell/module/Microsoft.PowerShell.Core/Update-Help) verifies the CAB
27-
contents when it unpacks the CAB. If `Update-Help` finds non-compliant file types in an Updatable
28-
Help CAB file, it generates a terminating error and stops the operation. It does not install any
29-
help files from the CAB, even those of compliant file types.
23+
The [Update-Help][02] verifies the CAB contents when it unpacks the CAB. If `Update-Help` finds
24+
non-compliant file types in an Updatable Help CAB file, it generates a terminating error and stops
25+
the operation. It doesn't install any help files from the CAB, even those of compliant file types.
26+
27+
[!INCLUDE [use-platyps](../../../includes/use-platyps.md)]
28+
29+
<!-- link references -->
30+
[01]: /powershell/module/Microsoft.PowerShell.Core/Save-Help
31+
[02]: /powershell/module/Microsoft.PowerShell.Core/Update-Help

reference/docs-conceptual/developer/help/helpinfo-xml-sample-file.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
---
22
description: HelpInfo XML Sample File
3-
ms.date: 09/12/2016
3+
ms.date: 07/10/2023
44
ms.topic: reference
55
title: HelpInfo XML Sample File
66
---
77
# HelpInfo XML Sample File
88

99
This topic displays a sample of a well-formed Updatable Help Information file, commonly known as
1010
"HelpInfo XML file." In this sample file, the UI culture elements are arranged in alphabetical order
11-
by UI culture name. Alphabetical ordering is a best practice, but it is not required.
11+
by UI culture name. Alphabetical ordering is a best practice, but it's not required.
1212

1313
## HelpInfo XML Sample File
1414

1515
```xml
16-
1716
<?xml version="1.0" encoding="utf-8"?>
1817
<HelpInfo xmlns="http://schemas.microsoft.com/powershell/help/2010/05">
1918
<HelpContentURI>https://go.microsoft.com/fwlink/?LinkID=141553</HelpContentURI>
@@ -36,5 +35,6 @@ by UI culture name. Alphabetical ordering is a best practice, but it is not requ
3635
</UICulture>
3736
</SupportedUICultures>
3837
</HelpInfo>
39-
4038
```
39+
40+
[!INCLUDE [use-platyps](../../../includes/use-platyps.md)]

reference/docs-conceptual/developer/help/helpinfo-xml-schema.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: HelpInfo XML Schema
3-
ms.date: 09/12/2016
3+
ms.date: 07/10/2023
44
ms.topic: reference
55
title: HelpInfo XML Schema
66
---
@@ -61,5 +61,10 @@ The HelpInfo XML file includes the following elements.
6161

6262
- **UICultureVersion** - Contains a 4-part version number in "N1.N2.N3.N4" format that represents
6363
the version of the help CAB file in the UI culture. Increment this version number whenever you
64-
upload new help CAB files in the UI culture that is specified by **UICultureName**. For more
65-
information about this value, see [Version Class](/dotnet/api/system.version).
64+
upload new help CAB files in the UI culture that's specified by **UICultureName**. For more
65+
information about this value, see [Version Class][01].
66+
67+
[!INCLUDE [use-platyps](../../../includes/use-platyps.md)]
68+
69+
<!-- link references -->
70+
[01]: /dotnet/api/system.version

reference/docs-conceptual/developer/help/how-to-add-a-cmdlet-description.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
---
22
description: How to Add a Cmdlet Description
3-
ms.date: 09/13/2016
3+
ms.date: 07/10/2023
44
ms.topic: reference
55
title: How to Add a Cmdlet Description
66
---
77
# How to Add a Cmdlet Description
88

9-
This section describes how to add content that is displayed in the **DESCRIPTION** section of the cmdlet
10-
Help. In the Help file, this content is added to the **Command** node for each cmdlet.
9+
[!INCLUDE [use-platyps](../../../includes/use-platyps.md)]
10+
11+
This section describes how to add content that's displayed in the **DESCRIPTION** section of the
12+
cmdlet Help. In the Help file, this content is added to the **Command** node for each cmdlet.
1113

1214
> [!NOTE]
1315
> For a complete view of a Help file, open one of the `dll-Help.xml` files located in the PowerShell
@@ -35,9 +37,12 @@ Help. In the Help file, this content is added to the **Command** node for each c
3537
resource. The security descriptor contains the access control lists (ACLs) of the resource. The
3638
ACL specifies the permissions that users and user groups have to access the resource."
3739

38-
- The detailed description should describe the cmdlet, but it should not describe concepts that the
40+
- The detailed description should describe the cmdlet, but it shouldn't describe concepts that the
3941
cmdlet uses. Place concept definitions in Additional Notes.
4042

4143
## See Also
4244

43-
[Windows PowerShell SDK](../windows-powershell-reference.md)
45+
[Windows PowerShell SDK][01]
46+
47+
<!-- link references -->
48+
[01]: ../windows-powershell-reference.md

reference/docs-conceptual/developer/help/how-to-add-a-see-also-section-to-a-provider-help-topic.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
22
description: How to Add a See Also Section to a Provider Help Topic
3-
ms.date: 09/12/2016
3+
ms.date: 07/10/2023
44
ms.topic: reference
55
title: How to Add a See Also Section to a Provider Help Topic
66
---
77
# How to Add a See Also Section to a Provider Help Topic
88

9+
[!INCLUDE [use-platyps](../../../includes/use-platyps.md)]
10+
911
This section explains how to populate the **SEE ALSO** section of a provider help topic.
1012

1113
The **SEE ALSO** section consists of a list of topics that are related to the provider or might help
@@ -14,8 +16,8 @@ help and conceptual ("about") help topics in Windows PowerShell. It can also inc
1416
books, paper, and online topics, including an online version of the current provider help topic.
1517

1618
When you refer to online topics, provide the URI or a search term in plain text. The `Get-Help`
17-
cmdlet does not link or redirect to any of the topics in the list. Also, the `Online` parameter of
18-
the `Get-Help` cmdlet does not work with provider help.
19+
cmdlet doesn't link or redirect to any of the topics in the list. Also, the `Online` parameter of
20+
the `Get-Help` cmdlet doesn't work with provider help.
1921

2022
The **See Also** section is created from the `RelatedLinks` element and the tags that it contains.
2123
The following XML shows how to add the tags.
@@ -37,7 +39,7 @@ The following XML shows how to add the tags.
3739

3840
1. For each topic in the **SEE ALSO** section, within the `RelatedLinks` element, add a
3941
`navigationLink` element. Then, within each `navigationLink` element, add one `linkText` element
40-
and one `uri` element. If you are not using the `uri` element, you can add it as an empty element
42+
and one `uri` element. If you aren't using the `uri` element, you can add it as an empty element
4143
(\<uri/>).
4244

4345
For example:

0 commit comments

Comments
 (0)