Skip to content

Commit

Permalink
Update User guide and Use cases
Browse files Browse the repository at this point in the history
  • Loading branch information
tiuweehan committed Oct 22, 2019
1 parent 1056d9b commit 6d8db6e
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 10 deletions.
10 changes: 10 additions & 0 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -762,6 +762,16 @@ Use case ends.
+
Use case ends.

[discrete]
=== Use Case 12: See details of an item

*MSS*

1. User requests to see the details of a specified item from the list of items.
2. AlgoBase displays the details of that item.
+
Use case ends.

[appendix]
== Non Functional Requirements

Expand Down
48 changes: 38 additions & 10 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,44 @@ Examples:

* `undonetask plan/1 task/1`

=== Tabs

==== Switching Tabs: `switchtab`
Switches between tabs in the GUI +
Format: `switchtab t/TAB_TYPE i/TAB_INDEX`

* Tab Type
** can be `display` or `details`

Examples:

* `switchtab t/display i/1`
* `switchtab t/details i/2`

==== Open Tabs: `opentab`
Opens a new tab in the GUI +
Format: `opentab m/MODEL_TYPE i/MODEL_INDEX`

* Model Type
** can be `problem`, `tag` or `plan`

Examples:

* `opentab m/problem i/1`
* `opentab m/plan i/2`

==== Close Tabs: `closetab`
Closes a tab in the GUI +
Format: `closetab t/TAB_TYPE i/TAB_INDEX`

* Tab Type
** can be `display` or `details`

Examples:

* `closetab t/display i/1`
* `closetab t/details i/2`

=== Importing and Exporting data

==== Importing data: `import`
Expand Down Expand Up @@ -285,16 +323,6 @@ Examples:

=== Miscellaneous

==== Switching tabs : `switch`

Switches to a tab display in the application. +
Format: `switch INDEX`

Examples:

* `switch 1`
Switches to the tab at index 1.

==== Viewing help : `help`

List all possible commands or find command usage using the command word. +
Expand Down

0 comments on commit 6d8db6e

Please sign in to comment.