Manual



Introduction

This website has been set up in the hopes that users of BookShare.Org can provide more ways of organizing the rapidly growing collection of digital books. The site has areas to create additional categories where titles can be catalogued as well as a series section. I hope to continually make improvements to the site based on user feedback and to add new features as they are thought of/suggested.


Categories

Browse by Category

This page provides a list of all category groups and the categories that they contain. Category groups are level two headings and categories are in bulleted lists under each. By selecting a category you are presented with a list of the titles in that category. Each title is a link to a live BookShare.Org title. By selecting a title you are taken to the download page on BookShare.Org.

Add Title to Category

This is a users only area where users can submit titles to be added to existing categories.

To add a title:

  1. Search the BookShare.Org website for the title you want to add. When on the BookShare.Org download page for a book, copy the number at the end of the address.
    For example, if you had this address:
    http://www.bookshare.org/web/SingleTitle.html?submittitleid=29527
    You would copy 29527.
    This number goes in the BookShare ID field.
  2. Select a category to put the title in. This is a combo/drop down box. In it are all categories grouped by their category group. For example you might see
    Animals > Dogs Fiction
    Animals > Dogs Non Fiction
    Animals > Horses Fiction
    In this example Animals is the category group and Dogs Fiction, Dogs Non Fiction and Horses Fiction are the categories.
  3. Enter the title of the book. This should be the same one that appears on BookShare.Org
  4. Enter the author of the book. This should be the same one that appears on BookShare.Org
  5. Select the Add Title button!

When a book is submitted, the system makes sure that:

  • The BookShare field has a number greater than 0
  • The Title field is not left blank
  • The Author field is not left blank

Add Category

This is a users only area where users can add categories.

To add a category:

  1. Select a category group to add the category to. For instance, if your category is Horses, you probably want to put it under the Animals group.
  2. Enter the name of the category
  3. Select the Add Category button!

When a category is submitted the system makes sure that:

  • The category field is not left blank.
  • The category does not already exist.

Add Category Group

This is a users only area where users can add category groups.

To add a category group:

  1. Enter the name of the Category Group.
  2. Select the Add Category Group button!

When a category group is submitted the system makes sure that:

  • The category group field is not left blank.
  • The category group does not already exist.

Edit Title in Category

This is a users only area where users can update book information in a category.

To update a title:

  1. Step 1: Select Category
    1. Select the Category you wish to edit from the combo/drop down box.
    2. Select the Get Category button!
  2. Step 2: Choose entry to Edit
    1. Select the title you want to edit from the combo/drop down box.
    2. Select the Get Title button!
  3. step 3: Edit
    Here you are presented with the current information in the database.
    1. Change the BookShare ID, Title and Author as needed.
    2. Select the Update Title button.

Note that this update will not immediately take effect on the site. A moderator or administrator must approve the request.

When a submission is made the system makes sure that:

  • The BookShare ID field is a number greater than or equal to 0.
  • The Title field is not left blank.
  • The Author field is not left blank.

Edit Name of Category

This is a users only area where users can request changes to the names of categories.

To request a change:

  1. Select the category you want to change from the combo/drop down list.
  2. Enter the new title you wish to request.
    NOTE: You should not include the category group name in the new name. Doing so will NOT move a category, to do that see Move Category.
    For example:
    If you want to rename the category:
    Animals > Kids Dog Stories
    To
    Animals > Children's Dog Fiction
    Then you should put the following in the box:
    Children's Dog Fiction
  3. Select the Update Category button!

Note that this update will not immediately take effect on the site. A moderator or administrator must approve the request.

When a request is submitted the system makes sure that:

  • The new category field is not left blank

Edit Name of Category Group

This is a users only area where users can request changes to the names of category groups.

To request a change:

  1. Select the category group you want to change from the combo/drop down box.
  2. Enter the new category group name.
  3. Select the Update Category Group button!

Note that this update will not immediately take effect on the site. A moderator or administrator must approve the request.

When a request is submitted the system makes sure that:

  • The new category field is not left blank

Move Category

This is a users only area where users can request a category be moved to another category group.

To request a category move:

  1. Select a category from the combo/drop down box.
  2. Select the destination category group from the combo/drop down box.
  3. Select the Move Category button!

Note that this update will not immediately take effect on the site. A moderator or administrator must approve the request.


Series

Browse by Series

This page provides a list of all series. By selecting a series a list of the titles in that series appears. In the series section, there is a filter at the top of the list. Selecting Show All will show all records in the database for a series. Filtering by Available Titles shows only those titles the database knows are on BookShare.Org. Filtering by Missing Titles gives a list of the records in the database that it does not know are on BookShare.Org.

Note that a title listed under Missing can in fact be on BookShare.Org. If you know of such a title you should go to the Edit Title in Series section to update the database.

Add Title to Series

This is a users only area where users can add books to a series.

To add a book:

  1. The BookShare ID:
    1. If the book is on BookShare.Org:
      Search the BookShare.Org website for the title you want to add. When on the BookShare.Org download page for a book, copy the number at the end of the address.
      For example, if you had this address:
      http://www.bookshare.org/web/SingleTitle.html?submittitleid=29527
      You would copy 29527.
      This number goes in the BookShare ID field.
    2. If the book is not on BookShare.Org:
      Enter 0 into the BookShare ID field.
  2. Select the series the book is a part of.
  3. Enter the position of the book in the series. If the book is a prequel or special, you can enter 0.
  4. Enter the title of the book, this should not include the series name.
  5. Enter the authors name
  6. Select the Keep Author checkbox if you are going to enter another book by that same author
  7. Select the Add Title button!

When a book is submitted the system makes sure that:

  • The BookShare ID field is greater than or equal to 0.
  • The position field is greater than or equal to zero.
  • The title field is not left blank
  • The author field is not left blank

Add Series

This is a users only section where users can create new series.

To add a series:

  1. Enter the series name
  2. Select the Add Series button!

When a series is submitted the system makes sure that:

  • The name field is not left blank.
  • The series does not already exist.

Edit Title in Series

This is a users only area where users can update book information in a series.

To update a title:

  1. Step 1: Select Series
    1. Select the series you wish to edit from the combo/drop down box.
    2. Select the Get Series button!
  2. Step 2: Choose entry to Edit
    1. Select the title you want to edit from the combo/drop down box.
    2. Select the Get Title button!
  3. step 3: Edit
    Here you are presented with the current information in the database.
    1. Change the BookShare ID, Position, Title and Author as needed.
    2. Select the Update Title button.

Upon successful submission one of the following will happen:

  • If the only change you make is in the BookShare ID field, the original ID was 0 and the new ID is not 0, the change is automatically applied to the website.
  • If you change Position, Title, Author, or BookShare ID from some number other than 0, the change must be approved by a moderator or an administrator before it will take effect.

When a submission is made the system makes sure that:

  • The BookShare ID field is a number greater than or equal to 0.
  • The Position field is a number greater than or equal to 0.
  • The Title field is not left blank.
  • The Author field is not left blank.

Edit Series Name

This is a users only area where users can request a change in name for a series.

To request a series name change:

  1. Select the series you want to edit from the combo/drop down box.
  2. Enter the new name you want to request in the text box.
  3. Select the Update Series button!

Note that this update will not immediately take effect on the site. A moderator or administrator must approve the request.

When a request is submitted the system makes sure that:

  • The new series name field is not left blank

Account

Registration

This is the section of the website where you can sign up as a user. All that is required is an E-mail address and password.

Note that passwords may not be longer than 12 characters and are CaSe SeNsAtIvE. Also, the site will not allow registration if a user is already logged in.

When registering the system makes sure that:

  • The E-mail address contains an at (@) symbol.
  • The E-mail address contains a period (.).
  • The E-mail address is not already registered.
  • The password field and confirm password fields match.

Login

To login to the site:

  1. Enter your E-mail address.
  2. Enter your Password.
  3. Select the Login button!

If successful you are presented with a success message and a proceed link. If your E-mail address was not found you are given an error to that effect and asked to try again. If your password is incorrect, you are returned automaticaly to the login screen without an error. You should remember that passwords are CaSe SeNsAtIvE.

Note that the system checks to see if a user is previously logged in before displaying the login screen. If a user is logged in you are given the option of continuing or logging out.

Logout

Users are logged out when they exit their browser; however, you can manually log yourself out by using this option. You are presented with a logout success message and link to the home page when the process is completed.


Administration

Pending

This is a moderator/administrators only area of the website where requests can be approved/rejected.

This page displays current information about an item that a user has made a request for along with the request itself. Consider the following senario:

The title of John Grisham's The Broker is mispelled as The Brocker.
User A: Submits a request for the title to be changed from The Brocker to The Broker.
User B: Submits the same request as user A.
If the request by user A is approved, then it will appear as though user B is requesting no change, because the current title of the book will be displayed as The Broker, not The Brocker which was the case when user B made the request.

Series Name Change Requests

This section contains a table with the following headings and values:

Heading Value
ID The identification number of the request.
Current Name The name of the series that is currently in the database. This is not necessarily the name when the request was made.
Requested Name The name that the user requests become the new name.
Requested by Lists the user's E-mail address who has made the request.
Action Contains a combo/drop down box with options to Approve or Reject a requested change and an Update button to process the decision.

Series Titles Change Requests

This section contains a table with the following headings and values:

Heading Values
ID The identification number of the request.
Current Contains the subheadings BKSID, Position, Title and Author. BKSID is the BookShare ID of the book. These values are the ones currently in the database, not necessarily the ones when the user made the request.
Request Contains the subheadings BKSID, Position, Title and Author. BKSID is the BookShare ID of the book. These are the new, requested changes.
Requested by Lists the user's E-mail address who has made the request.
Action Contains a combo/drop down box with options to Approve or Reject a requested change and an Update button to process the decision.

Category Name Change Requests

This section contains a table with the following headings and values:

Heading Value
ID The identification number of the request.
Current Name The namle of the category that is currently in the database. This is not necessarily the name when the request was made.
Requested Name The name that the user requests become the new name.
Requested by Lists the user's E-mail address who has made the request.
Action Contains a combo/drop down box with options to Approve or Reject a requested change and an Update button to process the decision.

Category Group Name Change Requests

This section contains a table with the following headings and values:

Heading Value
ID The identification number of the request.
Current Name The name of the category group that is currently in the database. This is not necessarily the name when the request was made.
Requested Name The name that the user requests become the new name.
Requested by Lists the user's E-mail address who has made the request.
Action Contains a combo/drop down box with options to Approve or Reject a requested change and an Update button to process the decision.

Category Titles Change Requests

This section contains a table with the following headings and values:

Heading Values
ID The identification number of the request.
Current Contains the subheadings BKSID, Title and Author. BKSID is the BookShare ID of the book. These values are the ones currently in the database, not necessarily the ones when the user made the request.
Request Contains the subheadings BKSID, Title and Author. BKSID is the BookShare ID of the book. These are the new, requested changes.
Requested by Lists the user's E-mail address who has made the request.
Action Contains a combo/drop down box with options to Approve or Reject a requested change and an Update button to process the decision.

Move Category Requests

This section contains a table with the following headings and values:

Heading Value
ID The identification number of the request.
Current Lists the current category group and category. These are not necessarily the same as when the request was made.
Requested Lists the requested new category group and category.
Requested by Lists the user's E-mail address who has made the request.
Action Contains a combo/drop down box with options to Approve or Reject a requested change and an Update button to process the decision.

Users

This is an administrators only section of the website.

A table with the following headings and values is displayed:

Heading Value
E-mail Displays user E-mail addresses
Password Displays user passwords.
Type Displays user account types: user, moderator or administrator

By selecting an E-mail address, administrators fcan edit E-mail, Password and Account Type.


Miscellaneous

Feedback Messages

ERROR
is always displayed in RED
Success
is always displayed in GREEN

Account Types

The following table shows the different types of accounts and what they are used for:

Account Type Description
User When a person registers, their account is automatically made a user. Users can add information to the database, can edit information under certain circumstances and can request changes to the website.
Moderator A user is elivated to moderator status by an administrator to help maintain the website. In addition to user rights, moderators can approve or reject requested changes to the website.
Administrator Is currently the site developer. In addition to moderator and user rights, administrators can make changes to accounts.

Known Bugs

06/07/2005: No known bugs at this time.

What runs the Site

When I first started writing this, I had some basic knowledge of HTML, CSS, Microsoft Access, Visual Basic and some other stuff that's not crept in yet. Since then I have gained knowledge of Visual Basic Script, SQL (sequel), ASP, ADO and more HTML.

The site is comprised mainly of ASP (Active Server Pages). Behind the scenes is an Access database. Inside the ASP pages there is a combination of Visual Basic Script (very similar to Visual Basic), HTML, CSS, ADO and SQL. The HTML handles displaying the actual text and controls page formatting. The CSS (Cascading Style Sheet) controls most aspects of how HTML elements display. The ADO objects make it possible to connect to and utilize the Access database. Finally, the SQL language allows for querying of the database. Yeesh! What else am I going to learn next?

By the way, you can find information on all these topics at www.w3schools.com. This isn't the only resource I used when researching to make the site, but it's usually the first I use as a reference.