en-GB/Elizium.TerminalBuddy-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>convertFrom-ColourComponents</command:name> <command:verb>convertFrom</command:verb> <command:noun>ColourComponents</command:noun> <maml:description> <maml:para>Convert colour components from raw real to numerics representation (ie the number value prior to hex conversion).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Given an ANSI colour (eg 'Ansi 1 Color') and a dictionary of colour definitions as real numbers, creates a hash table of the colour component name, to colour value.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>convertFrom-ColourComponents</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ColourDictionary</maml:name> <maml:Description> <maml:para>XML info representing the colour components for a single ansi colour.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SelectXmlInfo</command:parameterValue> <dev:type> <maml:name>SelectXmlInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ColourDictionary</maml:name> <maml:Description> <maml:para>XML info representing the colour components for a single ansi colour.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SelectXmlInfo</command:parameterValue> <dev:type> <maml:name>SelectXmlInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>ConvertFrom-ItermColors</command:name> <command:verb>ConvertFrom</command:verb> <command:noun>ItermColors</command:noun> <maml:description> <maml:para>Converts .itermcolor files into a format that can be used in Window Terminal Settings. Depending on the parameters provided, will either integrate generated schemes into the setting files, or generate a separate file from the existing settings file. Any schemes already present in the setting files will be preserved.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Since there is currently no settings UI in Windows Terminal Settings app and the format that is used to express colour schemes is vastly different to that used by iterm, it is not easy to leverage the work done by others in creating desirable terminal schemes. This function makes it easier to apply iterm colour schemes into Windows Terminal.</maml:para> <maml:para>There are multiple ways to use this function:</maml:para> <maml:para>1) generate an Output file (denoted by $Out parameter), which will contain a JSON object containing the colour schemes converted from iterm to Windows Terminal format. 2) generate a new Dry Run file which is a copy of the current Windows Terminal Settings file with the converted schemes integrated into it. 3) make a backup, of the Settings file, then integrate the generated schemes into the current Settings file. (See caveats further down below).</maml:para> <maml:para> The function errs on the side of caution, and by default works in 'Dry Run' mode. Due to the caveats, this method is effectively the same as not using the $SaveTerminalSettings switch, using $Out instead, because in this scenario, the user would be expected to open up the generated file and copy the generated scheme objects into the current Settings file. This is the recommended way to use this command.</maml:para> <maml:para> If the user wants to integrate the generated schemes into the Settings file automatically, then the $Force switch should be specified. In this case, the current live Settings file is backed up and then over-written by the new content. Existing schemes are preserved.</maml:para> <maml:para>And the caveats ...</maml:para> <maml:para>1) For some reason, Microsoft decided to include comments inside the JSON setting file (probably in lieu of there not being a proper settings UI, making configuring the settings easier). However, comments are not part of the current JSON schema (although they are permitted in the rarely and sparsely supported json5 spec), which means that this conversion process will not preserve the comments. There is an alternative api that supposedly supports non standard JSON features, newtonsoft.json.ConvertTo-JsonNewtonsoft/ConvertFrom-JsonNewtonsoft but using these functions yield unsatisfactory results.</maml:para> <maml:para>2) ConvertFrom-Json/Converto-Json do not properly handle the profiles</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertFrom-ItermColors</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The path containing the iterm scheme files. If this refers to a directory, then a Filter should be specified to identify the files. This Path can also just refer directly to an individual file, in which case, no Filter is required.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>When Path refers to a directory, use Filter to specify files. A * can be used as a wildcard.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Out</maml:name> <maml:Description> <maml:para>The output file written to with the JSON represented the converted iterm themes. This content is is just a fragment of the settings file, in fact it's a JSON object which contains a single member named 'schemes' (after the corresponding entry in the Windows Terminal Settings file.) which is set to an array of scheme objects.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>DryRunFile</maml:name> <maml:Description> <maml:para>When run in Dry Run mode (by default), this is the path of the file written to. It will contain a merge of the current Windows Terminal Settings file and newly generated schemes as converted from iterm files specified by the $Path.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>BackupFile</maml:name> <maml:Description> <maml:para>When not in Dry Run mode ($Force and $SaveTerminalSettings specified), this parameter specifies the path to backup the live Windows Terminal Settings file to.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ThemeName</maml:name> <maml:Description> <maml:para>The name of a Krayola Theme, that has been configured inside the global $KrayolaThemes hashtable variable. If not present, then an internal theme is used. The Krayola Theme shapes how output of this command is generated to the console.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>LiveSettingsFile</maml:name> <maml:Description> <maml:para>Well known path to the current windows terminal settings file. This is assumed to of the well known path. This can be overridden by the user if so required (just in case it's located elsewhere).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>PseudoSettingsFile</maml:name> <maml:Description> <maml:para>This file is only required because of certain caveats of the current implementation, owing to Microsoft's choice in not using standard JSON file. In the interests of safety, instead of integrating new schemes into the LiveSettingsFile, PseudoSettingsFile specifies the file used instead of overwriting LiveSettingsFile. This function will indicating that the schemes should be manually copied over at the end of the run.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Switch to indicate whether live settings should be modified to include generated schemes. To avoid accidental invocation, needs to be used in addition to SaveTerminalSettings.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SaveTerminalSettings</maml:name> <maml:Description> <maml:para>Switch, to indicate that the converted schemes should be saved into a complete settings file. Which settings file depends on the presence of the Force parameter. If Force is present, the the LiveSettingsFile path is used, otherwise the DryRunFile path is used.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>BackupFile</maml:name> <maml:Description> <maml:para>When not in Dry Run mode ($Force and $SaveTerminalSettings specified), this parameter specifies the path to backup the live Windows Terminal Settings file to.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>DryRunFile</maml:name> <maml:Description> <maml:para>When run in Dry Run mode (by default), this is the path of the file written to. It will contain a merge of the current Windows Terminal Settings file and newly generated schemes as converted from iterm files specified by the $Path.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>When Path refers to a directory, use Filter to specify files. A * can be used as a wildcard.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Switch to indicate whether live settings should be modified to include generated schemes. To avoid accidental invocation, needs to be used in addition to SaveTerminalSettings.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>LiveSettingsFile</maml:name> <maml:Description> <maml:para>Well known path to the current windows terminal settings file. This is assumed to of the well known path. This can be overridden by the user if so required (just in case it's located elsewhere).</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Out</maml:name> <maml:Description> <maml:para>The output file written to with the JSON represented the converted iterm themes. This content is is just a fragment of the settings file, in fact it's a JSON object which contains a single member named 'schemes' (after the corresponding entry in the Windows Terminal Settings file.) which is set to an array of scheme objects.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The path containing the iterm scheme files. If this refers to a directory, then a Filter should be specified to identify the files. This Path can also just refer directly to an individual file, in which case, no Filter is required.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>PseudoSettingsFile</maml:name> <maml:Description> <maml:para>This file is only required because of certain caveats of the current implementation, owing to Microsoft's choice in not using standard JSON file. In the interests of safety, instead of integrating new schemes into the LiveSettingsFile, PseudoSettingsFile specifies the file used instead of overwriting LiveSettingsFile. This function will indicating that the schemes should be manually copied over at the end of the run.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SaveTerminalSettings</maml:name> <maml:Description> <maml:para>Switch, to indicate that the converted schemes should be saved into a complete settings file. Which settings file depends on the presence of the Force parameter. If Force is present, the the LiveSettingsFile path is used, otherwise the DryRunFile path is used.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>ThemeName</maml:name> <maml:Description> <maml:para>The name of a Krayola Theme, that has been configured inside the global $KrayolaThemes hashtable variable. If not present, then an internal theme is used. The Krayola Theme shapes how output of this command is generated to the console.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>ConvertFrom-ItermColors -Path 'C:\shared\Themes\ITerm2\Schemes\Banana Blueberry.itermcolors' -Out ~/terminal-settings.single.output.json</dev:code> <dev:remarks> <maml:para>Convert a single file into Out file ~/terminal-settings.single.output.json</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>ConvertFrom-ItermColors -Path C:\shared\Themes\ITerm2\Schemes -Filter "B*.itermcolors" -Out ~/terminal-settings.output.json</dev:code> <dev:remarks> <maml:para>Bulk convert multiple files into Out file ~/terminal-settings.output.json</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>ConvertFrom-ItermColors -Path 'C:\shared\Themes\ITerm2\Schemes\Banana Blueberry.itermcolors' -SaveTerminalSettings</dev:code> <dev:remarks> <maml:para>Convert a single file into Dry Run file</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>ConvertFrom-ItermColors -Path C:\shared\Themes\ITerm2\Schemes\ -Filter 'B*.itermcolors' -SaveTerminalSettings</dev:code> <dev:remarks> <maml:para>Bulk convert multiple files into Dry Run file</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>ConvertTo-RGB</command:name> <command:verb>ConvertTo</command:verb> <command:noun>RGB</command:noun> <maml:description> <maml:para>Creates the colour specification in hex code form.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Hex string generated represents the string value supported by Windows Terminal that allows rendering in that colour.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertTo-RGB</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Components</maml:name> <maml:Description> <maml:para>Hashtable containing colour component descriptor mapped to the real colour value.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>NamingScheme</maml:name> <maml:Description> <maml:para>Mapping scheme that decouples external colour component names from internal names (not of interest to end user).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Components</maml:name> <maml:Description> <maml:para>Hashtable containing colour component descriptor mapped to the real colour value.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>NamingScheme</maml:name> <maml:Description> <maml:para>Mapping scheme that decouples external colour component names from internal names (not of interest to end user).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>get-SortedFilesNatural</command:name> <command:verb>get</command:verb> <command:noun>SortedFilesNatural</command:noun> <maml:description> <maml:para>Sort a collection of files from the pipeline in natural order.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sorts filenames in an order that makes sense to humans; ie 1 is followed by 2 and not 10.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>get-SortedFilesNatural</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>Collection of files from pipeline to be sorted.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>Collection of files from pipeline to be sorted.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-SortedFolderNatural 'E:\Uni\audio'</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>gci E:\Uni\audio | Get-SortedFilesNatural</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>get-WindowsTerminalSettingsPath</command:name> <command:verb>get</command:verb> <command:noun>WindowsTerminalSettingsPath</command:noun> <maml:description> <maml:para>Gets the windows terminal settings path.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If Windows terminal is not installed, this file won't exist, so empty string is returned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>get-WindowsTerminalSettingsPath</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>import-ItermColors</command:name> <command:verb>import</command:verb> <command:noun>ItermColors</command:noun> <maml:description> <maml:para>Imports XML data from iterm file and converts to JSON format.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function behaves like a reducer, because it populates an Accumulator collection for each file it is presented with.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>import-ItermColors</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Underscore</maml:name> <maml:Description> <maml:para>fileinfo object representing the .itermcolors file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileSystemInfo</command:parameterValue> <dev:type> <maml:name>FileSystemInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Index</maml:name> <maml:Description> <maml:para>0 based numeric index specifying the ordinal of the file in the batch.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>The dictionary object containing additional parameters. Also used by this function to append it's result to an 'ACCUMULATOR' hash (indexed by scheme name), which ultimately allows all the schemes to be collated into the 'schemes' array field in the settings file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Trigger</maml:name> <maml:Description> <maml:para>Trigger.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Index</maml:name> <maml:Description> <maml:para>0 based numeric index specifying the ordinal of the file in the batch.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>The dictionary object containing additional parameters. Also used by this function to append it's result to an 'ACCUMULATOR' hash (indexed by scheme name), which ultimately allows all the schemes to be collated into the 'schemes' array field in the settings file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Trigger</maml:name> <maml:Description> <maml:para>Trigger.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Underscore</maml:name> <maml:Description> <maml:para>fileinfo object representing the .itermcolors file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileSystemInfo</command:parameterValue> <dev:type> <maml:name>FileSystemInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>invoke-ForeachFile</command:name> <command:verb>invoke</command:verb> <command:noun>ForeachFile</command:noun> <maml:description> <maml:para>Performs iteration over a collection of files which are children of the directory specified by the caller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Invoke an operation for each file found from the Path. (This needs to be refactored/redesigned to use the pipeline via InputObject as this is the idiomatic way to do this in PowerShell).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>invoke-ForeachFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The parent directory to iterate.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Body</maml:name> <maml:Description> <maml:para>The implementation script block that is to be implemented for each child file. The script block can either return $null or a PSCustomObject with fields Message(string) giving an indication of what was implemented, Product (string) which represents the item in question (ie the processed item as appropriate) and Colour(string) which is the console colour applied to the Product. Also, the Trigger should be set to true, if an action has been taken for any of the files iterated. This is so because if we iterate a collection of files, but the operation doesn't do anything to any of the files, then the whole operation should be considered a no-op, so we can keep output to a minimum.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>The dictionary object used to pass parameters to the $Body scriptblock provided.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter to apply to Get-ChildItem.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Condition</maml:name> <maml:Description> <maml:para>The result of Get-ChildItem is piped to a where statement whose condition is specified by this parameter. The (optional) scriptblock specified must be a predicate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Body</maml:name> <maml:Description> <maml:para>The implementation script block that is to be implemented for each child file. The script block can either return $null or a PSCustomObject with fields Message(string) giving an indication of what was implemented, Product (string) which represents the item in question (ie the processed item as appropriate) and Colour(string) which is the console colour applied to the Product. Also, the Trigger should be set to true, if an action has been taken for any of the files iterated. This is so because if we iterate a collection of files, but the operation doesn't do anything to any of the files, then the whole operation should be considered a no-op, so we can keep output to a minimum.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Condition</maml:name> <maml:Description> <maml:para>The result of Get-ChildItem is piped to a where statement whose condition is specified by this parameter. The (optional) scriptblock specified must be a predicate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The filter to apply to Get-ChildItem.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>The dictionary object used to pass parameters to the $Body scriptblock provided.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The parent directory to iterate.</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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>join-AllSchemas</command:name> <command:verb>join</command:verb> <command:noun>AllSchemas</command:noun> <maml:description> <maml:para>Builds the json content representing all the schemes previously collated.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used by ConvertFrom-ItermColors.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>join-AllSchemas</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Schemes</maml:name> <maml:Description> <maml:para>Hastable of scheme names to their JSON string representations.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Schemes</maml:name> <maml:Description> <maml:para>Hastable of scheme names to their JSON string representations.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>merge-SettingsContent</command:name> <command:verb>merge</command:verb> <command:noun>SettingsContent</command:noun> <maml:description> <maml:para>Combines the new Content just generated with the existing Settings file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used by ConvertFrom-ItermColors.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>merge-SettingsContent</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The new settings content to merge.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>SettingsPath</maml:name> <maml:Description> <maml:para>The path to the settings 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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>OutputPath</maml:name> <maml:Description> <maml:para>The path to write the result to.</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>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Content</maml:name> <maml:Description> <maml:para>The new settings content to merge.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>OutputPath</maml:name> <maml:Description> <maml:para>The path to write the result to.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>SettingsPath</maml:name> <maml:Description> <maml:para>The path to the settings 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>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>new-SchemeJsonFromDocument</command:name> <command:verb>new</command:verb> <command:noun>SchemeJsonFromDocument</command:noun> <maml:description> <maml:para>Builds the json content representing all the schemes previously collated.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Processes an xml document for an iterm scheme. This format is not in a form particularly helpful for xpath expressions. The key and values are all present at the same level in the xml hierarchy, so there is no direct relationship between the key and the value. All we can do is make an assumption that consecutive items are bound together by the key/value relationship. So these are processed as a result of 2 xpath expressions, the first selecting the keys (/plist/dict/key) and the other selecting the values (/plist/dict/dict) and we just make the assumption that the length of both result sets are the same and that items in the same position in their result sets are bound as a key/value pair. Used by ConvertFrom-ItermColors.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>new-SchemeJsonFromDocument</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>XmlDocument</maml:name> <maml:Description> <maml:para>The XML document.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">XmlDocument</command:parameterValue> <dev:type> <maml:name>XmlDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>XmlDocument</maml:name> <maml:Description> <maml:para>The XML document.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">XmlDocument</command:parameterValue> <dev:type> <maml:name>XmlDocument</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>test-DoesContainScheme</command:name> <command:verb>test</command:verb> <command:noun>DoesContainScheme</command:noun> <maml:description> <maml:para>Predicate that returns true if SchemeName is present in the Schemes collection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Used by ConvertFrom-ItermColors.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>test-DoesContainScheme</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SchemeName</maml:name> <maml:Description> <maml:para>Name of the scheme to search for.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Schemes</maml:name> <maml:Description> <maml:para>0 based numeric index specifying the ordinal of the iterated target.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SchemeName</maml:name> <maml:Description> <maml:para>Name of the scheme to search for.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Schemes</maml:name> <maml:Description> <maml:para>0 based numeric index specifying the ordinal of the iterated target.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks /> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>write-HostItemDecorator</command:name> <command:verb>write</command:verb> <command:noun>HostItemDecorator</command:noun> <maml:description> <maml:para>Performs iteration over a collection of files which are children of the directory specified by the caller.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The purpose of this function is a act as a decorator to a custom function on behalf of which any write-host operations are performed. This keeps any display functionality out of that function so that it may be used in scenarios where output is not required.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>write-HostItemDecorator</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Underscore</maml:name> <maml:Description> <maml:para>The iterated target item provided by the parent iterator function.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileSystemInfo</command:parameterValue> <dev:type> <maml:name>FileSystemInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Index</maml:name> <maml:Description> <maml:para>0 based numeric index specifying the ordinal of the iterated target.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>The dictionary object used to pass parameters to the decorated scriptblock (enclosed within the PassThru Hashtable).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Trigger</maml:name> <maml:Description> <maml:para>Trigger.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Index</maml:name> <maml:Description> <maml:para>0 based numeric index specifying the ordinal of the iterated target.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>The dictionary object used to pass parameters to the decorated scriptblock (enclosed within the PassThru Hashtable).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Trigger</maml:name> <maml:Description> <maml:para>Trigger.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Underscore</maml:name> <maml:Description> <maml:para>The iterated target item provided by the parent iterator function.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">FileSystemInfo</command:parameterValue> <dev:type> <maml:name>FileSystemInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks /> </command:command> </helpItems> |