forked from nus-cs2103-AY2425S1/tp
-
Notifications
You must be signed in to change notification settings - Fork 5
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
Add cattag instructions to UG #234
Open
chrisjohntan
wants to merge
3
commits into
AY2425S1-CS2103T-F14a-4:master
Choose a base branch
from
chrisjohntan:update-cattag-ug
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+55
−25
Open
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -66,6 +66,30 @@ CampusConnect(CC) is a **desktop app** for managing contacts, optimized for use | |
* If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application. | ||
</box> | ||
|
||
-------------------------------------------------------------------------------------------------------------------- | ||
|
||
## Command summary | ||
|
||
Action | Format, Examples | ||
-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ||
**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL [t/TAG]…` <br> e.g., `add n/James Ho p/22224444 e/[email protected] t/friend t/colleague` | ||
**Clear** | `clear` | ||
**Delete** | `delete INDEX`<br> e.g., `delete 3` | ||
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [t/TAG]…`<br> e.g.,`edit 2 n/James Lee e/[email protected]` | ||
**Find by name** | `find n/KEYWORD [MORE_KEYWORDS]`<br> e.g., `find n/James Jake` | ||
**Find by email** | `find e/KEYWORD [MORE_KEYWORDS]`<br> e.g., `find e/[email protected] [email protected]` | ||
**Find by phone number** | `find p/KEYWORD [MORE_KEYWORDS]`<br> e.g., `find p/91234657 85432789` | ||
**Find by tag** | `find t/KEYWORD [MORE_KEYWORDS]`<br> e.g., `find t/friend roommate` | ||
**Delete tag** | `deltag INDEX t/KEYWORD` <br> e.g. `deltag 1 t/friend` | ||
**Add tag** | `addtag INDEX t/KEYWORD [t/MORE_TAGS]` <br> e.g. `addtag 1 t/friend t/classmate` | ||
**Categorize tag** | `cattag t/TAG [t/MORE_TAGS] CATEGORY` <br> e.g. `cattag t/floorball t/mahjong activity` | ||
**Undo action** | `undo` | ||
**Redo action** | `redo` | ||
**List** | `list` | ||
**Help** | `help` | ||
|
||
-------------------------------------------------------------------------------------------------------------------- | ||
|
||
### Viewing help : `help` | ||
|
||
Shows a message explaining how to access the help page. | ||
|
@@ -164,9 +188,9 @@ Examples: | |
|
||
Adds the specified person's tag. | ||
|
||
Format: `addtag INDEX t/KEYWORD [t/MORE_TAGS]` | ||
Format: `addtag INDEX t/TAG [t/MORE_TAGS]` | ||
|
||
* Adds the tags with the specified name `KEYWORD` of the person at the specified `INDEX`. | ||
* Adds the tags with the specified name `TAG` of the person at the specified `INDEX`. | ||
* The index refers to the index number shown in the displayed person list. | ||
* The index **must be a positive integer** 1, 2, 3, … | ||
* Multiple tags can be added at a time. | ||
|
@@ -180,9 +204,9 @@ Examples: | |
|
||
Deletes the specified person's tag. | ||
|
||
Format: `deltag INDEX t/KEYWORD` | ||
Format: `deltag INDEX t/TAG` | ||
|
||
* Deletes the tag with the specified name `KEYWORD` of the person at the specified `INDEX`. | ||
* Deletes the tag with the specified name `TAG` of the person at the specified `INDEX`. | ||
* The index refers to the index number shown in the displayed person list. | ||
* The index **must be a positive integer** 1, 2, 3, … | ||
* Only one tag can be deleted at a time. | ||
|
@@ -194,6 +218,30 @@ deletes the friend tag of the first person in the list. | |
Disallowed examples: | ||
* `deltag 2 t/classmate t/neighbour` will not succeed as it tries to delete 2 tags at once. | ||
|
||
### Categorizing a tag : `cattag` | ||
|
||
Categorizes a tag under a defined category. | ||
|
||
Format: `cattag t/TAG [t/MORE_TAGS] CATEGORY` | ||
|
||
* Sets the tag(s) in CampusConnect with the specified name `TAG` to fall under the specified `CATEGORY`. | ||
* Currently available categories and their respective keywords are: | ||
|
||
Category | Keyword (case sensitive) | ||
--------------|------------------------- | ||
**General** | `general` | ||
**Academics** | `acads` | ||
**Activities**| `activity` | ||
**Networking**| `network` | ||
**Mentorship**| `mentor` | ||
* Multiple tags can be categorized to the same category at a time. | ||
KrashKart marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* All tags specified must be valid existing tags. | ||
* Attempts to set a tag to its current category will cause the whole command to be rejected. | ||
|
||
Examples: | ||
* `cattag t/CS2100 acads` categorizes the tag `CS2100` under `Academics` | ||
* `cattag t/floorball t/mahjong activity` categorizes both tags `floorball` and `mahjong` under `Activities` | ||
|
||
### Undo a command : `undo` | ||
|
||
Undoes the previous command and reverts CampusConnect. | ||
|
@@ -255,25 +303,6 @@ _Details coming soon ..._ | |
1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again. | ||
2. **If you minimize the Help Window** and then run the `help` command (or use the `Help` menu, or the keyboard shortcut `F1`) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window. | ||
|
||
-------------------------------------------------------------------------------------------------------------------- | ||
|
||
## Command summary | ||
|
||
Action | Format, Examples | ||
-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ||
**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL [t/TAG]…` <br> e.g., `add n/James Ho p/22224444 e/[email protected] t/friend t/colleague` | ||
**Clear** | `clear` | ||
**Delete** | `delete INDEX`<br> e.g., `delete 3` | ||
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [t/TAG]…`<br> e.g.,`edit 2 n/James Lee e/[email protected]` | ||
**Find by name** | `find n/KEYWORD [MORE_KEYWORDS]`<br> e.g., `find n/James Jake` | ||
**Find by email** | `find e/KEYWORD [MORE_KEYWORDS]`<br> e.g., `find e/[email protected] [email protected]` | ||
**Find by phone number** | `find p/KEYWORD [MORE_KEYWORDS]`<br> e.g., `find p/91234657 85432789` | ||
**Find by tag** | `find t/KEYWORD [MORE_KEYWORDS]`<br> e.g., `find t/friend roommate` | ||
**Delete tag** | `deltag INDEX t/KEYWORD` <br> e.g. `deltag 1 t/friend` | ||
**Add tag** | `addtag INDEX t/KEYWORD [t/MORE_TAGS]` <br> e.g. `addtag 1 t/friend t/classmate` | ||
**Categorize tag** | `cattag INDEX t/KEYWORD` | ||
**Undo action** | `undo` | ||
**Redo action** | `redo` | ||
**List** | `list` | ||
**Help** | `help` | ||
`` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 consider condensing find by name, email, phone and tag since we have
SuperFind
now in the command summary and the description