QiitaDrive

0.1.0

en-US/QiitaDrive-help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems 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" schema="maml" xmlns="http://msh">
  <command:command>
    <command:details>
      <command:name>Copy-QiitaItem</command:name>
      <maml:description>
        <maml:para>Qiita 記事をファイルシステムにコピーします。</maml:para>
      </maml:description>
      <command:verb>Copy</command:verb>
      <command:noun>QiitaItem</command:noun>
    </command:details>
    <maml:description>
      <maml:para>Qiita ドライブ上の記事 (.md ファイル) をローカルファイルシステムにコピーします。 ワイルドカードに対応しており、複数記事の一括コピーが可能です。 内部的には Get-Content と Set-Content を使用して、異なるプロバイダ間のコピーを実現しています。</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Copy-QiitaItem</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Confirm</maml:name>
          <maml:description>
            <maml:para>実行前に確認を求めます。</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue>
        </command:parameter>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
          <maml:name>Destination</maml:name>
          <maml:description>
            <maml:para>コピー先のパス。複数ファイルをコピーする場合は既存のディレクトリを指定してください。</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue>
        </command:parameter>
        <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none">
          <maml:name>Path</maml:name>
          <maml:description>
            <maml:para>コピー元の Qiita ドライブパス。ワイルドカード (* や ?) が使用できます。</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>WhatIf</maml:name>
          <maml:description>
            <maml:para>実行内容を表示しますが、実際には実行しません。</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>Copy-QiitaItem</maml:name>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>Confirm</maml:name>
          <maml:description>
            <maml:para>実行前に確認を求めます。</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue>
        </command:parameter>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
          <maml:name>Destination</maml:name>
          <maml:description>
            <maml:para>コピー先のパス。複数ファイルをコピーする場合は既存のディレクトリを指定してください。</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue>
        </command:parameter>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="PSPath">
          <maml:name>LiteralPath</maml:name>
          <maml:description>
            <maml:para>コピー元の Qiita ドライブパス。ワイルドカード文字をエスケープせずそのまま使用します。
dir の出力をパイプで渡すと PSPath プロパティから自動バインドされます。</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
          <maml:name>WhatIf</maml:name>
          <maml:description>
            <maml:para>実行内容を表示しますが、実際には実行しません。</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>Confirm</maml:name>
        <maml:description>
          <maml:para>実行前に確認を求めます。</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue>
      </command:parameter>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">
        <maml:name>Destination</maml:name>
        <maml:description>
          <maml:para>コピー先のパス。複数ファイルをコピーする場合は既存のディレクトリを指定してください。</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue>
      </command:parameter>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>LiteralPath</maml:name>
        <maml:description>
          <maml:para>コピー元の Qiita ドライブパス。ワイルドカード文字をエスケープせずそのまま使用します。
dir の出力をパイプで渡すと PSPath プロパティから自動バインドされます。</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue>
      </command:parameter>
      <command:parameter required="true" variableLength="false" globbing="true" pipelineInput="false" position="0" aliases="none">
        <maml:name>Path</maml:name>
        <maml:description>
          <maml:para>コピー元の Qiita ドライブパス。ワイルドカード (* や ?) が使用できます。</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue>
      </command:parameter>
      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">
        <maml:name>WhatIf</maml:name>
        <maml:description>
          <maml:para>実行内容を表示しますが、実際には実行しません。</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="true">System.Management.Automation.SwitchParameter</command:parameterValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <dev:name>System.String</dev:name>
        </dev:type>
        <maml:description>
          <maml:para>-LiteralPath パラメータへの PSPath プロパティによるパイプライン入力 (ValueFromPipelineByPropertyName)。</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <dev:name>None</dev:name>
        </dev:type>
        <maml:description>
          <maml:para />
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>PowerShell の Copy-Item は異なるプロバイダ間のコピーをサポートしていないため、この関数が代替手段を提供します。</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>--------- Example 1: 記事を1つコピー ---------</maml:title>
        <maml:introduction>
          <maml:para>```powershell
PS C:\&gt; Copy-QiitaItem Qiita:\Me\Items\abc1234_Title.md C:\articles\
```</maml:para>
        </maml:introduction>
        <dev:code />
        <dev:remarks />
      </command:example>
      <command:example>
        <maml:title>--------- Example 2: ワイルドカードで一括コピー ---------</maml:title>
        <maml:introduction>
          <maml:para>```powershell
PS C:\&gt; Copy-QiitaItem Qiita:\Tags\PowerShell\*.md C:\temp\
```</maml:para> <maml:para>PowerShell タグの全記事をコピーします。</maml:para>
        </maml:introduction>
        <dev:code />
        <dev:remarks />
      </command:example>
      <command:example>
        <maml:title>--------- Example 3: パターンで絞り込み ---------</maml:title>
        <maml:introduction>
          <maml:para>```powershell
PS C:\&gt; Copy-QiitaItem Qiita:\Me\Items\*git*.md C:\articles\ -Verbose
```</maml:para> <maml:para>タイトルに "git" を含む自分の記事をコピーします。</maml:para>
        </maml:introduction>
        <dev:code />
        <dev:remarks />
      </command:example>
      <command:example>
        <maml:title>--------- Example 4: WhatIf で確認 ---------</maml:title>
        <maml:introduction>
          <maml:para>```powershell
PS C:\&gt; Copy-QiitaItem Qiita:\Me\Items\*.md C:\backup\ -WhatIf
```</maml:para> <maml:para>実際にはコピーせず、何がコピーされるかを確認します。</maml:para>
        </maml:introduction>
        <dev:code />
        <dev:remarks />
      </command:example>
      <command:example>
        <maml:title>--------- Example 5: パイプラインでコピー ---------</maml:title>
        <maml:introduction>
          <maml:para>```powershell
PS C:\&gt; dir Qiita:\Me\Items -First 10 | Copy-QiitaItem -Destination C:\backup\
```</maml:para> <maml:para>dir の出力を直接パイプで渡してコピーします。PSPath プロパティが -LiteralPath に自動バインドされます。</maml:para>
        </maml:introduction>
        <dev:code />
        <dev:remarks />
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>New-QiitaDrive</maml:linkText>
        <command:uri />
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
</helpItems>