.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../Includes.txt

.. _introduction:

Introduction
============

**Caution**: Upgrading to version 3.x
-------------------------------------

**Wait! Don't do it!**

Version 3 is a complete rewrite of the extensions and ommits all the existing configuration as soon as you open an existing content element and save it again (as the flexform configuration changed and thus not-found fields with pre-filled/old configuration is dumped).

So, what you could do, is one of the following:

- start from scratch: configure all plugins manually
- stay with version 2.x
- develop an upgrade wizard (and, please, send it to me)
- and of course, you should **read the upgrade guide**

.. toctree::
   :maxdepth: 5
   :titlesonly:
   :glob:

   upgrading/Index

What does it do?
----------------

It takes data (from more or less any source) and presents it (in more or less any format). It then lets (if specified) the user edit or delete, filter and sort the data. And (again, if specified) even creation of new data is possible.

A few examples
^^^^^^^^^^^^^^

- list database tables, file directories, etc.
- let the user modify their own or all data listed
- allow CSV downloads
- include links
- enable detail views
- directly show creation/edit forms (without data listings)
- ...

.. figure:: ../Images/Introduction/ExampleFileListing.png
	:width: 500px
	:alt: File Listing

	Data source is a directory, list entries are files in that directory. Thanks to JavaScript SlickGrid library, this frontend is pretty fast.


.. figure:: ../Images/Introduction/ExampleTableListing.png
	:width: 500px
	:alt: Table Listing

	Data from a MySQL table, filters active (indicated by a red header).


.. figure:: ../Images/Introduction/ExampleDetailView.png
	:width: 500px
	:alt: Detail View

	Detail view of a single record, completely stylable.


.. figure:: ../Images/Introduction/ExampleLargeForm.png
	:width: 500px
	:alt: Large Form

	Editing/Creation is possible in-line and also in a large form.