README

ITWS allows you to deploy and maintain, in an easy way, multiple websites.

ITWS offers high level features through a user friendly interface:

- News streams also usable as a simple blog
- Tags cloud
- Slideshow: multiple page content which can be displayed with specific layout
- Sections with composite layout
- Sidebar which could contain static data like web pages or dynamic
  data like:
  
  - filtered news
  - tag cloud
  - table of content
  - twitter/identi.ca stream
  - specific menu
  
- RSS feeds:

  - emission website's global, by tag or for news
  - display of external feeds with multiplexing and filtering

- Configurable menu
- Contents are editable directly through the front office, a specific editing
  mode adds helpers
- Inline editing of CSS, favicon, etc.
- Customizable Footer with multiple content which could be ordered or
  randomized
- `Sitemap`_


ITWS stands for ITaapy WebSites. It is the fruit of `Itaapy`_'s work for its
clients. It tries to responds different needs with a coherent product.


Based on iKaaro
===============

ITWS is a built on top of `iKaaro`_. It adds features to help communication and
ease of use.

iKaaro is a complete CMS featuring

- Multilingual contents
- Full search capabilities thanks to `Xapian`_
- Versioning of all contents and metadata
- A set of modules: agenda, forums, tracker, etc...
- A wiki which can generate ODT books (using lpOD project libraries)
- User and role management
- Flexible workflow engine
- One-click on line editing (external editor)

iKaaro (and the itools libraries) main technical characteristics are:

- `RESTFul`_ architecture
- Built around data: the object database is based on file system with data in
  its original format
- Heavy use of standards (iCal, XHTML, XML)
- Use of git as the transaction manager and versioning system


Learn more
==========

ITWS home page: http://www.hforge.org/itws

Browse ITWS code at http://git.hforge.org

Participate through:

- itools mailing list, see http://www.hforge.org/community
- Bug tracker: http://bugs.hforge.org/


Requirements
============

 - itools 0.62.x (http://www.hforge.org/itools)
 - ikaaro 0.62.x (http://www.hforge.org/ikaaro)


Install & Deployment
====================

See the file "INSTALL" for information on installing ITWS and deploying a
website.


.. _`Sitemap`: http://www.sitemaps.org/
.. _`Itaapy`: http://www.itaapy.com/
.. _`iKaaro`: http://www.hforge.org/ikaaro
.. _`Xapian`: http://xapian.org/
.. _`RESTFul`: http://en.wikipedia.org/wiki/Representational_State_Transfer


Known issues
====================

MapBox does not allow to use diferents 'render' (OSM, GoogleMap) inside the
same page. This is because, the scripts override each other.


Documentation
=============

To build documentation use ikaaro script::

  $ ipkg-docs.py

Build documentation PDF::

  $ ipkg-docs.py pdf
  $ evince docs/_build/latex/index.pdf


About versions
==============

Here details about ITWS versions::

  - ITWS 1.0 -> Use ikaaro/itools 0.61 (First version of ITWS)
  - ITWS 1.1 -> Use ikaaro/itools 0.61 (Same that ITWS 1.0 but with advance navigation)
  - ITWS 1.2 -> Use ikaaro/itools 0.62
  - ITWS 1.3 -> Use ikaaro/itools 0.62 (Same that v 1.2 but with the shop)
  - ITWS Master -> Devel branch