diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 347dcb9db0b..8a1b0f4d22b 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -103,7 +103,8 @@ Diving into TAPro, you'll encounter some handy notations and terms. We've decode | **URL** | Uniform Resource Locator | | **JSON** | JavaScript Object Notation | -### Recognised Prefixes for Attributes +### Recognized Prefixes for Attributes + | Prefix | Attribute | |---------|-----------------------------| | **n/** | Name of the student | @@ -188,7 +189,7 @@ A GUI similar to the below image should appear in a few seconds. Note how the ap Words in `UPPER_CASE` are the parameters to be supplied by the user. -#g#Example:## In `add n/NAME`, `NAME` is a parameter which can be used as `add n/John Doe`. +#g#Example:## In `addstu n/NAME`, `NAME` is a parameter which can be used as `addstu n/John Doe`. @@ -221,6 +222,13 @@ A GUI similar to the below image should appear in a few seconds. Note how the ap #g#Example:## If the command specifies `help 123`, it will be interpreted as `help`. + + +Non-recognized prefixes be parsed as part of the previous parameter's value. + +#g#Example:## If the command specifies `addstu n/John Doe a/Non-recognized-prefix`, it would be parsed as `NAME` parameter being `John Doe a/Non-recognized-prefix`, instead of just `John Doe`, as `a/` is not a [recognized prefix](#recognized-prefixes-for-attributes). + + @@ -561,12 +569,12 @@ The last parameter `TAG` is autocompleted. **Autocompletes the last parameter in the input:** -Autocomplete works on the last parameter (if any) in the command box, which is the text directly after a recognized prefix. +Autocomplete works on the last parameter (if any) in the command box, which is the text directly after a [recognized prefix](#recognized-prefixes-for-attributes). When reaching the end of the possible options list, pressing TAB will wrap -A parameter can only be autocompleted if it is not the first word, and has a recognized prefix. +A parameter can only be autocompleted if it is not the first word, and has a [recognized prefix](#recognized-prefixes-for-attributes).