source: extensions/Icy_Picture_Modify/README.md @ 31963

Revision 16495, 3.0 KB checked in by icy, 8 years ago (diff)

Version 2.0.0, advance ACL . Code copied from git/master.

I could not use merging with git svn . Stupidly copy-&-paste ;)

Line 
1# NAME
2
3  `icy_picture_modify` -- Allow user to modify any pictures
4
5# DESCRIPTION
6
7  A piwigo extension that allows users to edit any set of images.
8  This extension just works as the `picture_modify.php` for administrator.
9
10  The code of this plugin is based on the original source
11  `picture_modify.php` of the Piwigo distribution (version 2.2.3.)
12
13  Advanced ACL is supported since version 1.2.0.
14
15# FEATURES
16
17  Normal users in Piwigo system can delete image or modify image's metadata
18  (author, date, tags, description, metada, linking/represented categories).
19  They can upload some images to some categories.
20
21  Advanced ACL allows users to work with any set of images / categories.
22
23# USAGE
24
25  * Install and enable this plugin and the plugin `community`.
26  * Create and edit ACL file in `local/config/icy_acl.zml` in your Piwigo
27    installation. A sample file can be found in `doc/icy_acl.zml.sample`.
28    You don't have to modify any settings for the plugin `community`.
29    Moverover, any settings of the plugin `community` will be ignored.
30  * If you are using a development of the plugin, please clean up the
31    obsolete files (See `OBSOLETE FILES` below.)
32
33# OBSOLETE FILES
34
35  The following files are obsolsete. They need to be ported to new format
36  and/or to be removed
37
38  * `local/config/icy_acl.php`:
39    need to be ported to `local/config/icy_acl.zml`. After your old ACL
40    settings are ported to new format, you can safely delete this file;
41
42  * `_data/icy.log`:
43    if you are using `icy_picture_modify` version 2.0.0 or higher, you
44    can safely remove this file.
45
46# KNOWN PROBLEMS
47
48  * No webUI for ACL editting
49  * If an image is replaced by a new version (using plugin `Photo update`)
50    the new version is owned by administrator, not the current user.
51    Hence the image may not be editable by themself.
52  * This plugin doesn't support all known templates
53  * This plugin may not work smoothly without the plugin `community`.
54  * User can delete an image which is associated to some albums to which
55    the user doesn't have permission to write/access. This is true as the
56    plugin only checks owner of the image.
57
58# SUPPORT
59
60  To get support, please create new issue at
61    https://github.com/icy/icy_picture_modify/issues
62
63# DEVELOPMENT
64
65  The plugin requires a webUI for ACL editting. Unfortunately, the author
66  isn't good at template system used by Piwigo. Feel free to help us to
67  write a webUI :)
68
69# DONATION
70
71  If you know what `donation` is and how it works in Open source develoment,
72  feel free to donate ;) My Paypal email is `xkyanh@gmail.com`.
73
74# AUTHOR
75
76  The author's information
77
78  * Real name: Anh K. Huỳnh
79  * Email: kyanh@viettug.org, xkyanh@gmail.com
80  * Nickname on Piwigo's forum: icy
81
82# LICENSE
83
84  GPL2
85
86# HOMGEPAGE
87
88  * At Github.com:  https://github.com/icy/icy_picture_modify
89  * At Piwigo.com:  http://piwigo.org/ext/extension_view.php?eid=563
90  * SVN repository: http://piwigo.org/svn/extensions/Icy_Picture_Modify/
91  * Forum link:     http://piwigo.org/forum/viewtopic.php?pid=131585#p131585
Note: See TracBrowser for help on using the repository browser.