Skip to content

Commit

Permalink
Merge 6a14670 into 6ed11ec
Browse files Browse the repository at this point in the history
  • Loading branch information
dragontho committed Nov 11, 2019
2 parents 6ed11ec + 6a14670 commit cadcb31
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 18 deletions.
6 changes: 3 additions & 3 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ image::ModularDisplayClassDiagram.png[]

As our application also comprises a dynamically changing UI in replacement of the `PersonListPanel`, `ModularDisplay` contains multiple other `Panel` classes in itself in order to render the proper screens during runtime. This rendering is controlled by `UpdateUi` in `MainWindow`.

The `UI` component uses JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the link:{repoURL}/src/main/java/seedu/address/ui/MainWindow.java[`MainWindow`] is specified in link:{repoURL}/src/main/resources/view/MainWindow.fxml[`MainWindow.fxml`]
The `UI` component uses JavaFx UI framework. The layouts of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the link:{repoURL}/src/main/java/seedu/address/ui/MainWindow.java[`MainWindow`] is specified in link:{repoURL}/src/main/resources/view/MainWindow.fxml[`MainWindow.fxml`]

The `UI` component,

Expand Down Expand Up @@ -223,7 +223,7 @@ image::ModelClassDiagram.png[]

// end::chenhui-model[]

*API* : link:{repoURL}/src/main/java/seedu/address/model/Model.java[`Model.java`]
*API* : link:{repoURL}/blob/master/src/main/java/seedu/address/model/Model.java[`Model.java`]

The `Model`,

Expand Down Expand Up @@ -262,7 +262,7 @@ image::StorageClassDiagram.png[]

// end::chenhui-storage[]

*API* : link:{repoURL}/src/main/java/seedu/address/storage/Storage.java[`Storage.java`]
*API* : link:{repoURL}/tree/master/src/main/java/seedu/address/storage/Storage.java[`Storage.java`]

The `Storage` component,

Expand Down
Binary file modified docs/DeveloperGuide.pdf
Binary file not shown.
32 changes: 17 additions & 15 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ the use of self-created digital flashcards. *Supercharge your learning with Duke
3. Copy the file to the folder you want to use as the home directory of _Dukemon_ (this is where your
data will be stored).
4. Double-click the `Dukemon.jar` to run the app.
5. Before getting to the quick start instructions, get familiar with our interface and appication modes.
5. Before getting to the quick start instructions, get familiar with our interface and application modes.

=== User Interface

Expand Down Expand Up @@ -118,7 +118,7 @@ image::UserGuideFlowOverview.png[width="790"]

// tag::chenhui-quickstart[]

Lets select the sample _WordBank_ and play a game to get familiar.
Let's select the sample _WordBank_ and play a game to get familiar.


1. `select sample` kbd:[Enter]
Expand All @@ -134,17 +134,17 @@ Getting comfortable? Ready to master the application commands?

_Some typical commands to get familiar with are:_

* *`create <NAME>`*: Create an empty _WordBank_ with specified name. (in Home Mode)
* *`select <NAME>`*: Select and switch to _WordBank_ with the specified name. (in Home Mode)
* *`create <NAME>`*: Creates an empty _WordBank_ with specified name. (in Home Mode)
* *`select <NAME>`*: Selects and switch to _WordBank_ with the specified name. (in Home Mode)
* *`add w/<WORD> m/<MEANING>`*: Adds a new _Card_ with specified _Word_ and _Meaning_ into the current _WordBank_. (in Open Mode)
* *`list`*: List all _Cards_ in the current _WordBank_. (in Open Mode)
* *`list`*: Lists all _Cards_ in the current _WordBank_. (in Open Mode)
* **`start <EASY/MEDIUM/HARD>`**: Starts a _Game_ session with the specified _Difficulty_. Default difficulty in
_Settings_
will be used if not
specified. (after selecting _WordBank_)
* **`guess <YOUR_ANSWER>`**: Make a _Guess_ for the current _Word_ whose _Meaning_ is shown on the UI. (in Game Mode)
* **`guess <YOUR_ANSWER>`**: Makes a _Guess_ for the current _Word_ whose _Meaning_ is shown on the UI. (in Game Mode)
* **`stop`**: Stops the current _Game_ session. (in Game Mode)
* *`exit`*: Exit _Dukemon_. (in any mode except Game)
* *`exit`*: Exits _Dukemon_. (in any mode except Game)

// end::chenhui-quickstart[]

Expand Down Expand Up @@ -216,7 +216,7 @@ Format: `open`
****

==== Start the game: `start`
Start the game with the _WordBank_ selected.
Starts the game with the _WordBank_ selected.

Format: `start [DIFFICULTY]` +

Expand Down Expand Up @@ -313,7 +313,7 @@ Format: `clear`
(Available in Home mode)

==== Select a _WordBank_: `select`
Let Dukemon know what _WordBank_ you have selected.
Lets Dukemon know what _WordBank_ you have selected.

Format: `select WORD_BANK` +
Examples:
Expand All @@ -340,7 +340,7 @@ Examples:
* `remove Vocabulary`

==== Import a _WordBank_: `import`
Import the _WordBank_ from a specified folder path on your system. +
Imports the _WordBank_ from a specified folder path on your system. +

Format: `import w/WORD_BANK f/FOLDER` +

Expand All @@ -361,7 +361,7 @@ NOTE: We have a drag and drop feature. +
You can drag and drop a file from your computer into the section which holds the _WordBanks_.

==== Export a _WordBank_: `export`
Export the _WordBank_ to a specified file path on your system. +
Exports the _WordBank_ to a specified file path on your system. +

Format: `export w/WORD_BANK f/FOLDER` +

Expand Down Expand Up @@ -437,6 +437,8 @@ Format: `guess WORD`

- Makes a guess for the _Word_ described by the currently shown _Meaning_. (*non case-sensitive*)

NOTE: Do take note that the `guess` keyword is automatically enabled for you or every question. There is no need to type `guess` every time you want to guess a word.

2. *Skipping over a _Word_:*
+
Format: `skip`
Expand Down Expand Up @@ -567,12 +569,12 @@ image::avatar151.png[width='250']
`exit` is available in any mode *except* _Game_ mode)

==== Ask for help: `help`
Show the link to the User Guide (appears as a pop-up).
Shows the link to the User Guide (appears as a pop-up).

Format: `help`

==== Take a break: `exit`
Exit and close _Dukemon_.
Exits and closes _Dukemon_.

Format: `exit`

Expand Down Expand Up @@ -614,7 +616,7 @@ image::annotated_global_statistics_ui.png[]

=== Drag and drop

Streamline the process of sharing of _WordBanks_ with friends.
Streamlines the process of sharing of _WordBanks_ with friends.

//.Word bank file
//image:DragAndDrop1.png[130, 130, align="left"]
Expand Down Expand Up @@ -668,7 +670,7 @@ It is also smart enough to remove the _cards_ if you have cleared it afterwards.
.Quick look at revision bank's page.
image:revisionpage.png[450, 450]

Revision bank is best appreciated when you actually play around with some _WordBanks_, and then visit the revision bank
The revision bank is best appreciated when you actually play around with some _WordBanks_, and then visit the revision bank
to revise wrong _cards_. Give it a try!
// end::chenhui-userRevisionBank[]

Expand Down
Binary file removed docs/team/dragontho.pdf
Binary file not shown.

0 comments on commit cadcb31

Please sign in to comment.