By: AY1920S2-CS2103T-F09-4 Since: Jan 2020 Licence: MIT

Table of Contents

1. Introduction (Zeke)

Welcome! This document is a user guide written for you and other users of our travel companion, Volant. It will cover how you can use and navigate through Volant’s features so that you can get started with your travel planning.

Volant is a travel companion application for solo travellers for who prefer to use a desktop app to manage their travels.

Ui
Figure 1. Home page of Volant

Volant is optimised for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, Volant can get you planning, executing and reflecting on your trip faster than traditional GUI apps. All while enjoying our retro-inspired GUI.

Interested? Wait no further, jump to [Quick Start] to get started. Enjoy!

1.1. Reading this User Guide

Before you begin, here are some important notations that you should take note of when reading this user guide!

1.1.1. Icons and their meanings

In this user guide, you will see certain icons that aim to highlight some tips that can help you and some important information that will instruct you on things to take note of when using Volant.

Table 1. Icons in this User Guide
Icon Meaning
tip icon

Tips are just for your information. They can help you use Volant more efficiently.

info icon

A note informs you of specific conditions or behaviours of a feature.

important icon

Warnings denote extremely important details to take note of. These include irreversible actions, and important instructions that when not followed, may cause Volant to crash or corrupt its data files.

1.1.2. Markdown notations

There will also be certain markdown notations to distinguish between normal text in this guide and commands that you can use in Volant.

Table 2. Markdown notations in this User Guide
Markdown Meaning

Enter F1 F5

Keys to press on your keyboard.

delete INDEX
TRIP_FEATURE
TRIP PAGE

Commands and terminology that can be used in the Volant command line.

HOME, JOURNAL
ITINERARY, TRIP

Various features that Volant offers.

2. Quick Start (Ranice)

Follow this installation guide to get Volant up and running on your computer.

  1. Ensure you have Java 11 or above installed on your computer.

  2. Download the latest volant.jar file on the releases page.

  3. Copy the file to the folder you want to use as the home folder for the application.

  4. Double-click the JAR file to start the app.

  5. The GUI should appear in a few seconds.

  6. Type the command in the command box and press Enter to execute it.
    e.g. Typing help and pressing Enter will open a help window.

  7. Refer to Section 3, “Features (Zeke)” for a summary of the available features in this application.

  8. Refer to Section 4, “Usage of Commands” for the various commands that can be used in this program.

3. Features (Zeke)

This section describes the various features available in Volant. These include front-end features that you can interact with, such as the TRIP page, as well as back-end features such as the auto-saving of data.

3.1. Trips

You can create a new TRIP you to help you plan for your upcoming overseas trip.

In Volant, a TRIP represents a set of travel plans to a certain LOCATION within a date range. You can create and store trips in Volant to keep track of all your travels, plan your future travels and label each TRIP with a specific TRIP_NAME.

Each TRIP contains trip features such as an ITINERARY and JOURNAL to help you conveniently keep track of all things associated with your TRIP!

3.2. Home Page

You can view all your past and upcoming trips at one glance on the HOME page.

This TRIP list is neatly organised into two sections: your upcoming trips and your past trips.

3.3. Journal

To record your thoughts and memories during your trip, you can write journal entries in Volant. Volant has a JOURNAL feature that allows you to write and organise journal entries for every TRIP.

These entries are limited to 280 characters and allow users to include the LOCATION and WEATHER at the time of writing.

3.4. Itinerary

You can plan activities to do on your trip in the ITINERARY of your trip. This itinerary feature enables you to keep track of your daily activities planned for your trip. All activities are sorted in chronological order by default, with the first activity of the trip on top.

3.5. Data Storage and Auto-Saving of Data

In Volant, every TRIP you create will generate a folder named after the TRIP_NAME. This folder can be found in the data folder, under the directory that you have previously stored the Volant JAR file in. This folder stores all data associated with your TRIP 's ITINERARY and JOURNAL.

The data folder also contains a data file that stores your trip list and their respective details.

data storage
Figure 2. Diagram of data storage in Volant
Please do not edit the volant.json file, or the data of all your trips might be lost!

If you are concerned that you may forget to save your data every now and then, do not fret! Any changes that you make to your trips, journal or itinerary will automatically be saved upon every command that you give to Volant.

3.6. Fast In-App Navigation

You can navigate to the different pages of Volant quickly and efficiently, with universal commands like home and back. These commands help you to conveniently move through the pages in Volant without even touching your mouse!

In addition, certain commands such as goto itinerary can be shortened to goto i, so that you save those few precious seconds of your time.

4. Usage of Commands

This section covers the different commands that you can use on the pages in Volant.

4.1. Understanding Volant’s GUI (Mikhail)

This section covers the different components of a page in Volant and teaches you on how to utilise Volant’s GUI.

ui components
Figure 3. Components of a page in Volant

There are four major components that you will be using in Volant, which will be referenced in the upcoming sections.

  1. Menu bar
    The menu bar contains clickable buttons that you can use to execute certain commands, such as rf to refresh a page, help to open the help window, and exit to exit the application.

  2. Result display
    The result display presents the feedback from Volant to you after you have executed a command in Volant.

  3. Command line
    The command line is where you enter all your commands in Volant. After entering your command, you can execute it by clicking the Enter button on the GUI, or by simply using the Enter key on your keyboard.

  4. Status bar
    The status bar shows you where your data is being saved when you are using the features in Volant.

4.2. Pages in Volant (Mikhail)

This section covers the different pages available in Volant.

Volant consists of 4 core components: HOME page, TRIP page, ITINERARY page and JOURNAL page. Commands you enter will produce a different outcome depending on which page you are on. Additionally, there are a number of commands that are universal, which will work on every page.

4.2.1. HOME Page

Volant’s home page, featuring the entire list of trips in Volant, classified according to upcoming and past TRIP s.

home page
Figure 4. HOME page

4.2.2. TRIP Page

A page displaying the details of a specific TRIP, including the TRIP 's ITINERARY and JOURNAL.

trip page
Figure 5. TRIP page

4.2.3. JOURNAL Page

A page displaying the JOURNAL entries of a specific TRIP.

journal page
Figure 6. JOURNAL page

4.2.4. ITINERARY Page

A page displaying the ITINERARY activities of a specific TRIP.

itinerary page
Figure 7. ITINERARY page

There are specific navigation commands that you can use to navigate between these different pages. These commands will be covered in the upcoming sections.

Please take note of the different markdown formats in the following section. These formatsare used to distinguish between the different parameters used in Volant’s commands.

Command Format

  • Parameters in UPPER_CASE
    Words in plain UPPER_CASE are compulsory parameters to be supplied by you.
    e.g. In add n/NAME, NAME is a compulsory parameter and must be used as add n/John Doe.

  • Parameters in [SQUARE_BRACKETS]
    Words in square brackets (i.e. [f/FEELING]), are optional parameters to be supplied by you.
    e.g n/NAME [f/FEELING] can be used as n/John Doe f/SAD or as n/John Doe.

4.3. Universal Commands (Ranice)

Universal commands are commands that you can use on any page.

4.3.1. Opening the Help window: help

If you are lost, this command will open a convenient help window. This window contains details on the commands specific to the page you are currently on. This will be useful if you are having trouble using commands in a certain page, or would like to have a look at what commands are available on the page you are currently on.

Usage

Syntax

help

Example

help

You can also execute this command by using the F1 key on your keyboard.

Expected Outcome

A separate help window will appear with details on the available commands for the current page you are on, and their usage.

helpwindow
Figure 8. Help window

4.3.2. Refreshing a page: rf

If you would like to refresh a page to its original state, this command will reload the page. This is especially useful after executing a sort or find command, which will be discussed in later sections.

Usage

Syntax

rf

Example

rf

You can also execute this command by using the F5 key on your keyboard.

Expected Outcome

For example, after using the find command on the HOME page (see Section 4.4.5, “Finding a trip in the list: find), the HOME page will display the results of the find command. To return the HOME page to its original state (a list of all your trips), you can use the rf command.

1) After you have used the find command on the HOME page, only the results of the command will be displayed.

refresh command before
Figure 9. Result of find command

2) After using the rf command, the HOME page will return to its original state and will list all trips.

refresh command after
Figure 10. Result of rf command

4.3.3. Going back to a previous page: back

If you would like to return back to the previous page to access other features, this command navigates you to the previous page, depending on which page you are currently on.

Usage

Syntax

back

Example

back

Expected Outcome

For example, if you are on an ITINERARY page, using the back command will navigate you to the TRIP page associated with the ITINERARY.

1) You are on the ITINERARY page of a specific TRIP.

back command before
Figure 11. Using back command on ITINERARY page

2) After using the back command, you will be moved to the TRIP page of the specific TRIP.

back command after
Figure 12. Result of back command
Table 3. Outcomes when using the back command on specific pages
Your current page Outcome

The HOME page

Nothing will happen as it is the root page.

Any JOURNAL page

You will be directed to the TRIP page associated with the JOURNAL.

Any ITINERARY page

You will be directed to the TRIP page associated with the ITINERARY.

Any TRIP page

You will be directed to the HOME page.

4.3.4. Going back to the Home Page: home

If you would like to quickly jump back to the HOME page, this command will return you to the HOME page from any other page.

Usage

Syntax

home

Example

home

This command will not work while you are on the HOME page.

Expected Outcome

For example, if you would like to return to the HOME page of Volant from an ITINERARY page, using the home command will conveniently move you directly to the HOME page.

1) You are on the ITINERARY page of a specific TRIP.

back command before
Figure 13. Using home command on ITINERARY page

2) After using the home command, you will be moved to the HOME page.

home page
Figure 14. Result of home command

4.3.5. Exiting the app: exit

If you would like to quickly exit the Volant app from any page, this command will close the app.

Usage

Syntax

exit

Example

exit

This command is equivalent to clicking the "Close Window" button.

Expected Outcome

The app will close.

4.4. Commands for the Home Page (Zeke)

The HOME page consists of a list of all your upcoming and past trips.

home components
Figure 15. Components of the Home page.

From this page, you can manipulate your trip list, as well as navigate to other pages.

If you would like to access the features in a particular trip, this command navigates you to the page of a trip at the specified INDEX.

Usage

Syntax

goto INDEX

Example

goto 12

INDEX must be a positive integer value, within range of the number of entries in your trip list.

Expected Outcome

For example, you are on the HOME page and would like to navigate to the TRIP page of the trip, Winter Break.

1) You are on the HOME page and you want to navigate to the TRIP page of the third TRIP, Winter Break.

home goto before
Figure 16. Using goto command on HOME page

2) After using the goto command, you will be navigated to the third TRIP, Winter Break.

home goto after
Figure 17. Result of goto command

4.4.2. Adding a trip to your trip list: add

If you would like to embark on a new trip, this command adds a new trip to your trip list, while specifying the TRIP_NAME, the trip LOCATION, and the date range from TRIP_START_DATE to TRIP_END_DATE.

After you add a new TRIP to Volant, a new folder with the name TRIP_NAME will be created in the data file.

Usage

Syntax

add n/TRIP_NAME l/LOCATION d/TRIP_START_DATE to TRIP_END_DATE

Example

add n/Graduation Trip l/Bangkok d/01-06-2020 to 05-06-2020

  • The date range of your TRIP should be written in the format d/DD-MM-YYYY to DD-MM-YYYY.

  • The start date of the trip must be before or on the same date as the end date of the trip.

  • The date range of the trip cannot coincide with the date range of existing trips.

  • Two TRIP s cannot have the same TRIP_NAME, as data folders for each trip are named after the TRIP_NAME.
    See Data Storage for more details.

Expected Outcome

For example, you would like to add a TRIP to your trip list with the name Graduation Trip, location being Bangkok, and date range of the trip being from 1st February 2020 to 5th February 2020.

Entering the command add n/Graduation Trip l/Bangkok d/01-06-2020 to 05-06-2020 while on HOME page will add the TRIP to your trip list.

1) Enter the add command, including the specific metadata of the TRIP.

home add before
Figure 18. Using add command on HOME page

2) After using the add command, the new TRIP will be added to your trip list and displayed under UPCOMING TRIPS.

home add after
Figure 19. Result of add command

4.4.3. Deleting a trip: delete

If you would like to remove a trip from your trip list, this command will remove the trip at the specified INDEX.

Upon deletion of the TRIP, the folder containing the trip and its associated data will be deleted.

Usage

Syntax

delete INDEX

Example

delete 2

  • INDEX must be a positive integer value, within range of the number of trips in your trip list.

Expected Outcome

For example, you would like to delete the second TRIP on your trip list, Graduation Trip.

1) Enter the command delete 2.

home delete before
Figure 20. Using delete command on HOME page

2) After using the delete command, the trip will be removed from your trip list.

home delete after
Figure 21. Result of delete command

This command cannot be undone. Once a TRIP has been deleted, its respective data folder will be permanently deleted, together with all its associated data, including its ITINERARY and JOURNAL.

4.4.4. Editing trip details: edit

If you would like to update some trip details, this command allows you to edit the details of a trip at a specified INDEX.

Usage

Syntax

edit INDEX [n/TRIP_NAME] [l/LOCATION] [d/TRIP_START_DATE to TRIP_END_DATE]

Example

edit 1 n/Family Trip 2020 l/Frankfurt

  • INDEX must be a positive integer value, within range of the number of trips in your trip list.

  • The date range must be written in the format d/DD-MM-YYYY to DD-MM-YYYY.

  • The start date of must be before or on the end date.

  • The date range must not coincide with the date range of existing trips.

  • Editing the TRIP_NAME will also rename the data folder of the specific TRIP.

Expected Outcome

For example, you would like to edit the details of the first trip on your trip list, and would like to only change the TRIP_NAME of the TRIP, from "Family Trip" to "Family Trip 2020", and the LOCATION of the TRIP from "Berlin" to "Frankfurt".

1) Enter the command edit 1 n/Family Trip 2020 l/Frankfurt.

home edit before
Figure 22. Using edit command on HOME page

2) After using the edit command, the TRIP_NAME and LOCATION of the TRIP will be changed accordingly.

home edit after
Figure 23. Result of edit command

4.4.5. Finding a trip in the list: find

If you would like to search for a specific trip, this command will display any TRIP(s) that match(es) a specified KEYWORD.

Usage

Syntax

find KEYWORD

Example

find fuji

  • The KEYWORD parameter is case insensitive, meaning that using the KEYWORD "fUji" will return all trips with the word "fuji" in their names regardless of the case of each character.

Expected Outcome

For example, you would like search for a trip on the trip list with the KEYWORD, "fuji" in the TRIP_NAME. Volant will locate all TRIP s with the KEYWORD, "fuji", and display all matching results.

1) Use the command find fuji to search for trips with the KEYWORD "fuji".

home find before
Figure 24. Using find command on HOME page

2) After using the find command, Volant will display all trips with the specified KEYWORD.

home find after
Figure 25. Result of find command

If you would like to revert the HOME page to its original state after viewing the results of the find command, you can use the rf command to refresh the page.

4.5. Commands for the Trip Page (Mikhail)

The TRIP page of a specific trip displays the details of the trip as well as the details of the trip’s ITINERARY and JOURNAL at a glance. From this page, you can navigate to the ITINERARY and JOURNAL pages associated with the TRIP.

If you would like to access either the JOURNAL or ITINERARY of the trip, this command will navigate you to the feature of the TRIP.

Usage

Syntax

goto TRIP_FEATURE

Example

goto itinerary

  • List of available TRIP_FEATURE (case insensitive):

    • itinerary

    • journal

  • TRIP_FEATURE shortcuts are also available:

    • goto i is equivalent to goto itinerary

    • goto j is equivalent to goto journal

Expected Outcome

For example, you are on the TRIP page and would like to view your itinerary for that TRIP. After using the goto command, Volant will navigate you to the TRIP 's ITINERARY page.

1) You are on the TRIP page of the trip "Family Trip".

trip goto before
Figure 26. Using goto command on TRIP page

2) After using the goto command, you will be navigated to the TRIP 's ITINERARY page.

trip goto after
Figure 27. Result of goto command

4.6. Commands for the Itinerary Page (Nguyen)

The ITINERARY page of a specific trip consists of a list of all the planned activities for a specific trip. Here, you can manipulate the list of activities, as well as navigate to the TRIP page or HOME page.

itinerary components
Figure 28. ITINERARY page

4.6.1. Adding an activity: add

If you would like plan a new activity, this command adds a new activity to your itinerary.

Usage

Syntax

add a/ACTIVITY_TITLE l/LOCATION d/DATE t/TIME

Example

add a/Flight to Singapore l/Berlin Brandenburg Airport d/24-12-2020 t/19:00

  • Date must be specified in the following format: DD-MM-YYYY

  • Date must be between the date range of the TRIP.

  • Time must be specified in the following format: HH:MM (24-hour format, e.g. 23:00)

  • Date and time must be in the future — no use planning for the past!

Expected Outcome

A new activity titled Flight to Singapore at Berlin Brandenburg Airport at 07:00 AM on 24th December 2020 is added to the TRIP 's ITINERARY.

1) You would like to add a new activity into your ITINERARY with the specified metadata.

itinerary add before
Figure 29. Using add command on ITINERARY page

2) After using the add command, a new activity will be added to the ITINERARY.

itinerary add after
Figure 30. Result of add command

4.6.2. Deleting an activity: delete

If you would like to remove an activity from the itinerary, this command deletes the activity at a specified INDEX.

Usage

Syntax

delete INDEX

Example

delete 4

  • INDEX must be a positive integer value, within range of the number of activities in the ITINERARY.

  • Figure 28 in [Itinerary Page] shows where you can find the INDEX on the ITINERARY page.

Expected Outcome

The fourth activity on the ITINERARY is deleted.

1) You wish to delete the activity at INDEX 4 from your ITINERARY.

itinerary delete before
Figure 31. Using delete command on ITINERARY page

2) After using delete command, the activity at INDEX 4 is deleted.

itinerary delete after
Figure 32. Result of delete command

4.6.3. Editing an activity: edit

If you would like to update the details of an activity, this command allows you to edit the details of an existing activity in the ITINERARY.

Usage

Syntax

edit INDEX [a/ACTIVITY_TITLE] [l/LOCATION] [d/DATE] [t/TIME]

Example

edit 2 l/Starbucks t/10:00

  • INDEX must be a positive integer value, within range of the number of activities in the ITINERARY.

  • At least one of the optional fields must be provided.

  • When editing the date:

    • Date must be specified in the following format: DD-MM-YYYY

    • Date must be within the date range of the trip.

  • When editing the time:

    • Time must be specified in the following format: HH:MM (24-hour format, e.g. 23:00)

    • The new time cannot clash with the time of any existing activity.

Expected Outcome

The second activity in the ITINERARY has been edited to reflect the new location Starbucks and the new time 10:00 AM.

1) You wish to edit the LOCATION and TIME of the activity at INDEX 2.

itinerary edit before
Figure 33. Using edit command on ITINERARY page

2) After using edit command, the LOCATION and TIME of the activity at INDEX 2 will be updated accordingly.

itinerary edit after
Figure 34. Result of edit command

4.6.4. Locating an activity: find

If you would like to search for a specific activity, this command filters the ITINERARY for activities that match the keyword and displays them.

Usage

Syntax

find [a/ACTIVITY_TITLE] [l/LOCATION] [d/DATE] [t/TIME]

Example

find a/ferry

  • Date must be specified in the following format: DD-MM-YYYY

  • Time must be specified in the following format: HH:MM (24-hour format, e.g. 23:00)

Expected Outcome

All activities whose name consists of the keyword "ferry" are displayed.

1) You wish to find all activities that include the keyword "ferry"

itinerary find before
Figure 35. Using find command on ITINERARY page

2) After using find command, all activities that include the keyword "ferry" are displayed.

itinerary find after
Figure 36. Result of find command

4.7. Commands for the Journal Page (Grant)

The JOURNAL page of a specific TRIP consists of a list of all the journal entries associated with the TRIP. Here, you can manipulate the list of entries, as well as navigate to the TRIP page or HOME page.

journal components
Figure 37. JOURNAL page

4.7.1. Adding a journal entry: add

If you would like to record a new JOURNAL entry, this command adds a new entry to the JOURNAL.

Usage

Syntax

add d/DATE t/TIME c/CONTENT [l/LOCATION] [f/FEELING] [w/WEATHER]

Example

add d/01-12-2020 t/14:20 c/It’s a really good day today!

  • Date must be specified in the following format: DD-MM-YYYY

  • Time must be specified in the following format: HH:MM (24-hour format, e.g. 23:00)

  • CONTENT is limited to 280 characters

  • Available FEELING types (case insensitive):

    • CONFUSED

    • EXCITED

    • HAPPY

    • SAD

    • SCARED

    • SURPRISED

    • WORRIED

  • Available WEATHER types (case insensitive):

    • CLOUDY

    • COLD

    • COOL

    • DARK

    • HOT

    • RAINY

    • SNOWY

    • SUNNY

Expected Outcome

Adds a new journal entry to the entry list with the specified content, date, time, location and feeling fields.

1) You want to add an entry to the JOURNAL with the specified metadata.

journal add before
Figure 38. Using add command in JOURNAL page

2) After using the add command, a new entry is added to the JOURNAL.

journal add after
Figure 39. Result of add command

4.7.2. Deleting a journal entry: delete

If you would like to remove an entry from the journal, this command deletes the entry at the specified INDEX.

Usage

Syntax

delete INDEX

Example

delete 1

  • INDEX must be a positive integer value, within range of the number of trips in your trip list.

  • Figure 37 in [Journal Page] shows where you can find the INDEX on the page.

Expected Outcome

The entry at the specified INDEX will be deleted.

1) You wish to delete the entry at INDEX 1.

journal delete before
Figure 40. Using delete command in JOURNAL page

2) After using delete command, the entry at INDEX 1 will be deleted.

journal delete after
Figure 41. Result of delete command

4.7.3. Editing a journal entry: edit

If you would like to update a journal entry with new content, a new location, a new date, a new time, a new feeling and/or a new weather, this command allows you to edit the entry at a specified INDEX.

Usage

Syntax

edit INDEX [d/NEW_DATE] [t/NEW_TIME] [c/NEW_CONTENT] [l/NEW_LOCATION] [f/NEW_FEELING] [w/NEW_WEATHER]

Example

edit 2 w/snowy

  • At least one of the optional fields must be provided.

Expected Outcome

Changes the weather of the second entry to SNOWY.

1) You wish to edit the weather field of the entry at INDEX 2.

journal edit before
Figure 42. Using edit command on JOURNAL page

2) After using the edit command, the weather field of the entry at INDEX 2 will be updated accordingly.

journal edit after
Figure 43. Result of edit command

4.7.4. Sorting a list of current journal entries: sort

If you would like to arrange your journal entries in a certain order, this command sorts the list of entries in a specified order.

Usage

Syntax

sort [SORT_TYPE]

Example

sort oldest

  • Available SORT_TYPE:

    • NEWEST — newest entries first (default if SORT_TYPE is left empty)

    • OLDEST — oldest entries first

    • LOCATION — locations in alphabetical order

    • FEELING — feelings in alphabetical order

  • Default sorting of journal entries is in order of newest entries first.

Expected Outcome

Sorts the list of JOURNAL entries by oldest to newest.

1) You wish to sort the entries by oldest first.

journal sort oldest before
Figure 44. Using sort command on JOURNAL page

2) After using the sort command, the order of the entries will be sorted from oldest to newest.

journal sort oldest after
Figure 45. Result of sort command

5. FAQ (Grant)

This section discusses some frequently asked questions about Volant.

Q: Is Volant free?
A: Yes, Volant is absolutely free to use!

Q: I have volant.jar downloaded but cannot start the application. Is there anything I can do?
A: Yes, open the command prompt on your computer, navigate to the directory in which you have stored volant.jar and type java -jar volant.jar.

Q: Is Volant safe to use?
A: Yes, Volant is safe to use! We regularly review our code to ensure that hackers are unable to exploit the security structure of our software.

Q: Is Volant secure?
A: Yes, Volant is secure. Your data is stored only on your device. No data is sent to any online servers.

Q: Do I need an Internet connection to use Volant?
A: No, you don’t! Volant works 100% offline. This is especially useful when you travel to locations where Internet connection is spotty, or even scarce.

Q: Will Volant be consistently updated?
A: Yes! We are a dedicated team of software developers who constantly collate feedback and run tests on the Volant app. We are also looking forward to delivering more features for our users.

Q: Can I use Volant on a mobile device?
A: Volant is designed to work best on a desktop/laptop/tablet interface. We are currently adapting Volant’s user interface to support more mobile devices.

Q: How do I transfer my data to another device?
A: Install the app in the other device and overwrite the empty data file it creates with the file that contains the data of your previous Volant folder.

6. Command Summary (Nguyen)

This section summarises the syntax of all the commands available in the Volant app.

6.1. Command Formats

Use this list of command formats as a quick and convenient reference.

Table 4. Command formats

Section

Command

Format

Universal commands

Help

help

Refresh

rf

Navigate to home page

home

Navigate to previous page

back

Exit app

exit

Home page

Navigate to trip

goto INDEX

Add trip

add n/TRIP_NAME l/LOCATION d/TRIP_START_DATE to TRIP_END_DATE

Delete trip

delete INDEX

Edit trip

edit INDEX [n/TRIP_NAME] [l/LOCATION] [d/TRIP_START_DATE to TRIP_END_DATE]

Find trip

find KEYWORD

Trip page

Navigate to feature

goto FEATURE

Itinerary

Add activity

add a/ACTIVITY_TITLE l/LOCATION d/DATE t/TIME

Delete activity

delete INDEX

Edit activity

edit INDEX [a/ACTIVITY_TITLE] [l/LOCATION] [d/DATE] [t/TIME]

Find activity

find FIELD [a/ACTIVITY_TITLE] [l/LOCATION] [d/DATE] [t/TIME]

Journal

Add entry

add d/DATE t/TIME c/CONTENT [l/LOCATION] [f/FEELING] [w/WEATHER]

Delete entry

delete INDEX

Edit entry

edit INDEX [d/NEW_DATE] [t/NEW_TIME] [c/NEW_CONTENT] [l/NEW_LOCATION] [f/NEW_FEELING] [w/NEW_WEATHER]

Sort entries

sort [SORT_TYPE]

Below is a useful "cheat sheet" of all navigation commands that can be used to navigate between the pages in Volant.

navigation cheatsheet
Figure 46. Graphical summary of navigation commands in Volant

7. Glossary (Ranice)

This section will cover and explain certain technical/Volant-specific terms mentioned in this User Guide.

Term Explanation

Command Line Interface (CLI)

A user interface where users are required to use the program by entering commands into a text box.

Graphical User Interface (GUI)

A user interface that includes visual elements such as buttons, icons, images, menus etc.

Metadata

Details associated with an entity. For example, metadata of a TRIP include TRIP_NAME, LOCATION, TRIP_START_DATE, TRIP_END_DATE

Root Page

The first page that the Volant displays when opened. For Volant, this is the HOME page.