Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add "Input Files" section to README #101

Closed
wants to merge 2 commits into from
Closed

Add "Input Files" section to README #101

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6c6159
Add "Input Files" section to README
larsk21 May 5, 2020
10d1c40
Fix typos in README
larsk21 May 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` |`<global.json> <month.json> <output.tex>`| 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 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

| 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.*