modules/importexportapi/README.txt

// $Id$

Readme
------

The Import / Export API allows for the definition of data entities within
Drupal. The definition system lets data entities be related to each other,
and it includes a number of different field types. It also supports a system
of import (parsing) and export (rendering) engines, for formats such as XML
and CSV. Data entities are able to be exported from, and imported into, a
Drupal site, for purposes such as backup, offline editing, data migration,
and data transfer between Drupal databases.


Installation
------------

1.  Extract the package into your site's '/modules' directory.
2.  Enable the importexportapi and importexportui modules at 'administer ->
    modules'.
3.  Configure access privileges at 'administer -> access control'.


Performing imports and exports
------------------------------

A simple UI module, called 'importexportui', is currently included with the
API. To start performing data exports, go to 'administer -> export' and follow
the wizard on that page. To start performing data imports, go to 'administer ->
import', and follow the wizard on that page.

All data for importing is currently stored in a series of files in the
'/testdata' directory of the package. To add or edit the available import data,
simply edit the files in this directory, or add new files of your own (no
configuration needed - all files in this directory are made available for
import).


Support
-------

All issues (e.g. support requests, bug reports) are to be submitted using the
drupal.org issue tracker.


Author
------

Jeremy Epstein <jazepstein [ATT] greenash DOTT net DOTT au>
1	// $Id$
2
3	Readme
4	------
5
6	The Import / Export API allows for the definition of data entities within
7	Drupal. The definition system lets data entities be related to each other,
8	and it includes a number of different field types. It also supports a system
9	of import (parsing) and export (rendering) engines, for formats such as XML
10	and CSV. Data entities are able to be exported from, and imported into, a
11	Drupal site, for purposes such as backup, offline editing, data migration,
12	and data transfer between Drupal databases.
13
14
15	Installation
16	------------
17
18	1. Extract the package into your site's '/modules' directory.
19	2. Enable the importexportapi and importexportui modules at 'administer ->
20	modules'.
21	3. Configure access privileges at 'administer -> access control'.
22
23
24	Performing imports and exports
25	------------------------------
26
27	A simple UI module, called 'importexportui', is currently included with the
28	API. To start performing data exports, go to 'administer -> export' and follow
29	the wizard on that page. To start performing data imports, go to 'administer ->
30	import', and follow the wizard on that page.
31
32	All data for importing is currently stored in a series of files in the
33	'/testdata' directory of the package. To add or edit the available import data,
34	simply edit the files in this directory, or add new files of your own (no
35	configuration needed - all files in this directory are made available for
36	import).
37
38
39	Support
40	-------
41
42	All issues (e.g. support requests, bug reports) are to be submitted using the
43	drupal.org issue tracker.
44
45
46	Author
47	------
48
49	Jeremy Epstein <jazepstein [ATT] greenash DOTT net DOTT au>