Skip to content

Commit

Permalink
Merge branch 'master' into feature/auto-complete
Browse files Browse the repository at this point in the history
  • Loading branch information
shitian007 committed Oct 19, 2017
2 parents 500b9b0 + 6116d3a commit 7c4fb33
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 14 deletions.
5 changes: 3 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Address Book (Level 4)
= Immunity Book
ifdef::env-github,env-browser[:relfileprefix: docs/]
ifdef::env-github,env-browser[:outfilesuffix: .adoc]

Expand All @@ -16,7 +16,8 @@ image::images/Ui.png[width="600"]
endif::[]

* This is a desktop Address Book application. It has a GUI but most of the user interactions happen using a CLI (Command Line Interface).
* It is a Java sample application intended for students learning Software Engineering while using Java as the main programming language.
* Immunity Book is a newly conceptualised contact book that is secure, efficient and handy for users with everchanging contact list.
* It is a Java sample application intended for CS2103 Software Engineering in AY2017/18 while using Java as the main programming language.
* It is *written in OOP fashion*. It provides a *reasonably well-written* code example that is *significantly bigger* (around 6 KLoC)than what students usually write in beginner-level SE modules.
* What's different from https://github.com/se-edu/addressbook-level3[level 3]:
** A more sophisticated GUI that includes a list panel and an in-built Browser.
Expand Down
36 changes: 24 additions & 12 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -792,6 +792,7 @@ Use case resumes at step 2
Use case ends


[discrete]
== Use case: Backup storage files

*MSS*
Expand All @@ -803,22 +804,32 @@ Use case ends
Use case ends.

*Extensions*
1a. System detects there is no new file to backup
1a1. System outputs message saying there is nothing new to backup
Use case ends.
3a. System detects an invalid backup location
3a1. System asks for a new backup location
Steps 3 is repeated until a valid backup location is entered
Use cases resumes at step 4
3b. System detects not enough storage on hard drive
3b1. System tells user not enough space on hard drive
Use case ends.

* 1a. System detects there is no new file to backup

** 1a1. System outputs message saying there is nothing new to backup
Use case ends.

* 3a. System detects an invalid backup location

** 3a1. System asks for a new backup location

==Use case: View and delete obsolete contacts
** Steps 3 is repeated until a valid backup location is entered

Use cases resumes at step 4

* 3b. System detects not enough storage on hard drive

** 3b1. System tells user not enough space on hard drive

Use case ends.


[discrete]
== Use case: View and delete obsolete contacts

*MSS*

1. User requests to view unused contacts beyond a certain time (i.e. contacts not viewed for 3 years or more)
2. System asks user to input the time period
3. User input time period
Expand All @@ -828,8 +839,9 @@ Use case ends.


*Extensions*

4a. There are no unused users beyond the time period user input
Use case ends.
Use case ends.

{More to be added}

Expand Down
15 changes: 15 additions & 0 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,21 @@ There is no need to save manually.
Address book data can be stored in a back up file when necessary. This is good in case any the existing address book is corrupted. +
Format: `backup`

=== Import data : `import` (Since v1.2)

Add contact details from external xml file into current address book. +
Format: import FILE_PATH

****
* Adds all person that is not already in the address book.
* The FILE_PATH must contain a valid xml file.
****

Examples:

* `import C:\Desktop\colleagues.xml` +
Imports colleagues.xml into current address book.

=== Facebook Search (coming in V2.0)

Query Facebook using list of emails from address book.
Expand Down

0 comments on commit 7c4fb33

Please sign in to comment.