Skip to content

Latest commit

 

History

History
36 lines (29 loc) · 1.57 KB

how-to-add-notes-to-a-cmdlet-help-topic.md

File metadata and controls

36 lines (29 loc) · 1.57 KB
title ms.custom ms.date ms.reviewer ms.suite ms.tgt_pltfrm ms.topic ms.assetid caps.latest.revision
How to Add Notes to a Cmdlet Help Topic | Microsoft Docs
09/12/2016
article
2bea35e5-b680-4f86-b928-176890aac99d
5

How to Add Notes to a Cmdlet Help Topic

This section describes how to add a Notes section to a Windows PowerShell® cmdlet Help topic. The Notes section is used to explain details that do not fit easily into the other structured sections, such as a more detailed explanation of a parameter. This content could include comments on how the cmdlet works with a specific provider, some unique, yet important, uses of the cmdlet, or ways to avoid possible error conditions.

There are no limits to the number of notes that you can add to a Notes section. For each note, add a pair of <maml:alert> tags to the <maml:alertset> node. The content of each note is added within a set of <maml:para> tags. Use blank <maml:para> tags for spacing.

The following XML shows an <maml:alertset> node with two notes. Notice that each note has an optional <maml:title> tag (titles can be used to group any set of <maml:alert> tags), and that each note has a blank line following the content for spacing.

<maml:alertSet>
  <maml:title>title for Note 1</maml:title>
  <maml:alert>
    <maml:para> Note 1</maml:para>
    <maml:para></maml:para>
  </maml:alert>
  <maml:title>title for Note 2</maml:title>
  <maml:alert>
    <maml:para> Note 1</maml:para>
    <maml:para></maml:para>
  </maml:alert>
</maml:alertSet>