Merge branch 'develop' into update-DeveloperGuide

CS2103AUG2016-T14-C4 · Nov 7, 2016 · 138d913 · 138d913
2 parents 90a1bea + 8927e04
commit 138d913
Show file tree

Hide file tree

Showing 2 changed files with 152 additions and 8 deletions.
diff --git a/src/main/java/seedu/task/ui/HelpWindow.java b/src/main/java/seedu/task/ui/HelpWindow.java
@@ -19,9 +19,9 @@ public class HelpWindow extends UiPart {
     private static final String ICON = "/images/help_icon.png";
     private static final String FXML = "HelpWindow.fxml";
     private static final String TITLE = "Help";
-    private static final String USERGUIDE_URL =
-            "https://github.com/CS2103AUG2016-T14-C4/main/blob/master/docs/UserGuide.md";
-
+    //@@author A0153467Y
+    private static final String COMMANDSUMMARY_URL = HelpWindow.class.getClassLoader().getResource("command-summary/CommandSummary.html").toExternalForm();
+    //@@author
     private AnchorPane mainPane;
 
     private Stage dialogStage;
@@ -44,18 +44,17 @@ public String getFxmlPath() {
     }
 
     private void configure(){
-        Scene scene = new Scene(mainPane);
+        Scene scene = new Scene(mainPane, 700, 600);
         //Null passed as the parent stage to make it non-modal.
         dialogStage = createDialogStage(TITLE, null, scene);
-        dialogStage.setMaximized(true); //TODO: set a more appropriate initial size
         setIcon(dialogStage, ICON);
-
+        
         WebView browser = new WebView();
-        browser.getEngine().load(USERGUIDE_URL);
+        browser.getEngine().load(COMMANDSUMMARY_URL);
         FxViewUtil.applyAnchorBoundaryParameters(browser, 0.0, 0.0, 0.0, 0.0);
         mainPane.getChildren().add(browser);
     }
-
+    
     public void show() {
         dialogStage.showAndWait();
     }

diff --git a/src/main/resources/command-summary/CommandSummary.html b/src/main/resources/command-summary/CommandSummary.html
@@ -0,0 +1,145 @@
+<!--@@author A0153467Y -->
+
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>Hello!</title>
+<link rel="stylesheet" href="https://stackedit.io/res-min/themes/base.css" />
+<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML"></script>
+</head>
+<body><div class="container"><h3 id="welcome-to-mess">Welcome to MESS!</h3>
+
+
+
+<h2 id="help-page"><i class="icon-file"></i><strong>Help Page</strong></h2>
+
+
+
+<h3 id="detailed-user-guide"><a href="https://github.com/CS2103AUG2016-T14-C4/main/blob/master/docs/UserGuide.md">Detailed User Guide</a></h3>
+
+<hr>
+
+
+
+<h2 id="command-summary"><strong>Command Summary</strong></h2>
+
+<table>
+<thead>
+<tr>
+  <th>Command</th>
+  <th>Format</th>
+</tr>
+</thead>
+<tbody><tr>
+  <td>Add</td>
+  <td><strong>add</strong> TASK_NAME [<strong>starts</strong> START_DATE_TIME <strong>ends</strong> CLOSE_DATE_TIME <strong>tag</strong> TAG]</td>
+</tr>
+<tr>
+  <td>Alias</td>
+  <td><strong>alias</strong> COMMAND ALIAS</td>
+</tr>
+<tr>
+  <td>Delete</td>
+  <td><strong>delete</strong> INDEX</td>
+</tr>
+<tr>
+  <td>Complete</td>
+  <td><strong>complete</strong> INDEX</td>
+</tr>
+<tr>
+  <td>Uncomplete</td>
+  <td><strong>uncomplete</strong> INDEX</td>
+</tr>
+<tr>
+  <td>List</td>
+  <td><strong>list</strong></td>
+</tr>
+<tr>
+  <td>Find</td>
+  <td><strong>find</strong> KEYWORD</td>
+</tr>
+<tr>
+  <td>Update</td>
+  <td><strong>update</strong> INDEX [NAME <strong>starts</strong> START_DATE_TIME <strong>ends</strong> CLOSE_DATE_TIME <strong>tag</strong> TAG <strong>remove-tag</strong> TAG]</td>
+</tr>
+<tr>
+  <td>Undo</td>
+  <td><strong>undo</strong></td>
+</tr>
+<tr>
+  <td>Pin</td>
+  <td><strong>pin</strong> INDEX</td>
+</tr>
+<tr>
+  <td>Unpin</td>
+  <td><strong>unpin</strong> INDEX</td>
+</tr>
+<tr>
+  <td>Live Search</td>
+  <td><strong>searchbox</strong></td>
+</tr>
+<tr>
+  <td>Change Storage</td>
+  <td><strong>change-to</strong> PATH_NAME</td>
+</tr>
+<tr>
+  <td>Help</td>
+  <td><strong>help</strong></td>
+</tr>
+<tr>
+  <td>Exit</td>
+  <td><strong>exit</strong></td>
+</tr>
+</tbody></table>
+
+
+
+
+<h2 id="example-of-some-longer-commands">Example of some longer commands:</h2>
+
+
+
+<h4 id="add"><i class="icon-pencil"></i> <strong>Add</strong></h4>
+
+<p>Example: </p>
+
+<ul>
+<li>add meeting starts tomorrow 1pm ends tomorrow 3pm</li>
+<li>add quiz tag cs2102 tag easy</li>
+</ul>
+
+
+
+<h4 id="alias"><i class="icon-pencil"></i> <strong>Alias</strong></h4>
+
+<p>Example: </p>
+
+<ul>
+<li>alias add + </li>
+<li>alias alias q</li>
+</ul>
+
+
+
+<h4 id="update"><i class="icon-pencil"></i> <strong>Update</strong></h4>
+
+<p>Example:</p>
+
+<ul>
+<li>update 2 name shopping ends 9pm</li>
+<li>update 2 tag family remove-tag friends </li>
+<li>update 3 ends three hours later </li>
+</ul>
+
+
+
+<h4 id="change-to"><i class="icon-pencil"></i> <strong>Change-to</strong></h4>
+
+<p>Example:</p>
+
+<ul>
+<li>change-to data/taskmanager.xml</li>
+</ul></div></body>
+</html>