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.

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

Additional Documentation Updates #348

Merged
merged 4 commits into from
Jun 4, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/user_manual/C/gtg-add-sync.page
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<link type="seealso" xref="gtg-sync"/>
<link type="seealso" xref="gtg-remove-sync"/>

<revision pkgversion="1301" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.3.1" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.4.0" date="2020-05-10" status="outdated"/>
<credit type="author copyright">
<name>Radina Matic</name>
Expand Down
6 changes: 3 additions & 3 deletions docs/user_manual/C/gtg-add-tag.page
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<link type="seealso" xref="gtg-tag-color"/>


<revision pkgversion="1301" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.3.1" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.4.0" date="2020-05-17" status="candidate"/>
<credit type="author copyright">
<name>Radina Matic</name>
Expand All @@ -25,7 +25,7 @@

</info>

<title>Add or Modify Tags</title>
<title>Adding or Modifying Tags</title>

<p>To add a new tag or modify tags that are already assigned to a selected task, from the <gui>Task Browser</gui>, you can:</p>

Expand All @@ -51,7 +51,7 @@
<note style="tip"><p>When you create a new tag, the tag is only applied to the task that you are working on. If the task has subtasks already created, the tag is not applied to subtasks. However, when you create a new subtask from a parent task, the subtask inherits the tags of its parent. You can modify the tags of a subtask to make it different from its parent's tags, if needed. Modifying tags associated with a subtask does not affect the parent task.</p></note>

<section id="add-subtags">
<title>Add a Subtag</title>
<title>Adding a Subtag</title>
<p>You can drag and drop a tag onto another tag in the <gui>Sidebar</gui> to create "subtags". As an example, if you drag the tag <code>@to_pay</code> onto the tag <code>@money</code>, every task tagged with <code>@to_pay</code> is also displayed when viewing tasks that have the parent tag of <code>@money</code>; however, the <code>@money</code> tag is not added to the task.</p>
</section>
</page>
92 changes: 92 additions & 0 deletions docs/user_manual/C/gtg-complete-delete-dismiss-task.page
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
<page xmlns="http://projectmallard.org/1.0/"
xmlns:its="http://www.w3.org/2005/11/its"
type="topic" style="task"
id="gtg-complete-dismiss-delete-task">

<info>
<link type="guide" xref="index#gtg-working-task" group="fifth"/>
<link type="seealso" xref="gtg-create-new-task"/>
<link type="seealso" xref="gtg-edit-task"/>
<link type="seealso" xref="gtg-subtasks"/>
<link type="seealso" xref="gtg-set-task-date"/>

<revision pkgversion="0.3.1" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.4.0" date="2020-05-16" status="candidate"/>
<credit type="author copyright">
<name>Radina Matic</name>
<email its:translate="no">radina.matic@gmail.com</email>
<years>2013</years>
</credit>
<credit type="editor copyright">
<name>Danielle Vansia</name>
<email its:translate="no">daniellevansia@gmail.com</email>
<years>2020</years>
</credit>

<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>

</info>
<title>Completing, Dismissing, or Deleting Tasks</title>
<p>There are three actions that you can perform to close tasks or remove them from your <gui>Open</gui> or <gui>Actionable</gui> view modes: completing, dismissing, or deleting.</p>
<note><p>When working from any of the view modes, you can perform the below actions on multiple tasks by selecting the tasks while holding <key>SHIFT</key>. You can also perform complex, multi-selections using the <key>CTRL</key> key.</p></note>
<section id="complete-task">

<title>Completing a Task</title>

<p>When you are finished with a task, you can close the task by performing one of the following actions:</p>
<list>
<item><p>In the <gui>Open</gui> or <gui>Actionable</gui> view modes, select the task and use the <keyseq><key>Ctrl</key><key>D</key></keyseq> keyboard shortcut.</p></item>
<item><p>Right-click the task and select <gui>Mark as done</gui> from the context menu.</p></item>
<item><p>Click the <gui>Mark as Done</gui> button in the <gui>Task Editor</gui> window.</p></item></list>
<p>Once a task is marked as done, it is viewable in the <gui>Closed</gui> view mode.</p>
<section id="reopen-task"><title>Reopening a Complete Task</title>
<p>You may want to reopen a task that you previously marked as done. From the <gui>Closed</gui> view mode, you can:</p>
<list>
<item><p>Use the <keyseq><key>CTRL</key><key>D</key></keyseq> keyboard shortcut.</p></item>
<item><p>Right-click the task and select <gui>Mark as not done</gui> from the context menu.</p></item>
<item><p>Click the <gui>Mark as not Done</gui> button in the <gui>Task Editor</gui> window.</p></item></list>
</section>
</section>
<section id="dismiss-task">
<title>Dismissing a Task</title>

<p>When you decide that a certain task is no longer valid (does not need to be accomplished), you can dismiss it. To dismiss a selected task from the <gui>Open</gui> or <gui>Actionable</gui> view modes, you can:</p>

<list>
<item><p>Select the task and use the <keyseq><key>CTRL</key><key>I</key></keyseq> keyboard shortcut.</p></item>
<item><p>Right-click the task and select <gui>Dismiss</gui> from the context menu.</p></item>
</list>
<p>To dismiss an open <app>GTG</app> task:</p>
<steps>
<item><p>Click the <media type="image" src="figures/task-toolbar-menu.png"></media> icon in the task's headerbar.</p></item>
<item><p>Click <gui>Dismiss Task</gui>.</p></item>
</steps>

<p>You can view all of the tasks that are marked as dismissed in the <gui>Closed</gui> view mode.</p>

<section id="undismiss-task"><title>Undismissing a Task</title>
<p>You may want to reopen a task that you previously dismissed. From the <gui>Closed</gui> view mode, you can:</p>
<list>
<item><p>Use the <keyseq><key>CTRL</key><key>I</key></keyseq> keyboard shortcut.</p></item>
<item><p>Right-click the task and select <gui>Undismiss</gui> from the context menu.</p></item></list>
</section>
</section>
<section id="delete">

<title>Deleting a Task</title>

<p>To delete a selected task from the main <app>GTG</app> window, you can:</p>

<list>
<item><p>Select the task and use the <keyseq><key>CTRL</key><key>Del</key></keyseq> keyboard shortcut.</p></item>
<item><p>From any of the task view modes, right-click the task and select <gui>Delete</gui> from the context menu.</p></item>
</list>

<p>To delete an open <app>GTG</app> task:</p>
<steps><item><p>Click the <media type="image" src="figures/task-toolbar-menu.png"></media> icon in the task's headerbar.</p></item>
<item><p>Click <gui>Delete Task</gui>.</p></item></steps>

<note style="warning"> <p>Deleting a task is a permanent action. You will be asked to confirm the deletion before proceeding. If you want the ability to undo task deletions, consider using the <gui>Mark as Done</gui> or <gui>Dismiss</gui> actions instead.</p> </note>
</section>

</page>
9 changes: 4 additions & 5 deletions docs/user_manual/C/gtg-create-new-task.page
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,11 @@
<info>
<link type="guide" xref="index#gtg-working-task" group="first"/>
<link type="seealso" xref="gtg-edit-task"/>
<link type="seealso" xref="gtg-dismiss-task"/>
<link type="seealso" xref="gtg-delete-task"/>
<link type="seealso" xref="gtg-complete-dismiss-delete-task"/>
<link type="seealso" xref="gtg-subtasks"/>
<link type="seealso" xref="gtg-set-task-date"/>

<revision pkgversion="1301" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.3.1" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.4.0" date="2020-05-16" status="candidate"/>
<credit type="author copyright">
<name>Radina Matic</name>
Expand All @@ -28,7 +27,7 @@

</info>

<title>Create a New Task</title>
<title>Creating a New Task</title>

<p>There are three ways to create a new task in <app>GTG</app>:</p>

Expand All @@ -39,6 +38,6 @@
</list>

<p>The new task opens on top of the <app>GTG</app> main window or any other tasks that you may have opened.</p>

</page>

2 changes: 1 addition & 1 deletion docs/user_manual/C/gtg-create-plugin.page
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<info>


<revision pkgversion="1301" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.3.1" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.4.0" date="2020-05-10" status="outdated"/>
<credit type="author copyright">
<name>Radina Matic</name>
Expand Down
2 changes: 1 addition & 1 deletion docs/user_manual/C/gtg-create-sync.page
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@



<revision pkgversion="1301" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.3.1" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.4.0" date="2020-05-10" status="outdated"/>
<credit type="author copyright">
<name>Radina Matic</name>
Expand Down
48 changes: 0 additions & 48 deletions docs/user_manual/C/gtg-delete-task.page

This file was deleted.

4 changes: 2 additions & 2 deletions docs/user_manual/C/gtg-developer-resources.page
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
id="gtg-developer-resources">

<info>
<link type="guide" xref="index#gtg-advanced"/>
<link type="guide" xref="index#gtg-further" group="fourth"/>


<revision pkgversion="0.4.0" date="2020-05-10" status="candidate"/>
Expand All @@ -23,7 +23,7 @@

</info>

<title>Developer Resources</title>
<title>Developer Resources/ Contributing to <app>GTG</app></title>

<p>If you want more information about associated application dependencies, running <app>GTG</app> from the command line, or running the development version, visit <app>GTG's</app> <link href="https://github.com/getting-things-gnome/gtg">GitHub repository</link>. You can also report bugs and issues through GitHub. Ensure that you read the <link href="https://github.com/getting-things-gnome/gtg/blob/master/docs/contributors/bug%20reporting%20and%20triaging.md">Bug Reporting and Triaging</link> documentation before opening an issue.</p>

Expand Down
60 changes: 0 additions & 60 deletions docs/user_manual/C/gtg-dismiss-task.page

This file was deleted.

9 changes: 4 additions & 5 deletions docs/user_manual/C/gtg-edit-task.page
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,13 @@
id="gtg-edit-task">

<info>
<link type="guide" xref="index#gtg-working-task" group="fourth"/>
<link type="guide" xref="index#gtg-working-task" group="second"/>
<link type="seealso" xref="gtg-create-new-task"/>
<link type="seealso" xref="gtg-dismiss-task"/>
<link type="seealso" xref="gtg-delete-task"/>
<link type="seealso" xref="gtg-complete-dismiss-delete-task"/>
<link type="seealso" xref="gtg-subtasks"/>
<link type="seealso" xref="gtg-set-task-date"/>

<revision pkgversion="1301" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.3.1" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.4.0" date="2020-05-16" status="candidate"/>
<credit type="author copyright">
<name>Radina Matic</name>
Expand All @@ -28,7 +27,7 @@

</info>

<title>Edit a Task</title>
<title>Editing a Task</title>

<p>To open and edit an already-created task, you can:</p>

Expand Down
4 changes: 2 additions & 2 deletions docs/user_manual/C/gtg-faq.page
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
id="gtg-faq">

<info>
<link type="guide" xref="index#gtg-faq"/>
<link type="guide" xref="index#gtg-further" group="third"/>


<revision pkgversion="1301" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.3.1" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.4.0" date="2020-05-17" status="candidate"/>
<credit type="author copyright">
<name>Radina Matic</name>
Expand Down
4 changes: 2 additions & 2 deletions docs/user_manual/C/gtg-main-window.page
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<link type="seealso" xref="gtg-shortcut-keys"/>
<link type="seealso" xref="gtg-quickstart"/>

<revision pkgversion="1301" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.3.1" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.4.0" date="2020-05-10" status="candidate"/>

<credit type="author copyright">
Expand All @@ -26,7 +26,7 @@

</info>

<title>Understand <app>GTG</app> Main Window</title>
<title>Overview of the Main User Interface</title>
<p>Create, view, and maintain your tasks from the Main Window. Window sections and elements are described below.</p>
<figure>
<title><app>GTG</app> Main Window</title>
Expand Down
6 changes: 3 additions & 3 deletions docs/user_manual/C/gtg-plugins.page
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
id="gtg-plugins">

<info>
<link type="guide" xref="index#gtg-plugins"/>
<link type="guide" xref="index#gtg-further" group="second"/>

<revision pkgversion="1301" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.3.1" date="2013-06-18" status="candidate"/>
<revision pkgversion="0.4.0" date="2020-05-10" status="candidate"/>

<credit type="author copyright">
Expand All @@ -24,7 +24,7 @@

</info>

<title>Understand Plugins</title>
<title>Plugins</title>

<p><app>GTG</app> plugins offer the possibility to extend the basic functionality of the program. Plugins allow you to add new features and change the way <app>GTG</app> works.</p>

Expand Down
2 changes: 1 addition & 1 deletion docs/user_manual/C/gtg-preferences.page
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
id="gtg-preferences">

<info>
<link type="guide" xref="index#gtg-customization"/>
<link type="guide" xref="index#gtg-further" group="first"/>


<revision pkgversion="0.4.0" date="2020-05-10" status="candidate"/>
Expand Down
Loading