Table of Contents
1 Preface- 1.1 About the Documentation
- 1.2 Terminology
- 1.3 Limitations
2 Search- 2.1 Adding a Book to the Library
- 2.2 Searching Through the Library or a Booklist
3 Booklists- 3.1 Adding a New Booklist
- 3.2 Renaming a Booklist
- 3.3 Removing a Booklist
- 3.4 Adding Books to a Booklist
- 3.5 Removing a Book from a Booklist
- 3.6 The Favorites List
4 Personal Book Information(PBI)- 4.1 Reading Status
- 4.1.1 Marking a Book as Read
- 4.1.2 Marking the Current Page
- 4.1.3 Setting the Date Started
- 4.1.4 Clearing the Date Started
- 4.1.5 Setting the Date Started
- 4.1.6 Clearing the Date Started
4.2 Possession Status- 4.2.1 Marking a Book as Owned
- 4.2.2 Setting the Number of Copies Owned
- 4.2.3 Marking a Book as Signed (Author Signature)
- 4.2.4 Setting the Physical Condition of a Book
- 4.2.5 Setting the Physical Location of a Book
4.3 Borrowed/Loaned Status- 4.3.1 Marking a Book as Borrowed
- 4.3.2 Setting the Current Lender of a Book
- 4.3.3 Marking a Book as Loaned
- 4.3.4 Setting the Current Borrower of a Book
4.4 Rating Status and Notes- 4.4.1 Marking a Book as a Favorite
- 4.4.2 Giving a Book a Rating
- 4.4.3 Removing a Book Rating
- 4.4.4 Writing Notes
5 General Usage- 5.1 Viewing Basic Book Information
- 5.2 View Reviews for a Selected Book
5.3 Price Check- 5.3.1 Performing a Price Check
- 5.3.2 Purchasing Books Through a Price Check
5.4 Bibliographies- 5.5 Finding Similar Books
- 5.6 Finding Author Quotations
- 5.7 Exporting Booklists
- 5.8 Viewing Book in Cover Mode
- 5.9 Signing Out of BookBump
6 Version History
1. Preface
1.1 About the Documentation
The intended purpose of the documentation is to explain the main features of BookBump and to highlights features that may not be visible to first-time users.
1.2 Terminology
Throughout this documentation there may contain some definitions specific to BookBump. This section will attempt to define these sections as clearly as possible.
Library: a collection consisting of every book in a user's library
Booklist: a 'playlist' of books. These collections can be used for a wide variety of purposes, such as creating a wish list, organizing school books, represent physical bookshelves, etc.
Book Search: The bottom-left area of the screen (see picture below). Use this location to either directly add a book through the ISBN or search for a book by its Title, Author, or Keyword.
ISBN: a unique ten or thirteen digit number assigned to almost every printed book.
Personal Book Information (PBI): A section within the 'tools' pane for managing various personal aspects of the book catalog such as 'Date Started', 'Rating', and 'Borrower'
1.3 Limitations:
BookBump is a work in progress. Currently planned features include social networking, eBook integration, and online storefront (Half.com, AStore, etc.) management.
Publisher locations within the bibliography may also show the incorrect location but this issue will be improved upon as the database is updated with the pertinent information.
2. Search
2.1 Adding a Book to the Library
There are two ways to add a book to the Library:
1. Directly though and ISBN
2. Entering search terms (Title, Author, Keyword)
1. To add a book with the ISBN, click on 'ISBN' in the Book Search area and enter in an ISBN. The ISBN can be found on the back of most books near the barcode. It should either be ten or thirteen numbers long. BookBump recognizes inputs of nine, ten, twelve, or thirteen characters. After entering the ISBN, click the button that says 'Add to Library' or press enter. A book should be added to the library, or if the book is already in the library, it should become selected.
2. To add a book through the search, click on any search item ('Title, 'Author', 'Keyword') and enter in search criteria. Any combination of the three can be used (i.e. Title="Harry Potter", Author="J.K Rowling", Keyword="Goblets"; or Author="Kant", Keyword="Metaphysics"). Click the button that says 'Search For Book' or press enter. On the right side of the screen, the search panel should open showing ten books. To add one of these books, click the title or book cover. To see the next ten results, click the arrow pointing right, and to see the previous ten books hit the arrow pointing left.
2.2 Searching Through the Library or a Booklist
Select the Library or the intended booklist in which to search through. Select the field at the top of BookBump with the label 'Search Library' and enter in the search terms. The list should dynamically (after each keystroke) filter the books, leaving only ones that fulfill the search request.
If you wish to only retrieve results from a certain field simply type the field name (i.e 'Publisher:Scholastic') to retrieve results only from that field
Similarly, if you wish to retrieve results from the PBI, such as Read, Owned, etc; use the name of the specific field and the conditional(true or false), i.e 'Read: True', 'Lender: Guy Demeter'
3. Booklists
3.1 Adding a New Booklist
Click the button on the lower-left depicting a paper and a plus sign. This should create a booklist with the title 'Untitled Booklist-#'.
3.2 Renaming a Booklist
Double-click on the Booklist intended for change and type the desired name. Then click outside the Booklist to confirm the change. If the new name is already used, the chosen Booklist's name will revert back to its former title.
3.3 Removing a Booklist
Select the Booklist intended for deletion and press the button on the bottom-left depicting a '-' sign. Once a Booklist is deleted it will not be recoverable. The 'Favorites' list and 'Library' list cannot be deleted.
3.4 Adding Books to a Booklist
Select the intended books and drag them onto the target Booklist to add them. Duplicates entries will not register and will display only once.
3.5 Removing a Book from a Booklist
Select the Booklist you intend to remove a book from and select the targeted book. Press delete or the button on the bottom-left depicting a '-' sign. If a book is removed from the 'Library' list, it will be removed from all Booklists.
3.6 The Favorites List
The 'Favorites' list is intended to help signify which books are considered favorites. If a book is selected as a favorite in the 'Personal Book Information', for example, it will show up in this list. Also, if books are dragged into the Booklist, they will automatically be marked as favorites.
4. Personal Book Information (PBI)
4.1 Reading Status
4.1.1 Marking a Book as Read
To mark a book as being read, simply click the checkbox to indicate that the book has been read. Also, the 'Read' checkbox will automatically become selected when the 'Date Finished' field has been utilized.
4.1.2 Marking the Current Page
To mark the current page reached in a book, set the 'Current Page' field to that marker. To increase/decrease the page number by one, press the up/down arrow. If the number input is greater than the pages in the book, the current page will go to the last page in that selected book.
4.1.3 Setting the Date Started
To indicate the first day of a book's reading, click the 'Date Started' field and a calendar should pop up. Select the date that reading commenced.
4.1.4 Clearing the Date Started
To remove any indication of a book's first day of reading, click the 'Date Started' field and in the calendar, reselect the date that is currently selected. This action should clear the field.
4.1.5 Setting the Date Finished
To indicate the last day of a book's reading, click the 'Date Finished' field and a calendar should pop up. Select the date that reading finished. This will check the 'Read' field.
4.1.6 Clearing the Date Finished
To remove any indication of a book's final day of reading, click the 'Date Finished' field and in the calendar, reselect the date that is currently selected. This action should clear the field but it will not deselect the 'Read' field.
4.2 Possession Status
4.2.1 Marking a Book as Owned
To mark a book as being owned, simply click the 'Owned' checkbox to indicate that the book is owned. This will also set the number of 'Copies Owned' to one. In addition, the 'Owned' checkbox will automatically become selected when the 'Copies Owned' value is greater than one. Also, if the 'Copies Owned' value becomes zero, the 'Owned' checkbox will deselect. A second way to mark a book as owned is using the toggled button in the 'General' pane, simply clicking the icon of a Bookshelf will mark a book as owned.
4.2.2 Setting the Number of Copies Owned
To set the number of the selected books owned, simply set the 'Copies Owned' field to the specified number. If this number is equal to or greater than one, the 'Owned' field will become selected, and if the number of 'Copies Owned' is set to zero, the 'Owned' checkbox will become deselected.
4.2.3 Marking a Book as Signed (Author Signature)
To mark a book as being signed, simply click the 'Signed' checkbox to indicate that the book is signed.
4.2.4 Setting the Physical Condition of a Book
To set the physical condition of a book, select the 'Condition' field and either manually type the condition or select the arrow to bring down a list of conditions (New, Acceptable, etc.)
4.2.5 Setting the Physical Location of a Book
To set the physical location of a book, select the 'Location' field and either manually type the location or select the arrow to bring down a list of previously entered locations. When a unique location is entered, it is then added to the drop down list for future use.
4.3 Borrowed/Loaned Status
4.3.1 Marking a Book as Borrowed
To mark a book as being borrowed, simply click the 'Borrowed' checkbox to indicate that you are currently borrowing that book. If the 'Lender' field is filled then the 'Borrowed' checkbox will automatically become selected. Conversely, if the 'Borrowed' checkbox is deselected, the 'Lender' field will become empty.
4.3.2 Setting the Current Lender of a Book
To set the lender of a book, select the 'Lender' field and type the name of the current lender or select the arrow to bring down a list of lenders associated with other books. Adding to this field will mark a book as being borrowed.
4.3.3 Marking a Book as Loaned
To mark a book as being loaned, simply click the 'Loaned' checkbox to indicate that you are currently borrowing that book. If the 'Borrower' field is filled then the 'Loaned' checkbox will automatically become selected. Conversely, if the 'Loaned' checkbox is deselected, the 'Borrower' field will become empty.
4.3.4 Setting the Current Borrower of a Book
To set the borrower of a book, select the 'Borrower' field and type the name of the current borrower or select the arrow to bring down a list of borrowers associated with other books. Adding to this field will mark a book as being loaned.
4.4 Rating Status and Notes
4.4.1 Marking a Book as a Favorite
To mark a book as being a favorite, simply click the 'Favorite' checkbox. When the 'Favorite' list is selected, only the favorite books will show.
4.4.2 Giving a Book a Rating
To give a Book a star rating, simply click on the associated star.
4.4.3 Removing a Book Rating
To set the rating for a book back to nothing, simply press ‘Rating:’. These ratings will eventually be used to provide an average score throughout the BookBump network.
4.4.4 Writing Notes
To write notes pertaining to a book, simply type in the 'Notes' field.
5. General Usage
5.1 Viewing Basic Book Information
To view general book information, select one from the main list, and select 'General' from the top tab on the right side. If multiple books are selected, the information should pertain to the most recently selected book.
5.2 View Reviews for a Selected Book
To view reviews for a book, select one from the main list, and select 'Reviews' from the top tab on the right side. If multiple books are selected, the reviews should pertain to the most recently selected book. If no reviews can be found, BookBump will provide a notification and go to general book information.
5.3 Price Check
5.3.1 Performing a Price Check
To perform a price check for a book, select one from the main list and select 'Price Check' from the top tab on the right side. BookBump will then dynamically perform price checks at multiple online bookstores, ordering the stores by price. Bookstores will only appear if BookBump can confirm the price. If multiple books are selected, the prices found should pertain to the most recently selected book.
5.3.2 Purchasing Books Through a Price Check
After performing a price check, select the button with the shopping cart image to go directly to the selected bookstores webpage. The book can then be manually added to that stores online shopping cart.
5.4 Bibliographies
To create bibliographies for a book/books, simply select the desired books and click the 'Bibliography' tab in the 'Tools' section. The bibliographies will automatically be created for all selected books in the MLA, APA, Chicago, CSE, and Harvard formats.
5.5 Finding Similar Books
To find books related to a certain book, select the desired book and click 'Similar Books' in the 'Tools' section. To add a book from 'Similar Books' into the Library, click the book cover.
5.6 Finding Author Quotations
To find notable quotations from a certain author or from the author of a book, select the book and click 'Author Quotations' in the 'Tools' section. If quotations cannot be found then BookBump will show a notification and ill go to the 'Personal Book Information' section for the selected book.
5.7 Exporting Booklists
To export a book collection, click on the button in the lower-left depicting a list with an arrow. When the window comes up, first select the list to be exported. Then select the terms to be exported. Next choose a format to export (CSV,TSV, Text, or HTML are currently supported) and finally hit the button that says 'Export'
5.8 Viewing Book in Cover Mode
To change the program to "Cover Mode" simply click the center button on the divided button on the top
5.9 Signing Out of BookBump
To sign out of BookBump from within the program, click the upper-right corner of the screen where it says 'Sign Out:' and the user email.
Closing the window will not log the user out of BookBump. In this case, go to the BookBump website and click 'Sign Out' below where the sign in button should be.
6. Version History
[Rem]= Removed Feature
[Fix]= Bug Fix
[Opt]= Optimization
[New]= New Feature
[New] New graph categories for Date Started and Finished reading
[Fix] Fixed an error that would freeze application if ' or " were used in search terms
[Fix] Improved system security when adding a new book. [Fix] Graph labels moved to the right side
[Fix] Recommendation Button is now next to the flagged button
[Opt] Slight Optimization on initial data load (roughly 10% faster)
[Opt] Reskined Application
[Opt] Slightly smaller text size
[Opt] Slightly faster graph generation
[Opt] Adding a new book should sometimes be significantly faster.
[Rem] Removed Cover View for now because of performance issues
[Rem] Removed Link to Manual
[Fix] Can now remove items from booklist (previously called a nonfunctional script)
[Opt] Greatly reduced application size and faster load times by implementing RSL instead of loading entire framework each time
[Opt] Dead variable cleanup related to selected books
[Opt] Slightly faster book sorting (more noticeable with larger book sets)
[Opt] Slight optimization to bibliography code/ cover view/ and book/page counting.
[Opt] Optimized Chart Generation
[Fix] Placement issue for insufficient graph data notification
[Fix] Slight shift of Bibliographies to the right
[Fix] Corrupted data would appear if adding a book with an ISBN ending in X
[Fix] Alignment of items in export window
[Fix] Smaller minimum size allowed for the application to work better with lower resolutions
[Rem] Removed Textbooks.com from the price check
[Fix] Chart issue where a selected item grouping would not appear if just one item's information was not present
[Fix] 'Borrower box' in PBI is the correct length
[New] Added Graph View
[New] When a book search bar is selected(Title/Author/Keyword), the selection will be highlighted to allow faster searching
[Fix] When an item is selected while the search window is open, that item's information will display
[Fix] Price Check Bug caused by eCampus.com's Cross-Domain removal
[Fix] Minor alignment adjustments in the PBI
[Fix] Restored Used Book checking for ValoreBooks.com
[Fix] 'N/A' issues in the Price Check
[Rem] Removed searching for international books
[Fix] Bug that would prevent future searches if the ISBN is the wrong length
[Fix] The price check, so it now searches again from Barnes&Noble, BookByte, and ValoreBooks
[Fix] Start and Finished Dated
[New] Show/Hide Book Information
[New] Enhanced text based searching
[Fix] Searching through Favorites now works
[Fix] If Favorites is open and a book is removed that the list through the PBI it will remove itself automatically from the list
[Fix] The first booklist can now be renamed again
[Fix] Silver bar on top would appear
[Opt] Significantly improved loading times
[New] Easy Recommendations
[New] Flag Books for corrections
[New/Fix] BookBump will now sort Author/Date of Publication/ and Page Length correctly
[Fix] Enhanced User Interface(Corrected Minor Alignments, Icons, Object Repositioning, Brighter Coloring)
[Fix] Searching now gets more accurate information with defined ISBNs
[Fix] Multiple instances of Alibris would show up in the Price Check
[Fix] Synopsis would turn into a List if list items were contained in the previously loaded synopsis
[Fix] Location in Bibliography would not show up in some cases
[Fix] In Personal Book Information, a horizontal bar will now not show up if the vertical bar is present
[Opt] Slightly Faster and More Accurately Generated Bibliographies
[New] Enhanced Library Searched
[New] Various Tooltips
[Fix] Various Bugs dealing with Collection Sorting
[Fix] Bug When Clicking Out to Amazon Sites and ISBN Ended in 'X'
[New] Amazon Price Checks now work with German Books
[Fix] Numerous Graphical Bugs
[Opt] Replaced Popup Error Messages
[New] Search Displays Binding Format
[Fix] Recipient Information Now Saves
[New] Added FAQ button