putmarks: a PUT request handler for XBEL format bookmarks
---------------------------------------------------------

I.	Introduction

    putmarks is a very quick-n-dirty solution for use with an
XBEL bookmark synchronizing package, such as the wonderful
"Bookmarks Synchronizer" Firefox extension by Torisugari
(http://extensionroom.mozdev.org/more-info/booksync).

    Say you don't have or don't want to use an FTP server to
synchronize your XBEL bookmark data--but you have a PHP-enabled
web-server at your disposal--you may use putmarks to upload the
data and keep it in sync using an HTTP(S) PUT request, which is
very conveniently supported by the "Bookmarks Synchronizer"
extension.

    putmarks also keeps a simple log to let you know that it
is (or isn't) working.

II.	Installation

    Simply copy all of the files from this installation to
your web-server directory.  Make sure to change the ownership
of the stub xbel.xml and log.txt files to be the same as whatever
user the web-server executes as.  For example:

    $ mkdir -p ~/public_html/putmarks
    # From the directory you extracted putmarks into:
    $ cp -raf * ~/public_html/putmarks
    $ cd ~/public_html/putmarks
    $ chown apache:apache log.txt xbel.xml

    Optionally, you may create an .htaccess file and related .htpasswd
file to restrict access this directory to keep your bookmarks and
the ability to overwrite your xbel.xml bookmarks file private.  Please
review to the apache server documentation for further information on
how to set this up at: http://httpd.apache.org/docs/

    That's it for the installation!

III.	Usage

    

    With an extension such as "Bookmarks Synchronizer" for Firefox,
set your "Remote File Settings" to HTTP or HTTPS (if your web-server
supports SSL) and set your host, optional username & password,
and web-server path to the putmarks.php script.  If you click to
apply your new settings and click the "Upload" button, the log file
should show that the bookmarks file has been received and the xbel.xml
file should be populated with the new data.

    putmarks is able to distinguish between HTTP GET and HTTP PUT
requests so when you click "Download" putmarks will automatically
read and download your bookmarks file to the browser.

    That's it!  Happy book-marking!

VI.  Copyright Information

    This software is protected by the LGPL, and the copyright notice is as
    follows.  Please write the address below, or visit
    http://www.gnu.org/copyleft/lesser.html for more information.

    jFlash: Multilingual Web-Based Flashcard Software
    Copyright (C) 2004  Jordan Husney <jordan@husney.com>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

$Id: README,v 1.3 2005/02/10 05:54:47 jordanh Exp $