Skip to content

Commit

Permalink
Merge pull request nus-cs2103-AY1718S1#68 from RonakLakhotia/checkmerge
Browse files Browse the repository at this point in the history
Updated Tests and Facebook command
  • Loading branch information
RonakLakhotia authored Oct 24, 2017
2 parents d87b8b6 + 2c76b2e commit 681a015
Show file tree
Hide file tree
Showing 25 changed files with 923 additions and 27 deletions.
41 changes: 41 additions & 0 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -691,6 +691,47 @@ any directory. +

// end::addPhoto[]

=== FaceBook Integration

The facebook command helps the user to view the profile page of a person on the contact list. +
It requires the user to login to his/her account before they can view the profile page.The profile +
page is shown up on the browser panel.

FORMAT - `facebook [INDEX] [USERNAME]`

e.g. - `facebook 1 ronak.lakhotia`

==== Working flow

The `FaceBookCommand Parser` class parses the arguments and throws an exception if the index entered
is invalid. A new event is then raised in the ModelManager class.
The Brower Panel class then loads the page with the url of the profile page to be viewed on Facebook. +

---
public void loadPersonFaceBookPage(ReadOnlyPerson person, String username) {

String url = FACEBOOK_PROFILE_PAGE + username;
loadPage(url);
}
---

==== Reasons for this kind of implementation

* This helps the user to take a quick glance of the the profile image of the contacts on his/her list. +

* It is better than opening a brower on the desktop. +

==== Design Considerations

**Aspect:** How should the user view the profile page. +
**Alternative1 : ** View the profile page on a web browser +
**Pros:** Helps user exercise other functionalities like messaging. +
**Cons:** Does not make use of Weaver in any useful way. +
**Alternative2:** View the profile page on the browser panel. +
**Pros:** Makes it quicker and adds a fucntion to the personalised Weaver. +
**Cons:** Limits the functionalities that can be used on facebook. +


// tag::Logging[]
=== Logging

Expand Down
40 changes: 20 additions & 20 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Weaver - User Guide
= Weaver User HandBook
:toc:
:toc-title:
:toc-placement: preamble
Expand All @@ -15,7 +15,20 @@ endif::[]
By: `W13-B2` Since: `Aug 2017` Licence: `MIT`


== Quick Start
== Product Overview

Weaver is a desktop application that has a GUI (Graphical User Interface) but most of the interactions happen using
a Command Line Interface.Weaver is your personalised addressbook that will make your day to day life easier by letting
you access the details over your friends and family members as and when you want them.

== About

This User Guide gives you some basic guidlines that you need to follow to use Weaver.It gives you a brief introduction
of what the product intends to do and how it will benefit you as a user.Since Weaver uses a Command line Interface
you will find below the list of commands and how to execute them in order to use the application.
So lets get Started! +

== Getting started

. Ensure you have Java version `1.8.0_60` or later installed in your Computer.
+
Expand Down Expand Up @@ -372,29 +385,16 @@ Command - Photo 1 Delete +
this will delete the photo attached with the person at index 1.
****

=== Deleting a person's tag : `delete/t` SINCE V1.2

Deletes the tag(s) of an existing person in the address book. +
Format: `delete/t INDEX [t/TAG]...`
=== FaceBook Integration (SINCE V1.3)

****
* Deletes the tag of the person at the specified `INDEX`. The index refers to the index number shown in the last person listing. The index *must be a positive integer* 1, 2, 3, ...
* The search is case insensitive. e.g `friends` will match `Friends`
* Only full words will be matched e.g. `Friend` will not match `Friends`
* At least one of the tag fields must be provided.
****

Examples:
Helps you view the profile page of a person in your contact list. +

* `delete/t 1 t/friends` +
Deletes the tag `friends` from the person index `1`.
* `delete/t 2 t/friends t/colleagues` +
Deletes the tag `friends` and `colleagues` from the person index `2`.
Command Format - `Facebook [INDEX] [USERNAME OF PERSON ON FACEBOOK]` +

[TIP]
You can remove all the person's tags by typing `edit INDEX t/` without specifying any tags after it.
Refer to the link:#edit[Edit] section above for more details.
e.g. - `facebook 1 ronak.lakhotia`

image::facebook.png[width="790"]

=== Clearing all entries : `clear`

Expand Down
Loading

0 comments on commit 681a015

Please sign in to comment.