Revert "[CLEANUP] Rework/simplify copyright header and remove @package"
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Tests / Functional / Fixtures / Extensions / irre_tutorial / README.txt
1 =====================================================================================================
2 TYPO3: Inline Relational Record Editing Tutorial
3 (c) 2007-2010 Oliver Hader <oliver@typo3.org> - All rights reserved
4 =====================================================================================================
5 This script is part of the TYPO3 project. The TYPO3 project is free software; you can redistribute
6 it and/or modify it under the terms of the GNU General Public License as published by the Free So
7 Software Foundation; either version 2 of the License, or (at your option) any later version.
8 The GNU General Public License can be found at http://www.gnu.org/copyleft/gpl.html.
9 =====================================================================================================
10
11
12 -----------------------------
13  1. Installation
14 ---------------------------
15 Download the extension "irre_tutorial" from the TYPO3 Extension Repository at http://www.typo3.org/
16 Install the extension using the Extension Manager (EM) in the TYPO3 Backend. You need administrative
17 rights (admin user) at your TYPO3 installation to be able to do this.
18
19 After this extension was installed, a new backend module "Web>IRRE Tutorial" will appear. By clicking
20 on the module link in the left menu frame, you can import a set of sample data.
21
22 To uninstall the sample data you have to select "Uninstall sample data" from the upper right corner
23 in the "IRRE Tutorial" module. The script looks for a page alias "irre_tutorial_data" and removes, if
24 successfully found, this branch from your TYPO3 installation.
25
26
27
28 -----------------------------
29  2. Usage
30 ---------------------------
31 After you imported the IRRE Tutorial sample data, you are can play around, change tca.php files etc.
32 You can just do, what ever you'd like to. The ext_tables.php and tca.php have a additional string in
33 their filenames. This should help you to find the case you're looking fore faster. See the following
34 description what these strings (e.g. like "tx_irretutorial_<string>_hotel or tca.<string>.php) mean:
35
36         * 1ncsv: 1:n relations using comma separated values as list
37         * 1nff: 1:n relations using foreign_field as pointer on child table
38         * mnasym: m:n bidirectional asymmetric relations using intermediate table
39         * mnsym: m:n bidirectional symmetric relations using intermediate table
40         * mnattr: m:n bidirectional asymmetric attributed relations using intermediate table
41         * mnmmasym: m:n bidirectional asymmetric relations using the default MM feature of TYPO3
42
43
44
45 -----------------------------
46  3. To-Do
47 ---------------------------
48 ...
49
50
51
52 -----------------------------
53  4. Links
54 ---------------------------
55 Extension:      http://typo3.org/extensions/repository/view/irre_tutorial/
56 Thesis:         http://typo3.org/documentation/article/inline-relational-record-editing-irre/
57 Video:          http://typo3.org/videos/play/7-minutes-of-fame-inline-relational-record-editing-irre/
58 Core API:       http://docs.typo3.org/typo3cms/CoreApiReference/
59 Wiki:           http://wiki.typo3.org/IRRE
60 XING:           https://www.xing.com/profile/Oliver_Hader
61
62
63 =====================================================================================================