AdvancedHistory

1.0.2

en-US/AdvancedHistory-help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems schema="maml" xmlns="http://msh">

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Enable-AdvancedHistory</command:name>

      <command:verb>Enable</command:verb>

      <command:noun>AdvancedHistory</command:noun>

      <maml:description>

        <maml:para>Enable keyboard navigable history.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Adds a keyboard shortcut (Default: F7) to trigger a keyboard navigable command history of executed commands.</maml:para>

      <maml:para>* Up/Down Arrows: Navigate the list</maml:para>

      <maml:para>* Right/Left Arrows: Change the page</maml:para>

      <maml:para>* Enter/Return: Select the highlighted line item</maml:para>

      <maml:para>* Esc: Cancel</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Enable-AdvancedHistory</maml:name>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="Key">

          <maml:name>Shortcut</maml:name>

          <maml:Description>

            <maml:para>The keyboard shortcut to trigger the history menu. (Default: F7)</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

          <dev:type>

            <maml:name>String</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Unique</maml:name>

          <maml:Description>

            <maml:para>Only display unique executions from the history. (For example, if you have run `cd c:\temp` multiple times only the most recent will appear.)</maml:para>

          </maml:Description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="Key">

        <maml:name>Shortcut</maml:name>

        <maml:Description>

          <maml:para>The keyboard shortcut to trigger the history menu. (Default: F7)</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>

        <dev:type>

          <maml:name>String</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Unique</maml:name>

        <maml:Description>

          <maml:para>Only display unique executions from the history. (For example, if you have run `cd c:\temp` multiple times only the most recent will appear.)</maml:para>

        </maml:Description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>Example 1</maml:title>

        <dev:code>PS C:\&gt; Enable-AdvancedHistory -Unique</dev:code>

        <dev:remarks>

          <maml:para>Enables the AdvancedHistory menu using the defauly F7 keyboard shortcut and will only show unique history items.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Online Version:</maml:linkText>

        <maml:uri></maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

</helpItems>