Subversion Repositories regexpline_backup

[/] [stable/] [1.1/] [docs/] [readme.txt] - Blame information for rev 3

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 3 xrow
Datatype extension for eZ publish 3.6+ (License: GPL)
2
-----------------------------------------------------
3
 
4
Provides a regular expression datatype for eZ publish.
5
 
6
 
7
What is it?
8
-----------
9
For end users it will look like the standard "Text line" datatype that ships with eZ publish.
10
 
11
The biggest difference is that the input will be validated against a regular expression. This enables you to make sure the input meets certain criteria.
12
 
13
It can act like a regular "Text line" datatype by allowing all input (regexp: /.*/).
14
 
15
 
16
Features
17
--------
18
- Check user input against a regular expression (Perl-compatible)
19
- Use regular expression subpatterns to be able to use parts of the input in the object name pattern
20
- Ability to customise the text that will be used in the object name pattern
21
- Ability to supply a helptext for users
22
- Required checks compatible with newer eZ publish versions (drafts ignore required fields)
23
- Information collection support
24
- Attribute filtering support
25
- Ability to define preset regular expressions in an ini file
26
- Contentclass import & export
27
- i18n support
28
 
29
 
30
Planned Features
31
----------------
32
These features are NOT available yet, but they're coming.
33
 
34
No planned features at the time of writing
35
 
36
 
37
Requirements
38
------------
39
- A suitable eZ publish version: 3.6.x; 3.7.x has also been used during development.
40
- Knowledge of Perl Compatible Regular Expression syntax (http://www.php.net/manual/en/ref.pcre.php)
41
 
42
 
43
Installation
44
------------
45
You can always find the latest version of this extension @
46
http://pubsvn.ez.no/community/trunk/extension/regexpline
47
 
48
If you can't use SVN, you can also download the most recently released version from the Contributions section @
49
http://ez.no/community/contribs
50
 
51
- Extract or checkout the regexpline extension into the eZ publish 'extension' folder
52
- Activate the extension by means of the admin interface or by adding
53
 
54
  ActiveExtensions[]=regexpline
55
 
56
  to [ExtensionSettings] in site.ini.append(.php)
57
- Clear the template override cache to make sure eZ publish picks up the templates in the extension.
58
 
59
 
60
Bugs? Comments? Wishes?
61
-----------------------
62
- Bugs: If you report a bug, please make sure you have a minimal testcase so I can reproduce the problem.
63
  If I can't reproduce it, I can't fix it.
64
 
65
- Comments: Nothing special here :)
66
 
67
- Wishes: Please provide a clear description.
68
 
69
Direct all (fan|bug|wish)mail at: hans <dotty> melis <atty> gmail <dotty> com
70
 
71
Please note that this datatype has been developed in my spare time, and is supplied as is. I'm not responsible for any data loss or failures. YMMV!
72
 
73
 
74
Tips & Tricks
75
-------------
76
1. If you want to refer to the complete text that matched the regular expression in the object name pattern, you can use <0> as tag.
77
 
78
 
79
Copyright
80
---------
81
 
82
Regular Expression datatype for eZ publish 3.6+
83
Copyright (C) 2005-2006  Hans Melis
84
 
85
This program is free software; you can redistribute it and/or modify
86
it under the terms of the GNU General Public License as published by
87
the Free Software Foundation; either version 2 of the License, or
88
(at your option) any later version.
89
 
90
This program is distributed in the hope that it will be useful,
91
but WITHOUT ANY WARRANTY; without even the implied warranty of
92
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
93
GNU General Public License for more details.
94
 
95
You should have received a copy of the GNU General Public License
96
along with this program; if not, write to the Free Software
97
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA