PSMWUpdater.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-MwExtension --> <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-MwExtension</command:name> <command:verb>Get</command:verb> <command:noun>MwExtension</command:noun> <maml:description> <maml:para>Gets a list of extensions either from a local MediaWiki installation, LocalSettings.php, or WMF MediaWiki extension registry.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: Local --> <command:syntaxItem> <maml:name>Get-MwExtension</maml:name> <!-- Parameter: InstallationPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InstallationPath</maml:name> <maml:description> <maml:para>Path of the local MediaWiki installation.</maml:para> <maml:para>If specified, gets all the installed extensions from a local MediaWiki installation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Only list extensions of this type.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: LocalName --> <command:syntaxItem> <maml:name>Get-MwExtension</maml:name> <!-- Parameter: InstallationPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InstallationPath</maml:name> <maml:description> <maml:para>Path of the local MediaWiki installation.</maml:para> <maml:para>If specified, gets all the installed extensions from a local MediaWiki installation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BareName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BareName</maml:name> <maml:description> <maml:para>Return bare ExtensionName instead of LocalExtensionInfo-derived class.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Only list extensions of this type.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: LocalSettings --> <command:syntaxItem> <maml:name>Get-MwExtension</maml:name> <!-- Parameter: LocalSettingsPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>LocalSettingsPath</maml:name> <maml:description> <maml:para>Path of the LocalSettings.php file. If a folder is specified, it will be appended LocalSettings.php automatically.</maml:para> <maml:para>If specified, parses the file and outputs all the extensions and/or skins referenced in the file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Only list extensions of this type.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: LocalSettingsName --> <command:syntaxItem> <maml:name>Get-MwExtension</maml:name> <!-- Parameter: LocalSettingsPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>LocalSettingsPath</maml:name> <maml:description> <maml:para>Path of the LocalSettings.php file. If a folder is specified, it will be appended LocalSettings.php automatically.</maml:para> <maml:para>If specified, parses the file and outputs all the extensions and/or skins referenced in the file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BareName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BareName</maml:name> <maml:description> <maml:para>Return bare ExtensionName instead of LocalExtensionInfo-derived class.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Only list extensions of this type.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: RemoteName --> <command:syntaxItem> <maml:name>Get-MwExtension</maml:name> <!-- Parameter: BareName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BareName</maml:name> <maml:description> <maml:para>Return bare ExtensionName instead of LocalExtensionInfo-derived class.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Only list extensions of this type.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> <!-- Parameter set: Remote --> <command:syntaxItem> <maml:name>Get-MwExtension</maml:name> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Only list extensions of this type.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InstallationPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>InstallationPath</maml:name> <maml:description> <maml:para>Path of the local MediaWiki installation.</maml:para> <maml:para>If specified, gets all the installed extensions from a local MediaWiki installation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LocalSettingsPath --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>LocalSettingsPath</maml:name> <maml:description> <maml:para>Path of the LocalSettings.php file. If a folder is specified, it will be appended LocalSettings.php automatically.</maml:para> <maml:para>If specified, parses the file and outputs all the extensions and/or skins referenced in the file.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: BareName --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>BareName</maml:name> <maml:description> <maml:para>Return bare ExtensionName instead of LocalExtensionInfo-derived class.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Only list extensions of this type.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ExtensionInfo --> <command:returnValue> <dev:type> <maml:name>PSMWUpdater.ExtensionInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: ExtensionName --> <command:returnValue> <dev:type> <maml:name>PSMWUpdater.ExtensionName</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: LocalExtensionInfo --> <command:returnValue> <dev:type> <maml:name>PSMWUpdater.LocalExtensionInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> <!-- OutputType: LocalSettingsExtensionInfo --> <command:returnValue> <dev:type> <maml:name>PSMWUpdater.LocalSettingsExtensionInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Gets extension name list from WMF MediaWiki registry.</maml:para> </maml:introduction> <dev:code>PS> Get-MwExtension -BareName Name Type ---- ---- 3D Extension AJAXPoll Extension AbsenteeLandlord Extension AbuseFilter Extension AbuseFilterBypass Extension AccessControl Extension AccountInfo Extension ...</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Gets installed extensions from a MediaWiki installation.</maml:para> </maml:introduction> <dev: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 ...</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Gets installed extensions from a local MediaWiki installation.</maml:para> </maml:introduction> <dev: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 ...</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-MwExtensionBranch --> <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-MwExtensionBranch</command:name> <command:verb>Get</command:verb> <command:noun>MwExtensionBranch</command:noun> <maml:description> <maml:para>Gets the branch information about one or more MediaWiki extensions, including their download URLs.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-MwExtensionBranch</maml:name> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>One or more names of the extensions to fetch information.</maml:para> <maml:para>If there is ambiguity on whether the extension is a skin, prefix the extension name with `Extension:` or `Skin:`.</maml:para> </maml:description> <command:parameterValue required="true">ExtensionName[]</command:parameterValue> <dev:type> <maml:name>PSMWUpdater.ExtensionName[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllBranches --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllBranches</maml:name> <maml:description> <maml:para>Return all the matching branches instead of only the first matching branch.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Branch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Branch</maml:name> <maml:description> <maml:para>One or more version branches for the extension (e.g. "REL1_32", or "master").</maml:para> <maml:para>If `AllBranches` is not specified, the first matching branch is fetched. Otherwise, all the matching branches are fetched.</maml:para> <maml:para>If `AllBranches` is not specified and this parameter is neglected, the cmdlet will return the latest REL branch.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SuppressRedirect --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SuppressRedirect</maml:name> <maml:description> <maml:para>Whether to suppress the attempt to look for extension redirects (e.g. SyntaxHighlight --> SyntaxHighlight GeSHi).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>One or more names of the extensions to fetch information.</maml:para> <maml:para>If there is ambiguity on whether the extension is a skin, prefix the extension name with `Extension:` or `Skin:`.</maml:para> </maml:description> <command:parameterValue required="true">ExtensionName[]</command:parameterValue> <dev:type> <maml:name>PSMWUpdater.ExtensionName[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Branch --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Branch</maml:name> <maml:description> <maml:para>One or more version branches for the extension (e.g. "REL1_32", or "master").</maml:para> <maml:para>If `AllBranches` is not specified, the first matching branch is fetched. Otherwise, all the matching branches are fetched.</maml:para> <maml:para>If `AllBranches` is not specified and this parameter is neglected, the cmdlet will return the latest REL branch.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AllBranches --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AllBranches</maml:name> <maml:description> <maml:para>Return all the matching branches instead of only the first matching branch.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SuppressRedirect --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SuppressRedirect</maml:name> <maml:description> <maml:para>Whether to suppress the attempt to look for extension redirects (e.g. SyntaxHighlight --> SyntaxHighlight GeSHi).</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>PSMWUpdater.ExtensionName[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>One or more names of the extensions to fetch information.</maml:para> <maml:para>If there is ambiguity on whether the extension is a skin, prefix the extension name with `Extension:` or `Skin:`.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ExtensionBranchInfo --> <command:returnValue> <dev:type> <maml:name>PSMWUpdater.ExtensionBranchInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para>Ask for the latest `REL` branch.</maml:para> <maml:para></maml:para> </maml:introduction> <dev:code>PS> 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</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para>Ask for a specific branch instead of latest `REL` branch.</maml:para> <maml:para></maml:para> </maml:introduction> <dev:code>PS> 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</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <maml:introduction> <maml:para>Ask for all the known branches.</maml:para> <maml:para></maml:para> </maml:introduction> <dev:code>PS> 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</dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-MwSiteInfo --> <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-MwSiteInfo</command:name> <command:verb>Get</command:verb> <command:noun>MwSiteInfo</command:noun> <maml:description> <maml:para>Gets the basic information of a MediaWiki installation.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-MwSiteInfo</maml:name> <!-- Parameter: InstallationPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InstallationPath</maml:name> <maml:description> <maml:para>Specify the root of a local MediaWiki installation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: InstallationPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InstallationPath</maml:name> <maml:description> <maml:para>Specify the root of a local MediaWiki installation.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specify the root of a local MediaWiki installation.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: LocalSiteInfo --> <command:returnValue> <dev:type> <maml:name>PSMWUpdater.LocalSiteInfo</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> </helpItems> |