By: CS2103-AY1819S2-W10-1      Since: Jan 2019      Licence: MIT

1. Introduction

README is an integrated bookmark manager and feed reader desktop application that helps you read more content you care about anywhere you go.

You’ll love README if you consume a lot of web content and want to keep up to date with your favourite websites but you’re a road warrior who doesn’t have regular Internet access.

Whether you’re heading off on a long flight or working in a cafe, README has you covered with all the content you care about in one place.

README is for those who prefer to use a desktop app for subscribing to web feeds and saving web pages to read later on their personal computer.

More importantly, README is optimized 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, README can make you more efficient at consuming content than traditional GUI apps.

Jump to Section 3, “Quick Start” to get started!

2. How To Use This Guide

This User Guide contains everything you need to know in order to use README. You don’t need to read this Guide from start to finish - it is designed to help you find exactly what you need.

See Section 3, “Quick Start” to get up and running quickly.

See Section 4, “Features” to learn about how README works.

See Section 6, “Commands” to find out what each command does and the parameters you need to supply.

Here are icons we use and what they mean:

Useful but non-crucial information.
Helpful information that may make your experience better.
Important information about potential issues that may occur.

3. Quick Start

Get started quickly by installing README, getting to know its user interface, and touring of its main features!

3.1. Installation

  1. Ensure you have Java version 9 or later installed in your Computer.

  2. Download the latest README.jar here.

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

  4. Double-click the file to start the app. The GUI should appear in a few seconds.

3.2. User Interface

UiOverview

This is how the application should look like!

Enter your commands in the Command Box (B), and the execution result message will appear in the Result Display (C).

Browse your saved entries from the List Panel (F), and select any one of them to view it in the Browser Panel (G).

3.3. Quick Tour of Basic Features

  1. Type the command in the Command Box and press Enter to execute it.
    e.g. typing help and pressing Enter will open the help window.

  2. Try these commands in order!

    • list : shows your reading list of saved links

    • addl/https://en.wikipedia.org/wiki/Special:Random : adds a random Wikipedia page to your reading list

    • select1 : selects the Wikipedia page for reading

    • addl/https://en.wikipedia.org/wiki/Main_Page : adds the Wikipedia main page to your reading list

    • googlenews : displays the current top stories from Google News

    • add1 : adds the first news article to your reading list

    • list : goes back to your reading list

    • select3 : selects the just-added news article for reading

    • viewreader : switches to a more comfortable reading experience

    • archive3 : archives the news article

    • archives : shows your archived links

    • delete1 : delete the archived news article

    • feeds : shows your subscribed feeds

    • subscribel/https://www.buzzfeed.com/index.xml ti/BuzzFeed : subscribes to the BuzzFeed news feed (this can take a while)

    • list : goes back to your reading list

    • refresh1 : refreshes the first entry to get most recent version from internet

    • select1 : views the updated entry

    • exit : exits the app

  3. Refer to Section 6, “Commands” for details of each command.

4. Features

4.1. Overview

README helps you capture the content that you discover online.

Save the latest news stories, magazine articles, recipes, how-tos – anything you discover online. Whenever you find a web page you want to read later, add it to your reading list in README. To help you organize the mountain of content, README lets you tag link so you can always find what you’re looking for, and archive or delete links you’ve finished reading so your reading list won’t become cluttered.

4.1.2. Web Feeds Subscription - Read More

README keeps you up to date with your favourite websites.

Integrations with Bing Web Search and Google News mean you’ll never run out of things to read. Search for particular topics you’d like to know more about or just read the top news stories - it’s up to you. As README also functions as a feed reader, you can subscribe and unsubscribe from any RSS or Atom feed available on the Internet. Whenever you open README, the latest content from your subscribed feeds is automatically added to your reading list.

4.1.3. Offline Support - Read Anywhere

README lets you read offline, even on airplanes, trains, or on Wi-Fi-only devices away from Internet connections.

Whenever you save a link, README automatically downloads its web page to your personal computer if there is an Internet connection. This gives you the convenience of viewing your saved links anywhere, anytime, even if there is no Internet connection. If you still want to keep a link but no longer need to view it offline, you can archive it. This will delete its downloaded web page from your personal computer.

4.1.4. Reader View - Read Better

README makes your long reading sessions so much more comfortable.

Reader View strips out all the visual clutter from web pages and presents content in a perfectly formatted, clean layout, so you can focus on the content without any unnecessary distractions. You can even choose the colour scheme that suits you best - try the white or sepia style if you’re reading in a lighted environment, or the dark or black styles in a dark environment.

4.2. Glossary

4.2.1. Common Terms

  1. Feed
    A data format used by content providers to provide users with frequently updated content. Also known as a web feed, they can be found all over the web - you can usually find a link to them titled "RSS feed" or "Atom feed" at the footer of a website.

  2. Link
    Short for "hyperlink", a reference to a URL you can follow by clicking on its text.

  3. Tag
    A label attached to an entry for the purpose of identification or to give other information.

  4. URL
    An address to a web resource, usually beginning with http:// or https://. Stands for Uniform Resource Locator.

4.2.2. README-specific Terms

  1. Command
    An instruction you type in that makes README perform a function.

  2. Entry
    The name we use for a single web page that has been added to README. Similar to a bookmark, comprising URL, Title, and Description fields among others.

  3. Context
    The Context determines which Entries are displayed and what Commands are available. The four contexts are Reading List, Archives, Search Results and Feeds. Refer to Section 5, “Contexts” for more information.

  4. Reading List
    When you or a web feed that you Subscribe to Adds a new Entry, it is saved to your Reading List. Entries in your Reading List have their web pages automatically downloaded onto your personal computer for offline viewing. When you’re finished with an Entry, you can move it to your Archives for safekeeping.

  5. Archives
    When you’re finished with an Entry but would like to keep it for future reference, you can move it to the Archives. Archived items will still be available for viewing but will not have their web pages automatically downloaded to your personal computer. Therefore, you’ll need an Internet connection to view Entries in your Archives.

  6. Search Results
    When you Search online for new Entries, they are temporarily stored here until you do another Search. You can Add an Entry from here to your Reading List.

  7. Feeds
    Feeds you Subscribe to are listed here. You can Subscribe to a new Feed or Unsubscribe from an existing one.

  8. Add
    The action of adding a web page as an Entry to your Reading List. Sometimes we may refer to this as Saving as well.

  9. Edit
    If you would like to change the URL, Title, or Description fields or Tags of an Entry, you can Edit it.

  10. Archive
    If you’re finished with an Entry but would like to keep it for future reference, you can Archive it. This will move the Entry from your Reading List to your Archives. Archived Entries can be Unarchived.

  11. Unarchive
    If you’ve Archived an Entry but would like its web page to be downloaded to your personal computer, you can Unarchive it. This will move the Entry from your Archives to your Reading List. Unarchived Entries can be Archived again.

  12. Delete
    If you do not wish to keep an Entry, you can Delete it. This will permanently remove an Entry. Deleted Entries cannot be recovered.

  13. Find
    The action of finding certain existing Entries. You can narrow down to those that contain certain keywords.

  14. Select
    If you would like to view an Entry’s web page, you can Select it. You can also choose a View Mode.

  15. View Mode
    The View Mode determines how an Entry’s web page is displayed. The two available View Modes are Reader View and Browser View.

  16. Reader View
    Reader View displays a web page in a simplified layout that makes reading enjoyable and free of distracting ads, fancy layouts, and other extraneous things. You can customize the colour scheme to meet your own preferences.

  17. Browser View
    Browser View displays a web page just as it would appear in its original form in your web browser.

  18. Search
    The action of searching online for new Entries to Add. You can use Bing Web Search or Google News Search.

  19. Subscribe (to a website’s Feed)
    Keep up to date with a website by having any new Entries added to your Reading List.

  20. Unsubscribe (from a website’s Feed)
    Stop adding any new Entries from the website to your Reading List.

5. Contexts

README supports many features, from bookmarking and archiving to subscribing to feeds and searching for new content.

To help you navigate these features, we divided these functions into four major partitions, or contexts:

  1. Reading List

  2. Archives

  3. Search Result

  4. Feeds

Navigate the contexts via our context-switching commands (see Section 6.3, “Context-switching commands”), or by clicking the buttons on the sidebar!

ug contextx
Figure 1. Use the sidebar buttons to switch contexts
The Discover button brings you to the Search Result context!

For more information on what commands and functions are available in each context, refer to the section below!

6. Commands

6.1. Command Format

  • Words in UPPER_CASE are the parameters you need to supply.

    • For example, in add l/URL, URL is a parameter which can be used as add l/https://nus-cs2103-ay1819s2.github.io/cs2103-website.

  • Parameters in square brackets are optional.

    • For example, l/URL [ti/TITLE] can be used as l/https://nus-cs2103-ay1819s2.github.io/cs2103-website/ ti/CS2103 Website or as l/https://nus-cs2103-ay1819s2.github.io/cs2103-website/.

  • Parameters with …​ after them can be used multiple times including zero times.

    • For example, [t/TAG]…​ can be used as   (i.e. 0 times), t/tech, t/tech t/business etc.

  • Parameters can be in any order.

    • For example, if a command specifies ti/TITLE d/DESCRIPTION, d/DESCRIPTION ti/TITLE is also acceptable.

6.2. Non-contextual commands

These commands can be used from any context.

6.2.1. Custom user command macro: macro [coming in v2.0]

Creates macros that compose commands together.

Format: macro MACRO_NAME NUM_ARGS command1; command2; …​ commandN

Examples:

  • Adding a macro to quickly archive all entries with given tags.

    1. macro archive-tags-which-are-old 1 find t/$1; archiveall

6.2.2. Export settings and data to an export file : export [coming in v2.0]

Exports the feeds, saved data, history, and other preferences to an export file.

Format: export FILE_PATH

  • Serializes all the feeds and other preferences to a file.

  • Copies all saved data into the export folder

  • Compresses export folder to a export file.

Examples:

  • Saves an export file to desktop

    1. export /home/tt/Desktop

  • Saves an export file to desktop

    1. export C:\Users\Name\Desktop

6.2.3. Import settings and data from an export file : import [coming in v2.0]

Imports the feeds, saved data, history, and other preferences from an export file.

Format: import FILE_PATH

  • Decompresses export file

  • Deserializes all the feeds and other preferences from the export file and save it to the application

  • Copies all saved data from the export folder to application database

Examples:

  • Saves an export file to desktop

    1. import /home/tt/Desktop/export.jtjr

  • Saves an export file to desktop

    1. import C:\Users\Name\Desktop\export.jtjr

6.2.4. Adding a single entry: add

Adds a single entry from a link URL to your reading list. Content is automatically downloaded onto your personal computer.

Format: add l/URL [ti/TITLE_OVERRIDE] [d/DESCRIPTION_OVERRIDE] [t/TAG]…​

The entry’s URL must be unique. Duplicate entries with the same URL will not be added!
The Title and Description fields are automatically filled if you do not provide them.
A entry can have any number of tags (including 0).

Examples:

  • Adds a single entry with a description and tagged with “Business”

    1. add l/https://www.theatlantic.com/magazine/archive/2019/03/ford-ceo-jim-hackett-ux-design-thinking/580438/ d/Explains why UX is important t/Business

6.2.5. Subscribing to a feed: subscribe

Adds a feed and subscribes to its updates.
All entries in the subscribed feed will be added to the reading list.

Format: subscribe l/URL [ti/TITLE_OVERRIDE] [d/DESCRIPTION_OVERRIDE] [t/TAG]..

The Title and Description fields are automatically filled up if you do not provide them. If no tags were specified, the feed entry will automatically be tagged with the URL’s (stripped) hostname, if possible.

A feed can have any number of tags (including 0).
Imported entries from the feed will also be tagged with the same tags as the feed.

Examples:

  • Adds a feed whose name is “Kattis”.
    subscribe l/https://open.kattis.com/rss/new-problems t/programming

ug subx 1
Figure 2. Subscribing to a feed will add it to the feeds list.
ug subx 2
Figure 3. The links present in the feed are automatically imported to the reading list.

The application may be unresponsive for a short while when adding entries from a large feed.

6.2.6. Listing entered commands : history

Lists all the commands that you have entered in reverse chronological order.
Format: history

Pressing the ↑ and ↓ arrows will display the previous and next input respectively in the command box.

6.2.7. Enabling or disabling offline mode : offline

Some web pages may not work with offline mode. In order to browse these web pages, you may temporarily disable offline mode with this command, or enable it after you wish to re-enter offline mode.

Format: offline MODE(enable, disable)

Examples:

  • Disable offline mode

    1. offline disable

  • Enable offline mode

    1. offline enable

Offline mode is enabled by default at the start of every session so you don’t have to worry about forgetting to re-enable offline mode

6.2.8. Viewing help : help

Format: help

6.2.9. Exiting the program : exit

Exits the program.

Format: exit

6.3. Context-switching commands

These commands can be used from any context but change the context in which only allowed commands are recognised (e.g. archive, unarchive, feed).

6.3.1. Showing your Reading List: list

Shows your Reading List of all saved entries.

This command also enters the Reading List context. Refer to Section 6.4, “Reading List Context Commands” for available commands in this context.

Format: list

ug contextx list
Figure 4. Switch to the list context to see all your saved entries

6.3.2. Showing your Archives: archives

Shows your Archives of all archived entries.

This command also enters the Archives context. Refer to Section 6.5, “Archives Context Commands” for available commands in this context.

Format: archives

ug contextx archives
Figure 5. Switch to the archives context to see all your archived entries

6.3.3. Searching the web: bing

Searches Bing for entries that you can subsequently add.

This command also enters the Search Results context. Refer to Section 6.6, “Search Results Context Commands” for available commands in this context.

Format: bing [KEYWORD]…​

Examples:

  • Bing search the web for entries containing the Trump keyword

    1. bing Trump

ug contextx bing
Figure 6. Bing search for the phrase Trump

6.3.4. Searching for news: googlenews

Searches Google News for entries that you can subsequently add.

This command also enters the Search Results context. Refer to Section 6.6, “Search Results Context Commands” for available commands in this context.

Format: googlenews [KEYWORD]…​

Examples:

  • View the current top stories on Google News.

    1. googlenews

  • Search for news articles containing the Trump keyword

    1. googlenews Trump

ug contextx gnews
Figure 7. View the latest top news on google news using the googlenews command

6.3.5. Previewing a web feed: feed

Opens a web feed at the URL for previewing.

This command also enters the Search Results context. Refer to Section 6.6, “Search Results Context Commands” for available commands in this context.

Format: feed [FEED URL]

Examples:

ug contextx feed
Figure 8. Open any feed and view its contents as a list of entries

6.3.6. Searching a web page for links: links [coming in v2.0]

Lists all the links in a URL, or the currently displayed web page.

This command also enters the Search Results context. Refer to Section 6.6, “Search Results Context Commands” for available commands in this context.

Format: links Format: links [URL]

6.3.7. Showing feeds: feeds

Shows a list of feeds being followed.

This command also enters the Feeds context. Refer to Section 6.7, “Feeds Context Commands” for available commands in this context.

Format: feeds

Examples:

  • List all feeds

    1. feeds

  • List all feeds tagged with “Business” [coming in v2.0]

    1. feeds t/Business

ug contextx feeds
Figure 9. Switch to the feeds context to view your subscribed feeds

6.3.8. Searching online for feeds: searchfeeds [coming in v2.0]

Searches online for feeds that you can subsequently follow.

This command also enters the Feed Search context. Refer to Section 6.8, “Feeds Search Context Commands [coming in v2.0]” for available commands in this context.

Format: searchfeeds [KEYWORD]…​

Examples:

  • Shows some starter feeds you can add

    1. searchfeeds

  • Searches for Tech or Business feeds

    1. searchfeeds Tech Business

6.3.9. Showing reading statistics: stats [coming in v2.0]

Shows helpful and fun statistics about your reading progress and habits.

Format: stats

6.4. Reading List Context Commands

To add entries to the reading list, please refer to Section 6.2.4, “Adding a single entry: add”.

6.4.1. Editing an entry: edit

Edits an existing entry in the reading list.

Format: edit INDEX [ti/TITLE_OVERRIDE] [d/DESCRIPTION_OVERRIDE] [r/READ_STATUS] [t/TAG]…​

  • Edits the entry at the specified INDEX. The index refers to the index number shown in the displayed entry list. The index must be a positive integer 1, 2, 3, …​

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

  • Existing values will be updated to the input values.

  • When editing tags, the existing tags of the entry will be removed i.e adding of tags is not cumulative.

  • You can remove all the entry’s tags by typing t/ without specifying any tags after it.

Examples:

  • Edit the title and description of the 1st entry to be Software Design Patterns and Useful for software engineering project. respectively.

    1. edit 1 ti/Software Design Patterns d/Useful for software engineering project.

  • Clear all existing tags from the 2nd entry.

    1. edit 2 t/

6.4.2. Finding entries (by title, description, etc.): find

Finds entries whose fields contain any of the given keyphrases.

Format: find [a/SEARCH_PHRASE] [ti/TITLE_SEARCH_PHRASE] [d/DESCRIPTION_SEARCH_PHRASE] [l/LINK_SEARCH_PHRASE] [t/TAG_TO_SEARCH]…​

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

  • The search is case insensitive. e.g hans will match Hans

  • The search matches anywhere for title, description and link. e.g. ans B will match Hans Bo

  • The search matches exactly for tags. e.g. 'science' will match 'science', but not 'scienceandtech'

  • The search phrase with prefix a/ will try to match with every field in the entry according to the above rules.

    • i.e. find a/keyphrase is equivalent to find ti/keyphrase d/keyphrase l/keyphrase t/keyphrase

  • Entries matching at least one field will be returned (i.e. OR search).

    • e.g. find ti/aaa d/bbb l/ccc t/ddd will match an entry with title Aaawesome and an entry with description abbbA

Examples:

  • Find entries with title containing the phrase lambda, or link containing the phrase github.

    1. find ti/lambda l/github

ug findfieldx
Figure 10. Only entries with title containing lambda (red) or link containing github (orange) shown after find command

  • Find entries with the tag infoTheory.

    1. find t/infoTheory

ug findtagx
Figure 11. Only entries with tag infoTheory shown after find command

6.4.3. Selecting an entry: select

Selects the entry identified by the index number used in the displayed entry list for reading.

Format: select INDEX

  • Selects the entry at the specified INDEX for reading.

  • The index refers to the index number shown in the displayed entry list.

  • The index must be a positive integer 1`, 2, 3, …​`

Examples:

  • Select the 2nd entry in the reading list for reading.

    1. list

    2. select 2

  • Select the 1st entry in the find results for the phrase Trump in the title.

    1. find ti/Trump

    2. select 1

6.4.4. Changing the view mode: view

Changes the view mode between the original browser view or the reader view for a more comfortable reading experience.

Format: view MODE(browser, reader) [s/STYLE(default, sepia, dark, black)]

Examples:

  • Switch to the browser view mode, which displays web pages as they would appear in a web browser.

    1. view browser

BrowserView
Figure 12. A web page with many distracting elements like advertisements in browser view

  • Switch to the reader view mode, which strips away clutter and presents content in a clean layout.

    1. view reader

ReaderView
Figure 13. The same web page in reader view - with clutter stripped away more actual content is visible

  • Switch to the reader view mode with sepia colour scheme

    1. view reader s/sepia

ReaderViewSepia
Figure 14. A web page in reader view with sepia colour scheme

  • Switch to the reader view mode with dark colour scheme

    1. view reader s/dark

ReaderViewDark
Figure 15. A web page in reader view with dark colour scheme

  • Switch to the reader view mode with black colour scheme

    1. view reader s/black

ReaderViewBlack
Figure 16. A web page in reader view with black colour scheme

6.4.5. Refreshing an entry: refresh

If you added an entry a long time ago and you think that the saved page might be outdated, you can fetch the most updated version from the internet by using this command. This is helpful for pages such as Wikipedia, which may change often! See the refreshall command which may be useful to use if you need to refresh a large number of entries at the same time.

Format: refresh INDEX

  • Refreshes the content of the entry at the specified INDEX.

  • The index refers to the index number shown in the displayed entry list.

  • The index must be a positive integer 1, 2, 3, …​

Examples:

  • Refresh the content of the 2nd entry in the reading list.

    1. list

    2. refresh 2

6.4.6. Refreshing all displayed entries: refreshall

Refreshes all currently displayed entries.

Format: refreshall

  • Refreshes only entries that are currently displayed.

The application may be unresponsive for a short while when refreshing a large number of entries.

You may refer to the archiveall command for an example on how this command may be combined with other commands such as find to be more useful.

Examples:

  • Refresh all entries in the reading list. (Will take a long time if you have a large reading list!)

    1. list

    2. refreshall

  • Refresh all entries tagged “infoTheory”

    1. list

    2. find t/infoTheory

    3. refreshall

    4. list

6.4.7. Marking an entry as read: read [coming in v2.0]

Marks the specified entry as read.

Format: read INDEX

  • Marks as read the entry at the specified INDEX.

  • The index refers to the index number shown in the displayed entry list.

  • The index must be a positive integer 1, 2, 3, …​

Examples:

  • Mark the 2nd entry in the reading list as read.

    1. list

    2. read 2

6.4.8. Marking an entry as unread: unread [coming in v2.0]

Marks the specified entry as unread.

Format: unread INDEX

  • Marks as unread the entry at the specified INDEX.

  • The index refers to the index number shown in the displayed entry list.

  • The index must be a positive integer 1, 2, 3, …​

Examples:

  • Mark the 2nd entry in the reading list as unread.

    1. list

    2. unread 2

6.4.9. Sharing an entry: share [coming in v2.0]

Shares the specified entry through connected social media.

Format: share INDEX

6.4.10. Archiving an entry: archive

Moves the specified entry to the archive and removes its downloaded content.

Format: archive INDEX

  • Archives the entry at the specified INDEX.

  • The index refers to the index number shown in the displayed entry list.

  • The index must be a positive integer 1, 2, 3, …​

Examples:

  • Move the 2nd entry in the reading list to the archives and remove its downloaded content.

    1. list

    2. archive 2

    3. archives

ug archivex 1
Figure 17. Archiving the second entry
ug archivex 2
Figure 18. Entry is saved in the archives

6.4.11. Archiving all displayed entries: archiveall

If you want to archive many entries at the same time, you can make use of this command to move all the currently displayed entries to the archive, removing all entries' downloaded content at the same time. By using a find command first before executing archiveall, you can archive parts of your reading list by a search criteria.

Format: archiveall

  • Archives only entries that are currently displayed.

Examples:

  • Archive all entries in the reading list

    1. list

    2. archiveall

  • Archive all entries tagged “infoTheory” (you may refer to the figures below)

    1. list

    2. find t/infoTheory

    3. archiveall

    4. list

find archiveall
Figure 19. Filtering then archiving all infoTheory entries (steps 1-3)
find archiveall list
Figure 20. Reading list now no longer has any infoTheory entries (step 4)

6.4.12. Deleting an entry: delete

Deletes the specified entry from the reading list and removes its downloaded content.

Format: delete INDEX

  • Deletes the entry at the specified INDEX.

  • The index refers to the index number shown in the displayed entry list.

  • The index must be a positive integer 1, 2, 3, …​

Examples:

  • Delete the 2nd entry in the reading list.

    1. list

    2. delete 2

  • Delete the 1st entry in the results of the find command.

    1. find Trump

    2. delete 1

6.4.13. Deleting all displayed entries: deleteall

Deletes all currently displayed entries from the reading list, and removes the entries' downloaded content.

Format: deleteall

  • Deletes only the entries that are currently displayed

This operation is IRREVERSIBLE! Please take care not to accidentally delete entries you may wish to keep.

You may refer to the archiveall command for an example on how this command may be combined with other commands such as find to be more useful.

Examples:

  • Delete all entries in the reading list.

    1. list

    2. deleteall

  • Delete all entries whose titles contain “Trump”.

    1. list

    2. find ti/Trump

    3. deleteall

6.4.14. Clearing all entries : clear

Clears all saved entries from the manager.

Format: clear

6.5. Archives Context Commands

6.5.1. Finding entries by title: find

Finds entries whose fields contain any of the given keyphrases.
This command behaves the same as the Reading List context find command equivalent.

Format: find [a/SEARCH_PHRASE] [ti/TITLE_SEARCH_PHRASE] [d/DESCRIPTION_SEARCH_PHRASE] [l/LINK_SEARCH_PHRASE] [t/TAG_TO_SEARCH]…​

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

  • The search is case insensitive. e.g hans will match Hans

  • The search matches anywhere for title, description and link. e.g. ans B will match Hans Bo

  • The search matches exactly for tags. e.g. 'science' will match 'science', but not 'scienceandtech'

  • The search phrase with prefix a/ will try to match with every field in the entry according to the above rules.

    • i.e. find a/keyphrase is equivalent to find ti/keyphrase d/keyphrase l/keyphrase t/keyphrase

  • Entries matching at least one field will be returned (i.e. OR search).

    • e.g. find ti/aaa d/bbb l/ccc t/ddd will match an entry with title Aaawesome and an entry with description abbbA

Refer to Section 6.4.2, “Finding entries (by title, description, etc.): find” for examples!

6.5.2. Selecting an entry: select

Selects the entry identified by the index number used in the displayed entry list for reading.

Format: select INDEX

  • Selects the entry at the specified INDEX for reading.

  • The index refers to the index number shown in the displayed entry list.

  • The index must be a positive integer 1`, 2, 3, …​`

Examples:

Select the 2nd archived entry. . archives
. select 2

6.5.3. Unarchiving an entry: unarchive [since v1.3]

Moves the specified entry from the archives to the reading list.

Format: unarchive INDEX

  • Unarchives the entry at the specified INDEX.

  • The index refers to the index number shown in the displayed entry list.

  • The index must be a positive integer 1, 2, 3, …​

Examples:

  • Move the 2nd entry in the archives to the reading list and download its webpage content.

    1. archives

    2. unarchive 2

    3. list

6.5.4. Deleting an entry: delete

Deletes the specified entry from the archives.

Format: delete INDEX

  • Deletes the entry at the specified INDEX.

  • The index refers to the index number shown in the displayed entry list.

  • The index must be a positive integer 1, 2, 3, …​

Examples:

  • Delete the 2nd entry in the archives.

    1. archives

    2. delete 2

6.5.5. Deleting all displayed entries: deleteall

Deletes all currently displayed entries from the archives.

Format: deleteall

  • Deletes only the entries that are currently displayed

This operation is IRREVERSIBLE! Please take care not to accidentally delete entries you may wish to keep.

You may refer to the archiveall command for an example on how this command may be combined with other commands such as find to be more useful.

Examples:

  • Delete all entries in the reading list.

    1. list

    2. deleteall

  • Delete all entries whose titles contain “Trump”.

    1. list

    2. find ti/Trump

    3. deleteall

6.5.6. Clearing all entries : clear

Clears all archived entries from the manager.

Format: clear

6.6. Search Results Context Commands

6.6.1. Adding entries: addindex

Adds entries from results to the reading list. Content is automatically downloaded to disk.

Format: addindex INDEX

Format: addindex INDEX [ti/TITLE_OVERRIDE] [d/DESCRIPTION_OVERRIDE] [t/TAG]…​ [coming in v2.0]

Examples:

  • Add the 3rd entry

    1. addindex 3

  • Add the 1st entry with a description and tagged with “Business” [coming in v2.0]

    1. addindex 1 d/explains why UX is important t/Business

6.6.2. Adding all displayed entries: addall

Adds all currently displayed entries from results to the reading list. Content is automatically downloaded to disk.

Format: addall

  • Adds only the entries that are currently displayed

The application may be unresponsive for a short while when adding entries from a large search result.

You may refer to the archiveall command for an example on how this command may be combined with other commands such as find to be more useful.

Examples:

  • Add all entries that result from searching "Lambda Calculus" on bing.

    1. bing Lambda Calculus

    2. addall

  • Add all entries that result from searching "Lambda Calculus" on bing, but only those with a .org domain.

    1. bing Lambda Calculus

    2. find l/.org

    3. addall

6.6.3. Selecting an entry: select

Selects the entry identified by the index number used in the displayed entry list for viewing.

Format: select INDEX

  • Selects the entry and loads the content of the entry at the specified INDEX.

  • The index refers to the index number shown in the displayed entry list.

  • The index must be a positive integer 1`, 2, 3, …​`

Examples:

  • Selects the 2nd entry from the search results.

    1. select 2

6.6.4. Changing the view mode: view

Changes the view mode between the original browser or a more comfortable reading experience.

Format: view MODE(browser, reader) [s/STYLE(default, sepia, dark, black)]

Examples:

  • Switch to browser view mode.

    1. view browser

  • Switch to a clean and clutter-free reader view mode for a more comfortable reading experience.

    1. view reader

  • Switch to reader view mode with dark style colour scheme.

    1. view reader s/dark

6.7. Feeds Context Commands

To subscribe to a feed, please refer to .

6.7.1. Updating entries from feeds: refresh

Refreshes a feed.

Format: refresh INDEX

Format: refesh all [coming in v2.0]

Examples:

  • Update entries from all feeds. [coming in v2.0]

    1. refresh all

  • Update entries from the 2nd feed.

    1. refresh 2

The application may be unresponsive for a short while when adding entries from a large feed.

6.7.2. Updating entries from all currently displayed feeds: refreshall

Refreshes all currently displayed feeds.

Format: refreshall

  • Refreshes only the feeds that are currently displayed

The application may be unresponsive for a short while when adding entries from a large feed, or when refreshing many feeds.

You may refer to the archiveall command for an example on how this command may be combined with other commands such as find to be more useful.

Examples:

  • Refresh all subscribed feeds

    1. feeds

    2. refreshall

  • Refresh all news feeds

    1. feeds

    2. find ti/News

    3. refreshall

6.7.3. Selecting a feed: select

Selects the feed identified by the index number used in the displayed feed list and displays its entries.

Format: select INDEX

  • Selects the feed and displays its entries.

  • Equivalent to feed [URL_OF_INDEXED_FEED]

  • The index refers to the index number shown in the displayed feed list.

  • The index must be a positive integer 1`, 2, 3, …​`

Examples:

  • Select the 2nd feed in the manager and displays its entries.

    1. select 2

6.7.4. Editing a feed: edit [coming in v2.0]

Edits an existing feed in the manager.

Format: edit INDEX [u/URL] [n/NAME] [t/TAG]…​

  • Edits the feed at the specified INDEX. The index refers to the index number shown in the displayed feed list. The index must be a positive integer 1, 2, 3, …​

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

  • Existing values will be updated to the input values.

  • When editing tags, the existing tags of the feed will be removed i.e adding of tags is not cumulative.

  • You can remove all the feed’s tags by typing t/ without specifying any tags after it.

Examples:

  • Edit the name of the 1st feed.

    1. edit 1 n/HackerNews

  • Clear all existing tags from the 2nd feed.

    1. edit 2 t/

6.7.5. Unsubscribing from a feed: unsubscribe

Deletes the specified feeds from the manager and unsubscribes from them, but existing entries obtained from that feed will not be deleted.

Format: unsubscribe INDEX

  • Deletes the feeds at the specified indices.

  • The index refers to the index number shown in the displayed feed list.

  • The index must be a positive integer 1, 2, 3, …​

Examples:

  • Delete the 2nd shown feed.

    1. unsubscribe 2

6.7.6. Clearing all feeds : clear [coming in v2.0]

Clears all followed feeds from the manager.

Format: clear

6.8. Feeds Search Context Commands [coming in v2.0]

6.8.1. Subscribing to a feed: subscribe

Adds a feed from the search results to the manager and subscribes to updates.

Format: subscribe INDEX [n/NAME] [t/TAG]…​

Format: subscribe INDICES [t/TAG]…​

Format: subscribe all

A feed can have any number of tags (including 0)

Examples:

  • Add all shown feeds.

    1. subscribeall

  • Add a feed whose name is “Engadget” and whose entries will be tagged with Tech.

    1. subscribe 1 n/Engadget t/Tech

  • Add the 5th to 9th feeds whose entries will be tagged with Work.

    1. subscribe 5-9 t/Work

6.8.2. Selecting a feed: select

Selects the feed identified by the index number used in the displayed feed list.

Format: select INDEX

  • Selects the feed.

  • The index refers to the index number shown in the displayed feed list.

  • The index must be a positive integer 1`, 2, 3, …​`

Examples:

  • Selects the 2nd feed from the feeds list.

    1. select 2

7. FAQ

Q: Why is reader view not displaying any buttons or input fields?
A: Reader view only keeps text content and is not meant to used for web forms.

Q: Why is reader view not working?
A: We cannot guarantee Reader view works on every website.

8. Command Summary

8.1. Anywhere

Command Summary

add l/URL [ti/TITLE] [d/DESCRIPTION] [t/TAG]…​

Adds a single entry.

subscribe l/URL [ti/TITLE] [d/DESCRIPTION] [t/TAG]…​

Subscribes to a single feed.

history

Lists all commands entered previously in reverse order.

offline MODE(enable, disable)

Enables or disables internet connectivity.

help

Opens the User Guide in a new window.

exit

Exits the application.

8.2. Reading List Context

Command Summary

list

Switches to list context.

edit i/INDEX [ti/TITLE] [d/DESCRIPTION] [t/TAG]…​

Edits the entry specified by the index.

find [l/URL] [ti/TITLE] [d/DESCRIPTION] [t/TAG]…​

Finds entries matching the given arguments.

select INDEX

Selects the entry specified by the index for viewing.

refresh INDEX

Re-downloads the webpage content of the entry specified by the index.

refreshall

Re-downloads the webpage content of the entry specified by the index.

archive INDEX

Archives the entry specified by the index.

archiveall

Archives all displayed entries.

delete INDEX

Deletes the entry specified by the index.

deleteall

Deletes all displayed entries.

clear

Deletes all entries.

view MODE(browser, reader) [s/STYLE(default, sepia, dark, black)]

Changes the view mode of the browser panel.

8.3. Archives Context

Command Summary

archives

Switches to archives context.

find [l/URL] [ti/TITLE] [d/DESCRIPTION] [t/TAG]…​

Finds entries matching the given arguments.

select INDEX

Selects the entry specified by the index for viewing.

unarchive INDEX

Unarchives the entry specified by the index, adding it back to the reading list.

unarchiveall

Unarchives all displayed entries, adding them back to the reading list.

delete INDEX

Deletes the entry specified by the index.

deleteall

Deletes all displayed entries.

clear

Deletes all entries.

8.4. Search Result Context

Command Summary

bing [KEYWORD]

Searches Bing for entries that you can subsequently add.

googlenews [KEYWORD]

Searches Google News for entries that you can subsequently add.

feed [FEED URL]

Opens a web feed at the URL for previewing.

addindex INDEX

Adds the entry specified by the index to the reading list.

addall

Adds all displayed entries to the reading list.

select INDEX

Selects the entry specified by the index for viewing.

view MODE(browser, reader) [s/STYLE(default, sepia, dark, black)]

Changes the view mode of the browser panel.

8.5. Feeds Context

Command Summary

feeds

Switches to feeds context.

refresh INDEX

Refreshes the feed specified by the index.

refreshall

Refreshes all feeds.

select INDEX

Selects the entry specified by the index for viewing.

unsubscribe INDEX

Unsubscribes and deletes the feed specified by the index.