Graphiclious 0.1.0

data/README.txt

@@ -0,0 +1,126 @@
+This is still under development, but nevertheless usable!
+
+
+*** CREDITS/REQUIREMENTS ***
+
+First of all you'll need an account at:
+- del.icio.us, which is a social bookmark service
+
+These tools are the minimum requirements to get Graphiclious work for you:
+- The Ruby interpreter (Graphiclious is implemented in the Ruby programming language)
+- Rubygems, the Ruby package manager
+- Rubilicious, which makes the del.icio.us-API availiable within Ruby applications
+- RGL: The Ruby Graph Library
+
+Note that the Rubygems package manager will automatically ask for
+installation of Rubilicious and RGL when installing the Graphiclious gem.
+
+To get the most ut of Graphiclious you'll further need:
+- FXRuby, which makes the FOX gui toolkit availiable for Ruby applications
+- RMagick, a wrapper ImageMagick, which is a tool for image processing
+- Graphviz, a tool for generating nicely layouted graphs
+
+Developers will need Rake, the Ruby make tool, too.
+
+FXRuby and RMagick are availiable as Rubygems. You'll need a FXRuby version >= 1.2
+and RMagick might need further installation steps as described on the RMagick
+homepage http://rmagick.rubyforge.org/. Graphviz is easy to install, just follow the instructions
+at http://www.graphviz.org/.
+
+Note that some of these requirements, e. g. Rubygems and FXRuby, might be contained in your Ruby
+installation.
+
+*** GEM INSTALLTION ***
+
+gem install Graphiclious
+
+
+*** RUNNING GRAPHICLIOUS WITH GEM INSTALLATION ***
+
+Depending on your Ruby installation, it might be enough to run:
+
+ graphiclious --gui
+
+On Windows, create a shortcut and set
+- the working directory to a directory of your choice (output will be generated into this directory)
+- the command:
+
+  C:\ruby\bin\graphiclious.cmd --gui --user <your-delicious-name>
+
+
+*** COMMAND LINE OPTIONS ***
+
+Graphiclious has some useful options, the most mentionable options are:
+
+--help/-h will display a help text containing all options
+--gui/-g will start a graphical user interface
+--user/-u specify a del.icio.us user (its name will be used as output directory, too)
+--password/-p specify password for given user
+--version/-v prints actual version
+
+Without gui option you'll need to specify user and password.
+
+
+*** RUNNING GRAPHICLIOUS WITHOUT GEM INSTALLATION (TYPICAL CASE FOR DEVELOPERS) ***
+
+In general it shoud work to
+1. Open a console window
+2. Go to the graphiclious library directory (e.g. "cd ~/graphiclious/lib" or "cd C:\graphiclious\lib")
+3. Run graphiclious.rb with options of your choice (we recommend option --gui)
+
+Note that there are better ways to run it, but this one is easy to describe and quite platform independent.
+
+On WINDOWS create a shortcut which runs in the directory you want to generate output in
+(e. g. C:\homepage\graphiclious) and executes the following command:
+  
+  C:\ruby\bin\ruby.exe -rubygems -I "C:\graphiclious\lib" -Ilib "C:\graphiclious\bin\graphiclious" --gui
+  
+To analyse errors, it might be useful to keep a console open. Try something like this:
+
+  C:\WINNT\system32\CMD.EXE /k <command as described above> || pause
+
+On Debian unstable the following works if you have installed the package
+libfox-ruby:
+
+1. Go to the graphiclious root directory (e. g. cd ~/graphiclious)
+2. Run the following command:
+
+  ruby -rubygems -Ilib bin/graphiclious --gui
+
+
+*** RUNNING THE TESTS ***
+
+Go to the graphiclious installation directory and run rake.
+
+
+*** USAGE HINTS/KNOWN ISSUES ***
+
+- Downloading all links may take some time if you have lots of tags.
+  Be patient or better: use the quicker update mode "update recent"!
+  We try to avoid unnecessary updates by writing a timestamp. If you really
+  need a second run, delete the file delicious.time before running the program.
+  Note that the update mode won't use this timestamp.
+  It is not possible to delete links with the update mode.
+
+- We locally fixed a bug in Rubilicious 1.5 by overriding Rubilicious#all.
+
+- The number of generated files can be very large, it can become something like
+  3*(b + 2) + n + n*n where n is the number of tags and b is the number of bundles;
+  there will be no further warning about that.
+
+- Avoid spaces in the working directory you run Graphiclious in.
+
+- Avoid tags that could not be used as a filename
+  (depends on file system and operation systems, therefore our substitutions might not
+  cover every possible situation, also substitutions might cause overwrites if tags
+  only differ in special characters)
+
+- In general, if you use a new feature of del.icio.us: Make sure it is
+  correctly supported by Graphiclious before making the generated pages public
+  availiable.
+  
+- Html output will be overwritten. Old output will not be deleted so you
+  need to take care of obsolete files yourself. Note that old files might
+  contain private links if you once included them and later decided to
+  ignore them. Delete the whole output and regenerate in this case.
+  

data/Rakefile

@@ -0,0 +1,28 @@
+# Rakefile for Graphiclious   -*- ruby -*-
+
+begin
+  require 'rubygems'
+rescue Exception
+  nil
+end
+
+require 'rake/testtask'
+
+# The default task is run if rake is given no explicit arguments.
+
+desc "Default Task"
+task :default => :test
+
+# Define a test task.
+
+Rake::TestTask.new { |t|
+  t.libs << "lib,test"
+  t.pattern = File.join('test', 'test_*.rb')
+  t.verbose = true
+}
+
+task :test
+
+# Define a test that will run all the test targets.
+desc "Run all test targets"
+task :testall => [:test ]

data/bin/graphiclious

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'graphiclious'

data/doc/index.html

@@ -0,0 +1,32 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
+  <meta name="author" content="Sascha D�rdelmann">
+  <meta name="generator" content="Ulli Meybohms HTML EDITOR">
+  <meta name="keywords" lang="en" content="Graphiclious,del.icio.us,static webpage generator">
+  <link rel="stylesheet" type="text/css" href="style.css">
+  <title>Graphiclious Homepage</title>
+</head>
+<body>
+  <h1>Graphiclious Homepage</h1>
+  <div class="main">
+  <p>
+  Graphiclious takes your del.icio.us links and generates a bunch of static webpages.
+  </p>
+  <ul>
+  <li><a href="screenshots/thumb.html">Screenshots</a></li>
+  <li>Rubyforge project pages:
+    <ul>
+    <li><a href="http://rubyforge.org/projects/graphiclious/">Summary</a></li>
+    <li><a href="http://rubyforge.org/tracker/?group_id=1436">Tracker</a></li>
+    <li><a href="http://rubyforge.org/docman/?group_id=1436">Documentation</a></li>
+    <li><a href="http://rubyforge.org/news/?group_id=1436">News</a></li>
+    <li><a href="http://rubyforge.org/scm/?group_id=1436">Sources</a></li>
+    <li><a href="http://rubyforge.org/frs/?group_id=1436">Releases</a></li>
+    </ul>
+  </li>
+  </ul>
+  </div>
+</body>
+</html>

data/doc/screenshots/default.css

@@ -0,0 +1,44 @@
+body, p, td, a { font-family: Arial, Helvetica, sans-serif;
+   font-style: normal;
+   font-weight: normal;
+   line-height: normal;
+}
+body { background-color: #fafaed;
+   color: #000000;
+   font-size: 10pt;
+   text-align: center;
+}
+p { font-size: 10pt;
+   text-align: center;
+   margin-top: 2em;
+}
+h1 { color: #c5c589;
+   font-family: tahoma, arial, Helvetica, sans-serif;
+   font-size: 24pt;
+   font-style: normal;
+   font-weight: bold;
+   line-height: normal;
+   text-align: center;
+   margin-bottom: 1em;
+}
+table { margin-left: auto;
+   margin-right: auto;
+   background-color: #f5f5dc;
+   border-collapse: collapse;
+   border: 1px solid #c5c589;
+   empty-cells: hide;
+}
+td { color: #000000;
+   font-size: 10pt;
+   text-align: center;
+   vertical-align: baseline;
+   border: 1px solid #c5c589;
+}
+img { border: none;
+}
+a { color: blue;
+   font-size: 10pt;
+   text-decoration: none;
+}
+a:hover { text-decoration: underline;
+}

data/doc/screenshots/original/blue-style-1.html

@@ -0,0 +1,37 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+<meta name="GENERATOR" content="XnView">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<meta http-equiv="Content-Language" content="en-us">
+<title>Graphiclious screenshots</title>
+<link rel="stylesheet" type="text/css" href="../default.css">
+<style type="text/css">
+table, td {
+   border: none;
+   background-color: #ffffff;
+}
+</style>
+</head>
+<body>
+<H1>Graphiclious - blue-style-1.jpg</H1>
+<p>
+<a href="user-interface.html">Previous</a> |
+<a href="cornflower.html">Next</a> |
+<a href="../thumb.html">Thumbnails</a>
+</p>
+<table cellpadding="2" cellspacing="5">
+<tr>
+<td><img src="blue-style-1.jpg" alt="blue-style-1.jpg" width="695" height="568"></td>
+</tr>
+<tr>
+<td>blue-style-1</td>
+</tr>
+<tr>
+<td><p><i>This page was generated by <a href="http://www.xnview.com">XnView</a></i></p></td>
+</tr>
+</table>
+</body>
+</html>
+

data/doc/screenshots/original/cornflower.html

@@ -0,0 +1,37 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+<meta name="GENERATOR" content="XnView">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<meta http-equiv="Content-Language" content="en-us">
+<title>Graphiclious screenshots</title>
+<link rel="stylesheet" type="text/css" href="../default.css">
+<style type="text/css">
+table, td {
+   border: none;
+   background-color: #ffffff;
+}
+</style>
+</head>
+<body>
+<H1>Graphiclious - cornflower.jpg</H1>
+<p>
+<a href="blue-style-1.html">Previous</a> |
+<a href="custom-style.html">Next</a> |
+<a href="../thumb.html">Thumbnails</a>
+</p>
+<table cellpadding="2" cellspacing="5">
+<tr>
+<td><img src="cornflower.jpg" alt="cornflower.jpg" width="919" height="582"></td>
+</tr>
+<tr>
+<td>cornflower</td>
+</tr>
+<tr>
+<td><p><i>This page was generated by <a href="http://www.xnview.com">XnView</a></i></p></td>
+</tr>
+</table>
+</body>
+</html>
+

data/doc/screenshots/original/custom-style.html

@@ -0,0 +1,37 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+<meta name="GENERATOR" content="XnView">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<meta http-equiv="Content-Language" content="en-us">
+<title>Graphiclious screenshots</title>
+<link rel="stylesheet" type="text/css" href="../default.css">
+<style type="text/css">
+table, td {
+   border: none;
+   background-color: #ffffff;
+}
+</style>
+</head>
+<body>
+<H1>Graphiclious - custom-style.jpg</H1>
+<p>
+<a href="cornflower.html">Previous</a> |
+<a href="sample-graph.html">Next</a> |
+<a href="../thumb.html">Thumbnails</a>
+</p>
+<table cellpadding="2" cellspacing="5">
+<tr>
+<td><img src="custom-style.jpg" alt="custom-style.jpg" width="711" height="549"></td>
+</tr>
+<tr>
+<td>custom-style</td>
+</tr>
+<tr>
+<td><p><i>This page was generated by <a href="http://www.xnview.com">XnView</a></i></p></td>
+</tr>
+</table>
+</body>
+</html>
+

data/doc/screenshots/original/sample-graph.html

@@ -0,0 +1,37 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+<meta name="GENERATOR" content="XnView">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<meta http-equiv="Content-Language" content="en-us">
+<title>Graphiclious screenshots</title>
+<link rel="stylesheet" type="text/css" href="../default.css">
+<style type="text/css">
+table, td {
+   border: none;
+   background-color: #ffffff;
+}
+</style>
+</head>
+<body>
+<H1>Graphiclious - sample-graph.jpg</H1>
+<p>
+<a href="custom-style.html">Previous</a> |
+<a href="user-interface.html">Next</a> |
+<a href="../thumb.html">Thumbnails</a>
+</p>
+<table cellpadding="2" cellspacing="5">
+<tr>
+<td><img src="sample-graph.jpg" alt="sample-graph.jpg" width="1007" height="620"></td>
+</tr>
+<tr>
+<td>sample-graph</td>
+</tr>
+<tr>
+<td><p><i>This page was generated by <a href="http://www.xnview.com">XnView</a></i></p></td>
+</tr>
+</table>
+</body>
+</html>
+

data/doc/screenshots/original/user-interface.html

@@ -0,0 +1,37 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+<meta name="GENERATOR" content="XnView">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<meta http-equiv="Content-Language" content="en-us">
+<title>Graphiclious screenshots</title>
+<link rel="stylesheet" type="text/css" href="../default.css">
+<style type="text/css">
+table, td {
+   border: none;
+   background-color: #ffffff;
+}
+</style>
+</head>
+<body>
+<H1>Graphiclious - user-interface.jpg</H1>
+<p>
+<a href="sample-graph.html">Previous</a> |
+<a href="blue-style-1.html">Next</a> |
+<a href="../thumb.html">Thumbnails</a>
+</p>
+<table cellpadding="2" cellspacing="5">
+<tr>
+<td><img src="user-interface.jpg" alt="user-interface.jpg" width="348" height="427"></td>
+</tr>
+<tr>
+<td>user-interface</td>
+</tr>
+<tr>
+<td><p><i>This page was generated by <a href="http://www.xnview.com">XnView</a></i></p></td>
+</tr>
+</table>
+</body>
+</html>
+