OfficeRTool

1.0.2.0

en-US/OfficeRTool.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>Get-RTool</command:name>

            <maml:description>

                <maml:para>Office&#174;Tool downloader and secure installer.</maml:para>

            </maml:description>

            <maml:copyright>

                <maml:para/>

            </maml:copyright>

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

            <command:noun>RTool</command:noun>

            <dev:version/>

        </command:details>

        <maml:description>

            <maml:para>Downloads and unpack the latest Office&#174;Tool to specified path.

If path is not specified it will be donwloaded to your Deskotop.

BE SURE THAT ANTIVIRUS REALTIME PROTECTION IS DISABLED BEFORE USING.</maml:para>

        </maml:description>

        <command:syntax>

            <command:syntaxItem parametersetname="__AllParameterSets">

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

                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0">

                    <maml:name>DownloadPath</maml:name>

                    <maml:description>

                        <maml:para>Path where Tool will be unpacked at its working folder. Avoid path with spaces and special characters.</maml:para>

                    </maml:description>

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

                </command:parameter>

                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1">

                    <maml:name>RToolFolderName</maml:name>

                    <maml:description>

                        <maml:para>Type name od folder in download path where tool will be extracted.</maml:para>

                    </maml:description>

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

                </command:parameter>

                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2">

                    <maml:name>CheckWindowsDefender</maml:name>

                    <maml:description>

                        <maml:para>Check if Windows Defender Realtime Protection is enabled, script will add the download folder to exclusion.</maml:para>

                    </maml:description>

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

                </command:parameter>

                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3">

                    <maml:name>InstallSecured</maml:name>

                    <maml:description>

                        <maml:para>After getting Office&#174;Tool it will be placed at $env:ProgramData\rtl\ packed in 7-zip archive with password so Antivirus cannot detect it false positive.</maml:para>

                    </maml:description>

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

                </command:parameter>

            </command:syntaxItem>

        </command:syntax>

        <command:parameters>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0">

                <maml:name>DownloadPath</maml:name>

                <maml:description>

                    <maml:para>Path where Tool will be unpacked at its working folder. Avoid path with spaces and special characters.</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/>

            </command:parameter>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1">

                <maml:name>RToolFolderName</maml:name>

                <maml:description>

                    <maml:para>Type name od folder in download path where tool will be extracted.</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/>

            </command:parameter>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2">

                <maml:name>CheckWindowsDefender</maml:name>

                <maml:description>

                    <maml:para>Check if Windows Defender Realtime Protection is enabled, script will add the download folder to exclusion.</maml:para>

                </maml:description>

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

                <dev:type>

                    <maml:name>switch</maml:name>

                    <maml:uri/>

                </dev:type>

                <dev:defaultValue/>

            </command:parameter>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3">

                <maml:name>InstallSecured</maml:name>

                <maml:description>

                    <maml:para>After getting Office&#174;Tool it will be placed at $env:ProgramData\rtl\ packed in 7-zip archive with password so Antivirus cannot detect it false positive.</maml:para>

                </maml:description>

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

                <dev:type>

                    <maml:name>switch</maml:name>

                    <maml:uri/>

                </dev:type>

                <dev:defaultValue/>

            </command:parameter>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3">

                <maml:name>i</maml:name>

                <maml:description>

                    <maml:para/>

                </maml:description>

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

                <dev:type>

                    <maml:name>switch</maml:name>

                    <maml:uri/>

                </dev:type>

                <dev:defaultValue/>

            </command:parameter>

        </command:parameters>

        <maml:alertSet>

            <maml:title/>

            <maml:alert>

                <maml:para>Additional modules needed, it will be installed automatically.

Modules required: 7Zip4Powershell, AntivirusProductsDetailedStatus, ConvertPDFtoTXT

by chixus &#169;2024. - CHXOFT</maml:para>

            </maml:alert>

        </maml:alertSet>

        <command:examples>

            <command:example>

                <maml:title>--------------------------  EXAMPLE 1  --------------------------</maml:title>

                <maml:introduction>

                    <maml:para/>

                </maml:introduction>

                <dev:code>PS C:\&gt; Get-RTool -Path &quot;C:\Temp&quot;

                </dev:code>

                <dev:remarks>

                    <maml:para>PS C:\&gt; Get-RTool -Path &quot;C:\&quot; -RToolFolderName &quot;myTool&quot;

PS C:\&gt; Get-RTool -InstallSecured</maml:para>

                </dev:remarks>

            </command:example>

        </command:examples>

    </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">

        <command:details>

            <command:name>Start-Rtool</command:name>

            <maml:description>

                <maml:para>Start secure installed Office&#174;Tool.</maml:para>

            </maml:description>

            <maml:copyright>

                <maml:para/>

            </maml:copyright>

            <command:verb>Start</command:verb>

            <command:noun>Rtool</command:noun>

            <dev:version/>

        </command:details>

        <maml:description>

            <maml:para>Securely start installed Office&#174;Tool.</maml:para>

        </maml:description>

        <command:syntax>

            <command:syntaxItem parametersetname="__AllParameterSets">

                <maml:name>Start-Rtool</maml:name>

                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0">

                    <maml:name>ReadPDF</maml:name>

                    <maml:description>

                        <maml:para>Get content of PDF instruction file.</maml:para>

                    </maml:description>

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

                </command:parameter>

                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1">

                    <maml:name>EditINIFile</maml:name>

                    <maml:description>

                        <maml:para>A description of the EditINIFile parameter.</maml:para>

                    </maml:description>

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

                </command:parameter>

                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2">

                    <maml:name>CheckWindowsDefender</maml:name>

                    <maml:description>

                        <maml:para>Checks Windows Defender realtime protection.</maml:para>

                    </maml:description>

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

                </command:parameter>

            </command:syntaxItem>

        </command:syntax>

        <command:parameters>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0">

                <maml:name>ReadPDF</maml:name>

                <maml:description>

                    <maml:para>Get content of PDF instruction file.</maml:para>

                </maml:description>

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

                <dev:type>

                    <maml:name>switch</maml:name>

                    <maml:uri/>

                </dev:type>

                <dev:defaultValue/>

            </command:parameter>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0">

                <maml:name>instructions</maml:name>

                <maml:description>

                    <maml:para/>

                </maml:description>

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

                <dev:type>

                    <maml:name>switch</maml:name>

                    <maml:uri/>

                </dev:type>

                <dev:defaultValue/>

            </command:parameter>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1">

                <maml:name>EditINIFile</maml:name>

                <maml:description>

                    <maml:para>A description of the EditINIFile parameter.</maml:para>

                </maml:description>

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

                <dev:type>

                    <maml:name>switch</maml:name>

                    <maml:uri/>

                </dev:type>

                <dev:defaultValue/>

            </command:parameter>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1">

                <maml:name>set</maml:name>

                <maml:description>

                    <maml:para/>

                </maml:description>

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

                <dev:type>

                    <maml:name>switch</maml:name>

                    <maml:uri/>

                </dev:type>

                <dev:defaultValue/>

            </command:parameter>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2">

                <maml:name>CheckWindowsDefender</maml:name>

                <maml:description>

                    <maml:para>Checks Windows Defender realtime protection.</maml:para>

                </maml:description>

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

                <dev:type>

                    <maml:name>switch</maml:name>

                    <maml:uri/>

                </dev:type>

                <dev:defaultValue/>

                </command:parameter>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3">

                <maml:name>IgnoreAntivirusProduct</maml:name>

                <maml:description>

                    <maml:para>Ignores any antivirus product realtime protection including  Windows Defender.</maml:para>

                </maml:description>

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

                <dev:type>

                    <maml:name>switch</maml:name>

                    <maml:uri/>

                </dev:type>

                <dev:defaultValue/>                

                </command:parameter>

            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3">

                <maml:name>i</maml:name>

                <maml:description>

                    <maml:para/>

                </maml:description>

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

                <dev:type>

                    <maml:name>switch</maml:name>

                    <maml:uri/>

                </dev:type>

                <dev:defaultValue/>                

            </command:parameter>

        </command:parameters>

        <maml:alertSet>

            <maml:title/>

            <maml:alert>

                <maml:para>Additional modules needed, it will be installed automatically.

Modules required: 7Zip4Powershell, AntivirusProductsDetailedStatus, ConvertPDFtoTXT

by chixus &#169;2024. - CHXOFT</maml:para>

            </maml:alert>

        </maml:alertSet>

        <command:examples>

            <command:example>

                <maml:title>--------------------------  EXAMPLE 1  --------------------------</maml:title>

                <maml:introduction>

                    <maml:para/>

                </maml:introduction>

                <dev:code>PS C:\&gt; Start-Rtool

                </dev:code>

                <dev:remarks>

                    <maml:para>PS C:\&gt; Start-Rtool -instructions

PS C:\&gt; Start-Rtool -set</maml:para>

                </dev:remarks>

            </command:example>

        </command:examples>

    </command:command>

</helpItems>