/[drupal]/contributions/modules/hidden/README.txt
ViewVC logotype

Contents of /contributions/modules/hidden/README.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.3 - (show annotations) (download)
Thu Dec 18 15:29:06 2008 UTC (11 months, 1 week ago) by ekes
Branch: MAIN
CVS Tags: HEAD
Branch point for: DRUPAL-6--1
Changes since 1.2: +5 -5 lines
File MIME type: text/plain
#276732 Continuing D6 migration
  admin pages forms upgraded to D6
  tests written for admin pages
  filters section reworked and using drupal_write_record
1 Description
2 ===========
3
4 This module enables you to un-/hide nodes and comments.
5
6 The concept of 'hiding' has to be understood as something in between
7 - being published and shown in all sorts of places and
8 - being unpublished
9 it shall be visible if you go to another URI, e.g. hidden/, but
10 not when viewing nodes and comments in the normal way or by using
11 the search function.
12
13 The purpose is to help transparency of the 'open editing' process of an
14 'open publishing' site.
15
16 Features
17 ========
18
19 - Articles unpublished as hidden are available to users with 'access hidden'
20 privileges from under the /hidden links.
21 - Hidden articles are always displayed with the reason that they are hidden,
22 and custom css class.
23 - The reason for hiding can be selected from a list or/and typed in.
24 - The list of reasons for hiding can be set from admin.
25 - All pages with /hidden have robots meta tags to ask for no indexing.
26 - Filters can be set to automatically hide posted nodes and comments.
27 - Filters can be obvious reporting the reason to the user, or obfuscated by
28 delay.
29 - Notification of hidden articles can automatically be sent out by e-mail.
30 This can be individually or in batches.
31 - Users with 'report as hidden' privileges can report nodes and comments that
32 they think should be hidden.
33 - Admin pages for nodes and comments have additional tabs to look at hidden
34 and reported content and complete mass operations on them.
35
36 Installation
37 ============
38 After enabling the module, set access permissions at admin/user/access:
39 - 'access hidden' permission to view hidden nodes and comments.
40 - 'report for hiding' permission to be able to report nodes and comments
41 that should be hidden by someone who has...
42 - 'mark as hidden' permission to un-/mark nodes and comments as hidden
43 - 'administer hidden' permission allows changes to filters and settings
44 like what reports are made.
45 - 'bypass filter' for users who do not have their content checked against
46 filters for editorial violations.
47
48 You probably want the role that can 'mark as hidden' to be able to 'access
49 hidden' as well.
50
51 Visit /admin/settings/hidden to set what actions get logged and when and if
52 they get e-mailed. The e-mail address can be an editorial e-mail list. The
53 reports can be collected together and sent out periodically (requires cron) or
54 can be sent immediately an action happens.
55
56 Visit /admin/content/hidden to set what default reasons can be given for
57 hiding a node or comment. You can also set a short description that will be
58 displayed with the reason on a hidden item, this can include html <a> links to
59 editorial guidelines etc. Disabled reasons cannot be selected, but continue to
60 exist for any content already hidden using them.
61
62 Visit /admin/content/hidden/filters if you want to set up filters for words or
63 perl type regular expressions
64 (http://uk2.php.net/manual/en/reference.pcre.pattern.syntax.php) to match with
65 content that should be hidden pending moderation. If the filter is set to
66 happen immediately the user will be notified. If it is set to be delayed the
67 user will not be notified and the node or comment will only be automatically
68 hidden after the delay has expired and a cron is run (or when a user hides it).
69 Each filter also has a reason associated with it. See usage notes about report
70 and hide forms for details about how this information is displayed.
71
72 Hidden content will be accessible to users with 'access hidden' permission on
73 pages starting /hidden. You may want to make a link to that page from
74 editorial guidelines or you can enable a navigation menu link to it on
75 /admin/build/menu.
76
77 Additionally to the meta tags added to the /hidden pages created by the module
78 you may want to install a robots.txt file in the websites top directory
79 containing the lines:
80 User-agent: *
81 Disallow: /hidden/
82
83 Usage
84 ======
85 Every node or comment has an extra link.
86
87 Users with 'report for hiding' permission will have a link to report the post. The
88 following page allows them to explain why it should be hidden using one of the
89 default reasons set (see installation) and/or using free text notes.
90
91 Users with 'mark as hidden' permission will have a link to hide or unhide a
92 post. A hide link goes to a similar form as report for hiding.
93
94 The forms have a public text box. This text, which can contain some HTML (as
95 Dupal 'Basic HTML' settings), will be displayed with the hidden post.
96 There is also a private text box for users with 'mark as hidden' permission.
97 This will only be displayed to other users with 'mark as hidden' permission.
98
99 Mass Un-/Hiding for nodes:
100 - Go to admin/content/node.
101 - Tick the nodes you want to mass un-/hide.
102 - Select Un-/Hide in the dropdown list of operations and click Update.
103 The reason 'Policy Violation' will be applied automatically.
104
105 Mass Unhiding for nodes and comments:
106 - Go to admin/content/node/list/hidden or admin/content/comment/list/hidden
107 - Tick the nodes you want to mass unhide.
108 - Click update
109
110 Reported nodes and comments:
111 - Go to admin/content/node/list/hiddenreported or
112 admin/content/comment/list/hiddenreported
113 There you can mark content to be hidden for mass hiding of nodes above. You
114 can also mark them as 'seen' this lets other users who can 'mark as hidden'
115 that the reported content has been check and not hidden.
116
117 Notes
118 =====
119 - The private notes section of the report, hide and filter forms, for users
120 with 'mark as hidden' privileges, can be used to leave messages about the
121 content that will not be displayed or e-mailed out.
122 - For filters regular expressions are slower than plain text searches, so if
123 you are just looking for some text use plain text.
124 - You don't need to make users full admin users to be able to deal with
125 hidden posts.
126 - Users who can administer nodes and comments will see hidden content with
127 notes on pages other than /hidden ones.
128
129 Spam
130 ====
131 You probably don't want to hide automated spam. This module is written to
132 integrate with the spam.module. Additional integration is on the to do wiki
133 page below.
134
135 Credits
136 =======
137 Sebastian Henschel <aotearoa <at> kodeaffe <dot> de>
138 wrote original implementation of unpublishing hidden method (v1)
139 for Aotearoa Indymedia Centre
140 ekes <ekes <at> aktivix <dot> org>
141 rewritten and features implemented (v2)
142 updated for Drupal 6 and testing framework
143 Testing: kameron, alster
144
145 $Id: README.txt,v 1.2 2007/08/29 17:59:46 ekes Exp $

  ViewVC Help
Powered by ViewVC 1.1.2