Overhead-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>Get-TimeCardActivityData</command:name> <command:verb>Get</command:verb> <command:noun>TimeCardActivityData</command:noun> <maml:description> <maml:para>Process timecard data from the imported record information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-TimeCardActivity` cmdlet parses the data record to generate tallied data.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TimeCardActivityData</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>Data to parse and process.</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="0" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>Data to parse and process.</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>System.Management.Automation.PSObject</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: Import and parse time card information ------</maml:title> <dev:code>$data = Import-Clixml timecard.xml Get-TimeCardActivity $data</dev:code> <dev:remarks> <maml:para>Above imports the timecard information from the XML file, parses the data.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Import-TimeCardActivity</maml:linkText> <maml:uri></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-TimeCardAggregatedDaily</command:name> <command:verb>Get</command:verb> <command:noun>TimeCardAggregatedDaily</command:noun> <maml:description> <maml:para>Aggregate the file timecard information to daily tally.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-TimeCardAggregatedDaily` cmdlet parses the time card data and provides the daily aggregation of the hours.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TimeCardAggregatedDaily</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Tasks</maml:name> <maml:Description> <maml:para>Time card information imported and tallied by `Import-TimeCardActivity` or `Get-TimeCardActivity`.</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="0" aliases="none"> <maml:name>Tasks</maml:name> <maml:Description> <maml:para>Time card information imported and tallied by `Import-TimeCardActivity` or `Get-TimeCardActivity`.</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>System.Management.Automation.PSObject</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: Generate daily aggregation from the time card imported from timecard.csv</maml:title> <dev:code>$data = Import-TimeCardActivity -File timecard.csv Get-TimeCardAggregatedDaily $data</dev:code> <dev:remarks> <maml:para>The above imports the time card information from the file timecard.csv, then aggregates the time card data for the daily report.</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-TimeCardDailyHours</command:name> <command:verb>Get</command:verb> <command:noun>TimeCardDailyHours</command:noun> <maml:description> <maml:para>Generates hour counts per day.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Get-TimeCardDailyHours` cmdlets generates total hours per day based on the time card information provided.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TimeCardDailyHours</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Tasks</maml:name> <maml:Description> <maml:para>Time card information imported and tallied by `Import-TimeCardActivity` or `Get-TimeCardActivity`.</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="0" aliases="none"> <maml:name>Tasks</maml:name> <maml:Description> <maml:para>Time card information imported and tallied by `Import-TimeCardActivity` or `Get-TimeCardActivity`.</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>System.Management.Automation.PSObject</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: Generate total hours per day from the time card information</maml:title> <dev:code>$data = Import-TimeCardActivity -File timecard.csv Get-TimeCardDailyHours $data</dev:code> <dev:remarks> <maml:para>The above generates total hours per day from the time card information provided by the timecard.csv 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>Import-TimeCardActivity</command:name> <command:verb>Import</command:verb> <command:noun>TimeCardActivity</command:noun> <maml:description> <maml:para>Parses timecard CSV file to generate timecard data.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The `Import-TimeCardActivity` cmdlet generates timecard data from a time card CSV format consisting of Name, Category, Date, Start, End data.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-TimeCardActivity</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>File</maml:name> <maml:Description> <maml:para>Name of the file to import.</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="0" aliases="none"> <maml:name>File</maml:name> <maml:Description> <maml:para>Name of the file to import.</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:example> <maml:title> Example 1: Generates a time card data from timecard.csv file. </maml:title> <dev:code>PS C:\> Import-TimeCardActivity -File timecard.csv</dev:code> <dev:remarks> <maml:para>The above generates a time card data out from the timecard.csv file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-TimeCardActivity</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |