DeveloperGuide.adoc

EduBuddy - Developer Guide

By: CS2103JAN2018-T09-B1      Since: Mar 2018      Licence: MIT

• 1. Introduction
• 2. Setting up
  • 2.1. Prerequisites
  • 2.2. Setting up the project in your computer
  • 2.3. Verifying the setup
  • 2.4. Configurations to do before writing code
• 3. Design
  • 3.1. Architecture
  • 3.2. UI component
  • 3.3. Logic component
  • 3.4. Model component
  • 3.5. Storage component
  • 3.6. Common classes
• 4. Implementation
  • 4.1. Undo/Redo feature
  • 4.2. Sort feature
  • 4.3. TagReplace feature
  • 4.4. Subject streaming calculation feature
  • 4.5. Mass Tag Removal feature
  • 4.6. [Proposed] Data Encryption
  • 4.7. Browser Panel Revamp
  • 4.8. Remark Feature
  • 4.9. Logging
  • 4.10. Configuration
• 5. Documentation
  • 5.1. Editing Documentation
  • 5.2. Publishing Documentation
  • 5.3. Converting Documentation to PDF format
• 6. Testing
  • 6.1. Running Tests
  • 6.2. Types of tests
  • 6.3. Troubleshooting Testing
• 7. Dev Ops
  • 7.1. Build Automation
  • 7.2. Continuous Integration
  • 7.3. Coverage Reporting
  • 7.4. Documentation Previews
  • 7.5. Making a Release
  • 7.6. Managing Dependencies
• Appendix A: Suggested Programming Tasks to Get Started
  • A.1. Improving each component
  • A.2. Creating a new command: remark
• Appendix B: Product Scope
• Appendix C: Feature Contribution
• Appendix D: User Stories
• Appendix E: Use Cases
• Appendix F: Non Functional Requirements
• Appendix G: Glossary
• Appendix H: Product Survey
• Appendix I: Instructions for Manual Testing
  • I.1. Launch and Shutdown
  • I.2. Deleting a person
  • I.3. Saving data

1. Introduction

Welcome to EduBuddy! This application is based on a Command Line Interface(CLI), and is designed for secondary school teachers to manage student profiles in a simple and efficient manner.

This developer guide will help to provide you with a detailed walk-through of EduBuddy, from the application set up procedure, to the explanation of the features and troubleshooting methods.

2. Setting up

This section helps to guide you through the necessary steps to launch our application.

2.1. Prerequisites

1. JDK 1.8.0_60 or later

   ℹ️	Having any Java 8 version is not enough. This app will not work with earlier versions of Java 8.

2. IntelliJ IDE

   ℹ️	IntelliJ by default has Gradle and JavaFx plugins installed. Do not disable them. If you have disabled them, go to File > Settings > Plugins to re-enable them.

2.2. Setting up the project in your computer

1. Fork this repo, and clone the fork to your computer

2. Open IntelliJ (if you are not in the welcome screen, click File > Close Project to close the existing project dialog first)

3. Set up the correct JDK version for Gradle

   1. Click Configure > Project Defaults > Project Structure

   2. Click New…​ and find the directory of the JDK

4. Click Import Project

5. Locate the build.gradle file and select it. Click OK

6. Click Open as Project

7. Click OK to accept the default settings

8. Open a console and run the command gradlew processResources (Mac/Linux: ./gradlew processResources). It should finish with the BUILD SUCCESSFUL message.
   This will generate all resources required by the application and tests.

2.3. Verifying the setup

1. Run the seedu.address.MainApp and try a few commands

2. Run the tests to ensure they all pass.

2.4. Configurations to do before writing code

2.4.1. Configuring the coding style

This project follows oss-generic coding standards. IntelliJ’s default style is mostly compliant with ours but it uses a different import order from ours. To rectify,

1. Go to File > Settings…​ (Windows/Linux), or IntelliJ IDEA > Preferences…​ (macOS)

2. Select Editor > Code Style > Java

3. Click on the Imports tab to set the order

   • For Class count to use import with '*' and Names count to use static import with '*': Set to 999 to prevent IntelliJ from contracting the import statements

   • For Import Layout: The order is import static all other imports, import java.*, import javax.*, import org.*, import com.*, import all other imports. Add a <blank line> between each import

Optionally, you can follow the UsingCheckstyle.adoc document to configure Intellij to check style-compliance as you write code.

2.4.2. Updating documentation to match your fork

After forking the repo, links in the documentation will still point to the se-edu/addressbook-level4 repo. If you plan to develop this as a separate product (i.e. instead of contributing to the se-edu/addressbook-level4) , you should replace the URL in the variable repoURL in DeveloperGuide.adoc and UserGuide.adoc with the URL of your fork.

2.4.3. Setting up CI

Set up Travis to perform Continuous Integration (CI) for your fork. See UsingTravis.adoc to learn how to set it up.

After setting up Travis, you can optionally set up coverage reporting for your team fork (see UsingCoveralls.adoc).

ℹ️	Coverage reporting could be useful for a team repository that hosts the final version but it is not that useful for your personal fork.

Optionally, you can set up AppVeyor as a second CI (see UsingAppVeyor.adoc).

ℹ️	Having both Travis and AppVeyor ensures your App works on both Unix-based platforms and Windows-based platforms (Travis is Unix-based and AppVeyor is Windows-based)

2.4.4. Getting started with coding

When you are ready to start coding,

1. Get some sense of the overall design by reading Section 3.1, “Architecture”.

2. Take a look at Appendix A, Suggested Programming Tasks to Get Started.

return to Table of Contents

3. Design

This section illustrates the overall design of our application and provides the details of its individual components.

3.1. Architecture

Figure 1. Architecture Diagram

The Architecture Diagram given above explains the high-level design of the App. Given below is a quick overview of each component.

💡	The .pptx files used to create diagrams in this document can be found in the diagrams folder. To update a diagram, modify the diagram in the pptx file, select the objects of the diagram, and choose Save as picture.

Main has only one class called MainApp. It is responsible for,

• At app launch: Initializes the components in the correct sequence, and connects them up with each other.

• At shut down: Shuts down the components and invokes cleanup method where necessary.

Commons represents a collection of classes used by multiple other components. Two of those classes play important roles at the architecture level.

• EventsCenter : This class (written using Google’s Event Bus library) is used by components to communicate with other components using events (i.e. a form of Event Driven design)

• LogsCenter : Used by many classes to write log messages to the App’s log file.

The rest of the App consists of four components.

• UI: The UI of the App.

• Logic: The command executor.

• Model: Holds the data of the App in-memory.

• Storage: Reads data from, and writes data to, the hard disk.

Each of the four components

• Defines its API in an interface with the same name as the Component.

• Exposes its functionality using a {Component Name}Manager class.

For example, the Logic component (see the class diagram given below) defines it’s API in the Logic.java interface and exposes its functionality using the LogicManager.java class.

Figure 2. Class Diagram of the Logic Component

Events-Driven nature of the design

The Sequence Diagram below shows how the components interact for the scenario where the user issues the command delete 1.

Figure 3. Component interactions for delete 1 command (part 1)

ℹ️	Note how the Model simply raises a AddressBookChangedEvent when the Address Book data are changed, instead of asking the Storage to save the updates to the hard disk.

The diagram below shows how the EventsCenter reacts to that event, which eventually results in the updates being saved to the hard disk and the status bar of the UI being updated to reflect the 'Last Updated' time.

Figure 4. Component interactions for delete 1 command (part 2)

ℹ️	Note how the event is propagated through the EventsCenter to the Storage and UI without Model having to be coupled to either of them. This is an example of how this Event Driven approach helps us reduce direct coupling between components.

The sections below give more details of each component.

3.2. UI component

Figure 5. Structure of the UI Component

API : Ui.java

The UI consists of a MainWindow that is made up of parts e.g.CommandBox, ResultDisplay, PersonListPanel, StatusBarFooter, BrowserPanel etc. All these, including the MainWindow, inherit from the abstract UiPart class.

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 MainWindow is specified in MainWindow.fxml

The UI Browser window uses HTML’s w3.css framework. The layout of the Browser Panel is defined from src/main/resources/StudentPage/template.html.

The UI Browser window then reflects the user profile’s respective HTML file when a user is selected, found in {user.home}/StudentPage.

The UI component,

• Executes user commands using the Logic component.

• Binds itself to some data in the Model so that the UI can auto-update when data in the Model change.

• Responds to events raised from various parts of the App and updates the UI accordingly.

3.3. Logic component

Figure 6. Structure of the Logic Component

Figure 7. Structure of Commands in the Logic Component. This diagram shows finer details concerning XYZCommand and Command in Figure 6, “Structure of the Logic Component”

API : Logic.java

1. Logic uses the AddressBookParser class to parse the user command.

2. This results in a Command object which is executed by the LogicManager.

3. The command execution can affect the Model (e.g. adding a person) and/or raise events.

4. The result of the command execution is encapsulated as a CommandResult object which is passed back to the Ui.

Given below is the Sequence Diagram for interactions within the Logic component for the execute("delete 1") API call.

Figure 8. Interactions Inside the Logic Component for the delete 1 Command

3.4. Model component

Figure 9. Structure of the Model Component

API : Model.java

The Model,

• stores a UserPref object that represents the user’s preferences.

• stores the Address Book data.

• exposes an unmodifiable ObservableList<Person> that can be 'observed' e.g. the UI can be bound to this list so that the UI automatically updates when the data in the list change.

• does not depend on any of the other three components.

3.5. Storage component

Figure 10. Structure of the Storage Component

API : Storage.java

The Storage component,

• can save UserPref objects in json format and read it back.

• can save the Address Book data in xml format and read it back.

3.6. Common classes

Classes used by multiple components are in the seedu.addressbook.commons package.

return to Table of Contents

4. Implementation

This section describes some noteworthy details on how certain features are implemented.

4.1. Undo/Redo feature

4.1.1. Current Implementation

The undo/redo mechanism is facilitated by an UndoRedoStack, which resides inside LogicManager. It supports undoing and redoing of commands that modifies the state of the address book (e.g. add, edit). Such commands will inherit from UndoableCommand.

UndoRedoStack only deals with UndoableCommands. Commands that cannot be undone will inherit from Command instead. The following diagram shows the inheritance diagram for commands:

As you can see from the diagram, UndoableCommand adds an extra layer between the abstract Command class and concrete commands that can be undone, such as the DeleteCommand. Note that extra tasks need to be done when executing a command in an undoable way, such as saving the state of the address book before execution. UndoableCommand contains the high-level algorithm for those extra tasks while the child classes implements the details of how to execute the specific command. Note that this technique of putting the high-level algorithm in the parent class and lower-level steps of the algorithm in child classes is also known as the template pattern.

Commands that are not undoable are implemented this way:

public class ListCommand extends Command {
    @Override
    public CommandResult execute() {
        // ... list logic ...
    }
}

With the extra layer, the commands that are undoable are implemented this way:

public abstract class UndoableCommand extends Command {
    @Override
    public CommandResult execute() {
        // ... undo logic ...

        executeUndoableCommand();
    }
}

public class DeleteCommand extends UndoableCommand {
    @Override
    public CommandResult executeUndoableCommand() {
        // ... delete logic ...
    }
}

Suppose that the user has just launched the application. The UndoRedoStack will be empty at the beginning.

The user executes a new UndoableCommand, delete 5, to delete the 5th person in the address book. The current state of the address book is saved before the delete 5 command executes. The delete 5 command will then be pushed onto the undoStack (the current state is saved together with the command).

As the user continues to use the program, more commands are added into the undoStack. For example, the user may execute add n/David …​ to add a new person.

ℹ️	If a command fails its execution, it will not be pushed to the UndoRedoStack at all.

The user now decides that adding the person was a mistake, and decides to undo that action using undo.

We will pop the most recent command out of the undoStack and push it back to the redoStack. We will restore the address book to the state before the add command executed.

ℹ️	If the undoStack is empty, then there are no other commands left to be undone, and an Exception will be thrown when popping the undoStack.

The following sequence diagram shows how the undo operation works:

The redo does the exact opposite (pops from redoStack, push to undoStack, and restores the address book to the state after the command is executed).

ℹ️	If the redoStack is empty, then there are no other commands left to be redone, and an Exception will be thrown when popping the redoStack.

The user now decides to execute a new command, clear. As before, clear will be pushed into the undoStack. This time the redoStack is no longer empty. It will be purged as it no longer make sense to redo the add n/David command (this is the behavior that most modern desktop applications follow).

Commands that are not undoable are not added into the undoStack. For example, list, which inherits from Command rather than UndoableCommand, will not be added after execution:

The following activity diagram summarize what happens inside the UndoRedoStack when a user executes a new command:

4.1.2. Design Considerations

Aspect: Implementation of UndoableCommand

• Alternative 1 (current choice): Add a new abstract method executeUndoableCommand()

  • Pros: We will not lose any undone/redone functionality as it is now part of the default behaviour. Classes that deal with Command do not have to know that executeUndoableCommand() exist.

  • Cons: Hard for new developers to understand the template pattern.

• Alternative 2: Just override execute()

  • Pros: Does not involve the template pattern, easier for new developers to understand.

  • Cons: Classes that inherit from UndoableCommand must remember to call super.execute(), or lose the ability to undo/redo.

Aspect: How undo & redo executes

• Alternative 1 (current choice): Saves the entire address book.

  • Pros: Easy to implement.

  • Cons: May have performance issues in terms of memory usage.

• Alternative 2: Individual command knows how to undo/redo by itself.

  • Pros: Will use less memory (e.g. for delete, just save the person being deleted).

  • Cons: We must ensure that the implementation of each individual command are correct.

Aspect: Type of commands that can be undone/redone

• Alternative 1 (current choice): Only include commands that modifies the address book (add, clear, edit).

  • Pros: We only revert changes that are hard to change back (the view can easily be re-modified as no data are * lost).

  • Cons: User might think that undo also applies when the list is modified (undoing filtering for example), * only to realize that it does not do that, after executing undo.

• Alternative 2: Include all commands.

  • Pros: Might be more intuitive for the user.

  • Cons: User have no way of skipping such commands if he or she just want to reset the state of the address * book and not the view. Additional Info: See our discussion here.

Aspect: Data structure to support the undo/redo commands

• Alternative 1 (current choice): Use separate stack for undo and redo

  • Pros: Easy to understand for new Computer Science student undergraduates to understand, who are likely to be * the new incoming developers of our project.

  • Cons: Logic is duplicated twice. For example, when a new command is executed, we must remember to update * both HistoryManager and UndoRedoStack.

• Alternative 2: Use HistoryManager for undo/redo

  • Pros: We do not need to maintain a separate stack, and just reuse what is already in the codebase.

  • Cons: Requires dealing with commands that have already been undone: We must remember to skip these commands. Violates Single Responsibility Principle and Separation of Concerns as HistoryManager now needs to do two * different things.

return to Table of Contents

4.2. Sort feature

4.2.1. Current Implementation

The sorting feature allows the user to sort the list of students according to certain parameters like name and tag. After the sorting process has completed, the user will be presented with a read only view of the sorted list on the UI, and the state of the list will not be modified.

The figure below shows the Sequence Diagram for the interactions within the Logic component when "sort name" is typed into the CommandBox by the user.

1. Logic uses AddressBookParser class to parse the user command,

2. A SortCommand object is created which is then executed by the LogicManager.

3. The command executes and calls the sortPersonList(parameter) method, which then affects the Model.

4. After the sorting process has been completed, the result is encapsulated as a CommandResult object, which is then passed back to the Ui as a message shown to the user.

Below is an example of how the list looks like before and after the command "sort name" is executed.

4.2.2. Design Considerations

Aspect: How the list appears after sorting is done and the app is restarted

• Alternative 1 (current choice): List remains in its initial state after each restart of the app

  • Pros: Some users might prefer the default list that was created by themselves e.g. the need to track which student was added last.

  • Cons: It will be a hassle to sort the list every time the app starts up if there are not many changes to the list.

• Alternative 2: List is in the sorted form after the app is restarted every time

  • Pros: Reduces the time taken to sort the list for each start up of the app.

  • Cons: If the default list is required, SortCommand will have to be implemented as an UndoableCommand as well.

return to Table of Contents

4.3. TagReplace feature

4.3.1. Current Implementation

The tag replace is a command that replaces the target tag with the tag that we want. The tags would be passed in via the argument multimap which would extract the tags with t/ prefix. It would then be separated into two different tags, tag to be replaced and the tag to be placed. Then the Addressbook would proceed to look for the persons with the unwanted tag to remove the unwanted tag and to add the new tag to the person.

The figure below shows the Sequence Diagram for the interactions within the Logic component when "tagreplace t/TAGNAME t/TAGNAME" is typed into the CommandBox by the user.

1. Logic uses the AddressBookParser class to parse the command.

2. This results in a TagReplaceCommand object which is executed by the LogicManager.

3. The command execution calls the replaceTag method which then affects the Model.

4. The tag is then replaced and the result of the command execution is encapsulated as a CommandResult object which is passed back to the Ui.

Below is an example of how the list looks like before and after the command "tagreplace t/3G t/4G" is executed.

4.3.2. Design Considerations.

Aspect: Data structure to support the tag replace command

• Alternative 1: Reuse the set that exist in the Addressbook.

  • Pros: Need not introduce a new data structure to store the tags that are passed in.

  • Cons: A set arranges its elements in alphabetical order. This disrupts the order in which the user has entered, and it would cause the wanted tag to be removed instead of the unwanted one.

return to Table of Contents

4.4. Subject streaming calculation feature

4.4.1. Current Implementation

The subject streaming calculation features will be supported by calculation algorithms, calculateL1R5 and calculateL1B4 , which will be located in Person.java. The calculation algorithm will be called by the SelectCommand. It will help to analyse the subjects that are assigned to the student, and determine which combination of subjects will produce the lowest L1R5 or L1B4 score. The score will then be projected in the Command Box.

Figure 11. Sequence Diagram of implementation of Subject streaming calculation

1. When the SelectCommand is executing, it retrieves the Student object that the user was referencing to and calls the calculateL1R5/L1B4 method.

2. In the calculation method, it will store the subject list of the student in List<Subject> subjects and loop through the list according to the L1 subject category.

3. The relevant subjects of the subject category will be saved in a temporary List<Subject> subjectsToCheck and the list will be passed into a checkLowest() method.

4. In checkLowest(), the subject grades will be compared and the best subject will be removed from the list subjects.

5. The best grade will be returned back to calculateL1R5/L1B4 and stored in a temporary int variable, score. The function will then move on to check the other subject categories.

6. After the calculation, score will be returned to the SelectCommand which will project the result in the Command Box.

ℹ️

The subjects and their respective grades can be assigned to the students by the AddCommand, with a subject prefix sub/ followed by the Subject Name and Subject Grade. As the students are required to take at least 6 subjects, the subjects will be stored in as a parameter of each individual student as a List<Subject>.

Aspect: Implementation of command to call calculateL1R5 and calculateL1B4

• Alternative 1: Add new command classes L1R5Command and L1B4Command

  • Pros: It would be easy to implement as there is no need to worry about affecting other classes.

  • Cons: More commands for the user to remember.

• Alternative 2 (current choice): Just override execute() of SelectCommand

  • Pros: Easier to update the Display Panel later on when the user wants to access the Student’s details.

  • Cons: Need to update the test cases accordingly due to the change in the execute() function.

Aspect: Implementation of calculation function L1R5 and L1B4

• Alternative 1 (current choice): Add the calculation function in Person.java

  • Pros: Easier to understand as the function needs to access the subject list of the student for calculation.

  • Cons:

• Alternative 2 : Implement the calculation function in execute() of SelectCommand

  • Pros: Reduce the amount of coupling between SelectCommand and Person.

  • Cons: Makes the SelectCommand more complicated as it is performing more than it should.

return to Table of Contents

4.5. Mass Tag Removal feature

4.5.1. Current Implementation

The Mass Tag Removal feature is supported through the suggested Tag Removal feature for the Model Component in Section A.1, “Improving each component”. The command TagDeleteCommand is implemented to call the deleteTag() function in the Model interface. The deleteTag() function will loop through the students in the AddressBook and will remove the specified Tag from every student that has the specified Tag and the students' Tag List will be updated.

A TagDeleteCommand is where the user inputs tagdelete [TAG_NAME] or td [TAG_NAME] in the Command Box. When the user input fulfils the criteria of the expected input format, the command will execute. The deleteTag() function will be called and loops through the students in the AddressBook.

• If the specified tag is not found tagged to any student, a TagNotFoundException will be thrown and a error message will be returned to the user.

• Else, the Tag List of each student will be loaded and stored in a temporary List variable and the specified tag will be removed from it. Then a new student object with the updated Tag List will be replace the original student object. Thus the AddressBook will eventually have the updated list of students where the specified tag have been removed.

  1. Logic uses the AddressBookParser class to parse the command.

  2. This results in a TagDeleteCommand object which is executed by the LogicManager.

  3. The command execution calls the deleteTag method which then affects the Model.

  4. The tag is then deleted and the result of the command execution is encapsulated as a CommandResult object which is passed back to the Ui. The user will see a message on the Command Box in the format: Deleted Tag: [TAG_NAME] and the Tag will be removed.

Figure 12. Sequence Diagram of TagDeleteCommand if the specified tag exists.

4.5.2. Design Considerations

Aspect: Implementation of TagDeleteCommand

• Alternative 1: Create a new method in TagDeleteCommand to delete tag

  • Pros: Easier to understand the structure of TagDeleteCommand.

  • Cons: The deleteTag() function that was implemented would be redundant.

• Alternative 2 (current choice): Call the deleteTag() function

  • Pros: Implementation of the command would be easier as the main algorithm to delete the tag is within the code.

  • Cons: Increases coupling between Model and TagDeleteCommand.

return to Table of Contents

4.6. [Proposed] Data Encryption

{Explain here how the data encryption feature will be implemented}

4.7. Browser Panel Revamp

Figure 13. First Half of Browser Panel

Figure 14. Second Half of Browser Panel

We will use a html page with w3.css framework support to implement the new Browser Panel. The browser panel can be controlled from the CLI interface, which manipulates the data in the browser panel.

The browser will be invoked by the selection of a student from ui/BrowserPanel. loadPersonPage() invokes the html file of the student selected stored in resources/StudentPage.

Creation of a html StudentPage file:

After add command is called successfully, a template file from StudentPage will be duplicated as a backup, and renamed as the name that is called from the add command.

Editing StudentPage file: After any command that changes the data in the BrowserPanel is called, the HTML file will be stored as a string and edited accordingly. The file is then output to {user.home}/StudentPage.

return to Table of Contents

4.8. Remark Feature

4.8.1. Current Implementation

A new remark component is added to the person model.

This remark feature allows the user to add remarks to the student profile of the specified student.

Figure 15. Sequence Diagram of AddRemarkCommand

4.8.2. Design Considerations

Aspect: Implementation of the Remark feature

• Alternative 1: Using just one method to add and delete the remark.

  • Pros: Need not create 2 command just to add and delete the remarks.

  • Cons: The remark attached to the student in our student profile would not be able to exceed one line.

return to Table of Contents

4.9. Logging

We are using java.util.logging package for logging. The LogsCenter class is used to manage the logging levels and logging destinations.

• The logging level can be controlled using the logLevel setting in the configuration file (See Section 4.10, “Configuration”)

• The Logger for a class can be obtained using LogsCenter.getLogger(Class) which will log messages according to the specified logging level

• Currently log messages are output through: Console and to a .log file.

Logging Levels

• SEVERE : Critical problem detected which may possibly cause the termination of the application

• WARNING : Can continue, but with caution

• INFO : Information showing the noteworthy actions by the App

• FINE : Details that is not usually noteworthy but may be useful in debugging e.g. print the actual list instead of just its size

4.10. Configuration

Certain properties of the application can be controlled (e.g App name, logging level) through the configuration file (default: config.json).

return to Table of Contents

5. Documentation

We use asciidoc for writing documentation.

ℹ️	We chose asciidoc over Markdown because asciidoc, although a bit more complex than Markdown, provides more flexibility in formatting.

5.1. Editing Documentation

See UsingGradle.adoc to learn how to render .adoc files locally to preview the end result of your edits. Alternatively, you can download the AsciiDoc plugin for IntelliJ, which allows you to preview the changes you have made to your .adoc files in real-time.

5.2. Publishing Documentation

See UsingTravis.adoc to learn how to deploy GitHub Pages using Travis.

5.3. Converting Documentation to PDF format

We use Google Chrome for converting documentation to PDF format, as Chrome’s PDF engine preserves hyperlinks used in webpages.

Here are the steps to convert the project documentation files to PDF format.

1. Follow the instructions in UsingGradle.adoc to convert the AsciiDoc files in the docs/ directory to HTML format.

2. Go to your generated HTML files in the build/docs folder, right click on them and select Open with → Google Chrome.

3. Within Chrome, click on the Print option in Chrome’s menu.

4. Set the destination to Save as PDF, then click Save to save a copy of the file in PDF format. For best results, use the settings indicated in the screenshot below.

Figure 15. Saving documentation as PDF files in Chrome

return to Table of Contents

6. Testing

This section explains the various testing methods available in our application and also provides some troubleshooting techniques.

6.1. Running Tests

There are three ways to run tests.

💡	The most reliable way to run tests is the 3rd one. The first two methods might fail some GUI tests due to platform/resolution-specific idiosyncrasies.

Method 1: Using IntelliJ JUnit test runner

• To run all tests, right-click on the src/test/java folder and choose Run 'All Tests'

• To run a subset of tests, you can right-click on a test package, test class, or a test and choose Run 'ABC'

Method 2: Using Gradle

• Open a console and run the command gradlew clean allTests (Mac/Linux: ./gradlew clean allTests)

ℹ️	See UsingGradle.adoc for more info on how to run tests using Gradle.

Method 3: Using Gradle (headless)

Thanks to the TestFX library we use, our GUI tests can be run in the headless mode. In the headless mode, GUI tests do not show up on the screen. That means the developer can do other things on the Computer while the tests are running.

To run tests in headless mode, open a console and run the command gradlew clean headless allTests (Mac/Linux: ./gradlew clean headless allTests)

6.2. Types of tests

We have two types of tests:

1. GUI Tests - These are tests involving the GUI. They include,

   1. System Tests that test the entire App by simulating user actions on the GUI. These are in the systemtests package.

   2. Unit tests that test the individual components. These are in seedu.address.ui package.

2. Non-GUI Tests - These are tests not involving the GUI. They include,

   1. Unit tests targeting the lowest level methods/classes.
      e.g. seedu.address.commons.StringUtilTest

   2. Integration tests that are checking the integration of multiple code units (those code units are assumed to be working).
      e.g. seedu.address.storage.StorageManagerTest

   3. Hybrids of unit and integration tests. These test are checking multiple code units as well as how the are connected together.
      e.g. seedu.address.logic.LogicManagerTest

6.3. Troubleshooting Testing

Problem: HelpWindowTest fails with a NullPointerException.

• Reason: One of its dependencies, UserGuide.html in src/main/resources/docs is missing.

• Solution: Execute Gradle task processResources.

return to Table of Contents

7. Dev Ops

7.1. Build Automation

See UsingGradle.adoc to learn how to use Gradle for build automation.

7.2. Continuous Integration

We use Travis CI and AppVeyor to perform Continuous Integration on our projects. See UsingTravis.adoc and UsingAppVeyor.adoc for more details.

7.3. Coverage Reporting

We use Coveralls to track the code coverage of our projects. See UsingCoveralls.adoc for more details.

7.4. Documentation Previews

When a pull request has changes to asciidoc files, you can use Netlify to see a preview of how the HTML version of those asciidoc files will look like when the pull request is merged. See UsingNetlify.adoc for more details.

7.5. Making a Release

Here are the steps to create a new release.

1. Update the version number in MainApp.java.

2. Generate a JAR file using Gradle.

3. Tag the repo with the version number. e.g. v0.1

4. Create a new release using GitHub and upload the JAR file you created.

7.6. Managing Dependencies

A project often depends on third-party libraries. For example, Address Book depends on the Jackson library for XML parsing. Managing these dependencies can be automated using Gradle. For example, Gradle can download the dependencies automatically, which is better than these alternatives.
a. Include those libraries in the repo (this bloats the repo size)
b. Require developers to download those libraries manually (this creates extra work for developers)

return to Table of Contents

Appendix A: Suggested Programming Tasks to Get Started

Suggested path for new programmers:

1. First, add small local-impact (i.e. the impact of the change does not go beyond the component) enhancements to one component at a time. Some suggestions are given in Section A.1, “Improving each component”.

2. Next, add a feature that touches multiple components to learn how to implement an end-to-end feature across all components. Section A.2, “Creating a new command: remark” explains how to go about adding such a feature.

A.1. Improving each component

Each individual exercise in this section is component-based (i.e. you would not need to modify the other components to get it to work).

Logic component

Scenario: You are in charge of logic. During dog-fooding, your team realize that it is troublesome for the user to type the whole command in order to execute a command. Your team devise some strategies to help cut down the amount of typing necessary, and one of the suggestions was to implement aliases for the command words. Your job is to implement such aliases.

💡	Do take a look at Section 3.3, “Logic component” before attempting to modify the Logic component.

1. Add a shorthand equivalent alias for each of the individual commands. For example, besides typing clear, the user can also type c to remove all persons in the list.

   • Hints

     • Just like we store each individual command word constant COMMAND_WORD inside *Command.java (e.g. FindCommand#COMMAND_WORD, DeleteCommand#COMMAND_WORD), you need a new constant for aliases as well (e.g. FindCommand#COMMAND_ALIAS).

     • AddressBookParser is responsible for analyzing command words.

   • Solution

     • Modify the switch statement in AddressBookParser#parseCommand(String) such that both the proper command word and alias can be used to execute the same intended command.

     • Add new tests for each of the aliases that you have added.

     • Update the user guide to document the new aliases.

     • See this PR for the full solution.

Model component

Scenario: You are in charge of model. One day, the logic-in-charge approaches you for help. He wants to implement a command such that the user is able to remove a particular tag from everyone in the address book, but the model API does not support such a functionality at the moment. Your job is to implement an API method, so that your teammate can use your API to implement his command.

💡	Do take a look at Section 3.4, “Model component” before attempting to modify the Model component.

1. Add a removeTag(Tag) method. The specified tag will be removed from everyone in the address book.

   • Hints

     • The Model and the AddressBook API need to be updated.

     • Think about how you can use SLAP to design the method. Where should we place the main logic of deleting tags?

     • Find out which of the existing API methods in AddressBook and Person classes can be used to implement the tag removal logic. AddressBook allows you to update a person, and Person allows you to update the tags.

   • Solution

     • Implement a removeTag(Tag) method in AddressBook. Loop through each person, and remove the tag from each person.

     • Add a new API method deleteTag(Tag) in ModelManager. Your ModelManager should call AddressBook#removeTag(Tag).

     • Add new tests for each of the new public methods that you have added.

     • See this PR for the full solution.

       • The current codebase has a flaw in tags management. Tags no longer in use by anyone may still exist on the AddressBook. This may cause some tests to fail. See issue #753 for more information about this flaw.

       • The solution PR has a temporary fix for the flaw mentioned above in its first commit.

Ui component

Scenario: You are in charge of ui. During a beta testing session, your team is observing how the users use your address book application. You realize that one of the users occasionally tries to delete non-existent tags from a contact, because the tags all look the same visually, and the user got confused. Another user made a typing mistake in his command, but did not realize he had done so because the error message wasn’t prominent enough. A third user keeps scrolling down the list, because he keeps forgetting the index of the last person in the list. Your job is to implement improvements to the UI to solve all these problems.

💡	Do take a look at Section 3.2, “UI component” before attempting to modify the UI component.

1. Use different colors for different tags inside person cards. For example, friends tags can be all in brown, and colleagues tags can be all in yellow.

   Before

   

   After

   

   • Hints

     • The tag labels are created inside the PersonCard constructor (new Label(tag.tagName)). JavaFX’s Label class allows you to modify the style of each Label, such as changing its color.

     • Use the .css attribute -fx-background-color to add a color.

     • You may wish to modify DarkTheme.css to include some pre-defined colors using css, especially if you have experience with web-based css.

   • Solution

     • You can modify the existing test methods for PersonCard 's to include testing the tag’s color as well.

     • See this PR for the full solution.

       • The PR uses the hash code of the tag names to generate a color. This is deliberately designed to ensure consistent colors each time the application runs. You may wish to expand on this design to include additional features, such as allowing users to set their own tag colors, and directly saving the colors to storage, so that tags retain their colors even if the hash code algorithm changes.

2. Modify NewResultAvailableEvent such that ResultDisplay can show a different style on error (currently it shows the same regardless of errors).

   Before

   

   After

   

   • Hints

     • NewResultAvailableEvent is raised by CommandBox which also knows whether the result is a success or failure, and is caught by ResultDisplay which is where we want to change the style to.

     • Refer to CommandBox for an example on how to display an error.

   • Solution

     • Modify NewResultAvailableEvent 's constructor so that users of the event can indicate whether an error has occurred.

     • Modify ResultDisplay#handleNewResultAvailableEvent(NewResultAvailableEvent) to react to this event appropriately.

     • You can write two different kinds of tests to ensure that the functionality works:

       • The unit tests for ResultDisplay can be modified to include verification of the color.

       • The system tests AddressBookSystemTest#assertCommandBoxShowsDefaultStyle() and AddressBookSystemTest#assertCommandBoxShowsErrorStyle() to include verification for ResultDisplay as well.

     • See this PR for the full solution.

       • Do read the commits one at a time if you feel overwhelmed.

3. Modify the StatusBarFooter to show the total number of people in the address book.

   Before

   

   After

   

   • Hints

     • StatusBarFooter.fxml will need a new StatusBar. Be sure to set the GridPane.columnIndex properly for each StatusBar to avoid misalignment!

     • StatusBarFooter needs to initialize the status bar on application start, and to update it accordingly whenever the address book is updated.

   • Solution

     • Modify the constructor of StatusBarFooter to take in the number of persons when the application just started.

     • Use StatusBarFooter#handleAddressBookChangedEvent(AddressBookChangedEvent) to update the number of persons whenever there are new changes to the addressbook.

     • For tests, modify StatusBarFooterHandle by adding a state-saving functionality for the total number of people status, just like what we did for save location and sync status.

     • For system tests, modify AddressBookSystemTest to also verify the new total number of persons status bar.

     • See this PR for the full solution.

Storage component

Scenario: You are in charge of storage. For your next project milestone, your team plans to implement a new feature of saving the address book to the cloud. However, the current implementation of the application constantly saves the address book after the execution of each command, which is not ideal if the user is working on limited internet connection. Your team decided that the application should instead save the changes to a temporary local backup file first, and only upload to the cloud after the user closes the application. Your job is to implement a backup API for the address book storage.

💡	Do take a look at Section 3.5, “Storage component” before attempting to modify the Storage component.

1. Add a new method backupAddressBook(ReadOnlyAddressBook), so that the address book can be saved in a fixed temporary location.

   • Hint

     • Add the API method in AddressBookStorage interface.

     • Implement the logic in StorageManager and XmlAddressBookStorage class.

   • Solution

     • See this PR for the full solution.

return to Table of Contents

A.2. Creating a new command: remark

By creating this command, you will get a chance to learn how to implement a feature end-to-end, touching all major components of the app.

Scenario: You are a software maintainer for addressbook, as the former developer team has moved on to new projects. The current users of your application have a list of new feature requests that they hope the software will eventually have. The most popular request is to allow adding additional comments/notes about a particular contact, by providing a flexible remark field for each contact, rather than relying on tags alone. After designing the specification for the remark command, you are convinced that this feature is worth implementing. Your job is to implement the remark command.

A.2.1. Description

Edits the remark for a person specified in the INDEX.
Format: remark INDEX r/[REMARK]

Examples:

• remark 1 r/Likes to drink coffee.
  Edits the remark for the first person to Likes to drink coffee.

• remark 1 r/
  Removes the remark for the first person.

A.2.2. Step-by-step Instructions

[Step 1] Logic: Teach the app to accept 'remark' which does nothing

Let’s start by teaching the application how to parse a remark command. We will add the logic of remark later.

Main:

1. Add a RemarkCommand that extends UndoableCommand. Upon execution, it should just throw an Exception.

2. Modify AddressBookParser to accept a RemarkCommand.

Tests:

1. Add RemarkCommandTest that tests that executeUndoableCommand() throws an Exception.

2. Add new test method to AddressBookParserTest, which tests that typing "remark" returns an instance of RemarkCommand.

[Step 2] Logic: Teach the app to accept 'remark' arguments

Let’s teach the application to parse arguments that our remark command will accept. E.g. 1 r/Likes to drink coffee.

Main:

1. Modify RemarkCommand to take in an Index and String and print those two parameters as the error message.

2. Add RemarkCommandParser that knows how to parse two arguments, one index and one with prefix 'r/'.

3. Modify AddressBookParser to use the newly implemented RemarkCommandParser.

Tests:

1. Modify RemarkCommandTest to test the RemarkCommand#equals() method.

2. Add RemarkCommandParserTest that tests different boundary values for RemarkCommandParser.

3. Modify AddressBookParserTest to test that the correct command is generated according to the user input.

[Step 3] Ui: Add a placeholder for remark in PersonCard

Let’s add a placeholder on all our PersonCard s to display a remark for each person later.

Main:

1. Add a Label with any random text inside PersonListCard.fxml.

2. Add FXML annotation in PersonCard to tie the variable to the actual label.

Tests:

1. Modify PersonCardHandle so that future tests can read the contents of the remark label.

[Step 4] Model: Add Remark class

We have to properly encapsulate the remark in our Person class. Instead of just using a String, let’s follow the conventional class structure that the codebase already uses by adding a Remark class.

Main:

1. Add Remark to model component (you can copy from Address, remove the regex and change the names accordingly).

2. Modify RemarkCommand to now take in a Remark instead of a String.

Tests:

1. Add test for Remark, to test the Remark#equals() method.

[Step 5] Model: Modify Person to support a Remark field

Now we have the Remark class, we need to actually use it inside Person.

Main:

1. Add getRemark() in Person.

2. You may assume that the user will not be able to use the add and edit commands to modify the remarks field (i.e. the person will be created without a remark).

3. Modify SampleDataUtil to add remarks for the sample data (delete your addressBook.xml so that the application will load the sample data when you launch it.)

[Step 6] Storage: Add Remark field to XmlAdaptedPerson class

We now have Remark s for Person s, but they will be gone when we exit the application. Let’s modify XmlAdaptedPerson to include a Remark field so that it will be saved.

Main:

1. Add a new Xml field for Remark.

Tests:

1. Fix invalidAndValidPersonAddressBook.xml, typicalPersonsAddressBook.xml, validAddressBook.xml etc., such that the XML tests will not fail due to a missing <remark> element.

[Step 6b] Test: Add withRemark() for PersonBuilder

Since Person can now have a Remark, we should add a helper method to PersonBuilder, so that users are able to create remarks when building a Person.

Tests:

1. Add a new method withRemark() for PersonBuilder. This method will create a new Remark for the person that it is currently building.

2. Try and use the method on any sample Person in TypicalPersons.

[Step 7] Ui: Connect Remark field to PersonCard

Our remark label in PersonCard is still a placeholder. Let’s bring it to life by binding it with the actual remark field.

Main:

1. Modify PersonCard's constructor to bind the Remark field to the Person 's remark.

Tests:

1. Modify GuiTestAssert#assertCardDisplaysPerson(…​) so that it will compare the now-functioning remark label.

[Step 8] Logic: Implement RemarkCommand#execute() logic

We now have everything set up…​ but we still can’t modify the remarks. Let’s finish it up by adding in actual logic for our remark command.

Main:

1. Replace the logic in RemarkCommand#execute() (that currently just throws an Exception), with the actual logic to modify the remarks of a person.

Tests:

1. Update RemarkCommandTest to test that the execute() logic works.

A.2.3. Full Solution

See this PR for the step-by-step solution.

return to Table of Contents

Appendix B: Product Scope

Target user profile:

• is a secondary school teacher

• needs to know more about the students that they have taught

• has a need to track results

• has a need to manage a significant number of students

• prefer desktop apps over other types

• can type fast

• prefers typing over mouse input

• is reasonably comfortable using CLI apps

Value proposition: manage contacts faster than a typical mouse/GUI driven app

return to Table of Contents

Appendix C: Feature Contribution

Name	Major	Minor
Johnny	Display Panel: Add display panel functionalities to UI window	Data Integration: Integrate data input from user into display window
Xin Hui	Academic Section: Help teachers to view and manage students' academic information	Subject Class Database: Create subject class and integrate input into command. Add L1R5 calculation support into subject inputs.
Kun Hong	Administrative Information: Add student administrative information into EduBuddy	Tag Support: Enhance tag functionalities in EduBuddy
Keng Seng	Calendar: Add calendar features which supports different administrative tasks	Sorting feature: Add sorting functionalities based on various parameters

return to Table of Contents

Appendix D: User Stories

Priorities: High (must have) - * * *, Medium (nice to have) - * *, Low (unlikely to have) - *

Priority	As a …​	I want to …​	So that I can…​
* * *	new user	see usage instructions	refer to instructions when I forget how to use the App
* * *	teacher	sort students' results	know who are the ones that need more academic help easily
* * *	teacher	update students' classes	know which classes they are in easily
* * *	teacher	update students' academic results	view and obtain students' streaming score (eg.L1R5)
* * *	teacher	access student’s academic and non-academic achievements	stream the students properly (e.g. Normal Academic, Normal Technical, Express)
* * *	teacher	access student profiles easily	have first hand information on all my students without going through a lot of documentation
* * *	teacher	edit remarks of each individual student	update the students' individual needs that occur during class
* *	teacher	filter and group students	access information of specific students
* *	teacher	update student’s marks	track the student’s improvement in a certain subject
* *	teacher	know the students' emergency contact information	know who to contact when something happens to the student
* *	teacher	update student’s attendance records	know if a student has been absent too frequently
*	teacher	look up on student’s identity	recognize who the student is
*	teacher	know which subjects that I have taught them before	customize my teaching methods for different students
*	teacher	can track the student’s progress in the CCA	decide whether to involve the student more
*	teacher	key in the levels attained by the students in the various domains in L.E.A.P.S system	calculate the Co-Curricular Attainment achieved by the student.
*	teacher	view the student’s injuries history	to know the need of my students.
*	teacher	know which subjects that I have taught them before	customize my teaching methods for different students

return to Table of Contents

Appendix E: Use Cases

(For all use cases below, the System is EduBuddy and the Actor is the user, unless specified otherwise)

Use case: Delete person

Main Success Scenario

1. User requests to list persons

2. AddressBook shows a list of persons

3. User requests to delete a specific person in the list

4. AddressBook deletes the person

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. The given index is invalid.

  • 3a1. AddressBook shows an error message.

    Use case resumes at step 2.

Use case: Retrieve information of selected person

Main Success Scenario

1. User requests to list or find persons

2. AddressBook shows a list of persons

3. User requests to select a specific person in the list

4. AddressBook loads the information of the selected person

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. The given index is invalid.

  • 3a1. AddressBook shows an error message.

    Use case resumes at step 2.

Use case: Add remarks for person

Main Success Scenario

1. User requests to list or find persons

2. AddressBook shows a list of persons

3. User requests to add remarks for a specific person in the list

4. AddressBook shows the updated information of the selected person

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. The given index is invalid.

  • 3a1. AddressBook shows an error message.

    Use case resumes at step 2.

Use case: Add an appointment

Main Success Scenario

1. User requests to list or find persons

2. AddressBook shows a list of persons

3. User requests to add an appointment for a specific person in the list by typing in a date and time

4. AddressBook shows the updated details of the appointment

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. The given index is invalid.

  • 3a1. AddressBook shows an error message.

    Use case resumes at step 2.

• 3b. The given date or time is in a invalid format.

  • 3b1. AddressBook shows an error message.

    Use case resumes at step 2.

• 3c. The given date or time is already booked by another appointment.

  • 3c1. AddressBook prompts user to input another date or time.

    Use case resumes at step 2.

Use case: Update students' academic results

Main Success Scenario

1. User requests to list or find persons

2. AddressBook shows a list of persons

3. User requests to update students' academic results

4. AddressBook shows updated details of academic results

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. The given index is invalid.

  • 3a1. AddressBook shows an error message.

    Use case resumes at step 2.

Use case: Sort students by the students' academic streaming results

Main Success Scenario

1. User requests to list or find persons

2. AddressBook shows a list of persons

3. User requests to sort students by students' academic results

4. AddressBook shows sorted list of students

   Use case ends.

Extensions

• 2a. The list is empty.

  Use case ends.

• 3a. Students do not have subjects assigned to them.

  • 3a1. AddressBook shows an error message.

    Use case resumes at step 2.

return to Table of Contents

Appendix F: Non Functional Requirements

1. Should work on any mainstream OS as long as it has Java 1.8.0_60 or higher installed.

2. Should be able to hold up to 1,200 students without a noticeable sluggishness in performance for typical usage.

3. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.

return to Table of Contents

Appendix G: Glossary

Grade

The grading of the subjects by the level of competence the students show during the "O-Level examination". The level of achievement in each subject is indicated by the grade obtained, with A1 being the highest achievable grade and F9 the lowest:

Grade	Percentage of Competency
A1	75% - 100%
A2	70% - 74%
B3	65% - 69%
B4	60% - 64%
C5	55% - 59%
C6	50% - 54%
D7	45% - 49%
E8	40% - 44%
F9	0% - 39%

L1B4

A grading system for Secondary School students taking "O-Level Examination" at the end of their four years of studies in Secondary School. The score obtained from the grading system will be used to determine the eligibility of the students to enter the next level of education, Polytechnic. L1 represents the First language subject and B4 represents 2 relevant subjects, according to the polytechnic course applied, and 2 other best subjects. The score will be calculated by considering the subjects' grades. Each subject can only be considered once.

L1R5

A grading system for Secondary School students taking "O-Level Examination" at the end of their four years of studies in Secondary School. The score obtained from the grading system will be used to determine the eligibility of the students to enter the next level of education, Junior College. L1 represents the First language subject and R5 represents 5 relevant subjects. The score will be calculated by considering the subjects' grades. Each subject can only be considered once.

Mainstream OS

Windows, Linux, Unix, OS-X

Private contact detail

A contact detail that is not meant to be shared with others

Subject

These are the following subjects that are examinable in O-level Examinations in Singapore (as of Year 2018).

ℹ️	The subjects in the brackets are not to be used as input. The subjects not in brackets are preferred for better efficiency in typing.

Subject Category	Subjects
L1	English, HTamil(Higher Tamil), HChi(Higher Chinese), HMalay(Higher Malay)
R1	Hist(History), Geog(Geography), ComHum(Combined Humanities), ELit(English Literature), CLit(Chinese Literature), MLit(Malay Literature), TLit(Tamil Literature), HArt(Higher Art), HMusic(Higher Music), BIndo(Bahasa Indonesia), CSP(Chinese Special Programme), MSP(Malay Special Programme)
R2	EMath(Elementary Mathematics), AMath(Additional Mathematics), Phy(Physics), Chem(Chemistry), Bio(Biology), Sci(Combined Science)
R3	Consist of both R1 and R2 subjects
R4	Consist of L1, R1 and R2 subjects. French, German, Spanish, Hindi, Urdu, Gujarati, Panjabi, Bengali, Burmese, Thai, Jap(Japanese), Tamil, Chinese, Malay, DnT(Design and Technology), Comp(Computing), FnN(Food and Nutrition), PoA(Principles of Accounting), Econs(Economics), Drama, PE(Physical Education), Biz(Business Studies), Biotech(Biotechnology), Design(Design Studies)
R5	Consist of R4 subjects

• The following subjects can be assigned to students but are not considered as O-Level subjects: ChiB (Chinese B), MalayB (Malay B), TamilB(Tamil B).

return to Table of Contents

Appendix H: Product Survey

Product Name

Author: …​

Pros:

• …​

• …​

Cons:

• …​

• …​

return to Table of Contents

Appendix I: Instructions for Manual Testing

Given below are instructions to test the app manually.

ℹ️	These instructions only provide a starting point for testers to work on; testers are expected to do more exploratory testing.

I.1. Launch and Shutdown

1. Initial launch

   1. Download the jar file and copy into an empty folder

   2. Double-click the jar file
      Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.

2. Saving window preferences

   1. Resize the window to an optimum size. Move the window to a different location. Close the window.

   2. Re-launch the app by double-clicking the jar file.
      Expected: The most recent window size and location is retained.

I.2. Deleting a person

1. Deleting a person while all persons are listed

   1. Prerequisites: List all persons using the list command. Multiple persons in the list.

   2. Test case: delete 1
      Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated.

   3. Test case: delete 0
      Expected: No person is deleted. Error details shown in the status message. Status bar remains the same.

   4. Other incorrect delete commands to try: delete, delete x (where x is larger than the list size) {give more}
      Expected: Similar to previous.

I.3. Saving data

1. Dealing with missing/corrupted data files

   1. {explain how to simulate a missing/corrupted file and the expected behavior}

return to Table of Contents