From fbef5471ab730bbe4e1f8b54195df9817238e98a Mon Sep 17 00:00:00 2001 From: yisiox Date: Sat, 13 Apr 2024 15:24:46 +0800 Subject: [PATCH 01/10] UserGuide.md: Update glossary --- docs/UserGuide.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 21ddf337bb2..41f0ab28817 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -728,9 +728,15 @@ Action | Format ## Glossary +#### Alphanumeric +Consists of only letters and numbers. + #### Asset An item or amenity of logistical significance. +#### Character +A single letter, number, or symbol. Examples: `a`, `1`, `&`, `-`. + #### Clipboard A place where text is stored in the computer, and can be typically retrieved with `right click -> paste`, `Ctrl+V`, or `Command+V`. @@ -745,9 +751,3 @@ Windows, MacOS and Linux are examples of operating systems. #### Parameter A detail that a command expects to be entered by the user. For example, name is a parameter of the `add` command. - -#### Character -A single letter, number, or symbol. Examples: `a`, `1`, `&`, `-`. - -#### Alphanumeric -Consists of only letters and numbers. From d75323b64ddc26898166444246c9b069ad3cf696 Mon Sep 17 00:00:00 2001 From: yisiox Date: Sat, 13 Apr 2024 15:39:03 +0800 Subject: [PATCH 02/10] Fix multiple errors in UG Resolves multiple minor mistakes in the user guide such as alphabetical order and grammatical mistakes. Also specified that the backslash is not allowed as input in the parameters. --- docs/UserGuide.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 41f0ab28817..a5df299e0fe 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -44,7 +44,7 @@ referenced section immediately. A [glossary](#glossary) is provided in case you encounter any unfamiliar terms. - Look out for icons like this, which may contain addition information, tips and warnings. + Look out for icons like this, which indicate addition information, tips and warnings. @@ -91,8 +91,8 @@ or skip to the [command summary](#command-summary). + [Finding Contacts](#finding-contacts-find) + [Undoing Commands](#undoing-commands-undo) + [Redoing Commands](#redoing-commands-redo) - + [Navigating Command History](#navigating-command-history-and) - + [Copy a Field from a Contact](#copy-a-field-from-a-contact-copy) + + [Navigating Command History](#navigating-command-history--and-) + + [Copying a Field from a Contact](#copying-a-field-from-a-contact-copy) + [Getting Help](#getting-help-help) + [Exiting the Application](#exiting-the-application-exit) + [Saving the data file](#saving-the-data-file) @@ -140,7 +140,7 @@ The following instructions are for **Windows**, **MacOS** and **Linux**.

- Having trouble? You may find the FAQ useful. + Having trouble? You may find the FAQ useful.
@@ -362,6 +362,12 @@ up instead. + + +Note that the backslash `\` is **not** allowed to be inputted as part of any parameter as it is reserved to signify the prefixes. + + + ---
@@ -601,7 +607,7 @@ Only successfully executed commands are saved in the command history. --- -### Copy a Field from a Contact: `copy` +### Copying a Field from a Contact: `copy` Copies a specific field to your clipboard for ease of pasting elsewhere. @@ -667,7 +673,7 @@ Furthermore, certain edits can cause the *AssetBook* to behave in unexpected way ## Frequently Asked Questions -**Q**: My device is running MacOS, and the text is not displaying correctly.
+**Q**: My device is running MacOS, and the text is not displaying correctly. What should I do?
**A**: Try installing [this](https://www.azul.com/downloads/?version=java-11-lts&os=macos&architecture=arm-64-bit&package=jdk-fx) Java 11 version instead. **Q**: My device is running an operating system that is not Windows, MacOS or Linux. Can I use *AssetBook*?
From 97ce9f97984f94eab266fd28bca65aec030c86ff Mon Sep 17 00:00:00 2001 From: yisiox Date: Sat, 13 Apr 2024 15:50:06 +0800 Subject: [PATCH 03/10] UserGuide.md: Revert wrongly changed hyperlink --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index a5df299e0fe..df7920c5290 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -91,7 +91,7 @@ or skip to the [command summary](#command-summary). + [Finding Contacts](#finding-contacts-find) + [Undoing Commands](#undoing-commands-undo) + [Redoing Commands](#redoing-commands-redo) - + [Navigating Command History](#navigating-command-history--and-) + + [Navigating Command History](#navigating-command-history-and) + [Copying a Field from a Contact](#copying-a-field-from-a-contact-copy) + [Getting Help](#getting-help-help) + [Exiting the Application](#exiting-the-application-exit) From 3e5a143775a75874c8026a946edb78604046010f Mon Sep 17 00:00:00 2001 From: yisiox Date: Sat, 13 Apr 2024 22:03:43 +0800 Subject: [PATCH 04/10] UserGuide.md: Improve phrasing --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index df7920c5290..d7889d959fc 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -364,7 +364,7 @@ up instead. -Note that the backslash `\` is **not** allowed to be inputted as part of any parameter as it is reserved to signify the prefixes. +Note that the backslash `\` is reserved for prefixes. It is **not** allowed to be part of any inputted parameter. From 8c8ebaefc928a7c27a5a41ddbf7934f737613f1f Mon Sep 17 00:00:00 2001 From: yisiox Date: Sat, 13 Apr 2024 23:30:37 +0800 Subject: [PATCH 05/10] UserGuide.md: Fix page breaks --- docs/UserGuide.md | 23 +++++++---------------- 1 file changed, 7 insertions(+), 16 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index d7889d959fc..823c745c569 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -166,25 +166,16 @@ You can resize the command output box by dragging the top edge. --- +
+ ### Tutorials This section provides a walkthrough of common actions performed in *AssetBook*. +Here we show you how to add a contact associated with an asset, search for your added contact and edit it. All actions are performed through typing specific text into the [command input box](#navigating-the-gui). For detailed documentation of all available features, please refer to the [features](#features) section. - - -**Tips for Beginners** - -- Always double-check the details you enter. -- If an action doesn't work as expected, review the command format and your input. -- Practice makes perfect. Try adding a few contacts and assets to get comfortable with the commands. - - - -
- #### Adding Your First Contact Let's get started by adding our first contact, John Doe, into AssetBook. @@ -246,8 +237,8 @@ Let's update the email of our first contact added John. Begin by locating and clicking into the command input box within the AssetBook interface. 2. **Find out what is John's Index**: - Firstly, using the previous command `find`, we can find out what index John has by checking the number beside his name. - In this case he has index 1. + We can find out what index John has by checking the number beside his name. The `find` command makes this easier by + limiting the number of contacts displayed on the screen. Here he has index 1.

@@ -318,8 +309,6 @@ A valid input by the user corresponding to the above will be `add n\John Doe e\johndoe@example.com a\574 Ang Mo Kio Ave 10 p\12345678 A\L293D` -
- Command words are not case-sensitive, i.e. `add`, `Add`, `ADD`, etc. are all valid. @@ -530,6 +519,8 @@ If you unintentionally deleted all contacts, you can use the `undo` command to r --- +
+ ## Miscellaneous Shortcuts This section contains the details for **non-modifying commands** and other useful shortcuts. From 078ed6e749223dea3308093084df8d87fe6befaa Mon Sep 17 00:00:00 2001 From: yisiox Date: Sun, 14 Apr 2024 02:29:54 +0800 Subject: [PATCH 06/10] UserGuide.md: Update information for MacOS --- docs/UserGuide.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 823c745c569..6b97b537529 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -23,7 +23,7 @@ Rejoice because *AssetBook* is here! *AssetBook* helps to streamline the task of **tracking contacts and which logistical assets they are in charge of**, making your management tasks smoother than ever. -*AssetBook* is designed to: +*AssetBook* is a **contact management application** designed to: + **Digitally Organize Your Contacts**
Say goodbye to scattered contacts; now, have them all organized and accessible in one place. @@ -176,6 +176,8 @@ Here we show you how to add a contact associated with an asset, search for your All actions are performed through typing specific text into the [command input box](#navigating-the-gui). For detailed documentation of all available features, please refer to the [features](#features) section. +--- + #### Adding Your First Contact Let's get started by adding our first contact, John Doe, into AssetBook. @@ -205,6 +207,8 @@ Let's get started by adding our first contact, John Doe, into AssetBook.

+--- +
#### Searching for Contacts @@ -228,6 +232,8 @@ Now that you've successfully added John Doe to AssetBook, let's go through the s

+--- +
#### Editing your Contact @@ -243,6 +249,8 @@ Let's update the email of our first contact added John.

+--- +
3. **Enter the Edit Command**: @@ -264,6 +272,8 @@ We can edit John's email by typing the following command:

+--- +
#### Editing Assets @@ -667,6 +677,9 @@ Furthermore, certain edits can cause the *AssetBook* to behave in unexpected way **Q**: My device is running MacOS, and the text is not displaying correctly. What should I do?
**A**: Try installing [this](https://www.azul.com/downloads/?version=java-11-lts&os=macos&architecture=arm-64-bit&package=jdk-fx) Java 11 version instead. +**Q**: My device is running MacOS, and I am unable to open `assetbook.jar` by double-clicking. What should I do? +**A**: Right click `assetbook.jar`, then select 'Open'. Select 'Open' on the pop-up to start the application. + **Q**: My device is running an operating system that is not Windows, MacOS or Linux. Can I use *AssetBook*?
**A**: *AssetBook* may work on your device, but it is not guaranteed to work. If there is high demand, we may start supporting new operating systems! From cde91b1bd0b6e7ec58e403769544265060e7ee42 Mon Sep 17 00:00:00 2001 From: bryanyee33 Date: Sun, 14 Apr 2024 17:44:10 +0800 Subject: [PATCH 07/10] Improve phrasings --- docs/UserGuide.md | 146 ++++++++++++++++++++++++---------------------- 1 file changed, 77 insertions(+), 69 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 6b97b537529..173fd19f8d9 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -12,24 +12,24 @@ Welcome **logistics managers**! If you are someone who -+ **Manages logistics and inventory** in a professional capacity, ++ **Manages logistics and inventory** in a professional capacity -+ Is a **fast typist**, tired of shuffling back and forth between your mouse and keyboard, ++ Is a **fast typist**, tired of shuffling back and forth between a mouse and keyboard + Is feeling **swamped by the tedium of contact management** on traditional office software... Rejoice because *AssetBook* is here! -*AssetBook* helps to streamline the task of **tracking contacts and which logistical assets they are in charge of**, +*AssetBook* helps to streamline the task of **tracking contacts and the logistical assets they are in charge of**, making your management tasks smoother than ever. *AssetBook* is a **contact management application** designed to: -+ **Digitally Organize Your Contacts**
Say goodbye to scattered contacts; now, have them all organized and accessible in one place. ++ **Digitally Organize your Contacts:**
Say goodbye to scattered contacts. Have them all organized and easily accessible in one place. -+ **Effortlessly Track All Your Assets**
Keep tabs on who is responsible for every piece of equipment and every item in your inventory. ++ **Effortlessly Track all your Assets:**
Keep tabs on who is responsible for every piece of equipment and item in your inventory. -+ **Maximize Your Operational Efficiency**
Our application, combined with your swift keyboard skills, turns the chore of contact management into a seamless and satisfying process ++ **Maximize your Operational Efficiency:**
Our application, combined with your swift keyboard skills, turns the chore of contact management into a seamless and satisfying process with convenient commands and shortcuts. --- @@ -39,31 +39,28 @@ making your management tasks smoother than ever. ## Using this Guide This user guide is meant to provide guidance for using *AssetBook* and comprehensively document its features. -You can click on blue-colored hyperlinks like this link to the [table of contents](#table-of-contents) to jump to the +You can click on blue-colored texts such as this link to the [table of contents](#table-of-contents) to jump to the referenced section immediately. + A [glossary](#glossary) is provided in case you encounter any unfamiliar terms. - Look out for icons like this, which indicate addition information, tips and warnings. - - - - Use the sidebar to the right to immediately jump to any section from anywhere on this page. + Look out for texts with icons similar to this, which would contain additional information, tips, or warnings. #### New Users -If this your first time using *AssetBook*, head over to the [quick start](#quick-start) to learn how to set up the +If this your first time using *AssetBook*, head to the [quick start](#quick-start) to learn how to set up the application and get started. -After which, you can have a look at the [features](#features) of *AssetBook*, or simply follow this guide in order. +After which, you may take a look at the [features](#features) of *AssetBook*, or simply follow this guide in order. - If you do not have much technical know-how, not to worry! We will guide you through step-by-step. + Don't worry if you don't have much technical know-how! We will guide you through step-by-step. #### Experienced Users -If you are not a new user, and are just looking to refresh your memory, you can utilise the [table of contents](#table-of-contents) +If you are not a new user and are just looking to refresh your memory, you can utilise the [table of contents](#table-of-contents) or skip to the [command summary](#command-summary). --- @@ -124,7 +121,7 @@ The following instructions are for **Windows**, **MacOS** and **Linux**.

-3. Move the file into the folder where you want *AssetBook* to store the contact information. New users may simply +3. Move `assetbook.jar` into the folder where you want *AssetBook* to store the contact information. New users may simply create a folder on their desktop, then drag and drop `assetbook.jar` inside.

@@ -132,7 +129,7 @@ The following instructions are for **Windows**, **MacOS** and **Linux**.

-4. To launch the application, double-click on the `assetbook.jar` file and a GUI as shown in the following section should appear. +4. To launch the application, double-click on `assetbook.jar` and a GUI similar to the one below should appear. Note that the application contains some sample data when launched for the first time.

@@ -161,7 +158,7 @@ Here are the components of the GUI. 6. **Assets** -You can resize the command output box by dragging the top edge. +You can resize the command output box by dragging its top edge. --- @@ -170,26 +167,26 @@ You can resize the command output box by dragging the top edge. ### Tutorials -This section provides a walkthrough of common actions performed in *AssetBook*. +This section provides a walkthrough of common tasks performed in *AssetBook*. -Here we show you how to add a contact associated with an asset, search for your added contact and edit it. -All actions are performed through typing specific text into the [command input box](#navigating-the-gui). -For detailed documentation of all available features, please refer to the [features](#features) section. +Here we show you how to add a contact with an associated asset, search for your added contact, and edit it. +All commands are performed by typing specific texts into the [command input box](#navigating-the-gui). +For detailed information on all available features, please refer to the [features](#features) section. --- #### Adding Your First Contact -Let's get started by adding our first contact, John Doe, into AssetBook. +Let's get started by adding our first contact, John Doe, into *AssetBook*. 1. **Click on the Command Input Box**: - Begin by locating and clicking into the [command input box](#navigating-the-gui) at the bottom of your application's interface. + Begin by locating and clicking on the [command input box](#navigating-the-gui) near the bottom of the application.

-2. **Adding Our First Contact, John**: +2. **Adding Our First Contact**: Let's add your first contact, John, by copying the following command into the command input box:
`add n\John Doe p\98765432 e\johnd@example.com a\311, Clementi Ave 2, #02-25 t\friends t\owesMoney A\screwdriver`

@@ -197,12 +194,12 @@ Let's get started by adding our first contact, John Doe, into AssetBook.

3. **Execute the Command**: - After typing the command, simply press `Enter` to add the contact to AssetBook. + After typing the command, simply press `Enter` to add the contact into *AssetBook*.
4. **Confirmation**: - Check for a confirmation message in the application to verify that John Doe has been added successfully. + Check for a confirmation message to verify that John Doe has been added successfully.

@@ -212,22 +209,22 @@ Let's get started by adding our first contact, John Doe, into AssetBook.
#### Searching for Contacts -Now that you've successfully added John Doe to AssetBook, let's go through the steps to find his contact. +Now that you've successfully added John Doe to *AssetBook*, let's try to find his contact. 1. **Click the Command Input Box**: - First, click into the command input box in the AssetBook interface. This is where you'll enter your find command. + First, click on the command input box of *AssetBook*. This is where you'll enter the find command. 2. **Enter the Find Command**: - Let's now find the contact, John, we just added by copying the following command:
+ Let's now find the contact, John, we just added by entering the following command:
`find John`

3. **Execute the Command**: - After typing the command, simply press `Enter` to find the contact in AssetBook. + After typing the command, simply press `Enter` to find the contact in *AssetBook*. 4. **View the Results**: - The application will display John Doe in the contacts list, along with the total number of entries matching 'John' found. + John Doe will be displayed in the contacts list, along with the total number of contacts matching 'John' found.

@@ -237,18 +234,22 @@ Now that you've successfully added John Doe to AssetBook, let's go through the s
#### Editing your Contact -Let's update the email of our first contact added John. +Let's update John's email address. 1. **Click on the Command Input Box**: - Begin by locating and clicking into the command input box within the AssetBook interface. + Begin by locating and clicking on the command input box. -2. **Find out what is John's Index**: - We can find out what index John has by checking the number beside his name. The `find` command makes this easier by - limiting the number of contacts displayed on the screen. Here he has index 1. +2. **Find out John's Index**: + We can find out what John's index is by checking the number currently beside his name. The `find` command makes it easier by + reducing the number of contacts displayed. Here, he has index 1.

+ +The index each contact has changes when you use the find command. + + ---
@@ -261,13 +262,13 @@ We can edit John's email by typing the following command:

-4. **Execute the Command** - Press `Enter` after typing in the command. This will update John's contact details in AssetBook. +4. **Execute the Command**: + Press `Enter` after typing in the command. This will update John's email address.
-5. **Confirmation** - Look for a confirmation message in AssetBook, indicating that John's email address has been successfully updated. +5. **Confirmation**: + Look for a confirmation message, indicating that John's email has been successfully updated.

@@ -277,13 +278,13 @@ We can edit John's email by typing the following command:
#### Editing Assets -Let's update the assets we already have. +Let's update our existing assets. 1. **Click on the Command Input Box**: - Start by clicking into the command input box located within the AssetBook interface. + Start by clicking on the command input box. 2. **Enter the Edit Asset Command**: - If you need to rename an asset, for instance from "screwdriver" to "screw", use the following command:
+ We can change all assets with the name "screwdriver" to "screw" using the following command:
`asset o\screwdriver n\screw`

@@ -291,10 +292,10 @@ Let's update the assets we already have.

3. **Execute the Command**: - After entering the command, press `Enter`. This action will update the asset's details in AssetBook. + After entering the command, press `Enter`. This will update the asset details in *AssetBook*. 4. **Confirmation**: - Wait for a confirmation message in AssetBook to ensure that the asset has been successfully updated. + Check for a confirmation message to ensure that the asset has been successfully updated.

@@ -305,11 +306,11 @@ Let's update the assets we already have. ## Features -This section documents in detail all the features of *AssetBook*. +This section documents all the features of *AssetBook* in detail. -Most features of *AssetBook* come in the form of *commands*, which are *specific text inputs* that the user enters to -perform an action in the application. Features fall into two broad categories: those that allow the user to **modify -contact data** and those that are **miscellaneous shortcuts** for convenience. +Most features of *AssetBook* come in the form of *commands*, which are *specific text inputs* that the user enters +into the application. Features fall into two broad categories: those that allow the user to **modify contact data**, +and those that are **miscellaneous shortcuts** for convenience. Colored text that look like the following describe the format of a command. @@ -331,39 +332,39 @@ Command words are not case-sensitive, i.e. `add`, `Add`, `ADD`, etc. are all val * Here, `add` is the *command word*, signifying that this adds a new contact to the list of contacts. -* `n\`, `p\`, `e\`, etc. are *prefixes* of *parameters*, signifying the text after them is some data field of the contact. - They are included in the text that the user should input. +* Parameters have the format `PREFIX\FIELD`.
+ e.g. `n\`, `p\`, `e\` are prefixes. +`John Doe`, `98765432`, `johnd@example.com` are respective examples of fields. -* Text in bold like `NAME` are descriptions of what kind of text should be entered in its place.
- e.g. `n\John Doe` should be entered in place of `n\NAME`. +* Text that are capitalized like `NAME` are descriptions of what kind of text the field should be.
+ e.g. For `n\NAME`, `n\John Doe` should be entered in its place. * Items in square brackets are optional.
- e.g. `n\NAME [t\TAG]` can represent `n\John Doe t\friend` or simply `n\John Doe`. + e.g. For `n\NAME [t\TAG]`, both `n\John Doe t\friend` and `n\John Doe` are valid. * Items followed by `...` indicates that it can be entered multiple times.
- e.g. `[t\TAG]...` can represent `t\friend`, `t\friend t\colleague`, etc. + e.g. For `[t\TAG]...`, both `t\friend` and `t\friend t\colleague` are valid. * Parameters can be in any order.
- e.g. if the command specifies `n\NAME p\PHONE`, `p\PHONE n\NAME` is also acceptable. + e.g. if the command specifies `n\NAME p\PHONE`, `p\PHONE n\NAME` is also valid. -* Parameters not specified by the command format entered by the user will be ignored.
+* Parameters entered by the user but not specified by the command format will be ignored.
e.g. The format is `exit`, but the user enters `exit 123`. This will still be interpreted as `exit`. After successful execution of a command, some feedback will appear in the [command output box](#navigating-the-gui). -If you enter something that the application did not expect or does not understand, often an *error* message will show -up instead. +If you enter something that the application did not expect or does not understand, an *error* message will show up instead. -**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. +**If you are using a PDF version of this document**, be careful when you copy and paste commands that span multiple lines, as space characters may be missing when copied over to the application. -Note that the backslash `\` is reserved for prefixes. It is **not** allowed to be part of any inputted parameter. +Note that the backslash `\` is reserved for prefixes. It is **not** allowed to be part of any field. @@ -377,7 +378,7 @@ This section contains the details for **modifying commands**, which add, edit or ### Adding a Contact: `add` -Adds a new contact, with 0 or more assets associated with the contact. +Adds a new contact. Format: `add n\NAME p\PHONE e\EMAIL a\ADDRESS [t\TAG]... [A\ASSET]...` @@ -408,7 +409,7 @@ If the command was executed successfully, the following message will appear:
#### Failure -If the example was not executed successfully, the proper syntax of the `add` command will be shown to you instead. +If the command was not executed successfully, the proper format of the `add` command will be shown to you instead.

@@ -416,7 +417,7 @@ If the example was not executed successfully, the proper syntax of the `add` com

-#### Parameters +#### Fields `NAME` * Name of the contact. * Case sensitive, i.e. `john doe` is not the same as `John Doe`. @@ -427,7 +428,7 @@ If the example was not executed successfully, the proper syntax of the `add` com * Phone number of the contact. * Only digits, '+', '-', ',' and spaces are allowed. * The phone number must contain at least 3 characters. -* Example: `+65-8765-4321, +97 6223 5555`. +* Example: `+65-8765-4321, +97 6223 5555` is allowed. `EMAIL` * Email of the contact. @@ -445,6 +446,7 @@ If the example was not executed successfully, the proper syntax of the `add` com `TAG` * Tag(s) to categorize the contact into. * Only digits and alphabets are allowed. +* Spaces are not allowed. `ASSET` * Asset(s) associated with contact. @@ -687,7 +689,7 @@ Furthermore, certain edits can cause the *AssetBook* to behave in unexpected way **A**: While it may work with other versions of Java, *AssetBook* is developed specifically for Java 11. We cannot guarantee that it works on versions other than Java 11. **Q**: How do I transfer my data to a new device?
-**A**: Set up AssetBook on the new device and copy the `data` folder from the old device to the new device. Ensure that the `data` folder is located in the same folder as `assetbook.jar`. +**A**: Set up *AssetBook* on the new device and copy the `data` folder from the old device to the new device. Ensure that the `data` folder is located in the same folder as `assetbook.jar`. --- @@ -718,7 +720,7 @@ details to assets such as serial number, location, etc. ## Command Summary -Action | Format | Example +Command | Format | Example -----------------|-------------------------------------------------------------------------------|--- **Add** | `add n\NAME p\PHONE e\EMAIL a\ADDRESS [t\TAG]... [A\ASSET]...` | `add n\John Doe e\johndoe@example.com p\+12345678 A\L293D` **Delete** | `delete INDEX` | `delete 1` @@ -753,6 +755,9 @@ A place where text is stored in the computer, and can be typically retrieved wit #### Command A specific text input entered into the command input box to interact with *AssetBook*. +#### Field + + #### GUI Graphical User Interface. The window that appears when an application is launched. @@ -761,3 +766,6 @@ Windows, MacOS and Linux are examples of operating systems. #### Parameter A detail that a command expects to be entered by the user. For example, name is a parameter of the `add` command. + +#### Prefix + From ec8d4b73f8aaaad59988002869757d525af9a993 Mon Sep 17 00:00:00 2001 From: bryanyee33 Date: Sun, 14 Apr 2024 19:30:59 +0800 Subject: [PATCH 08/10] Add missing terms and improve wordings --- docs/UserGuide.md | 98 ++++++++++++++++++++++------------------------- 1 file changed, 45 insertions(+), 53 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 173fd19f8d9..9cb59e755f3 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -45,17 +45,17 @@ referenced section immediately. A [glossary](#glossary) is provided in case you encounter any unfamiliar terms. - Look out for texts with icons similar to this, which would contain additional information, tips, or warnings. +Look out for texts with icons similar to this, which would contain additional information, tips, or warnings. #### New Users -If this your first time using *AssetBook*, head to the [quick start](#quick-start) to learn how to set up the +If this your first time using *AssetBook*, head over to [quick start](#quick-start) to learn how to set up the application and get started. After which, you may take a look at the [features](#features) of *AssetBook*, or simply follow this guide in order. - Don't worry if you don't have much technical know-how! We will guide you through step-by-step. +Don't worry if you don't have much technical know-how! We will guide you through step-by-step. #### Experienced Users @@ -88,7 +88,7 @@ or skip to the [command summary](#command-summary). + [Finding Contacts](#finding-contacts-find) + [Undoing Commands](#undoing-commands-undo) + [Redoing Commands](#redoing-commands-redo) - + [Navigating Command History](#navigating-command-history-and) + + [Display Previous Commands](#display-previous-commands-and) + [Copying a Field from a Contact](#copying-a-field-from-a-contact-copy) + [Getting Help](#getting-help-help) + [Exiting the Application](#exiting-the-application-exit) @@ -108,9 +108,7 @@ or skip to the [command summary](#command-summary). ### Setting Up - The following instructions are for **Windows**, **MacOS** and **Linux**. - 1. Ensure you have [Java 11](https://www.oracle.com/java/technologies/downloads/#java11) installed on your device. @@ -137,7 +135,7 @@ The following instructions are for **Windows**, **MacOS** and **Linux**.

- Having trouble? You may find the FAQ useful. +Having trouble? You may find the FAQ useful.
@@ -321,9 +319,7 @@ A valid input by the user corresponding to the above will be `add n\John Doe e\johndoe@example.com a\574 Ang Mo Kio Ave 10 p\12345678 A\L293D` - Command words are not case-sensitive, i.e. `add`, `Add`, `ADD`, etc. are all valid. - @@ -357,15 +353,11 @@ After successful execution of a command, some feedback will appear in the [comma If you enter something that the application did not expect or does not understand, an *error* message will show up instead. - **If you are using a PDF version of this document**, be careful when you copy and paste commands that span multiple lines, as space characters may be missing when copied over to the application. - - Note that the backslash `\` is reserved for prefixes. It is **not** allowed to be part of any field. - --- @@ -446,7 +438,6 @@ If the command was not executed successfully, the proper format of the `add` com `TAG` * Tag(s) to categorize the contact into. * Only digits and alphabets are allowed. -* Spaces are not allowed. `ASSET` * Asset(s) associated with contact. @@ -455,9 +446,7 @@ If the command was not executed successfully, the proper format of the `add` com * Multiple assets can be specified at once. For example, a valid option is `A\asset1 A\asset2 A\asset3`. - You may assign the same asset to multiple contacts, so remember to name different assets with unique names. - --- @@ -472,9 +461,9 @@ Format: `delete INDEX` #### Example -`delete 1` deletes the contact with index `1`. +`delete 1` deletes the contact at index `1`. -* `INDEX` refers to the unique contact index shown in the GUI. +* `INDEX` refers to the unique contact index shown beside the contact names. --- @@ -485,18 +474,16 @@ Edit existing contacts without recreating them. Format: `edit INDEX [n\NAME] [p\PHONE] [e\EMAIL] [a\ADDRESS] [t\TAG]... [A\ASSET]...` #### Example -`edit 1 e\newemail@example.com` edits the contact with id `1`, changing its email to `newemail@example.com`. +`edit 1 e\newemail@example.com` edits the contact with index `1`, changing its email to `newemail@example.com`. -* Edits the contact with the specified `INDEX`. `INDEX` refers to the unique contact index shown in the GUI. -* At least one of the optional fields must be provided. -* Existing values will be updated to the input values. +* Edits the contact at the specified `INDEX`. `INDEX` refers to the unique contact index shown in the GUI. +* At least one of the optional parameters must be provided. +* Existing fields will be changed to the inputted fields. * You can remove all tags associated to the contact by typing `t\` without specifying any tags after it. * You can remove all assets associated to the contact by typing `A\` without specifying any assets after it. - -Edit **replaces** the current assets associated to a contact. It does **not** add to the list of associated assets. - +Edit **replaces** the current tags and assets of a contact. It does **not** add on to existing tags and assets. --- @@ -524,9 +511,7 @@ Deletes all contacts. Format: `clear` - -If you unintentionally deleted all contacts, you can use the `undo` command to revert this. - +If you unintentionally deleted all your contacts, you can use the `undo` command to bring them back. --- @@ -543,11 +528,13 @@ Displays all contacts. Format: `list` +* Useful when you have filtered the contacts list with `find`. + --- ### Finding Contacts: `find` -Finds contacts by names, tags or assets. +Finds contacts by name, tag or asset. Format: `find QUERY` @@ -555,7 +542,7 @@ Format: `find QUERY` `find John` searches all contact names, tags and assets for the query `John`. * The query is case-insensitive. -* All whitespaces in both the query and fields will be ignored. +* Spaces in both query and fields will be ignored. * Each field is individually checked against the query. * A match is found if the field contains the entire query, i.e. the field `assets` contains `set`, but does not contain `settings`. @@ -587,39 +574,39 @@ Format: `redo` If an asset name was changed, after `undo` was executed to verify what the previous asset name was, `redo` can be used to revert to the new asset name. - After executing an `undo` command, you cannot `redo` this if another modifying command was executed. - ---
-### Navigating Command History: `↑` and `↓` +### Display Previous Commands: `↑` and `↓` -Use keyboard shortcuts to navigate the command history. +Displays previously executed commands, which can then be edited and executed again. -Press the `↑` arrow key to view the previous command. +Press the `↑` arrow key to show older commands. -Press the `↓` arrow key to view the next command. +Press the `↓` arrow key to show newer commands. -Only successfully executed commands are saved in the command history. +Only successfully executed commands will be shown. --- ### Copying a Field from a Contact: `copy` -Copies a specific field to your clipboard for ease of pasting elsewhere. +Copies a specific field to your clipboard, which you can paste elsewhere. Format: `copy INDEX PREFIX` +* `INDEX` refers to the unique contact index shown in the GUI. + #### Example -`copy 1 p\` copies the phone number of the first contact displayed onto the clipboard. +`copy 1 p\` copies the phone number of the contact with index `1` onto the clipboard. -* `INDEX` refers to the unique contact index shown in the GUI. +
#### Prefix Reference @@ -646,7 +633,7 @@ Format: `help` ### Exiting the Application: `exit` -Exits the application. Equivalent to pressing the cross in the top right corner. +Exits the application. Equivalent to pressing `X` on the top right corner on Windows, and top left corner on MacOS. Format: `exit` @@ -666,8 +653,9 @@ Advanced users are welcome to update data directly by editing that data file. **Caution:** -If your changes to the data file makes its format invalid, *AssetBook* will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
+If your changes to the data file makes the format invalid, *AssetBook* will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
Furthermore, certain edits can cause the *AssetBook* to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly. + --- @@ -679,11 +667,14 @@ Furthermore, certain edits can cause the *AssetBook* to behave in unexpected way **Q**: My device is running MacOS, and the text is not displaying correctly. What should I do?
**A**: Try installing [this](https://www.azul.com/downloads/?version=java-11-lts&os=macos&architecture=arm-64-bit&package=jdk-fx) Java 11 version instead. -**Q**: My device is running MacOS, and I am unable to open `assetbook.jar` by double-clicking. What should I do? -**A**: Right click `assetbook.jar`, then select 'Open'. Select 'Open' on the pop-up to start the application. +**Q**: My device is running MacOS, and I am unable to open `assetbook.jar` by double-clicking. What should I do?
+**A**: Hold `Ctrl` and click on `assetbook.jar`. Select 'Open', and then 'Open' again to start the application. + +**Q**: My device is running Linux, and I am unable to open `assetbook.jar` by double-clicking. What should I do?
+**A**: Open the terminal, enter `java -jar path/to/assetbook.jar`, replacing `path/to` with the location where `assetbook.jar` is saved. **Q**: My device is running an operating system that is not Windows, MacOS or Linux. Can I use *AssetBook*?
-**A**: *AssetBook* may work on your device, but it is not guaranteed to work. If there is high demand, we may start supporting new operating systems! +**A**: *AssetBook* may work on your device, but it is not guaranteed to work. If there is high demand, we may start supporting other operating systems! **Q**: Do I have to use Java 11 specifically?
**A**: While it may work with other versions of Java, *AssetBook* is developed specifically for Java 11. We cannot guarantee that it works on versions other than Java 11. @@ -707,12 +698,12 @@ that may include symbols such as `/`, `'` and `-`. As such, the application may A remedy is planned for the future to perform more robust checks on names. #### Scrolling -The astute user will notice that ability to scroll with keyboard is missing from the application's features. This feature -will be implemented in an upcoming release as soon as possible. +An astute user may notice that the ability to scroll with the keyboard is missing from the application. This feature +will be implemented as soon as possible in an upcoming release. #### More Asset Details -Some users may require greater detail about the assets to be recorded. We plan to add features to support adding more -details to assets such as serial number, location, etc. +Some users may require assets to have more details recorded. We plan to add features that allow adding of more +fields to assets such as serial number, location, etc. --- @@ -726,12 +717,13 @@ Command | Format **Delete** | `delete INDEX` | `delete 1` **Edit contact** | `edit INDEX [n\NAME] [p\PHONE] [e\EMAIL] [a\ADDRESS] [t\TAG]... [A\ASSET]...` | `edit 1 e\newemail@example.com` **Edit asset** | `asset o\OLD_ASSET_NAME n\NEW_ASSET_NAME` | `asset o\hammer n\screwdriver` +**Clear** | `clear` | `clear` **List** | `list` | `list` **Find** | `find QUERY` | `find John` **Undo** | `undo` | `undo` **Redo** | `redo` | `redo` -**Clear** | `clear` | `clear` **Copy** | `copy INDEX PREFIX` | `copy 1 p\` +**Help** | `help` | `help` **Exit** | `exit` | `exit` --- @@ -756,7 +748,7 @@ A place where text is stored in the computer, and can be typically retrieved wit A specific text input entered into the command input box to interact with *AssetBook*. #### Field - +A detail that is part of a parameter, and is after the prefix. For example, `NAME` is a field of the `n\NAME` parameter. #### GUI Graphical User Interface. The window that appears when an application is launched. @@ -765,7 +757,7 @@ Graphical User Interface. The window that appears when an application is launche Windows, MacOS and Linux are examples of operating systems. #### Parameter -A detail that a command expects to be entered by the user. For example, name is a parameter of the `add` command. +A detail that a command expects to be entered by the user. For example, `n\NAME` is a parameter of the `add` command. #### Prefix - +A detail that is part of a parameter, and is before the field. For example, `n\` is a prefix of the `n\NAME` parameter. From 6e3bcaf4b11637092f9806525b47b56f102f0953 Mon Sep 17 00:00:00 2001 From: yisiox Date: Mon, 15 Apr 2024 00:41:41 +0800 Subject: [PATCH 09/10] UserGuide.md: Update editing data file --- docs/UserGuide.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 9cb59e755f3..7ab097f8631 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -653,8 +653,9 @@ Advanced users are welcome to update data directly by editing that data file. **Caution:** -If your changes to the data file makes the format invalid, *AssetBook* will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
-Furthermore, certain edits can cause the *AssetBook* to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly. +Editing the JSON file directly is a feature meant only for advanced users. +If you edit the JSON file, it is your responsibility to ensure that the edits are valid. +If the JSON file is invalid, a warning message will be shown when *AssetBook* is launched. From f8fe22a98a136b61472e4edee7a4993f3a7fc76f Mon Sep 17 00:00:00 2001 From: yisiox Date: Mon, 15 Apr 2024 15:08:43 +0800 Subject: [PATCH 10/10] UserGuide.md: Fix punctuation --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 7ab097f8631..eeedf801740 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -16,7 +16,7 @@ Welcome **logistics managers**! If you are someone who + Is a **fast typist**, tired of shuffling back and forth between a mouse and keyboard -+ Is feeling **swamped by the tedium of contact management** on traditional office software... ++ Is feeling **swamped by the tedium of contact management** on traditional office software Rejoice because *AssetBook* is here!