Timeline

Timeline is a SIMILE web widget for visualizing temporal data.

Using Timeline

You should look over the examples in src/webapp/examples/ for reference for now. There may be more added to the project's GitHub wiki later. There are obsolete examples on the Timeline web site.

Running Timeline Locally

Timeline consists entirely of static files (Javascript libraries, image files, and CSS files). All you really need is to serve those resources off a web server without having to install any special server-side functionality. Any web server will do.

If you have a web server already running on your machine, you will need to obtain SimileAjax. After acquiring the code for it, you will need to configure your web server to:

• Serve simile-ajax/src/webapp/ at /ajax
• Serve timeline/src/webapp/ at /timeline

You'll find the Timeline page with examples at http://localhost/timeline/index.html.

If you do not hvae a web server, this project also includes a mechanism for running one to serve Timeline. You will again need to obtain SimileAjax. You will also need to install Java.

• You will have to copy (not link) simile-ajax/src/webapp/ to timeline/src/ajax/
• Open a shell or command prompt in the same directory of this file and type:

[win32]> run
[unix/macosx]> ./run

and then point your browser to http://127.0.0.1:9999/timeline/

Developing Timeline

You need Java and Apache Ant and Node.js in order to work with Timeline. You'll also need a web server (if you don't want to use the one bundled in this project) and a clone of the repository for the supporting SimileAjax library to get started. Familiarity with RequireJS is strongly suggested.

You should symlink SimileAjax's /src/webapp into Timeline's src/ as src/ajax/ in order to build properly. Run ant in SimileAjax to generate the built, concatenated bundles for it.

• dev/
• simile-ajax/
• src/
• webapp/
• timeline/
• src/
• ajax -> ../../simile-ajax/src/webapp/

Run ant in Timeline in order to generate its built, concatenated bundles.

Mailing List and Forum

Join the community by joining the Google Group SIMILE Widgets.

Licensing

Timeline is open source software and is licensed under the modified BSD license in the LICENSE.txt file located in the same directory as this README.

• RequireJS is covered by the modified BSD license.
• The RequireJS i18n plugin is covered by the modified BSD license.
• almond is covered by the modified BSD license.

This code contains libraries found in lib/, tools/, and optimize/ that support development that are covered by their own licenses.

• Jetty is covered by the Apache 2.0 License
• JSMin Task is covered by the Apache 2.0 License
• r.js is covered by the modified BSD license.

Latest Release - 3.0.0

Released August, 2013.

• Forked source to https://github.com/zepheira/timeline/
• Uses RequireJS.
• Uses SimileAjax 3.0.0.
• Removed all files related to loading and original bundling / compression, substituted with RequireJS optimizer builds.
• Removed several parameters around locales (now handled by RequireJS); defaultLocale, forceLocale, and locales do not work; to simulate the behavior in development, use RequireJS to set the locale.
• Added an ajax parameter to be set in order to find the SimileAjax stylesheet; it should be able to be located if Timeline and SimileAjax are deployed on the same server, but set if not.
• General usage remains backwards compatible, but users should consider changing use-paradigm to RequireJS instead if any flexibility in loading or otherwise is needed.
• Minor bug fixes.
• See https://github.com/zepheira/timeline/compare/2.3.1...3.0.0 for all commits.

Credits

This software was created by the SIMILE project and originally written by the SIMILE development team:

• David Huynh