With the editor you can edit all aspects of the help content. Editor UI has a list view to store module commands and four help-related tabs.

Command list

image 

Command list contains a full list of module commands. Command titles are colored depending on its status:

Blue — this is a new command in the module and project file do not have any information about it. When the project is saved, information about new command is saved in the project file too.

Black — the command has an incomplete help content. Incomplete means when either or both, Synopsis and Detailed description fields are empty (see below).

Green — the command has filled mandatory help fields, Synopsis and Detailed description (see below).

Red — the command previously existed in the module and was removed from the module. Commands marked in red are not published in the XML help file and online.

General tab

image

In this tab you can edit the following information:

  • Synopsis — specifies brief information about the command.
    • is mandatory: yes
    • BB-codes allowed: yes
  • Detailed description — specifies detailed information about the command. This should include command behavior, conditions and other specific information.
    • is mandatory: yes
    • BB-codes allowed: yes
  • Notes — provides remarks for the command. You can use this field for authoring. BB-codes are supported;
    • is mandatory: no
    • BB-codes allowed: yes
  • Input type — if the command accepts pipeline input, you can specify the type or types of the object that can be passed through pipeline. If the command do not accept pipeline input, you can leave this field empty or type “None” text. You can specify multiple types by separating them with a semicolon (;) character.
    • is mandatory: no
    • BB-codes allowed: yes ([url] tag should not be used)
  • Input type URLs — provides URLs for input types (for example, to a object type online reference). URLs for each type must be separated with a semicolon (;) character. If particular input type has no URL, an empty semicolon character should be placed.
    • is mandatory: no
    • BB-codes allowed: yes
  • Input type description — combined with previous two fields. Specifies remarks about the input type. For example, instructions how to obtain/generate input object. Descriptions for each type must be separated with a semicolon (;) character. If particular input type has no description, an empty semicolon character should be placed.
    • is mandatory: no
    • BB-codes allowed: yes
  • Return type — specifies object type if the command outputs objects to pipeline. Leave this field empty or type “None” if the command do not return any object.
    • is mandatory: no
    • BB-codes allowed: yes ([url] tag should not be used)
  • Return type URLs — provides URLs for return types (for example, to a object type online reference). URLs for each type must be separated with a semicolon (;) character. If particular return type has no URL, an empty semicolon character should be placed.
    • is mandatory: no
    • BB-codes allowed: yes
  • Return type description — combined with previous two fields. Specifies remarks about returned objects and their types. Descriptions for each type must be separated with a semicolon (;) character. If particular input type has no description, an empty semicolon character should be placed. 
    • is mandatory: no
    • BB-codes allowed: yes

Parameters

This tab is used to review and edit information about each parameter configured for the command. Parameters are picked by selecting them from a list box at the bottom of the tab.

image

The following information about the command can be provided:

  • Parameter description — detailed description about the parameter.
    • is mandatory: yes
    • BB-codes allowed: yes
  • Default value — provide default value for the parameter if parameter has default value in the command metadata (default value is used when no value is specified for the parameter). Leave this field empty if there is no default value. 
    • is mandatory: no
    • BB-codes allowed: no
  • Globbing (checkbox) — specifies whether the parameter accepts wildcards (e.g. “*” and “?”).
    • is mandatory: no
    • BB-codes allowed: no

Also this tab provides various technical information about the command, like object type, pipeline input options, parameter attributes (for example, [ValidateSet()]) and parameter aliases.

Parameter list uses colorized entries:

Blue — this is a new parameter for the command and project file do not have any information about it. When the project is saved, information about new parameter is saved in the project file too.

Green — the command has filled Parameter description field..

Red — the parameter previously existed in the command and was removed. Parameters marked in red are not published in the XML help file and online.

Examples

This tab is used to create and modify example usages of current command.

image

If you want to edit existing example, select example name in the list box. If there are no examples in the list or you want to create a new one, click New button. Click Remove, to remove selected example. If necessary, you can rearrange examples, by clicking Up and Down buttons. The following fields are used to create command example:

  • Example name — specifies example name. Usually it is “Example” keyword with a sequence number. Although, you can put your own name, it is recommended to use default generated name.
    • is mandatory: yes
    • BB-codes allowed: no
  • Example command — specifies the code snippet that displays particular command usage example. If necessary, you can put example output.
    • is mandatory: yes
    • BB-codes allowed: no
  • Example description — specifies detailed description of the current example.
    • is mandatory: yes
    • BB-codes allowed: yes

Note: Example output field is disabled and deprecated.

Related Links

In this tab you can manage a list of related to this commands and online version URL.

image

If you want to edit existing link, select link name in the list box. If there are no links in the list or you want to create a new one, click New button. Click Remove, to remove selected example. If necessary, you can rearrange related links, by clicking Up and Down buttons. The following fields are used to create related link:

  • Related link — usually, specifies related command name.
    • is mandatory: yes
    • BB-codes allowed: no
  • URL — specifies the URL to a related link. URL should be used only for online version.
    • is mandatory: no
    • BB-codes allowed: no

Last edited Jan 2, 2015 at 11:31 AM by camelot, version 9

Comments

No comments yet.