QBFreak.net·TWiki·BlogUp
...discover TWiki details, and how to start your own site.
Search: 
Logon | Register | Print

Navigation

Main

Blog

Programs

Sandbox

Users

System

BlogUp: a twiki based weblog setup

Note: The BlogUp application is part of the BlogPlugin.

Introduction

BlogUp is a TWikiApplication addon package that turns TWiki into a weblog tool. In combination with the NatSkin it offers the look & feel of well known blogging tools like MovableType or WordPress but embedded into a full-fledged wiki.

The main features are:

  • single- or multi-author blogging
  • one-click easy publishing and correction of postings and comments
  • extensible tagging system
  • tagged news aggregation
  • semin-automatic computation of "related" postings
  • threaded comment system
  • full content syndication
  • flexible archiving and retrieval
  • tag statistics
  • completely form-based TWikiApplication using the TWikiWorkbench approach

Planned features:

  • selective syndication: only postings, postings+comments, syndication per posting
  • optional email subscription for comments
  • posting series: parts, followups, redux, ...
  • blog pages: non-chronological tagged content
  • integrating TrackBack and PingBack

Screenshots

%IMAGEGALLERY%

Getting started

TODO

User Manual

TODO The BlogUp TWikiApplication is made up of tree levels that are of use depending on the role of the visitor.
  1. application level: that's the view a normal visitor gets on the site
  2. blog author level: grant access to tools needed to post a blog entry or add new SubjectCategories?
  3. administrative level: grant access to TopicFunctions that render the site

Roles are assigned using TWikiGroups, i.e. the BlogAuthorGroup and the BlogAdminGroup. Each blog is contained in one web; one blog can be a multi-author or single-author blog. A multi-author blog will display authorship per posting, not so a single-author blog.

Exploring the blog

TODO

Publishing a new blog entry

TODO

Adding a new SubjectCategory?

TODO

Aggregating news

TODO

Commenting

TODO

Implementation

The BlogUp is implemented using the TWikiWorkbench approach consisting (at least) of a set of TopicTypes, TopicFunctions, TWikiForms and TopicTemplates that are used to implement the application.

TopicTypes

Each topic is typed using TWikiForms, that is TWikiForms define TopicTypes. A TopicType form has a token and a free-form TopicDescription? that describes the purpose of an instance of that type.

In general a TopicType is made up of three parts:

  1. the TopicType topic named XXX
  2. the TWikiForm topic named XXXForm
  3. the TopicTemplate topic named XXXTemplate

The XXX TopicType topic lists an overview of all topics of the given type and a form to create a new one.

Name Description
AdminTool TopicType for topics on the administrative level
BlogAuthor TopicType used in BlogEntryForm to collect all BlogEntries of one author
BlogComment TopicType for user comments
BlogEntry TopicType to create blog entries
BlogLink TopicType that links to another news or blog site.
BlogPage TopicType of a tagged TWikiTopic
FrontPage TopicType of pages that display a (sub)set of BlogEntries
SubjectCategory TopicType and TWikiFormAttribute that describes BlogEntry categories
TWikiForm TopicType of TWiki.TWikiForms
TWikiFormAttribute TopicType for an attribute description of a TWikiForm
TWikiTopic TopicType of a normal TWiki topic
TopicFunction TopicType of topics to be called by a (parameterized) INCLUDE or DBCALL
TopicTemplate TopicType used to create topics of the associated type
TopicType TopicType of all possible TopicTypes in the _BlogPlugin web
TopicView TopicType of topics that implement a TMPL template to view topics

TopicFunctions

TopicFunctions are the basic building blocks that are used to render the application. TopicFunctions are divided into sections that are extracted using parametrized INCLUDEs. (Note, that the BlogPlugin does not use INCLUDE or SEARCH but DBCALL and DBQUERY provided by the DBCachePlugin.) Thereby TopicFunctions are "called" as functions in a library are called to be executed. Every TopicFunction is named RenderXXX where XXX describes the output generated by it. A TopicFunction is also documenting itself and its parameters.

Name Description
RenderAddComment Render a form to post a BlogComment
RenderAdminTools Sidebar for the Users.BlogAdminGroup
RenderArchives Render a list of all months that have postings.
RenderAtom Render rss an feed
RenderAuthorTools Render buttons visible if the user is a blog author
RenderAuthors Render the list of BlogAuthors in the sidebar
RenderBlogArchive Renders the BlogArchive
RenderBlogArchiveCat Renders the BlogArchive in CAT mode
RenderBlogArchiveChron Renders the BlogArchive in CHRON mode
RenderBlogArchiveHitList Render the search result in the BlogArchive
RenderBlogArchiveLex Renders the BlogArchive in CAT mode
RenderBlogArchiveTag Renders the BlogArchive in TAG mode
RenderBlogAuthorSwitch Switch of the blogAuthor css class when this blog is single-authored
RenderBlogComment Render a single BlogComment
RenderBlogComments Renders all comments of a BlogEntry
RenderBlogEntriesInCategory Renders a set of BlogEntry teasers in a SubjectCategory
RenderBlogEntriesOfAuthor Render all BlogEntries of a BlogAuthor as teaser.
RenderBlogEntry Render a single BlogEntry
RenderBlogLink Renders a BlogLink
RenderBlogLinksInCategory Render list of all BlogLinks of a given SubjectCategory
RenderBlogPage Render the header of a BlogPage
RenderBlogRoll Render the list of BlogLinks in the sidebar
RenderBlogTeaser Render a teaser for a BlogEntry
RenderCategories Render the list of SubjectCategories in the sidebar
RenderDocNavigation Render a double linked list to previous and next documents
RenderFrontPage Render a set of BlogEntries
RenderFrontTeaser Render a set of teasers where the first n are rendered verbosly
RenderFullTeaser Render a BlogEntry for a FrontPage
RenderFunctionCallers Render a list of topics that use a given TopicFunction
RenderHttpEquivs Render a set of links to alternative formats for the current html page
RenderNewBlogEntryButton Renders button to create a new BlogEntry
RenderNewBlogLinkButton Renders button to create a new BlogLink
RenderNewBlogPageButton Renders a button to create a new BlogPage
RenderNewCategoryButton Renders button to create a new SubjectCategory
RenderNewTWikiTopicButton Renders a button to create a new TWikiTopic
RenderNewTopicTypeForm Renders a form that allows generate a new topic of the given type
RenderNextCommentNr Compute the next comment nr given a current BlogEntry or BlogComment
RenderPageNavigation Render a navigation to previous/next blog entries on the FrontPage
RenderPages Renders a list of BlogPages put into the sidebar
RenderRecentComments Render the list of recent comments in the WebSideBar
RenderRecentPostings Render the list of recent postings in the WebSideBar
RenderRelatedEntries Render a list of related BlogEntries for the BlogEntry sidebar
RenderRss Render rss an feed
RenderSideBar Render the sidebar navigation
RenderSubComments Render all BlogComments recursively
RenderTWikiFormList Renders a list of TWikiForms that use a given TWikiFormAttribute
RenderTopicList Implements a formatted metadatasearch
RenderTopicSummary Render a topic summary for a search hit
RenderTopicTypes Render list of TopicTypes
RenderUnpublishedBlogEntries Render a list of BlogEntries that are not yet published
RenderValidateButton Render a button to validate the html of the page that it is on
RenderVisitors Render the visitors for the sidebar
RenderWebChanges Replacement for TWiki's default WebChanges

TWikiForms

TODO

Name Description
BlogAuthorForm TWikiForm for BlogAuthors
BlogCommentForm TWikiForm for BlogComments
BlogEntryForm TWikiForm for BlogEntries
BlogLinkForm TWikiForm for NewsFeeds
BlogPageForm TWikiForm for BlogPages
SubjectCategoryForm TWikiForm for SubjectCategories
TopicForm TWikiForm attached to general TWikiTopics

TopicTemplates

TODO

Name Description
AdminToolTemplate Template to create an AdminTool
BlogAuthorTemplate Template to create BlogAuthors
BlogCommentTemplate Template for BlogComments
BlogEntryTemplate Template to create BlogEntries
BlogLinkTemplate Template to create an BlogLink
BlogPageTemplate Template to create BlogPages
SubjectCategoryTemplate Template to create SubjectCategories
TWikiFormAttributeTemplate Template to create TWikiFormAttributes
TWikiFormTemplate Template to create TWikiForm topics
TopicFunctionTemplate Template to create TopicFunctions
TopicTemplateTemplate Template to create a TopicTemplate
TopicTypeTemplate Template to create TopicTypes
TopicViewTemplate Template to create TopicViews
WebTopicEditTemplate Generic template for topics in the _BlogPlugin web

Customization

TODO

See also: BlogPlugin, BlogUp template web

Application Info

Author: TWiki:Main/MichaelDaum
Copyright ©: 2006, Michael Daum
License: GPL (GNU General Public License)
Version: v0.47
Dependencies: BlogPlugin
Change History: (see also the change history of the BlogPlugin)
24 Jan 2006: Initial version
Demo: http://jojowiki.dyndns.org/view/Blog/WebHome
Home: TWiki:Plugins/BlogUp
Feedback: TWiki:Plugins/BlogPlugin
Appraisal: TWiki:Plugins/BlogPluginAppraisal

-- TWiki:Main/MichaelDaum - 08 Feb 2006

r2 - 21 Mar 2006 - 02:36 - TWikiAdminGroup
  Attachment Action Size Date Who Comment
jpg BlogPluginSnap11.jpg props, move 93.0 K 21 Mar 2006 - 02:36 TWikiAdminGroup Saved by install script
jpg BlogPluginSnap8.jpg props, move 108.5 K 21 Mar 2006 - 02:36 TWikiAdminGroup Saved by install script
jpg BlogPluginSnap6.jpg props, move 20.6 K 21 Mar 2006 - 02:36 TWikiAdminGroup Saved by install script
jpg BlogPluginSnap12.jpg props, move 67.7 K 21 Mar 2006 - 02:36 TWikiAdminGroup Saved by install script
jpg BlogPluginSnap9.jpg props, move 45.1 K 21 Mar 2006 - 02:36 TWikiAdminGroup Saved by install script
jpg BlogPluginSnap7.jpg props, move 100.3 K 21 Mar 2006 - 02:36 TWikiAdminGroup Saved by install script
jpg BlogPluginSnap14.jpg props, move 52.5 K 21 Mar 2006 - 02:36 TWikiAdminGroup Saved by install script
jpg BlogPluginSnap4.jpg props, move 80.0 K 21 Mar 2006 - 02:36 TWikiAdminGroup Saved by install script
jpg BlogPluginSnap2.jpg props, move 151.6 K 21 Mar 2006 - 02:36 TWikiAdminGroup Saved by install script
jpg BlogPluginSnap13.jpg props, move 108.8 K 21 Mar 2006 - 02:36 TWikiAdminGroup Saved by install script
jpg BlogPluginSnap5.jpg props, move 94.3 K 21 Mar 2006 - 02:36 TWikiAdminGroup Saved by install script
jpg BlogPluginSnap1.jpg props, move 121.1 K 21 Mar 2006 - 02:36 TWikiAdminGroup Saved by install script
jpg BlogPluginSnap3.jpg props, move 26.8 K 21 Mar 2006 - 02:36 TWikiAdminGroup Saved by install script
jpg BlogPluginSnap10.jpg props, move 73.6 K 21 Mar 2006 - 02:36 TWikiAdminGroup Saved by install script
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding QBFreak.net? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.BlogUp
Powered by TWiki/Dakar Wed, 08 Feb 2006 build 8740
Syndicate this site RSSATOM