VeilVer

1.1.0

en-US/VeilVer-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>Get-VVVersion</command:name>

      <command:verb>Get</command:verb>

      <command:noun>VVVersion</command:noun>

      <maml:description>

        <maml:para>Gets the hidden version of a document.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Gets the hidden version of a document, based on git tags on the blob.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-VVVersion</maml:name>

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

          <maml:name>Path</maml:name>

          <maml:description>

            <maml:para>The path to the document to get the hidden versions of.</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:syntaxItem>

    </command:syntax>

    <command:parameters>

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

        <maml:name>Path</maml:name>

        <maml:description>

          <maml:para>The path to the document to get the hidden versions of.</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: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>System.Object</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; Get-VVVersion -DocumentPath "C:\path\to\document.md"</dev:code>

        <dev:remarks>

          <maml:para>Gets the hidden version of the document at "C:\path\to\document.md".</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <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>Remove-VVVersion</command:name>

      <command:verb>Remove</command:verb>

      <command:noun>VVVersion</command:noun>

      <maml:description>

        <maml:para>Remove a specific version from a file.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Remove a specific version from a file.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Remove-VVVersion</maml:name>

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

          <maml:name>Path</maml:name>

          <maml:description>

            <maml:para>The path to the file to remove the hidden version from.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>Version</maml:name>

          <maml:description>

            <maml:para>The version to remove from the file.</maml:para>

          </maml:description>

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

          <dev:type>

            <maml:name>Version</maml:name>

            <maml:uri />

          </dev:type>

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

        </command:parameter>

      </command:syntaxItem>

      <command:syntaxItem>

        <maml:name>Remove-VVVersion</maml:name>

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

          <maml:name>Tag</maml:name>

          <maml:description>

            <maml:para>The full version tag to remove, instead of a specific file and version, such as "VV/path/to/file/v1.0.0"</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:syntaxItem>

    </command:syntax>

    <command:parameters>

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

        <maml:name>Path</maml:name>

        <maml:description>

          <maml:para>The path to the file to remove the hidden version from.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Tag</maml:name>

        <maml:description>

          <maml:para>The full version tag to remove, instead of a specific file and version, such as "VV/path/to/file/v1.0.0"</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="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>Version</maml:name>

        <maml:description>

          <maml:para>The version to remove from the file.</maml:para>

        </maml:description>

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

        <dev:type>

          <maml:name>Version</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</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>System.Object</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; Remove-VVVersion -Path "C:\path\to\document.md" -Version 1.0.0</dev:code>

        <dev:remarks>

          <maml:para>Remove the version 1.0.0 from the file at the specified path.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <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>Set-VVVersion</command:name>

      <command:verb>Set</command:verb>

      <command:noun>VVVersion</command:noun>

      <maml:description>

        <maml:para>Sets the hidden version of a document.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Sets the hidden version of a document, based on git tags on the blob.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Set-VVVersion</maml:name>

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

          <maml:name>Path</maml:name>

          <maml:description>

            <maml:para>The path to the document to set the hidden versions of.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">

          <maml:name>Version</maml:name>

          <maml:description>

            <maml:para>The semantic version of the document to set.</maml:para>

          </maml:description>

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

          <dev:type>

            <maml:name>Version</maml:name>

            <maml:uri />

          </dev:type>

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

        </command:parameter>

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

          <maml:name>Metadata</maml:name>

          <maml:description>

            <maml:para>The metadata to set with the document version.</maml:para>

          </maml:description>

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

          <dev:type>

            <maml:name>Hashtable</maml:name>

            <maml:uri />

          </dev:type>

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

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

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

        <maml:name>Metadata</maml:name>

        <maml:description>

          <maml:para>The metadata to set with the document version.</maml:para>

        </maml:description>

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

        <dev:type>

          <maml:name>Hashtable</maml:name>

          <maml:uri />

        </dev:type>

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

      </command:parameter>

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

        <maml:name>Path</maml:name>

        <maml:description>

          <maml:para>The path to the document to set the hidden versions of.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">

        <maml:name>Version</maml:name>

        <maml:description>

          <maml:para>The semantic version of the document to set.</maml:para>

        </maml:description>

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

        <dev:type>

          <maml:name>Version</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</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>System.Object</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; Set-VVVersion -Path "C:\path\to\document.md" -Version "v1.0.0" -Metadata @{ Comment = "Initial release"; Author = "Emanuel Palm" }</dev:code>

        <dev:remarks>

          <maml:para>Sets the hidden version of the file at "C:\path\to\document.md" to "v1.0.0" with a comment and an author.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

</helpItems>