en-US/PsTodoTxt-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-TodoTxt</command:name> <command:verb>ConvertFrom</command:verb> <command:noun>TodoTxt</command:noun> <maml:description> <maml:para>Converts a todo object to a todotxt string.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Converts a todo object to a todotxt string.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertFrom-TodoTxt</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Todo</maml:name> <maml:Description> <maml:para>This is the todotxt object (as output from ConvertTo-TodoTxt for example).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</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 (ByValue)" position="1" aliases="none"> <maml:name>Todo</maml:name> <maml:Description> <maml:para>This is the todotxt object (as output from ConvertTo-TodoTxt for example).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Input type [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>Output type [System.String]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Paul Broadwith (https://github.com/pauby)</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$todoObject | ConvertFrom-TodoTxt</dev:code> <dev:remarks> <maml:para>Converts $todoObject into a todotxt string.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.github.com/pauby/pstodotxt</maml:linkText> <maml:uri>http://www.github.com/pauby/pstodotxt</maml:uri> </maml:navigationLink> </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-TodoTxt</command:name> <command:verb>ConvertTo</command:verb> <command:noun>TodoTxt</command:noun> <maml:description> <maml:para>Converts a todo text string to a TodoTxt object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Converts a todo text string to a TodoTxt object.</maml:para> <maml:para>If the task description is not present then you will find that various components of the todo end up as it.</maml:para> <maml:para>See the project documentation for the format of the object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertTo-TodoTxt</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Todo</maml:name> <maml:Description> <maml:para>This is the raw todo text - ie. 'take car to garage @car +car_maintenance'</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>ParseOnly</maml:name> <maml:Description> <maml:para>Requests that the todo not be validated and only parsed.</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="True (ByValue)" position="1" aliases="none"> <maml:name>Todo</maml:name> <maml:Description> <maml:para>This is the raw todo text - ie. 'take car to garage @car +car_maintenance'</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>ParseOnly</maml:name> <maml:Description> <maml:para>Requests that the todo not be validated and only parsed.</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>Input type [System.String]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Output type [System.Object]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Paul Broadwith (https://github.com/pauby)</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>ConvertTo-TodoTxt -Todo 'take car to garage @car +car_maintenance'</dev:code> <dev:remarks> <maml:para>Converts the todo text into it's components and returns them in an object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$todo = 'take car to garage @car +car_maintenance' $todo | ConvertTo-TodoTxt</dev:code> <dev:remarks> <maml:para>Converts the todo text into it's components and returns them in an object</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.github.com/pauby/pstodotxt</maml:linkText> <maml:uri>http://www.github.com/pauby/pstodotxt</maml:uri> </maml:navigationLink> </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-TodoTxtDate</command:name> <command:verb>ConvertTo</command:verb> <command:noun>TodoTxtDate</command:noun> <maml:description> <maml:para>Converts a date into the TodoTxt date format.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Converts a date into the TodoTxt date format.</maml:para> <maml:para>If you do not pass a date then todays date is assumed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertTo-TodoTxtDate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Date</maml:name> <maml:Description> <maml:para>{{ Fill Date Description }}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>(Get-Date)</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Date</maml:name> <maml:Description> <maml:para>{{ Fill Date Description }}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>(Get-Date)</dev:defaultValue> </command:parameter> </command:parameters> <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>Author: Paul Broadwith (https://github.com/pauby)</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>ConvertTo-TodoTxtDate -Date (Get-Date).AddDays(-20)</dev:code> <dev:remarks> <maml:para>Converts the date, 20 days ago, into a TodoTxt date format.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/pauby/PsTodoTxt/tree/master/docs/en-US/ConvertTo-TodoTxtDate.md</maml:linkText> <maml:uri>https://github.com/pauby/PsTodoTxt/tree/master/docs/en-US/ConvertTo-TodoTxtDate.md</maml:uri> </maml:navigationLink> </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>Export-TodoTxt</command:name> <command:verb>Export</command:verb> <command:noun>TodoTxt</command:noun> <maml:description> <maml:para>Exports todotxt objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Exports todotxt, previously created with ConvertTo-TodoTxt, to a text file. Before exporting the todotxt objects are converted back to todotxt strings by calling the cmdlet ConvertFrom-TodoTxt.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-TodoTxt</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Todo</maml:name> <maml:Description> <maml:para>Object(s) to export</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</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>Path</maml:name> <maml:Description> <maml:para>Path to the todo file. The file will be created if it does not exist</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>Append</maml:name> <maml:Description> <maml:para>Append to todo file</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="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Todo</maml:name> <maml:Description> <maml:para>Object(s) to export</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</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>Path</maml:name> <maml:Description> <maml:para>Path to the todo file. The file will be created if it does not exist</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>Append</maml:name> <maml:Description> <maml:para>Append to todo file</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:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Author: Paul Broadwith (https://github.com/pauby)</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$todo = Import-TodoTxt -Path c:\input.txt Export-TodoTxt -Todo $todo -Path c:\output.txt</dev:code> <dev:remarks> <maml:para>Converts the todotxt objects in $todo to todotxt strings and writes them to the file c:\output.txt.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Import-TodoTxt -Path c:\input.txt | Export-TodoTxt -Path c:\output.txt -Append</dev:code> <dev:remarks> <maml:para>Imports todotxt strings from c:\input.txt and then exports the file c:\output.txt by appending them to the end of the file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://www.github.com/pauby/pstodotxt</maml:linkText> <maml:uri>https://www.github.com/pauby/pstodotxt</maml:uri> </maml:navigationLink> </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-TodoTxtTodaysDate</command:name> <command:verb>Get</command:verb> <command:noun>TodoTxtTodaysDate</command:noun> <maml:description> <maml:para>Gets todays date in todo.txt format.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>gets todays date in the correct todo.txt format.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TodoTxtTodaysDate</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Todays date. Output type is [datetime]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author : Paul Broadwith (paul@pauby.com) History : 1.0 - 29/09/15 - Initial version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-TodoTodaysDate</dev:code> <dev:remarks> <maml:para>Outputs todays date.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://www.github.com/pauby/</maml:linkText> <maml:uri>https://www.github.com/pauby/</maml:uri> </maml:navigationLink> </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-TodoTxt</command:name> <command:verb>Import</command:verb> <command:noun>TodoTxt</command:noun> <maml:description> <maml:para>Imports todotxt strings and converts them to objects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Imports todotxt strings from the source file and converts them to objects.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-TodoTxt</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Path to the todo file. The file must exist. Throws an exception if the file does not exist. Nothing is returned if file is empty.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>Path to the todo file. The file must exist. Throws an exception if the file does not exist. Nothing is returned if file is empty.</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: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>Author: Paul Broadwith (https://github.com/pauby)</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Import-Todo -Path c:\todo.txt</dev:code> <dev:remarks> <maml:para>Reads the todotxt strings from the file c:\todo.txt and converts them to objects.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://www.github.com/pauby/pstodotxt</maml:linkText> <maml:uri>https://www.github.com/pauby/pstodotxt</maml:uri> </maml:navigationLink> </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>Set-TodoTxt</command:name> <command:verb>Set</command:verb> <command:noun>TodoTxt</command:noun> <maml:description> <maml:para>Sets a todo's properties.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Validates and sets a todo's properties.</maml:para> <maml:para>The function itself does not validate the Todotxt input object. It does validate the parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-TodoTxt</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Todo</maml:name> <maml:Description> <maml:para>The todo object to set the properties of.</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dd, done"> <maml:name>DoneDate</maml:name> <maml:Description> <maml:para>The done date to set. This is only validated as a date in the correct format and can be any date past, future or present. To remove this property value from the object pass $null or an empty string as the parameter value.</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="cd, created"> <maml:name>CreatedDate</maml:name> <maml:Description> <maml:para>The created date to set. This is only validated as a date in the correct format and can be any date past, future or present. As a todo must always have a created date you cannot remove this property value, only change it.</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="pri, u"> <maml:name>Priority</maml:name> <maml:Description> <maml:para>The priority of the todo. To remove this property value from the object pass an empty string as the parameter value.</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="t"> <maml:name>Task</maml:name> <maml:Description> <maml:para>The tasks description of the todo. As a todo must always have a task this property cannot be removed.</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="c"> <maml:name>Context</maml:name> <maml:Description> <maml:para>The context(s) of the todo. To remove this property value from the object pass $null or an empty string as the parameter value.</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="p"> <maml:name>Project</maml:name> <maml:Description> <maml:para>The project(s) of the todo. To remove this property value from the object pass $null or an empty string as the parameter value.</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="a"> <maml:name>Addon</maml:name> <maml:Description> <maml:para>The addon key:value pairs of the todo. To remove this property value from the object pass $null as the parameter 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="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: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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Todo</maml:name> <maml:Description> <maml:para>The todo object to set the properties of.</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="dd, done"> <maml:name>DoneDate</maml:name> <maml:Description> <maml:para>The done date to set. This is only validated as a date in the correct format and can be any date past, future or present. To remove this property value from the object pass $null or an empty string as the parameter value.</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="cd, created"> <maml:name>CreatedDate</maml:name> <maml:Description> <maml:para>The created date to set. This is only validated as a date in the correct format and can be any date past, future or present. As a todo must always have a created date you cannot remove this property value, only change it.</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="pri, u"> <maml:name>Priority</maml:name> <maml:Description> <maml:para>The priority of the todo. To remove this property value from the object pass an empty string as the parameter value.</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="t"> <maml:name>Task</maml:name> <maml:Description> <maml:para>The tasks description of the todo. As a todo must always have a task this property cannot be removed.</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="c"> <maml:name>Context</maml:name> <maml:Description> <maml:para>The context(s) of the todo. To remove this property value from the object pass $null or an empty string as the parameter value.</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="p"> <maml:name>Project</maml:name> <maml:Description> <maml:para>The project(s) of the todo. To remove this property value from the object pass $null or an empty string as the parameter value.</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="a"> <maml:name>Addon</maml:name> <maml:Description> <maml:para>The addon key:value pairs of the todo. To remove this property value from the object pass $null as the parameter 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="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: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: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>Author: Paul Broadwith (https://github.com/pauby)</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$todoObj = $todoObj | Set-TodoTxt -Priority "B"</dev:code> <dev:remarks> <maml:para>Sets the priority of the $todoObj to "B" and outputs the modified todo.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://www.github.com/pauby</maml:linkText> <maml:uri>https://www.github.com/pauby</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |