From b6c615938f770c15819c17efc2511b976fe8ead9 Mon Sep 17 00:00:00 2001 From: Lars <57503246+larsk21@users.noreply.github.com> Date: Tue, 5 May 2020 18:11:25 +0200 Subject: [PATCH 1/2] Add "Input Files" section to README --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index 1148ed5..f9af214 100644 --- a/README.md +++ b/README.md @@ -16,3 +16,41 @@ Run TimeSheetGenerator (requires Java 8 or higher): | `-v` | `--version` | _none_ | Print the version of the application. | | `-g` | `--gui` | _none_ | Generate an output file based on files chosen in a file dialog.| | `-f` | `--file` |` `| Generate an output file based on the given files. | + +## Input Files + +For now only JSON files are supported. + +### Global Time Sheet Definition + +| Property | Type | Description | +| ----------- | ------------ | ---------------------------------------------------------------------------------------------------------- | +| name | String | Name of the employee. | +| staffId | Integer | Staff ID of the employee. | +| department | String | Department where the employee is employed at. | +| workingTime | TimeSpan | Maximum allowed working time per month according to the employment contract. | +| wage | Decimal | Wage per hour according to the employment contract. | +| workingArea | {"ub", "gf"} | Working area of the employee; either "ub" (= "Universitaetsbereich") or "gf" (= "Grossforschungsbereich"). | + +### Monthly Working Time Recording + +| Property | Type | Description | +| ------------- | --------- | -------------------------------------------------------------------------------------------- | +| year | Integer | Year for which the working time is recorded. | +| month | Integer | Month for which the working time is recorded. | +| pred_transfer | TimeSpan | Working time transfer, in hours, from the predecessing month. *(default: 0:00)* | +| succ_transfer | TimeSpan | Working time transfer, in hours, to the successing month. *(default: 0:00)* | +| entries | [Entries] | Array of entries, where each entry represent a continual period of working or vacation time. | + +#### Monthly Working Time Entry + +| Property | Type | Description | +| -------- | --------- | -------------------------------------------------------------------------------- | +| action | String | Description of the actions performed in this period of working or vacation time. | +| day | Integer | Day of the month. | +| start | ClockTime | Starting time for the period of working or vacation time in 24-hour format. | +| end | ClockTime | Ending time for the period of working or vacation time in 24-hour format. | +| pause | TimeSpan | Combined pause time during the period of working time. *(default: 0:00)* | +| vacation | Boolean | If the recorded period of time represents vacation time. *(default: False)* | + +*Note that the pause and the vacation property may not both be present.* From 10d1c407e076de2fcc79de1205a468e630076d90 Mon Sep 17 00:00:00 2001 From: Lars <57503246+larsk21@users.noreply.github.com> Date: Tue, 5 May 2020 18:25:54 +0200 Subject: [PATCH 2/2] Fix typos in README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f9af214..52d2b8f 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ For now only JSON files are supported. | department | String | Department where the employee is employed at. | | workingTime | TimeSpan | Maximum allowed working time per month according to the employment contract. | | wage | Decimal | Wage per hour according to the employment contract. | -| workingArea | {"ub", "gf"} | Working area of the employee; either "ub" (= "Universitaetsbereich") or "gf" (= "Grossforschungsbereich"). | +| workingArea | {"ub","gf"} | Working area of the employee; either "ub" (= "Universitaetsbereich") or "gf" (= "Grossforschungsbereich"). | ### Monthly Working Time Recording @@ -38,8 +38,8 @@ For now only JSON files are supported. | ------------- | --------- | -------------------------------------------------------------------------------------------- | | year | Integer | Year for which the working time is recorded. | | month | Integer | Month for which the working time is recorded. | -| pred_transfer | TimeSpan | Working time transfer, in hours, from the predecessing month. *(default: 0:00)* | -| succ_transfer | TimeSpan | Working time transfer, in hours, to the successing month. *(default: 0:00)* | +| pred_transfer | TimeSpan | Working time transfer, in hours, from the preceding month. *(default: 0:00)* | +| succ_transfer | TimeSpan | Working time transfer, in hours, to the succeeding month. *(default: 0:00)* | | entries | [Entries] | Array of entries, where each entry represent a continual period of working or vacation time. | #### Monthly Working Time Entry