From 33b3d4c6375f55f3dc21fe947a3b0fb9979eb5e7 Mon Sep 17 00:00:00 2001 From: Dennis Eichhorn Date: Thu, 25 Jun 2020 19:41:54 +0200 Subject: [PATCH] add pseudo de help doc --- Docs/Dev/de/SUMMARY.md | 3 + Docs/Dev/de/task.md | 153 +++++++++++++++++++++++++++++++++++ Docs/Help/de/SUMMARY.md | 3 + Docs/Help/de/introduction.md | 51 ++++++++++++ Docs/Help/de/task.md | 38 +++++++++ 5 files changed, 248 insertions(+) create mode 100644 Docs/Dev/de/SUMMARY.md create mode 100644 Docs/Dev/de/task.md create mode 100644 Docs/Help/de/SUMMARY.md create mode 100644 Docs/Help/de/introduction.md create mode 100644 Docs/Help/de/task.md diff --git a/Docs/Dev/de/SUMMARY.md b/Docs/Dev/de/SUMMARY.md new file mode 100644 index 0000000..ec5565a --- /dev/null +++ b/Docs/Dev/de/SUMMARY.md @@ -0,0 +1,3 @@ +# Developer Content + +* [Task]({%}&page=Dev/task) diff --git a/Docs/Dev/de/task.md b/Docs/Dev/de/task.md new file mode 100644 index 0000000..7877d27 --- /dev/null +++ b/Docs/Dev/de/task.md @@ -0,0 +1,153 @@ +# Task + +## Create + +```php +$response = new HttpResponse(); +$request = new HttpRequest(); + +$request->setData('id', ); +$request->setData('title', ); +$request->setData('description', <description>); +$request->setData('due', <due>); +$request->setData('status', <status>); +$request->setData('type', <type>); +$request->setData('priority', <priority>); +$request->setData('closable', true|false); // optional +$request->setData('editable', true|false); // optional + +$module = $this->app->moduleManager->get('Tasks'); +$module->apiTaskCreate($request, $response); +``` + +#### Web + +| HTTP Method | URI | +| ----------- | ------ | +| POST | /tasks | + +``` +{ + "id": <id>, + "title": <title>, + "description": <description>, + "due": <due>, + "status": <status>, + "type": <type>, + "priority": <priority>, + "closable": true|false + "editable": true|false +} +``` + +### Type + +Aside from the normal tasks it's also possible to mark task completely invisible in the task overview and task list. This may be helpful if other modules want to make use of the Tasks module without directly showing this to the user. Additionally, it's also possible to define task templates which can be re-used. + +```php +$response = new HttpResponse(); +$request = new HttpRequest(); + +$request->setData('id', <id>); +$request->setData('type', <type>); + +$module = $this->app->moduleManager->get('Tasks'); +$module->apiTaskSet($request, $response); +``` + +#### Web + +| HTTP Method | URI | +| ----------- | ------ | +| POST | /tasks | + +``` +{ + "id": <id>, + "type": <type> +} +``` + +### Editable + +```php +$response = new HttpResponse(); +$request = new HttpRequest(); + +$request->setData('id', <id>); +$request->setData('editable', true|false); + +$module = $this->app->moduleManager->get('Tasks'); +$module->apiTaskSet($request, $response); +``` + +#### Web + +| HTTP Method | URI | +| ----------- | ------ | +| POST | /tasks | + +``` +{ + "id": <id>, + "editable": true|false +} +``` + +### Closable + +By default tasks are closable by a user in the task itself however, in some situations users should not be able to manually close a task but the task should be closed automatically depending on actions in a different module. By defining a task as none-closable the task can only be closed based on the action in a different module and a user cannot directly close a task in the Tasks module. + +```php +$response = new HttpResponse(); +$request = new HttpRequest(); + +$request->setData('id', <id>); +$request->setData('closable', true|false); + +$module = $this->app->moduleManager->get('Tasks'); +$module->apiTaskSet($request, $response); +``` + +#### Web + +| HTTP Method | URI | +| ----------- | ------ | +| POST | /tasks | + +``` +{ + "id": <id>, + "closable": true|false +} +``` + +## Status Change + +### API + +#### Internal + +```php +$response = new HttpResponse(); +$request = new HttpRequest(); + +$request->setData('id', <id>); +$request->setData('status', <status>); + +$module = $this->app->moduleManager->get('Tasks'); +$module->apiTaskSet($request, $response); +``` + +#### Web + +| HTTP Method | URI | +| ----------- | ------ | +| POST | /tasks | + +``` +{ + "id": <id>, + "status": <status> +} +``` \ No newline at end of file diff --git a/Docs/Help/de/SUMMARY.md b/Docs/Help/de/SUMMARY.md new file mode 100644 index 0000000..980b86d --- /dev/null +++ b/Docs/Help/de/SUMMARY.md @@ -0,0 +1,3 @@ +# User Content + +* [Task]({%}&page=Help/task) diff --git a/Docs/Help/de/introduction.md b/Docs/Help/de/introduction.md new file mode 100644 index 0000000..fd218c4 --- /dev/null +++ b/Docs/Help/de/introduction.md @@ -0,0 +1,51 @@ +# Introduction + +The **Tasks** module can create tasks/todos, for other people and for oneself. + +## Target Group + +The target groups for this module is everyone who would like to keep track of todos and tasks or share the progress of a task with other people. This module is also a often used dependency by other modules. + +# Setup + +The module can be installed through the integrated module downloader and installer or by uploading the module into the `Modules/` directory and executing the installation through the module installer. + +The module is depending on the **Editor** module which provides most of the writing features. + +# Features + +## Due & Priority + +Tasks can get created with a due and priority + +## Sharing Tasks + +Tasks can be shared like emails. A task can be assigned to multiple people or groups. It's also possible to make tasks visible to other people and groups by referencing them in a task (cc.) so they can see how the task is progressing. Tasks can be forwarded to other people in case someone else is responsible for the task. + +## Analysis + +The integrated analysis tool allows to investigate how long it takes to finish tasks on average, how many certain people have to solve, how many they created for other people etc. + +## Markdown + +The module makes use of an extended markdown version for easy writing and modifications. + +### Extendability + +Modules can provide custom elements which allows them to provide elemnts that normal markdown doesn't support. Some modules that already provide custom elements for articles: + +* Media +* Charts +* Spreadsheets +* Calendar/Events +* Tasks +* Checklists +* Profiles/Contacts + +# Recommendation + +Other modules that work great with this one together are: + +* [Kanban](Kanban) +* [ProjectManagement](ProjectManagement) +* [EventManagement](EventManagement) \ No newline at end of file diff --git a/Docs/Help/de/task.md b/Docs/Help/de/task.md new file mode 100644 index 0000000..c8f80e4 --- /dev/null +++ b/Docs/Help/de/task.md @@ -0,0 +1,38 @@ +# Task + +A task can be created by yourself, another user or by another module as part of a workflow. Tasks (or TODOs) are used to describe what needs to be done and with which priority they should be done. In some cases other modules can also create tasks for users as part of their purpose and workflow. + +## Priority & Due + +Tasks can have either a priority or a due date. Both are exclusive and cannot be used in combination. In some cases it can make more sense to give something a priority if no definitive due date is known/agreed upon and in some situations a fixed due date can be used. + +When sorting tasks the priorities are sorted according to the following criteria: + +* Very high = same as due in 1 day +* High = same as due in 1 week +* Medium = same as due in 2 weeks +* Low = same as due in 1 month +* Very low = due after 1 month + +## Visibility + +Tasks are visible to: + +* people/groups the task is assigned to +* people/groups mentioned in copy +* the person who created the task +* people/groups the task got forwarded to + +## Editable + +A task can be made editable or locked. In case a task is marked as locked, the task and created responses cannot be changed. This can be important for tasks which need to be auditable / non-changable (e.g. ISO system). A task which is defined as locked can never be made editable again, so please be careful when you choose to define a task as locked. By default tasks are editable. + +## Status + +The status of a task can be one of the following: + +* Open = default status +* Working = working on task +* Suspended = task is on hold +* Canceled = task got canceled/aborted +* Done = task is completed \ No newline at end of file