/* @(#)README 1.3 04/11/01 * * Copyright (c) 2004 Sun Microsystems, Inc. All Rights Reserved. * * This software is the confidential and proprietary information * of Sun Microsystems, Inc. ("Confidential Information"). You shall * not disclose such Confidential Information and shall use it only in * accordance with the terms of the license agreement you entered into * with Sun. * * SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF * THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED * TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A * PARTICULAR PURPOSE, OR NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. */ -------------------------------------------------------------------------- CONTENTS: 1. What is Auto-bookmarks? 2. Source distribution directory overview. 3. Building and running the distribution. 4. Known problems and limitations. -------------------------------------------------------------------------- 1. What is Auto-bookmarks? -------------------------- The files in this distribution are an attempt to automatically generate browser bookmarks from an initial set of topics, by using the Google Java API and extracting the best hit for each query. For more information on the reasoning behind why this is considered useful, see: http://blogs.sun.com/richb/20040908#google_web_search_api_s http://blogs.sun.com/richb/20040910#initial_version_of_a_auto http://blogs.sun.com/richb/20040930#more_work_on_auto_generating http://blogs.sun.com/richb/20041008#automatic_dewey_decimal_bookmarks Bookmarks are generated in the XML Bookmark Exchange Language (XBEL) format. For more details on this specification see: http://pyxml.sourceforge.net/topics/xbel/ To use the Auto-bookmarks software, you will need to download a copy of the Google developer's kit, create a Google account and obtain a licence key. For more details on this, see: http://www.google.com/apis/ The distribution contains various files related to generating bookmarks based on the Library of Congress Classification. For more information on LCC, see: http://www.loc.gov/catdir/cpso/lcco/lcco.html In particular, the file LCC/LCC.txt is a text-based representation of the various LCC PDF files found on the above web site, and will be the input for the auto-bookmark work being done based on LCC data. 2. Source distribution directory overview. ------------------------------------------ ChangeLog - description of changes made to Auto-bookmarks. COPYING - the LPGL license that this software is released under. README - the file you are reading now. TODO - the list of known problems, bugs and suggested enhancements. LCC/bookmarks.xsl - XSL used to convert from XBEL to HTML format. LCC/dtds/xbel.dtd - DTD used to convert from XBEL to HTML format. LCC/LCC.txt - Text version of the LCC PDF files. LCC/LCC-bookmarks.html - HTML file of LCC classifications. LCC/LCC-bookmarks.xbel - XBEL file of LCC classifications. LCC/LCC-bookmarks.xml - Auto-bookmark XML input file (from LCC.txt). LCC/make-LCC-xml.sh - convert LCC file to Auto-bookmark XML input format. src/AutoBookmarks.java - GUI-based application for generating bookmarks. src/Batch.java - batch-based application for generating bookmarks. src/CmdLineOpts.java - common class for command line option handling. src/Google.java - common class for handling the Google searches. 3. Building and running the distribution. ----------------------------------------- First you will need to compile the Java source files in the src directory. This will be with something like: % javac -cp /path/to/googleapi.jar \ AutoBookmarks.java CmdLineOpts.java Google.java Batch.java Next task would be to generate the input file for the Auto-bookmark applications. In other words, taking the LCC/LCC.txt file, and converting each of the Subclass lines in that file and generating the XML tags understood by the Auto-bookmark applications. There is a make-LCC-xml.sh script in the LCC directory that could be the basis for doing this on a UNIX platform. After this, you would either run the GUI Application (AutoBookmarks) or the batch application (Batch) in order to generate the XBEL bookmarks file. The GUI application allows you to selectively choose which bookmarks you'd like to see generated. The batch application automatically converts all of the input file. You can supply the input and output filenames and the Google license key via command line options. This would be something like: % java -cp ../src:/path/to/googleapi.jar Batch \ -key "...your google license key..." \ -input "LCC-bookmarks.xml" \ -output "LCC-bookmarks.xbel" Finally, if you don't have a browser that takes XBEL format bookmark files, then you can convert the XBEL file to a simple HTML web page with something like: % /bin/xsltproc -o LCC-bookmarks.html bookmarks.xsl LCC-bookmarks.xbel Note that before you do this conversion, all occurances of "&" in the LCC-bookmarks.xbel file will need to be converted to "&". 4. Known problems and limitations. ---------------------------------- See the TODO file in the top-level directory. ---------------------------------------------------------------------------- Suggestions for further improvement would be most welcome, plus bug reports and comments.