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