source: products/qPloneBlog/trunk/README_qPloneBlog.txt

Last change on this file was 1, checked in by myroslav, 18 years ago

Building directory structure

  • Property svn:eol-style set to native
File size: 12.7 KB
Line 
1qPloneBlog
2
3qPloneBlog is a SimpleBlog based product with refactorings and extendings.
4
5
6APPLIED FEATURES:
7
8  - categorization
9  - technorati tags support
10  - trackback supporting with management and spam defense
11  - pinging
12  - RSS1, RSS2 syndication
13  - allow working with Blogger, Weblog, MetaWeblog APIs
14  - bookmarklets
15  - Google adsence management in blog pages
16
17
18PACKAGE's PRODUCTS:
19
20  * SimpleBlog v.qg2.5
21  * qPingTool v.0.3
22    * qRSS2Syndication v. 0.5
23    * XMLRPCMethod, v.XMLRPC Method-1-1
24  * RPCAuth v.0.1.0-final
25  * qTrackSpam (extender product) v.0.2
26  * adsenseproduct (extender product) v.0.1
27
28
29DEPENDENCIES:
30
31  * Plone v.2.1+
32  * Archetypes v.1.3.5 and above
33  * ATContentTypes v.1.0.1-final and above
34
35
36INSTALLATION
37
38  * downloads qPloneBlog package
39  * put all package's products to Plone's Product directory
40  * in ZMI create RPCAuth object in the rooty of your Plone instance.
41  * using quickinstaller install SimpleBlog, qPingTool, qRSS2Syndication,
42    qTrackSpam and adsenseproduct
43
44
45PRODUCT SETUP AND TUNING
46
47  * SimpleBlog:
48    * in plone control panel go to SimpleBlog setup.
49      Here is portal wide options for blogs.
50
51  * Pinging:
52    * in ZMI in portal_pingtool input web address of your site
53    * in ZMI in portal_syndication:
54        * allow syndication in portal_pingtool/propertiesForm
55        * allow syndication tab visibility in
56          portal_syndication/manage_editActionsForm
57    * in plone control panel go to Ping Tool setup.
58      Here you can add, delete, change ping info for pinging sites list.
59    * go to Blog or BlogFolder, which you wish to ping.
60      * in syndication tab - allow syndication
61      * in added 'ping setup' tab - enable pinging and select desired ping
62        sites and save this settings.
63        * here you can ping container's content to selected sites
64          whenever you want.
65
66  * Trackback management:
67    You have 2 configlets in plone control panel:
68      * BlackList Importer
69        Allow you form URL's black list - both: by direct Black list
70        editing or by file uploading.
71        black list records interprets as regular expressions.
72      * Clean TrackBacks
73        Allow manage new (not published) trackbacks: mark as black and
74        remove, publish.
75        Represent all trackbacks from all portal's blogs in table.
76
77  * Adsense in blogs
78    Allow adding google adsense block in Blog entries.
79      * go to plone control panel to Adsense Properties and input
80        you customer Id
81
82  * Blog API
83    For working with blog and it's content through external application,
84
85
86DESCRIPTION:
87
88  qPloneBlog is an easy to use Plone based weblog application with fore
89portal types: Blog, BlogFolder, BlogEntry and  Trackback:
90  Blog - Folderish object that is the container for the BlogEntries and the
91         front-page of the weblog.
92  BlogEntry - Entry object inside the weblog.
93  BlogFolder - Folder that can only exist inside the Blog container.
94               The folder allows you to organize the BlogEntries in any way
95               you like.
96  Trackback - trackback to other blog-post (web resource possible).
97              Can be added only to BlogEntry type object.
98              Contains short information about blog-post, which links to blog
99              entry, where trackback URL, of this BlogEntry is added.
100              Can be in two workflow states: pending and published.
101
102
103GETTING STARTED
104
105  You can go to any folder that you have permissions for and add
106a Blog from any of the dropdown lists. You will be given a form
107where you can provide the necessary information to create a new Blog:
108
109  * **Short Name**, **Title**, **Description** will speak for themselves.
110
111  * **Maximum number of blog entries to display** defines how many
112    items should be visible on the Blog's front-page.
113
114  * **Available entry Categories**, **Tags** is a list of categories
115    and tags accordingly, that can be used inside BlogEntries
116    (one category or tag per line).
117
118After clicking on **next** button you will go to next blog's
119**[interface]** property list and provide appropriate customizations:
120
121  * **Show warning for unpublished entries** - turning on/off displaying
122    warning on the blog's frontpage if there are entries that are not
123    yet published.
124
125  * **Show Byline footer**, **Show Icons** - checkboxes for switching on/off
126    appearance accordingly footer and icon for BlogEntry.
127
128  * **Enable technorati tags** and **Allow Trackback** - will speak
129    for themselves.
130
131  * **Turn ... bookmarklet** - turn on/off appearance appropriate
132    bookmarklet in the Byline footer.
133
134  * **Turn top Adsence block** and **Turn bottom Adsence block** -
135    turn on/off top and bottom google adsense blocks for blog entries.
136
137  * **Select top adsence template** and **Select bottom adsence template** -
138    give you possibility to chose an adsense template.
139
140After you have created the Blog, you can adjust its Display settings from the
141Display menu in Plone. Currently there are 3 different display settings.
142Besides these settings, there is also a stylesheet in product's skin that you
143can customize at will.
144
145After you have created the Blog, you can start creating BlogEntries.
146Choose BlogEntry from the Add items list and fill in the form:
147
148  * **Short Name**, **Title**, **Teaser**, **Body** will speak for
149      themselves. **Note** when you use the Upload a file field, be aware
150      that it will replace the current content!!
151
152  * **Always on top** Controls if the Entry, when published is always shown
153    first. This can be handy for announcements etc.
154
155  * **Categories** Select one or more categories from the list to classify
156    the BlogEntry.
157
158  * **Tags** - allow you select or add tag(s) for technorati.com
159
160  * **sendTrackBackURLs** - a list of trackback URLs (one per line). On
161    publishing this blog entry, information about it sends to URLs.
162
163  * **Digg topic** - Choose the digg topic for symplify blog entry readers
164    digging this entry.
165
166  * **Related items** point to other content in your portal to indicate them
167    as related.
168
169  * **Allow Discussion on this item** control whether people can comment on
170    this entry.
171
172After the BlogEntry is saved, it will be in the 'draft' workflow state and is
173only visible by the owner and the manager (by default). So, in order to make
174it appear on the Blog's front-page, it must be set in the 'published' state
175The Blog will search and display the BlogEntries that have this state (this
176state is defined in the simpleblog_tool in ZMI and in the configlet in Plone
177setup). When putting the BlogEntry in the published state, you can also choose
178to give it an effective date somewhere in the future. SimpleBlog uses the
179standard way of publishing content.
180
181Inside the Blog you can create BlogFolders. These are a bit similar to the
182Blog itself in that it has roughly the same view but this time it only shows
183the Entries that are stored inside the BlogFolder (and subfolders).
184BlogFolders are there for your convenience, to organize or archive Entries in
185any way you want and to have additional categories (see below).
186
187To BlogEntry also Trackback can be added. Trackback include following fields:
188
189  * **Short Name**, **Title**, **Description** will speak for themselves.
190
191  * **Url**, **Blog_name** and **excerpt** point to URL, Blog's name and
192    excerpt accordingly of trackbacked blog post, frow witch this blog entry
193    was linked in.
194
195Commonly trackbacks added by blog itself (trackback system). After adding
196Trackback presents in **pending** state and on defoult permissions set is
197visible only for Manager and Owner roles. After publishing - it's visible
198for all.
199
200
201CATEGORIES
202
203  qPloneBlog can use categories to classify BlogEntries. When you edit and
204configure the Blog object, you can provide it with a list of categories that
205will present itself as a multi-selection list when you edit/create a BlogEntry.
206Next to that, BlogFolders can define additional categories.
207In BlogEntries created inside the BlogFolder, a selection can be made out of
208the categories defined in the Blog *and*, additionally, out of the ones
209defined by the BlogFolder(s) it sits in. All the categories will add up. This
210feature can be useful when the Blog is maintained by several authors. You can
211then incorporate some policy that certain Entries must be created in specific
212BlogFolders because of the additional categories. Categories you can later
213search for but you don't want exposed to all the other authors.
214
215  Next to categories defined by the Blog object and the BlogFolders, you can
216also define a set of global categories. These categories are available to all
217the BlogEntries created in the portal. Defining these global categories can
218be done in ZMI in the simpleblog_tool or in the Plone setup.
219
220  BlogEntries can be searched for in the Catalog and in Topics using
221categories. Use the EntryCategory index.
222
223
224TECHNORATI TAGS
225
226  qPloneBlog support Technorati tags if following manner: in **Tags** field
227of BlogEntry - you may point existent or add new tag(s). On the BlogEntry
228view page - you may view pointed tags. Clicking one of the BlogEntry =tag=
229bring you to page "Everything tagged =tag=", on www.technorati.com.
230
231
232TRACKBACKS
233
234  qPLoneBlog support trackback system.
235  BlogEntry can be both trackback source (BE-source) and trackback holder
236(BE-holder).
237  BE-source provide **trackback URL** and register short information about
238every BE-holder in Trackback-type objects, by adding Trackbacks to
239BE-source.
240  BE-holder add **trackback URL** of BE-sources (to field
241**sendTrackBackURLs**). On publishing BE-holder short information about it
242sends to list of **trackback URL**s.
243
244**trackback URL** - present on BlogEntry view page.
245**Trackback** object automatically creates and added in BE-source on
246publishing BE-holder.
247New created Trackback object appear in pending workflow state. Manager or
248Owner can publish or delete Trackback object.
249Trackbacks is visible only in navigation tree.
250
251It is qTrackSpam product, which provide trackback management
252(http://projects.quintagroup.com/products/wiki/qTrackSpam)
253For manage trackbacks it is 2 configlets in plone control panel:
254**BlackList importer** and **Clean TrackBacks**.
255  * **BlackList importer** - allow manage with blac list filters. Every line
256      in BlackList presents separate filter. Actually filter is regular
257      expression, which apply to **Url** field of new added trackback.
258  * **Clean TrackBacks** - is form to site wide trackbacks managements, which
259      allow you to select group of trackback(s) and publish or blacklist and
260      remove selection.
261
262
263PINGING
264
265(http://projects.quintagroup.com/products/wiki/qPingTool)
266  qPloneBlog allows ping Blog or BlogFolder to one or more ping servers.
267For pinging working - syndication should be allowed for portal in
268portal_syndiction/propertiesForm, and also should be allowed syndication for
269pingin container (Blog/BlogFolder), which can be done by go to syndication tab
270on pingin container (Blog/BlogFolder) or if it invisible - go to
271[pinging container URL]/synPropertiesForm URL. After that on pingin container
272adds **ping setup** tab, wich allow you to tune pinging and perform pinging of
273course. After perform pingign, information about pinging results appear in
274"portal message" block.
275  For add, delete pinging site(s) or change its properties - you should go to
276plone control panel to **Ping setup** and operate with Ping Info objects. This
277type object has following properties:
278    * Title ping site's name
279    * URL - ping site's URL
280    * Method_name - name of RPC method (get from ping site instructions)
281    * RSS_version - set version of RSS, which used to form result page for
282      ping site. Default - "Blog", leave default value if you don't now
283      exactly what you are doing.
284
285
286
287OTHER FEATURES
288
289  * RSS2 SUPPORT with qRSS2Syndication product
290    (http://projects.quintagroup.com/products/wiki/qRRS2Syndication)
291
292  * BLOGGER APIS
293    qPloneBlog provide 3 blogger APIs:
294      - MetaWeblog API
295      - MovableType API
296      - Blogger API
297    You need not to perform any tuning in Blog or portal - only in Blogger
298    apllication for use this possibility.
299
300  * BOOKMARKLETS
301    As was mentioned earlier, on Blog editing page, on interface shemata
302    settings you will see 5 checkboxes **Turn ... bookmarklet**, which manage
303    bookmarklets appearance on BlogEntry footer.
304
305  * GOOGLE ADSENSE
306      On Blog editing page, on interface shemata also presernt 2 checkboxes:
307    **Turn ... Adsence block** with self explanatory labels. It is important
308    to notise, that this checkboxes switches google adsense appearance in
309    **every BlogEntry of the blog**.
310      Other tuning google adsense block possibility is selection block type
311    for each top and bottom blocks. This featchure also present on interface
312    schemata
313    of Blog edit page.
314      And at last - you have to go to plone control panel, to
315    **Adsense Properties** and enter **customer Id**, got from Google.
316
Note: See TracBrowser for help on using the repository browser.