From 0ead4dac0680edb31a38f228f887550bdcec3627 Mon Sep 17 00:00:00 2001 From: Dana Poon Date: Thu, 7 Nov 2019 18:45:28 +0800 Subject: [PATCH] Ug update 7 nov (#364) * Added skeleton classes for Parse * Added toString() and modified some javadocs for it. * docs/User Guide.md created from https://stackedit.io/ * Add UG markdown * Minor update to Loan and Template section * Fixes to tables and unclosed ` * Random blank lines fixed. * More minor fixes * Fix title * Minor fixes * Update CS2113T-F09-3-Eggventory-UG.md * Update CS2113T-F09-3-Eggventory-UG.md --- docs/CS2113T-F09-3-Eggventory-UG.md | 105 +++++++++++++--------------- 1 file changed, 50 insertions(+), 55 deletions(-) diff --git a/docs/CS2113T-F09-3-Eggventory-UG.md b/docs/CS2113T-F09-3-Eggventory-UG.md index 3068a26649..1e306cd907 100644 --- a/docs/CS2113T-F09-3-Eggventory-UG.md +++ b/docs/CS2113T-F09-3-Eggventory-UG.md @@ -1,5 +1,6 @@ -# Eggventory User GuideBy: Team F09-03 -Dated: 5 November 2019 +# Eggventory User Guide +By: Team F09-03 +Dated: 7 November 2019 ## Table of contents ### [1. Introduction ](#introduction) ### [2. Quick Start ](#quickstart) @@ -86,8 +87,6 @@ Note: Stock Type names are not allowed to have spaces in them. This adds a new category of stock to the inventory. Format: `add stocktype ` - - eg. add stocktype Resistor @@ -96,21 +95,18 @@ eg. add stocktype Resistor This removes a stocktype from the inventory, and all stock under it. Format: `delete stocktype ` - - #### 3.2.3 Editing Stock Types: `edit stocktype` -This changes the name of the selected stock type. +This changes the name of the selected stock type. -Format: `edit stocktype ` - #### 3.2.4 Listing Stock Types: `list stocktype` +Format: `edit stocktype ` + +#### 3.2.4 Listing Stock Types: `list stocktype` This lists out all Stock Types that are present in the inventory. Format: `list stocktype all` - - --- ### 3.3 Working with Stocks @@ -119,10 +115,11 @@ Stocks are the main types of items that Eggventory helps you to manage. Every St Stocks may be Collective or Unique. Collective stocks consist of items that are not tracked individually. They generally are stocks that do not have each have their own serial number, and are considered interchangeable. Unique stocks are items that are often expensive or limited in quantity. Such stocks usually are each assigned a serial number, and are loaned out and tracked by this number. Stocks are set as Collective by default. Stocks have the following properties: + | Property | Description | -|---:|---| +|---:|---| StockType|The category the stock belongs to. The StockType should have previously been added to the inventory system before being referenced. -StockCode|nique string of numbers and letters, used to identify the stock. +StockCode|A unique string of numbers and letters, used to identify the stock. Quantity | The number of items under the stock. Description | The common name of the item. @@ -138,13 +135,13 @@ eg. `add stock Resistor R500 1000 500ohm resistor` **[coming in v2.0]** In addition to the required parameters, stocks can also be added with the following optional parameters: + Format|Purpose| |---|---| -`-mq ` |Sets the minimum quantity of stock that should be maintained in the inventory +`-mq ` |Sets the minimum quantity of stock that should be maintained in the inventory `-u`|Sets the stock to contain items that are unique - - + Format: `add stock {}` eg. `add stock Resistor R500 1000 500ohm resistor -mq 100` @@ -152,18 +149,15 @@ eg. `add stock Resistor R500 1000 500ohm resistor -mq 100` #### 3.3.2 Deleting Stocks: `delete stock` This removes a stock from the inventory, including any references to loaned out stock. - Format: delete stock + Format: `delete stock ` #### 3.3.3 Editing Stock: `edit stock` -This directly modifies the value of a property stock. You may modify as many properties as you wish in one command. +This directly modifies the value of a property stock. You may modify as many properties as you wish in one command. Keywords to modify each property: - -- - -- stockcode +- stockcode - description @@ -174,14 +168,14 @@ Keywords to modify each property: - minquantity -Format: `edit stock { }` +Format: `edit stock ` -eg. `edit stock R500 quantity 1000 description stockcode Res500` +eg. `edit stock R500 quantity 1000` : Changes the quantity of the stock R500 to 1000. #### 3.3.4 Listing Stock: `list stock` This lists out all Stocks that are present in the inventory. -Format: list stock +Format: `list stock` #### 3.3.5 Listing Stock of a particular StockType: `list ` @@ -195,15 +189,14 @@ eg. `list Resistor` ### 3.4 Managing your list of People People have to be added to the system before they can take loans from the inventory. Each person is identified by their matric number, as the inventory primarily loans out stock to students. -#### 3.4.1 Adding a Person: `add person` +#### 3.4.1 Adding a Person: `add person` This adds a new person to keep track that will loan stock. - - Format: `add person ` -eg. `add person A0123456` +eg. `add person A0123456 Akshay` + Note: By nature, the matric number of each Person should be unique, meaning no two individuals are allowed to share the same matric number. @@ -214,8 +207,6 @@ Optional Parameters: |---|---| |`-n `|Sets the name of the person being added| |`-c `|Sets the course of the person being added| - - Format: `add person { }` @@ -233,11 +224,11 @@ eg. `delete person A0123456` This directly modifies the value of a property of a person. You may modify as many properties as you wish in one command. Properties: - - matric - name -Format: `edit person { edit person A0123456 name Alex` +Format: `edit person ` +e.g. `edit person A0123456 name Alex` #### 3.4.4 Listing all People: `list person` @@ -250,26 +241,32 @@ Format: `list person` #### 3.5.1 Adding a Loan: `add loan` -This adds a new Loan made by a Person. is possible to add multiple stocks at once. +This adds a new Loan and assigns it to a Person. -Format: `add loan { }` +Format: `add loan ` eg. `add loan A0123456 R500 1000 X123 80` + +#### 3.5.2 Deleting a Loan: `delete loan` +This deletes an existing Loan assigned to a Person. If there are multiple loans of the same StockCode to the same + Person, the first instance of such a Loan will be deleted. + +Format: `delete loan ` + +e.g. `delete loan A0123456 R500` -#### 3.5.2 Returning specific Loans: `loan return` [coming in v1.4] +#### 3.5.3 Returning specific Loans: `loan return` [coming in v2.0] This marks specific Loans of a Person as returned. Format: `loan return { }` -#### 3.5.3 Returning all Loans: `loan returnall` [coming in v1.4] +#### 3.5.4 Returning all Loans: `loan returnall` [coming in v2.0] This marks all Loans of a Person as returned. - - Format: `loan returnall ` -#### 3.5.4 Listing all Persons and their Loans: `list loan` +#### 3.5.5 Listing all Persons and their Loans: `list loan` This lists out all loans currently recorded, listed by the Person who made the loan. @@ -279,15 +276,16 @@ Format: `list loan` ### 3.6 Loaning using Templates To speed up the loaning process, Eggventory allows you to create loan templates. These templates are simply lists of - stocks and quantity to be loaned out all at once. The name of each template must be unique, or it will not added. + stocks and quantity to be loaned out all at once. #### 3.6.1 Adding loan templates: `add template` - -This creates a template that can be substituted for { } in loan commands. +This creates a new template of Loans. -Format: `add template “” { }` +Format: `add template { }` e.g. `add template CG1112_Alex R500 5 A123 1` + + Note: The name of each template must be unique, or it will not be added. #### 3.6.2 Deleting a Template: `delete template` @@ -299,7 +297,8 @@ eg. `delete template CG1112_Alex` #### 3.6.3 Making a Loan from a template: `add loan` -This adds a Loan to a Person from a Template. +This adds a Loan to a Person from a Template. Every loan in the template will be added to the person as if you added + them individually. Format: `add loan