Update User Guide and Developer Guide for display command

CS2103-AY1819S2-W10-3 · Mar 12, 2019 · 5bea9f9 · 5bea9f9
1 parent a71d8e2
commit 5bea9f9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/docs/DeveloperGuide.adoc b/docs/DeveloperGuide.adoc
@@ -159,6 +159,8 @@ The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `Re
 
 The `UI` component uses JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the link:{repoURL}/src/main/java/seedu/address/ui/MainWindow.java[`MainWindow`] is specified in link:{repoURL}/src/main/resources/view/MainWindow.fxml[`MainWindow.fxml`]
 
+The `UI` component shows webpages e.g. `DisplayGmap.html` hosted somewhere on the Internet. To host a webpage yourself, you may put your webpage into `\docs\staticpages`. All pages in `\docs\staticpages` will be copied to `gh-pages` branch and hosted on `gh-pages`.
+
 The `UI` component,
 
 * Executes user commands using the `Logic` component.
@@ -399,6 +401,8 @@ This will render the SE-EDU navigation bar at the top of the page, and add some
 
 Each `.adoc` file may also specify some file-specific https://asciidoctor.org/docs/user-manual/#attributes[asciidoc attributes] which affects how the file is rendered.
 
+All files under `\docs\staticpages\` will be copied to final output documentation folders as well. You may put any static pages you want to public to `\docs\staticpages`.
+
 Asciidoctor's https://asciidoctor.org/docs/user-manual/#builtin-attributes[built-in attributes] may be specified and used as well.
 
 [TIP]

diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc
@@ -132,7 +132,7 @@ Example:
 * `view equipment 12839`
 
 === Selecting an equipment or work list: `select`
-Selects the equipment or work list identified by the index number used in the displayed equipment list or displayed work list. +
+Selects the equipment or work list identified by the index number used in the displayed equipment list or displayed work list. The address of the equipment will be shown as marker on the map. +
 Format: `select INDEX`
 
 * Selects the equipment and loads the equipment at the specified INDEX. +
@@ -171,7 +171,7 @@ Examples:
 Returns `Clementi Police Station` and `Clementi CC`
 
 === Show in map: `display`
-Display entries on the list to the map.
+Display entries on the list to the map. Addresses of the equipment will be taken to plot marker on map.
 Format: `display`
 
 Example: