en-US/ConvertPDFtoTXT.psm1-Help.xml

<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" schema="maml">
    <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">
        <command:details>
            <command:name>Convert-PDF2TXT</command:name>
            <maml:description>
                <maml:para>Convert-PDF2TXT converts PDF to text</maml:para>
 
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>Convert</command:verb>
            <command:noun>PDF2TXT</command:noun>
            <dev:version/>
        </command:details>
        <maml:description>
                <maml:para>Convert PDF file to raw text format. Just type the path to the PDF file.
Use Get-Help Convert-PDF2TXT -Examples</maml:para>
 
        </maml:description>
        <command:syntax>
            <command:syntaxItem parametersetname="__AllParameterSets">
                <maml:name>Convert-PDF2TXT</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
                    <maml:name>PDFPath</maml:name>
                    <maml:description>
                        <maml:para>Enter full path to the PDF file.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
                <maml:name>PDFPath</maml:name>
                <maml:description>
                    <maml:para>Enter full path to the PDF file.</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></dev:defaultValue>
            </command:parameter>
        </command:parameters>
        <maml:alertSet>
            <maml:title></maml:title>
            <maml:alert>
                <maml:para>by chixus - CHXOFT &#169;2023.</maml:para>
            </maml:alert>
        </maml:alertSet>
        <command:examples>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para></maml:para>
                </maml:introduction>
                <dev:code>PS C:\&gt;Convert-PDF2TXT -PDFPath C:\mypdf.PDF
</dev:code>
                <dev:remarks>
                    <maml:para>- Returns converted PDF text.
 
PS C:\&gt;$ConvertedPDFText = Convert-PDF2TXT -PDFPath C:\mypdf.PDF
- Adds converted text to string.
 
PS C:\&gt;Convert-PDF2TXT -PDFPath C:\mypdf.PDF &gt;&gt; convertedPDFtext.txt
- Adds converted text to file.</maml:para>
 
                </dev:remarks>
            </command:example>
        </command:examples>
    </command:command>
</helpItems>