PluginProbe
Private groups / 1.7
Private groups v1.7
trunk 1.5 1.6 1.7 1.8 1.8.1 1.9.1 1.9.2 2.0 2.0.1 2.2 2.3 2.4 2.5 2.5.2 2.5.3 2.5.4 2.5.5 2.5.6 3.0.1 3.0.2 3.0.3 3.0.4 3.0.5 3.0.6 All 116 releases
bbp-private-groups / readme.txt

readme.txt in Private groups 1.7, at readme.txt

169 lines 6.5 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 === Private groups ===
2 Contributors: Robin Wilson
3 Tags: forum, bbpress, bbp, private, groups
4 Requires at least: 3.0.1
5 Donate link: http://www.rewweb.co.uk/donate
6 Tested up to: 3.9
7 Stable tag: 1.7
8 License: GPLv2 or later
9 License URI: http://www.gnu.org/licenses/gpl-2.0.html
10
11 For bbPress - Creates private forum groups
12
13 == Description ==
14 This Plugin creates unlimited private forum groups.
15
16 Forums are then allocated to one or more groups, and users allocated to one group.
17
18 What this achieves
19 unlimited private groups
20 Each user is set to a group, and each forum can have any or all the groups associated with it
21 Any number of public forums combined with any number of group forums. The group forums can be individually set to public or private.
22 Forum title and description (but not topics or replies) can be set to be visible to non-group users, allowing people to see that a forum exists but not access it
23 Separate pages can be set to allow redirection of non group users for sign-up or information
24
25 Example
26
27 So if
28 User a belongs to group 1
29 User b belongs to group 2
30 User c belongs to group 3
31
32 and
33 Forum x is set to allow group 2
34 Forum y is set to allow group 2 and group 3
35 Forum z is set to allow group 1 and group 3
36
37 Then
38 User a can access only forum z
39 User b can access forum x and forum y
40 User c can access forum y and forum z
41
42 Restrictions/warnings
43
44 The widgets (bbpress) forums list, (bbpress) recent replies, and (bbpress) recent topics SHOULD NOT BE USED, as they will show topics headings and author names for all forums. Replacement widgets called (private groups) forums list, (private groups) recent replies, and (private groups) recent topics are available instead
45
46
47
48 Works with bbpress 2.5.3
49
50
51
52 == Installation ==
53 To install this plugin :
54
55 1. Go to Dashboard>plugins>add new
56 2. Search for 'private groups'
57 3. Click install
58 4. and then activate
59 6. go into settings and set up as required.
60
61 <strong>Settings</strong>
62
63 Go to Dashboard>settings>Private Groups
64
65 There are 3 settings tabs.
66
67 <em><strong>Forum Visibility tab.</strong></em>
68
69 This tab allows you to set forum visibility.
70
71 By default where the forum has groups set, then these are only visible to authorised users. However you may want users to see that forums exist (to attract new forum users), but not to see content.
72
73 For instance on a cookery site you might have a cake group, who exchange recipes and advice on cakes. You might want people to sign up before being able to contribute, but if they don't know the forum exists, they won't join.
74
75 So by listing the forums (and optionally the description - see tab below) users can see they exist, and if they click the forum or freshness links, they can be taken to any url or wordpress page you wish. Typically this might be a sign-up page, or a 'you can't access' page. For instance you page might say
76
77 Sorry, you need to be a member to see this area. To join click here Login if need-be [bbp-login]
78
79 In this tab, you can set whether non-group members can see the forums in the indexes (but not access). If the forum is set to public, then both non-logged in and logged in users will see this. If the forum is set to private, then only logged in users will see the existence of these forums. this gives a highly granular approach to what forums are displayed for different groups.
80
81 If visibility is set, then there are options for redirecting, and what freshness messages are displayed.
82
83 <em><strong>General Settings</strong></em>
84
85 In general settings, you have the ability to hide topic and reply counts, show sub-forum descriptions, and remove the 'private' prefix from the forum displays.
86
87 <em><strong>Group Name Settings</strong></em>
88
89 Here you set 'friendly' names for the groups, to help you remember. These names do not affect how the restrictions work, group 1 will remain group 1 whatever you name it.
90
91 <strong>To set forums</strong>
92
93 For each restricted forum
94 <ol>
95 <li>Go in to Dashboard&gt;forums and select the forum you wish to restrict.</li>
96 <li>Under the text you’ll see a box called ‘Forum Groups’ – select the group or groups you wish to allow to access this forum</li>
97 <li>If you wish to have a custom error message, you can set one here.</li>
98 </ol>
99 <strong> Setting Widgets</strong>
100
101 The bbPress topics and replies widgets will still at this stage show <b>all</b> topic and reply titles etc. If a topic/reply is selected this will give an error message, but titles and authors will be visible, which might be embarrassing !
102
103 So you will probably not want people to see these subjects, so there are 3 new widgets that the plugin has added that filter this to only show appropriate content.
104
105 Go in to Dashboard&gt;appearance&gt;widgets
106 <ol>
107 <li>You will see three new widgets starting with (private groups) and covering topics, replies and Topics lists.</li>
108 <li>If you are using the standard bbPress topic, reply or forum list widgets, you should remove these from your sidebar and replace them with the (private groups) ones</li>
109 </ol>
110 <strong> </strong>
111
112
113
114
115
116
117
118
119
120
121
122
123 To set forums
124
125 For each restricted forum
126 1.Go in to Dashboard>forums and select the forum you wish to restrict.
127 2.Under the text you’ll see a box called ‘Forum Groups’ – select the group or groups you wish to allow to access this forum
128
129
130 Setting Widgets
131
132 The bbPress topics and replies widgets will still at this stage show all topic and reply titles etc. If a topic/reply is selected this will give an error message (see below).
133
134 However you will probably not want people to see these subjects, so there are two widgets that the plugins have added that filter this to only show appropriate content.
135
136 Go in to Dashboard>appearance>widgets
137 1.You will see three new wiggets starting with '(Private Groups)' and covering topics, replies and forum list.
138 2.If you are using the standard bbPress topic, reply or forum list widgets, you should remove these from your sidebar and replace them with the ‘tehnik’ ones
139
140
141
142 == Screenshots ==
143 1. A sample forum setup screen
144 2. Setting a user to a group
145
146
147
148
149 == Changelog ==
150 1.0 Version 1
151
152 1.1 Minor changes
153
154 1.2 Author and replies issues fixed
155
156 1.3 topics and replies paging fixed
157
158 1.4.1 compatibility with 'mark as read' plugin
159
160 1.5 Amended to have unlimited groups
161
162 1.6 Shortcode [bbp-topic-form] now only shows allowed forums
163
164 1.7 Moderators can now be set to moderate all forums or just their group ones (plus any open forums)
165 Improved topic filtering to speed performance
166 allow Super sticky topics to be seen by all forums
167
168
169