BlogAddOn < System

You are here: Foswiki>System Web>BlogAddOn (19 Feb 2011, ProjectContributor) (raw view)EditAttach
---+!! Blog !AddOn
<div class="foswikiNotification">
Note: release 1.6 and onwards works on Foswiki 1.2 and newer. %BR%
When upgrading, make sure not to overwrite any existing topic !BlogCategory.
</div>
%SHORTDESCRIPTION%.

%TOC%

---++ Screenshots
<p>Example list view:</p>
<div class="foswikiImage"><img src="%ATTACHURLPATH%/screenshot_list.png" alt="screenshot_list.png" width='795' height='518' /></div>
<p>Example post:</p>
<div class="foswikiImage"><img src="%ATTACHURLPATH%/screenshot_post.png" alt="screenshot_post.png" width='795' height='518' /></div> 

---++ Features
   * Integrates blog posts with Foswiki topics.
   * Uses editable categories to filter or group posts. Categories can also be used to distinguish multiple blogs with separate 'owners'.
   * Offers tags to further filter blog posts.
   * Offers comments and options to hide or close comments.
   * Provides a handy interface with sorting and filtering options that can be INCLUDEd in any topic in the same Web.
   * Optionally displays user pictures; see [[#AddOnSettings][Settings]] below


#WorkingWith
---++ Working with !BlogAddOn
<div class="foswikiHelp">
To update the instructions on this page to point to your blog web, enter the name of the blog web:%BR%
<form name="doc" action="%SCRIPTURL{view}%/%WEB%/%TOPIC%#WorkingWith" method="get">
<input type="text" name="blogWeb" value="Blog" class="foswikiInputField" />&nbsp;<input type="submit" value="Update" class="foswikiButton" />
</form>
</div>
Once you have copied the topics from _BlogAddOn (temporary) web to %URLPARAM{"blogWeb" default="the web you want the blog to appear"}%:
   * Visit %URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPost for the overview of blog posts
   * Visit %URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPostCreator to create new blog entries
   * Visit %URLPARAM{"blogWeb" default="yourblogweb"}%.BlogCategories to edit the categories

---+++ Putting the blog post list in a different topic
To put the overview in a topic, write:
<pre class="tml">
%<nop>INCLUDE{"%URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPost"}%
</pre>

This will show all posts, grouped (paginated) by 10, the most recent first.

It will also include the filter and sort options above the blog posts.

#ListDisplayOptions
---++++ List display options
Use =display="posts"= to show the blog posts *without filter/short dropdown controls* (but with author/category/tag filters):
<pre class="tml">
%<nop>INCLUDE{
"%URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPost"
display="posts"
}%
</pre>

Use =display="list"= to show *only the posts*, without filter/sort dropdown controls and without author/category/tag filters.
<pre class="tml">
%<nop>INCLUDE{
"%URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPost"
display="list"
}%
</pre>
NOTE: because author/category/tag filters are not displayed, users will not be able to remove filtering. Use this display variant only in specific places.

---++++ Summary options
Use parameter =outline= to control the contents of the summary text. Possible values:

%TABLE{sort="off" headeralign="left"}%
| *Value*              | *Will show*  |
| =formfield(Summary)= (default) | Contents of form field Summary. If the field does not exist or is empty, =summary(200)= is used instead. |
| =summary=            | Topic summary, just the plain text, all formatting and line breaks removed; up to 162 characters. You can use other notations for =summary=, such as =summary(n)= and =summary(n, noheader)= - see %SYSTEMWEB%.FormattedSearch. |
| =text=               | The full topic text. |


Example
<pre class="tml">
%<nop>INCLUDE{
"%URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPost"
display="posts"
outline="summary(450, noheader)"
}%
</pre>

---++++ Images in list view
Each post can show these images:
   * author picture: if setting =BLOGADDON_AUTHOR_PICTURE_FIELD= points to a form field in the user profile that contains the name of an attached file - see Settings below
   * summary picture: if the blog post has a value for form field =<nop>SummaryImage= that contains the name of an attached file
   * commenter picture: see author picture
   
You can define the sizes with these INCLUDE settings (values in pixels):
%TABLE{sort="off" headeralign="left"}%
| *Name*              | *Default value*  |
| =picsizeauthor=     | =50= |
| =picsizesummary=    | =85= | 
| =picsizecommenter=  | =20= |

For example:
<pre class="tml">
%<nop>INCLUDE{
"%URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPost"
picsizeauthor="30"
}%
</pre>


---++++ Create button
To add the *"Create a new post" button*, write:
<pre class="tml">
%<nop>INCLUDE{
"%URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPost"
section="createButton"
}%
</pre>
Set a different button label with param =label=:
<pre class="tml">
%<nop>INCLUDE{
"%URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPost"
section="createButton"
label="Write up!"
}%
</pre>


---++++ Filtering and sorting options
You may set display defaults, for example for category and sort field, using  additional parameters. Possible values are:

%TABLE{sort="off" headeralign="left"}%
| *Parameter* | *Possible values*  | *Default value*  |
| =category=   |%SEARCH{"   *\s*.*?" topic="BlogCategory" web="%URLPARAM{"blogWeb" default="yourblogweb"}%" type="regex" multiple="on" casesensitive="on" nonoise="on" separator=", " format="=$pattern(.*   \*\s*([^\n]*).*)="}% (categories are defined in %URLPARAM{"blogWeb" default="yourblogweb"}%.BlogCategory) | none |
| =tag=       | Any tag (set in each blog post, comma separated) | none |
| =sort=     | =formfield(Title)=, =formfield(Category)=, =formfield(Author)=, =formfield(<nop>PublishingDate)=, =modified=  | =created= (fallback) |
| =sortdirection=   | =ascending=, =descending=  | =ascending=, when sorting on dates: =descending= |
| =pagesize=     | How many posts are displayed per screen; can be any number  | =10= |

<div class="foswikiNotification">
If you are upgrading from a previous version (before 1.6.0), and your blog posts do not have the form field =<nop>PublishingDate=, set =sort= to =created= or =modified=:
<pre class="tml">
%<nop>INCLUDE{
"%URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPost"
sort="created"
}%
</pre>
</div>

---+++++ Showing the latests post, 15 posts per screen
To show the latest posts (date defined by form field =PublishingDate=), latest post on top (is the default setting), 15 per screen, write:
<pre class="tml">
%<nop>INCLUDE{
"%URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPost"
sort="formfield(PublishingDate)"
pagesize="15"
}%
</pre>

---+++++ Showing blog posts in 1 category

To show a list of blog posts in category "Interesting", write:
<pre>
%<nop>INCLUDE{
"%URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPost"
sort="formfield(PublishingDate)"
category="Interesting"
}%
</pre>


---+++ Creating filter links

You may want to have a list of links that lead to a filtered blog post list. For instance, the link named "Interesting" would lead to a list of blog posts of that category.

Here's how:
<pre>
<span class='foswikiUnvisited'>%<nop>SEARCH{"   *\s*.*?" topic="BlogCategory" web="%URLPARAM{"blogWeb" default="yourblogweb"}%" type="regex" multiple="on" casesensitive="on" nonoise="on" format="&lt;a href='%<nop>SCRIPTURL{view}%/%URLPARAM{"blogWeb" default="yourblogweb"}%/BlogPost?sort=created;pagesize=10;sortdirection=descending;category=$pattern(.*   \*\s*([^\n]*).*)'>$pattern(.*   \*\s*([^\n]*).*)&lt;/a>"}%</span>
</pre>

%IF{"defined blogWeb and $'blogWeb'!=''" then="This creates:%BR%
<span class='foswikiUnvisited'>$percntSEARCH{$quot   *\s*.*?$quot topic=$quotBlogCategory$quot web=$quot%URLPARAM{"blogWeb" default="yourblogweb"}%$quot type=$quotregex$quot multiple=$quoton$quot casesensitive=$quoton$quot nonoise=$quoton$quot format=$quot<a href='%SCRIPTURL{view}%/%URLPARAM{"blogWeb" default="yourblogweb"}%/BlogPost?sort=created;pagesize=10;sortdirection=descending;category=$pattern(.*   \*\s*([^\n]*).*)'>$pattern(.*   \*\s*([^\n]*).*)</a>$quot}$percnt"}%</span>

#AddOnSettings
---++ Settings

   * To show user pictures:
      * In WebPreferences or %USERSWEB%.SitePreferences: point preference setting =BLOGADDON_AUTHOR_PICTURE_FIELD= to the field name of the user topic that contains the filename of the user picture. For example, for !PersonalInfoAddOn that field is named "Picture", so you would write: %BR%
      <pre class="tml">   * Set BLOGADDON_AUTHOR_PICTURE_FIELD = Picture</pre>
   * To use a different list topic (default is %URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPost):
      * In WebPreferences or %USERSWEB%.SitePreferences, or in the list topic itself, write: %BR%
      <pre class="tml">   * Set BLOGADDON_LIST_TOPIC = %URLPARAM{"blogWeb" default="yourblogweb"}%.thelisttopic</pre>
      * Note: if you wish to use the topic macro, write =BASETOPIC= instead of =TOPIC=; do not forget to add the Web. This is correct: =Set BLOGADDON_LIST_TOPIC = %<nop>BASEWEB%.%<nop>BASETOPIC%=
   * To let comments be posted to a different Web:
      * In WebPreferences or %USERSWEB%.SitePreferences: point preference setting =BLOGADDON_COMMENTS_WEB= to the Web you want to get comments. By default this is the %URLPARAM{"blogWeb" default="current"}% Web.%BR%
      For example:%BR%
      <pre class="tml">   * Set BLOGADDON_COMMENTS_WEB = <nop>Comments</pre>
   * To hide comments for a user or all members of a group:
      * In WebPreferences or %USERSWEB%.SitePreferences, or in the list topic itself, write: %BR%
      <pre class="tml">   * Set BLOGADDON_HIDE_COMMENTS = <nop>WikiName or <nop>GroupName</pre>
      * Note that you cannot add multiple names or groups, only one user or group name.
      * To hide all comments and comment box from not logged-in users, use: %BR%
      <pre class="tml">   * Set BLOGADDON_HIDE_COMMENTS = <nop>WikiGuest</pre>
   * To disallow a user or all members of a group to give comments:
      * In WebPreferences or %USERSWEB%.SitePreferences, or in the list topic itself, write: %BR%
      <pre class="tml">   * Set BLOGADDON_DENY_COMMENTING = <nop>WikiName or <nop>GroupName</pre>
      * Note that you cannot add multiple names or groups, only one user or group name.
      * To show existing comments, but hide the comment box from not logged-in users, use: %BR%
      <pre class="tml">   * Set BLOGADDON_DENY_COMMENTING = <nop>WikiGuest</pre>
   * =BLOGADDON_ALLOW_GUEST_COMMENTS= - to allow guest comments. Experimental feature.

<!--
   * Set SHORTDESCRIPTION = A simple weblog application based on Data Forms
-->
      
---++ Installation Instructions
<div class="foswikiNotification">
Note: release 1.6 and onwards works on Foswiki 1.2 and newer. %BR%
When upgrading, make sure not to overwrite any existing topic !BlogCategory.
</div>
   * Download the ZIP file from the Plugin web (see below)
   * Unzip ==%TOPIC%.zip== in your ($FOSWIKI_ROOT) directory.
   * Copy the topics from =/data/_BlogAddOn= to %URLPARAM{"blogWeb" default="the web you want the blog to appear"}%
   * Alternatively,
      * Manually resolve the dependencies listed below.
      <table class="foswikiTable" border="1"><tr><th>Name</th><th>Version</th><th>Description</th></tr><tr><td align="left">Foswiki::Plugins::ZonePlugin</td><td align="left">&gt;=3.1</td><td align="left">Required. required for Foswiki < 1.1</td></tr><tr><td align="left">Foswiki::Plugins::CommentPlugin</td><td align="left">&gt;=6512</td><td align="left">Required</td></tr><tr><td align="left">Foswiki::Plugins::SpreadSheetPlugin</td><td align="left">&gt;=1</td><td align="left">Required</td></tr></table>

#AdminReference
---++ Reference for administrators
<div class="foswikiHelp">
To update the instructions on this page to point to your blog web, enter the name of the blog web:%BR%
<form name="doc" action="%SCRIPTURL{view}%/%WEB%/%TOPIC%#AdminReference" method="get">
<input type="text" name="blogWeb" value="Blog" class="foswikiInputField" />&nbsp;<input type="submit" value="Update" class="foswikiButton" />
</form>
</div>
   * %URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPost - overview of all posts with filtering and sorting options
   * %URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPostCreator - form to start new posts
   * %URLPARAM{"blogWeb" default="yourblogweb"}%.BlogCategory - editable list of blog categories
   * %URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPostForm - form definition with post data fields
   * %URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPostTemplate - every new post gets settings from this topic
   * %URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPostViewTemplate - every post is displayed through this view template
   * %URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPostCommentTemplate - form template for comment box (see %SYSTEMWEB%.CommentPlugin)
   * %URLPARAM{"blogWeb" default="yourblogweb"}%.BlogRss - RSS feed topic with filters for category, tags and author
   * %URLPARAM{"blogWeb" default="yourblogweb"}%.BlogPostExample - example blog post; delete when everything works

*Note:* Care must be taken when:
   * Renaming post topics: the comment topic needs to be renamed as well
      * The comment topic is created automatically when the first comment is submitted, using the syntax =topic name= + =Comment=.
   * Renaming categories: the comment topics are not updated automatically
   
   
---++ !AddOn Info

|  Authors: | Foswiki:Main.ArthurClemens |
|  Copyright &copy;: | 2006-2011 Arthur Clemens |
|  License: | [[http://www.gnu.org/copyleft/gpl.html][GPL]] |
|  Dependencies: | <table class="foswikiTable" border="1"><tr><th>Name</th><th>Version</th><th>Description</th></tr><tr><td align="left">Foswiki::Plugins::ZonePlugin</td><td align="left">&gt;=3.1</td><td align="left">Required. required for Foswiki < 1.1</td></tr><tr><td align="left">Foswiki::Plugins::CommentPlugin</td><td align="left">&gt;=6512</td><td align="left">Required</td></tr><tr><td align="left">Foswiki::Plugins::SpreadSheetPlugin</td><td align="left">&gt;=1</td><td align="left">Required</td></tr></table> |
|  Version: | 10818 (2011-02-27) |
|  Release: | 1.9.1 |
|  Change&nbsp;History: | <!-- specify latest version first -->&nbsp; |
|  31 May 2011 | 1.9.1 Encodes quotes in displayed summary text. |
|  26 Feb 2011 | 1.9.0 Added setting =outline= to control the summary text. Added form field !SummmaryImage to choose the attachment name to be displayed in the summary. Improved display of comments in list view. Added options to define image sizes. | 
|  24 Feb 2011 | 1.8.0 Added settings =BLOGADDON_HIDE_COMMENTS= and =BLOGADDON_DENY_COMMENTING=. Foswikitask:Item10407 - now saves comments to the correct web if =BLOGADDON_COMMENTS_WEB= is set. Fixes tag links in blog post.  |
|  24 Feb 2011 | 1.7.0 Fixed sorting on dates. Added =INCLUDE= param =display= instead of =section=. Added setting =BLOGADDON_COMMENTS_WEB=. Documentation update. Foswikitask:Item10378 - make sure the existing value of Category field is not lost. |
|  19 Feb 2011 | 1.6.0 Re-arranged sort and filter options to fit on smaller screens. Improved filter interaction for categories, tags and authors. Moved documentation from !BlogAddOnHome to !BlogAddOn (this topic) and updated documentation. Added setting =BLOGADDON_LIST_TOPIC=. Changed =BLOGPOSTADDON_AUTHOR_PICTURE_FIELD= to =BLOGADDON_AUTHOR_PICTURE_FIELD=. |
|  13 Feb 2011 | 1.5.1 Simplified disply of author pictures: now use preference setting =BLOGPOSTADDON_AUTHOR_PICTURE_FIELD=. Added options to close or hide comments, publishing date, tags and a blog specific rss feed. |
|  06 Oct 2010 | 1.4 Foswikitask:Item9804 - Fix dependencies file and packaging issues on Foswiki 1.1 |
|  10 Jan 2009 | 1.3 Foswiki release |
|  07 Apr 2008 | 1.2 Added optional inclusion of author pictures from Foswiki:Extensions/PersonalInfoAddOn. *Important upgrade notice:* this version uses =WIKINAME= instead of  =WIKIUSERNAME= in the =Author= form field. This change is not compatible with existing blog topics. If you have existing posts, you must change all author names from =Main.<nop>UserName= to =<nop>UserName=. |
|  26 Jan 2008 | 1.1 Adds the creation date to blog post topic names. Adds an Edit link to the Comments header in a blog post. Increases the height of the comment box. Bug fix: allow topic names with periods. |
|  26 Jun 2007 | 1.0.9 Fixed html bug in !BlogPost; added comment count to !BlogPost; improved styling of form elements. |
|  08 Apr 2007 | 1.0.8 Show link to latest comment in !BlogPost listing. Improved readability for comments. This version relies on CommentPlugin svn release number 13313 and PatternSkin svn release number 13320, but !BlogAddOn will now play nicely with other skins as well. | 
|  06 Feb 2007 | 1.0.7 Added no-javascript fallback to !BlogPost and !BlogPostCreator (so that topic can actually be created without javascript). Fixed a javascript bug that was introduced when a Core function was renamed. |
|  25 Feb 2007 | 1.0.6 URL param for limit setting now overrides INCLUDE parameter. |
|  25 Feb 2007 | 1.0.5 Prevents recreation/overwriting of existing topics. Added "No limit" label to filter dropdown. |
|  15 Feb 2007 | 1.0.4 Removed my name from the templates. |
|  16 Dec 2006 | 1.0.3 The comment topic will automatically be created as child topic of the blog post. Changed parameter =reverse= to =sortdirection=.  |
|  15 Dec 2006 | 1.0.2 RSS feed link to category filter, fixes to sorting/filtering.  |
|  14 Dec 2006 | 1.0.1 Option to set defaults when including !BlogPost.  |
|  12 Dec 2006 | 1.0 First release.  |
|  Home: | http://foswiki.org/Extensions/%TOPIC% |
|  Feedback: | http://foswiki.org/Extensions/%TOPIC%Dev |
|  Support: | http://foswiki.org/Support/%TOPIC% |

<!-- %JQREQUIRE{"chili"}% -->
Topic attachments
I	Attachment	Action	Size	Date	Who
png	icon_tag_delete_btn.png	manage	3.0 K	18 Feb 2011 - 00:02	UnknownUser
png	screenshot_list.png	manage	90.1 K	07 Oct 2010 - 05:00	UnknownUser
png	screenshot_post.png	manage	50.7 K	07 Oct 2010 - 05:00	UnknownUser
gif	silhouette.gif	manage	1.1 K	01 Nov 2008 - 19:45	UnknownUser
Topic revision: r1 - 19 Feb 2011, ProjectContributor
System
Webs
Cosmo
Main
Sandbox
System
Copyright © CC-BY-SA by the contributing authors. All material on this collaboration platform is copyrighted under CC-BY-SA by the contributing authors unless otherwise noted.
Ideas, requests, problems regarding Foswiki? Send feedback