SCDB - Simple Comics Database - Starting and Using

Basic Program Construction
All files used by SCDB are contained in the scdb directory. There are three types of files. *.xul are the static XUL files that provide the GUI. *.js files are contain the Javascript that do all the dynamic actions required (filling forms, etc). *.txt are text files containing the information needed to build lists within forms.

Starting

For Firefox 3.x Users
Since SCDB is written in XUL, it requires XULRunner to work. Firefox 3.0 and later contain a built-in XULRunner package that allows you to run XUL-based applications without downloading the seperate XULRunner package.

You start SCDB much like you would your browser, except you add -app switch to the command line. Using the -app switch assumes permission is granted to run SCDB scripts and runs it as a standalone application without the normal browser controls (back button, location bar, etc).

To start SCDB you would execute this command on the command line (or use as the target in a desktop shortcut of some sort):
     firefox -app <path to install dir>/application.ini

So if I installed SCDB in /opt/scdb I would start it like this:
     firefox -app /opt/scdb/application.ini


For Users of Firefox 1.x/2.x and Seamonkey
Unlike Firefox 3.x, older versions of Firefox and all Seamonkey versions do not have the built-in XULRunner package. You will need to install the seperate package to run SCDB. XULRunner is available as source at on the Mozilla Developer Center site. However, all distros should have pre-built packages in their repositories.

Once XULRunner is installed, you can run SCDB by doing the following from the command line:

  1. Change to the directory where SCDB is installed (default is /opt/scdb).
  2. Enter xulrunner application.ini and press Enter


First Use

Upon starting SCDB for the first time, you will be presented with the main window. If you installed SCDB via installation script, you should not need to set any of the preferences. However, if you managed to install SCDB manually, these preferences will need to be set before you can use it.

Setting Configuration Preferences
To access the Configuration form in Preferences, click on Other --> Prefs --> Configuration.

In the Preferences form, you will see four fields:

NOTE: Failing to set the above parameters correctly can cause SCDB to not work properly.

Once this information has been updated, click on Save. This will save the data in a configuration file called .scdb.config in your home directory.

Once saved, you will be returned to the main listing screen. Click on one of the publishers buttons to reload the preferences. SCDB is now ready for use.


Adding to the Inventory

There are two ways to add to the inventory: one entry at a time or a series of sequential entries (for example, Atari Force issues 1 through 10).

Adding a Single Entry

There are two ways to add a single entry to the inventory: using the Add toolbar menu option or using the Add Next popup menu option in the listing.

Using Add Single
This function adds a single issue to the inventory using the menu on the toolbar. This allows for complete data entry using the Data Entry Form.

  1. Click on the Add button and select Single from the menu. This will open the data form.
  2. Fill out the form. Hover over each field to see notes on what can/should be entered.
  3. Click on the Save button to save the data into the data file. A message will appear telling you that the entry has been saved. You will be returned to the main listing screen.
  4. Repeat as needed for each single entry you want to enter.
NOTE: If an entry already exists in the inventory that matches the new one, a message will appear stating so. You will be given the option of adding the entry as a second copy or not adding it at all.

Using Add Next
This function adds the next single issue in a series based on what is selected from the inventory listing. This function is located in the popup menu when you right-click on an entry in the list. It allows for quick data entry by copying the Publisher, Title, Series, Issue and Type data from the selected entry then incrementing the issue number by one.

  1. In the inventory list, find the entry for the issue that you want to add the next issue for and right-click on it. This will bring up the popup menu.
  2. Select "Add Next" from the popup menu. A dialog will appear showing what info the new entry will have. If you want to add any notes, enter them in the Notes field.
  3. Click on the OK button to save the data into the data file. A message will appear telling you that the entry has been saved. You will be returned to the main listing screen.
  4. Repeat as needed for each next issue entry you want to enter.


Adding Sequential Entries

  1. Click on the Add button and select Multiple from the menu. This will open the data form.
  2. Foll out the form. Hover over each field to see notes on what can/should be entered.
  3. Click on the Save button to save the data into the data file. A message will appear telling you that the entry has been saved. You will be returned to the main listing screen.


Editing an Inventory Entry

  1. Right-click on the entry in the main listing that you want to edit. The context menu will appear.
  2. Click on the Edit button. This will open the data form.
  3. Change the data for the entry as needed.
  4. Click on the Save button to save the data into the data file. A message will appear telling you that the entry has been updated. You will be returned to the main listing screen.
  5. Repeat as needed for each entry you want to update.

Note: You can also double-click on the entry in the inventory to open it in the data form.



Deleting an Inventory Entry

Deleting a Single Entry
  1. Click on the entry in the main listing that you want to delete
  2. Click on the Delete button. A message will ask you to confirm your decision.
  3. Click on OK to delete the entry. A message will appear telling you that the entry has been deleted. You will be returned to the main listing screen.
  4. Repeat as needed for each entry you want to delete.

Deleting Multiple Entries

  1. Highlight the entries in the list that you want to delete. To do this, you can:
    • Click on first entry you want to delete, press and hold the Shift key and click on last entry you want to delete. This will highlight all entries between the first and last, selecting them all for deletion.
    • Press and hold the CTRL key then click on each entry in the list you want to delete. This will select multiple entries non-sequentially.
  2. Right-click on one of the highlighted entries. This will open the popup context menu.
  3. Select Delete Multiple from the menu. You will be prompted for whether or not you really want to delete the selected entries.
  4. Choose your answer accordingly. The entries will then be deleted.


Printing the Inventory or an Inventory Entry

Printing a Single Entry
  1. Click on the entry in the inventory that you want to print.
  2. Click on the Print button. A new window will open and display the entry as it will be printed.
  3. Click on the Print button at the bottom of the window. A print dialog box will also appear allowing you to print the entry.
  4. Select your printer and click on Print. The entry will be printed.
  5. Once you are done printing, exit the window.

Printing the Inventory

  1. Click on the All button or one of the publisher buttons to select the listing you want to print.
  2. Click on the Print button. A new window will open and display the inventory as it will be printed.
  3. Click on the Print button at the bottom of the window. A print dialog box will also appear allowing you to print the inventory. See the image at right for an example of the formatting of the printed inventory.
  4. Select your printer and click on Print. The listing will be printed.
  5. Once you are done printing, exit the display window.


Filter the Inventory

There are three ways to filter the inventory: by publisher, by category or by simple keyword search.

Filtering By Publisher

By selecting a publisher from the Show Publisher menu, you will see only the entries in the data file for that publisher. Clicking on All returns to the full listing.


Filtering By Category

This function filters the inventory using one or more of the following fields: Type, Reprint, CGC Graded.

1. Click on All to filter all entries in the data file or select a publisher from the Show Publisher menu to filter only those entries by that publisher.
2. Click on the List button and select Filter from the menu. This will open the filter form.
3. Select the fields you want to use as a filter. Hover over each field to see notes on what can/should be entered. You must select at least one field to use as a filter. You may select more than one. For instance, if you want to see all Marvel comics in the inventory select Marvel from the Publisher drop-down menu. If you want to see all Marvel comics that are mini-series, select Marvel from the Publisher drop-down menu and Mini-Series from the Type drop-down menu.
4. Click on the Filter button to filter the inventory. You will be returned to the main listing screen which will show the filtered results.
5. To return to the full inventory list, click on the List button and select Reload.


Filtering by Keyword Search

This function provides a method of searching the database by one or more keywords. Whatever is typed in the search field is what will be searched for. The search is case insensitive, so searching for marvel will return inventory entries containing Marvel and marvel.

  1. Click on Filter and select By Search from the menu. This will open the Search dialog box.
  2. In the text field, enter the word or words that you want to search for. Example (without quotes): "Superman" or "Star Wars".
  3. Click on Search to execute the search. The dialog box will disappear and the results will appear in the main window.


Backup/Restore the Data File

Backup
  1. Click on the Other button and select Backup/Restore from the menu. This will open the Backup/Restore dialog.
  2. The Backup radio button in the Backup/Restore dialog should already be checked. If not, click to select it.
  3. Click on the Go button. A backup copy of the data file will be made in the directory specified in the Preferences screen (see Setting Preferences below).
  4. When the copy has been made, a message stating so will appear containing the location of the backup file and its name.

Restore

  1. Click on the Other button and select Backup/Restore from the menu. This will open the Backup/Restore dialog.
  2. Select the Restore radio button.
  3. Click on the Go button. This will open a File Open dialog.
  4. In the File Open dialog, locate the backup file you wish to restore.
  5. A message will appear stating that this restore will overwrite the current data file. If you want to continue, click on OK. If not, click on Cancel.
  6. If you clicked on OK, a message stating that the restore has occurred. Click on OK.


Importing and Exporting Data

It is highly encouraged that you backup your data file before importing

Importing from a File

SCDB can import comma seperated value (CSV) data. However, this requires the data to be in a certain format in the CSV file. Specifically, the first line of the file must contain something other than data and cannot be a blank line.

The data on the following lines must be in the following format.
     Publisher,Title,Series,Issue,Type,Grade,CGC Graded?,CGC Number,Reprint?,Notes,Inv Number
For example:
     DC,Atari Force,1984,20,Regular,,No,,No,Last issue,

Note that there is nothing entered into the Inv Number position in the example. This position should always remain blank when importing as SCDB will assign inventory numbers during the import process.

Once the data file has been formatted, you can import it into SCDB by following these steps:

  1. Click on the Other button and select Import/Export from the menu. The Import/Export dialog will open.
  2. Click on Import then click on Go. A File Open dialog will appear.
  3. In the File Open dialog, locate the file containing the data you wish to import.
  4. When the data is imported, a message will appear stating so. Click on OK.
  5. The main window will reload and your new entries will appear in the inventory.


Exporting to a File

SCDB can export to CSV or simple HTML files.

  1. Click on the Other button and select Import/Export from the menu. The Import/Export dialog will appear.
  2. Select which format you wish to export to (CSV or HTML) then click on Go. This will open a Save dialog box.
  3. In the Save dialog box, set the location you want to save the file to and the file name.
  4. Once the location and name are set, click on Save.
  5. When the file has been exported, a message stating so will appear.


Getting Statistics

SCDB can provide basic stats for the inventory. These stats are: To see the stats, select Other-->Stats from the menu. You will be presented with a window like the one shown at left.


Searching for Info on the GCD Site

About the GCD
The Grand Comic-Book Database (GCD) is a non-commercial online database of comic books. From the GCD wiki: "The Grand Comic-Book Database (GCD) is an ongoing international project to build a detailed comic-book database that will be easy to use and understand, and also easy for contributors to add information to it." Learn more about the GCD and how you can contribute to it by visiting their web site.


Searching the GCD via Right-Click Menu
1. Right-click on an entry in the inventory listing.
2. Select "Search GCD" from the pop-up menu. This will open a modified browser window and load the search results for that title from the GCD website.
3. View the results of the information.
4. When finished, close the browser window.


Seaching GCD from the Data Form
This option is available when adding or editing a comic.
1. In the data form, ensure the Title field is filled in.
2. Click on the "Title" label next to the field. This will open a modified browser window and load the search results for that title from the GCD web site.
3. View the results of the information.
4. When finished, close the browser window.


Setting Preferences

Certain preferences for SCDB can be modified through the Edit Preferences dialog. The preferences that can be updated are:
  • the location of the SCDB install directory.
  • the location of the SCDB backup directory.
  • the location of the SCDB data directory.
  • the name of the SCDB data file.
  • the list of comic book publishers.
  • the list of comic book types.
  • the maximum number of comics to allowed in the inventory.
  • the column to sort on (ie - Publisher, Title, etc).
  • the sort order (ascending or descending).
To view or modify these preferences, do the following:
  1. Click on the Other button and select Edit Preferences from the menu. This will open the Preferences dialog.
  2. Select the tab containing the preference you want to view or modify.
  3. Change the data as needed. For the Dirs and Files entries, see the First Use section for an explanation of each of the data fields.
  4. Click on the Save button.
  5. Repeat steps 1 thru 4 to view or modify other preferences.
  6. Click on Cancel to close the Preferences dialog.
WARNING - Be careful about changing the Configuration entries. They can break the operation of SCDB if not set correctly.


Online Help

This help information is available within SCDB. Click on Help and select Help from the menu. A new menu dialog will appear with the each of the help topics listed. Select the help topic you wish to view by clicking on it.









About SCDB

A small bit of information about SCDB can be found by clicking Help --> About in the menu.