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
Update UG #148
Update UG #148
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good so far, just have to amend some typos and sentence structure.
docs/UserGuide.adoc
Outdated
@@ -207,41 +207,86 @@ exp/23-Nov-2020 a/21` | |||
|
|||
==== Add with system prompting | |||
|
|||
In this mode, the user can add the person's attributes one by one. | |||
After entering an attribute, the system will prompt the user input for another attribute. | |||
In this mode, instead of typing a long command, you can add a person's attributes one by one. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps can add "instead of typing a long command at one go".
docs/UserGuide.adoc
Outdated
|
||
image::form.png[width="790"] | ||
* `/abort` - The command to abandon the current form that you are currently filling. | ||
* `/undo` - The command to undo the last entry that you entered, this can be useful as sometimes you might make some careless mistakes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps can just say "The command to undo the last entry that you entered, which is useful when you want to undo any changes made".
docs/UserGuide.adoc
Outdated
|
||
ORGANice will prompt the user to type in each attribute, one by one until all the fields are filled. | ||
Note that both `/abort` and `/undo` commands can be used at any point in times, while `/done` command can only be used once all the required attributes have been specified. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
at any point in time
docs/UserGuide.adoc
Outdated
For example, when a user wants to add a patient, the display box will prompt the user to enter the patient's name. | ||
For the user to add a patient that is named "John Doe", type `John Doe` and then press enter. | ||
After entering the name, the patient's name will be displayed in the form, as shown below. | ||
That's the important commands for this feature, now let's see an example on how the feature will look like. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These are the important commands for this feature, so now let's take a look at an example of this how this feature can be used.
docs/UserGuide.adoc
Outdated
image::abandonForm.png[width="790"] | ||
|
||
Furthermore, if you made any mistake while you are filling up the form, you can type in `/undo` to remove the last entry you entered. | ||
For example, if you enter the wrong name and want to undo the action, type `/undo` in the `Command Box` and press kbd:[Enter]. Your previous input for the name will be removed from the form ass seen in `Figure 11` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo in as, not ass
docs/UserGuide.adoc
Outdated
At any point in times, if you decided not to proceed with the addition and typed in `/abort`, you will be directed into the main page and notified that | ||
you have abandoned the form as seen in `Figure 10`. | ||
|
||
.The UI changed back to it's original state and shows a message the the form has been abandoned |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo, have two thes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
No description provided.