PSMWUpdater.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>PSMWUpdater</name>
    </assembly>
    <members>
        <member name="T:PSMWUpdater.Commands.GetMwExtensionCommand">
            <summary>
            <para type="synopsis">
            Gets a list of extensions either from a local MediaWiki installation, LocalSettings.php,
            or WMF MediaWiki extension registry.
            </para>
            </summary>
            <example>
            <para>Gets extension name list from WMF MediaWiki registry.</para>
            <code>
            PS> Get-MwExtension -BareName
            Name Type
            ---- ----
            3D Extension
            AJAXPoll Extension
            AbsenteeLandlord Extension
            AbuseFilter Extension
            AbuseFilterBypass Extension
            AccessControl Extension
            AccountInfo Extension
            ...
            </code>
            </example>
            <example>
            <para>Gets installed extensions from a MediaWiki installation.</para>
            <code>
            PS> Get-MwExtension -LocalSettingsPath X:\mediawiki-1.33.0
            LineNumber LocalPath Name
            ---------- --------- ----
                     5 X:\mediawiki-1.33.0\skins\CologneBlue Skin:CologneBlue
                     6 X:\mediawiki-1.33.0\skins\Modern Skin:Modern
                     7 X:\mediawiki-1.33.0\skins\MonoBook Skin:MonoBook
                     8 X:\mediawiki-1.33.0\skins\Vector Skin:Vector
                     9 X:\mediawiki-1.33.0\skins\Timeless Skin:Timeless
                    22 X:\mediawiki-1.33.0\extensions\Babel Extension:Babel
                    23 X:\mediawiki-1.33.0\extensions\Cite Extension:Cite
            ...
            </code>
            </example>
            <example>
            <para>Gets installed extensions from a local MediaWiki installation.</para>
            <code>
            PS> Get-MwExtension -InstallationPath X:\mediawiki-1.33.0
            Name Branch Version Revision RevisionTime LocalPath
            ---- ------ ------- -------- ------------ ---------
            Extension:CategoryTree X:\mediawiki-1.33.0\extensions\CategoryTree
            Extension:Cite 1.0.0 X:\mediawiki-1.33.0\extensions\Cite
            Extension:CiteThisPage X:\mediawiki-1.33.0\extensions\CiteThisPage
            Extension:CodeEditor X:\mediawiki-1.33.0\extensions\CodeEditor
            Extension:InputBox 0.3.0 X:\mediawiki-1.33.0\extensions\InputBox
            Extension:intersection REL1_33 1.7.0 05edc37 6/17/2019 7:24:11 PM X:\mediawiki-1.33.0\extensions\intersection
            Extension:Interwiki 3.1 201… X:\mediawiki-1.33.0\extensions\Interwiki
            Extension:LocalisationUpdate 1.4.0 X:\mediawiki-1.33.0\extensions\LocalisationUpdate
            ...
            </code>
            </example>
        </member>
        <member name="P:PSMWUpdater.Commands.GetMwExtensionCommand.InstallationPath">
            <summary>
            <para type="description">Path of the local MediaWiki installation.</para>
            <para type="description">If specified, gets all the installed extensions from a local MediaWiki installation.</para>
            </summary>
        </member>
        <member name="P:PSMWUpdater.Commands.GetMwExtensionCommand.LocalSettingsPath">
            <summary>
            <para type="description">Path of the LocalSettings.php file. If a folder is specified, it will be appended LocalSettings.php automatically.</para>
            <para type="description">If specified, parses the file and outputs all the extensions and/or skins referenced in the file.</para>
            </summary>
        </member>
        <member name="P:PSMWUpdater.Commands.GetMwExtensionCommand.BareName">
            <summary>
            <para type="description">Return bare <see cref="T:PSMWUpdater.ExtensionName"/> instead of <see cref="T:PSMWUpdater.LocalExtensionInfo"/>-derived class.</para>
            </summary>
        </member>
        <member name="P:PSMWUpdater.Commands.GetMwExtensionCommand.Type">
            <summary>
            <para type="description">Only list extensions of this type.</para>
            </summary>
        </member>
        <member name="M:PSMWUpdater.Commands.GetMwExtensionCommand.ProcessRecordAsync(System.Threading.CancellationToken)">
            <inheritdoc />
        </member>
        <member name="T:PSMWUpdater.Commands.GetMwExtensionBranchCommand">
            <summary>
            <para type="synopsis">
            Gets the branch information about one or more MediaWiki extensions, including their download URLs.
            </para>
            </summary>
            <example>
            <para>Ask for the latest `REL` branch.</para>
            <para></para>
            <code>
            PS&gt; Get-MwExtensionBranch -Name Vector, Echo
            ExtensionName BranchName Url
            ------------- ---------- ---
            Extension:Echo REL1_33 https://extdist.wmflabs.org/dist/extensions/Echo-REL1_33-f106596.tar.gz
            Skin:Vector REL1_33 https://extdist.wmflabs.org/dist/skins/Vector-REL1_33-878c1e8.tar.gz
            </code>
            </example>
            <example>
            <para>Ask for a specific branch instead of latest `REL` branch.</para>
            <para></para>
            <code>
            PS&gt; Get-MwExtensionBranch -Name Vector, Echo
            ExtensionName BranchName Url
            ------------- ---------- ---
            Extension:Echo REL1_33 https://extdist.wmflabs.org/dist/extensions/Echo-REL1_33-f106596.tar.gz
            Skin:Vector REL1_33 https://extdist.wmflabs.org/dist/skins/Vector-REL1_33-878c1e8.tar.gz
            </code>
            </example>
            <example>
            <para>Ask for all the known branches.</para>
            <para></para>
            <code>
            PS&gt; Get-MwExtensionBranch -Name Vector, Echo -AllBranches
             
            ExtensionName BranchName Url
            ------------- ---------- ---
            Extension:Echo REL1_31 https://extdist.wmflabs.org/dist/extensions/Echo-REL1_31-b56ec9b.tar.gz
            Extension:Echo REL1_32 https://extdist.wmflabs.org/dist/extensions/Echo-REL1_32-335389f.tar.gz
            Extension:Echo REL1_33 https://extdist.wmflabs.org/dist/extensions/Echo-REL1_33-f106596.tar.gz
            Extension:Echo master https://extdist.wmflabs.org/dist/extensions/Echo-master-4c991af.tar.gz
            Extension:Echo source https://gerrit.wikimedia.org/r/mediawiki/extensions/Echo.git
            Skin:Vector REL1_31 https://extdist.wmflabs.org/dist/skins/Vector-REL1_31-f0327dc.tar.gz
            Skin:Vector REL1_32 https://extdist.wmflabs.org/dist/skins/Vector-REL1_32-d3ed21a.tar.gz
            Skin:Vector REL1_33 https://extdist.wmflabs.org/dist/skins/Vector-REL1_33-878c1e8.tar.gz
            Skin:Vector master https://extdist.wmflabs.org/dist/skins/Vector-master-bf365aa.tar.gz
            Skin:Vector source https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git
            </code>
            </example>
        </member>
        <member name="P:PSMWUpdater.Commands.GetMwExtensionBranchCommand.Name">
            <summary>
            <para type="description">One or more names of the extensions to fetch information.</para>
            <para type="description">If there is ambiguity on whether the extension is a skin, prefix the extension name with `Extension:` or `Skin:`.</para>
            </summary>
        </member>
        <member name="P:PSMWUpdater.Commands.GetMwExtensionBranchCommand.Branch">
            <summary>
            <para type="description">One or more version branches for the extension (e.g. "REL1_32", or "master").</para>
            <para type="description">If `AllBranches` is not specified, the first matching branch is fetched.
            Otherwise, all the matching branches are fetched.</para>
            <para type="description">If `AllBranches` is not specified and this parameter is neglected,
            the cmdlet will return the latest REL branch.</para>
            </summary>
        </member>
        <member name="P:PSMWUpdater.Commands.GetMwExtensionBranchCommand.AllBranches">
            <summary>
            <para type="description">Return all the matching branches instead of only the first matching branch.</para>
            </summary>
        </member>
        <member name="P:PSMWUpdater.Commands.GetMwExtensionBranchCommand.SuppressRedirect">
            <summary>
            <para type="description">Whether to suppress the attempt to look for extension redirects
            (e.g. SyntaxHighlight --> SyntaxHighlight GeSHi).</para>
            </summary>
        </member>
        <member name="M:PSMWUpdater.Commands.GetMwExtensionBranchCommand.BeginProcessing">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.Commands.GetMwExtensionBranchCommand.ProcessRecordAsync(System.Threading.CancellationToken)">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.Commands.GetMwExtensionBranchCommand.EndProcessingAsync(System.Threading.CancellationToken)">
            <inheritdoc />
        </member>
        <member name="T:PSMWUpdater.Commands.GetMwSiteInfoCommand">
            <summary>
            <para type="synopsis">
            Gets the basic information of a MediaWiki installation.
            </para>
            </summary>
        </member>
        <member name="P:PSMWUpdater.Commands.GetMwSiteInfoCommand.InstallationPath">
            <summary>
            <para type="description">Specify the root of a local MediaWiki installation.</para>
            </summary>
        </member>
        <member name="M:PSMWUpdater.Commands.GetMwSiteInfoCommand.ProcessRecord">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.Infrastructures.PSAsyncCmdlet.BeginProcessing">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.Infrastructures.PSAsyncCmdlet.ProcessRecord">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.Infrastructures.PSAsyncCmdlet.StopProcessing">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.Infrastructures.PSAsyncCmdlet.EndProcessing">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.Infrastructures.PSSyncCmdlet.BeginProcessing">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.Infrastructures.PSSyncCmdlet.StopProcessing">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.Infrastructures.PSSyncCmdlet.Dispose">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.Infrastructures.QueueSynchronizationContext.Send(System.Threading.SendOrPostCallback,System.Object)">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.Infrastructures.QueueSynchronizationContext.Post(System.Threading.SendOrPostCallback,System.Object)">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.Infrastructures.QueueSynchronizationContext.CreateCopy">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.Infrastructures.QueueSynchronizationContext.Dispose">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.MediaWikiInstallation.ToString">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.ExtensionName.ToString">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.ExtensionName.Equals(PSMWUpdater.ExtensionName)">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.ExtensionName.Equals(System.Object)">
            <inheritdoc />
        </member>
        <member name="M:PSMWUpdater.ExtensionName.GetHashCode">
            <inheritdoc />
        </member>
        <member name="T:PSMWUpdater.LocalExtensionInfo">
            <summary>
            Contains information about an extension that is installed locally.
            </summary>
        </member>
        <member name="P:PSMWUpdater.LocalExtensionInfo.LocalPath">
            <summary>
            Local path of the extension root folder.
            </summary>
        </member>
        <member name="P:PSMWUpdater.LocalExtensionInfo.LastWriteTime">
            <summary>
            Max last write time.
            </summary>
        </member>
        <member name="T:PSMWUpdater.LocalSettingsExtensionInfo">
            <summary>
            Contains information about an extension that is referred in <c>LocalSettings.php</c>.
            </summary>
        </member>
        <member name="T:PSMWUpdater.ExtensionBranchInfo">
            <summary>
            Describe a specific branch of an MediaWiki extension.
            </summary>
        </member>
    </members>
</doc>