annotate plugins/advanced_search/README.md @ 34:50ac5484d514

one fix to distro
author Charlie Root
date Sun, 27 May 2018 16:53:56 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
34
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
1
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
2 Advanced Search Plugin for Roundcube
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
3 ====================================
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
4
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
5 ## Getting It
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
6
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
7 You can download direct from GitHub or consider using
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
8 the [plugin repository for Roundcube](http://plugins.roundcube.net/)
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
9
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
10 ## Usage
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
11
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
12 After install, 'Advanced search' will show up under the 'more' menu.
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
13
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
14 Please use the _'stable'_ brach for deployment.
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
15
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
16 Advantages:
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
17
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
18 * This version should be tested and bug-free
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
19 * It uses minified versions of the JavaScript
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
20
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
21 ## Requirements
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
22 Version 2.0.0 requires Roundcube 0.9.4 or later
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
23
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
24 ## License
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
25
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
26 This plugin is released under the GNU General Public License Version 3
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
27 or later (http://www.gnu.org/licenses/gpl.html).
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
28
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
29 Even if skins might contain some programming work, they are not considered
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
30 as a linked part of the plugin and therefore skins DO NOT fall under the
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
31 provisions of the GPL license. See the README file located in the core skins
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
32 folder for details on the skin license.
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
33
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
34 ## Download
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
35
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
36 ### GIT :
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
37 * Clone the GitHub repository to 'advanced_search':
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
38
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
39 > git clone git://github.com/GMS-SA/roundcube-advanced-search.git advanced_search
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
40
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
41 * Change to the 'stable' branch:
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
42
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
43 > cd advanced_search
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
44 > git checkout -b stable origin/stable
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
45
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
46 ### ZIP :
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
47 * Swap branches to 'stable'
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
48 * Click on the 'ZIP' download icon
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
49 * Rename the unziped directory 'advanced_search'
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
50
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
51 ## Install
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
52
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
53 * Place the 'advanced_search' plugin folder into the plugins directory of Roundcube.
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
54 * If using git and not wanting all the '.git' repository data in your live webmail:
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
55
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
56 > cd advanced_search
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
57 > git archive --format=tar --prefix=advanced_search/ stable | tar -x -C /path/to/roundcube/plugins/
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
58
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
59 This will give you a git-free copy of the stable branch.
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
60 * Add advanced_search to $rcmail_config['plugins'] in your Roundcube config
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
61
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
62 * To override defaults, copy the config-default.inc.php file to config.inc.php and modify
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
63
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
64 ## Upgrade
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
65 If upgrading from 1.2.0 or lower, you *must* review the config file.
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
66
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
67 ## Configuration
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
68
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
69 * Available search criterias
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
70 * Targeted roundcube menu for the advanced search
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
71
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
72 ## Credits
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
73
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
74 * Wilwert Claude
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
75 * Ludovicy Steve
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
76 * Moules Chris
50ac5484d514 one fix to distro
Charlie Root
parents:
diff changeset
77 * [Global Media Systems](http://www.gms.lu)