CompleteDocumentation
Complete documentation for the BlogApp

02 May 2019 - 20:32 | Version 1 |

Description

...

Documentation

Type Hierarchy

G BlogEntry Blog Entry SeoTopic SeoTopic SeoTopic->BlogEntry CategorizedTopic CategorizedTopic Category Category CategorizedTopic->Category ClassifiedTopic ClassifiedTopic CategorizedTopic->ClassifiedTopic WikiTopic WikiTopic WikiTopic->CategorizedTopic TaggedTopic TaggedTopic WikiTopic->TaggedTopic ClassifiedTopic->SeoTopic TaggedTopic->ClassifiedTopic

TopicType

Blog Entry

a posting published in a blog web
This is the central TopicType to store blog entries. See also

TopicFunction

BlogEntryRenderIndexItem

Render a summary for a BlogEntries
This method is called by RenderCategory to display a summary for an object of type ClassifiedTopic.

Parameters
  • OBJECT
  • THEICON

... read more

BlogEntryRenderRss

renders an item for a blog posting in an rss feed

Parameters
  • OBJECT

... read more

RenderArchives

display a list of months and the numbers of BlogEntries in it for the sidebar
TODO

Parameters
  • CAT: render archive links in this Category (optional)
  • THEWEB: web to read blog entries, default: BASEWEB

... read more

RenderAuthorTools

tools visible to blog authors
TODO

Parameters
  • NONE

... read more

RenderBlogEntries

Render a set of postings to leaf through
This TopicFunction displays a collection of BlogEntries within the given CATegory and/or TAG.

Parameters
  • SKIP: offset into the archive
  • LIMIT: number of postings to show at max
  • CAT: categories to extract (optional)
  • TAG: tagged entries to be extracted (optional)
  • STICKY: a pattern the Sticky field must match to list the posting see the "Sticky" definition in Blog Entry (optional)
  • NOSTICKY: same as STICKY but with inverse logic
  • FROM_TIME: lower boundary of timespan to display in epoch seconds
  • TO_TIME: uppwer boundary of timespan to display in epoch seconds
  • ONLYTEASER: switch "on" to just render the teaser section; defaults to rendering the full posting ... read more

RenderBlogEntryPagination

renders a navigation to link to the prev and next posting on the timeline

Parameters
  • CLASS: to be added to the container
  • THEWEB: web to search for blog entries, default BASEWEB ... read more

RenderBlogEntryTitle

renders the heading section of a Blog Entry

Parameters
  • THETOPIC, defaults to BASEWEB.BASETOPIC
  • TITLE_EXTRA
  • SHOWREVINFO: boolean flag to switch on/off revinfo

... read more

RenderCategories

display a list of categories in the sidebar
TODO

Parameters
  • CAT: top category whose subcategories are displayed, defaults to TOP

... read more

RenderNumberOfComments

Parameters
  • THETOPIC to display the counts for
  • COMMENTSYSTEM

... read more

RenderRecentBlogEntries

display a list of recent BlogEntries for the sidebar
TODO

Parameters
  • LIMIT: maximal number of BlogEntries to list
  • CAT: optionally render restrict list to this category
  • THEWEB: blog web, defaults to BASEWEB

... read more

RenderRecentComments

display a list of recent comments in the current web
This function is used to render a section in a sidebar listing the recent comments last month limitted to a max of 10 by default. To fetch the list of most recent comments there are two implementations below: one using DBQUERY and METACOMMENT and the other using SOLRSEARCH. The latter is used automatically when SolrPlugin is installed.

Parameters
  • LIMIT: max number of comments to show
  • CAT: retrieve recent comments on BlogEntries in that category
  • MONTHS: age of comments to display by number of months, defaults to 1

... read more

RenderRecentNews

This function renders a list of recent BlogEntries in the given web. Only published postings will be rendered as well as those not tagged "blogonly". Each posting's teaser will be extracted.

See also:

Parameters
  • SKIP: number of items to skip, default 0
  • LIMIT: number of items to show, default 4
  • THEWEB: web holding blog entries, default Blog
  • CAT: categories to extract (optional)
  • TAG: tagged entries to be extracted (optional)
  • SHOWREVINFO: on/off, default on

... read more

RenderSideBar

sidebar for the blog app
TODO

Parameters
  • SIDEBAR: kind of sidebar to display

... read more

RenderSimilarBlogEntries

display a list of related BlogEntries
This needs Foswiki:Extensions/SolrPlugin

Parameters
  • NONE

... read more

Installation

...

Manifest

#Sorted ascending Name Type
  a posting published in a blog web
  Editor for BlogEntries
  Render a summary for a BlogEntries
  renders an item for a blog posting in an rss feed
  TopicView for BlogEntries
  Solr search for blogs
  special category view for blogs
   
  TopicView for BlogEntries (PatternSkin variation)
  TopicView for categories (PatternSkin variation)
  some basic mappings into PatternSkin
   
  display a list of months and the numbers of BlogEntries in it for the sidebar
  tools visible to blog authors
  Render a set of postings to leaf through
  renders a navigation to link to the prev and next posting on the timeline
  renders the heading section of a BlogEntry
  display a list of categories in the sidebar
   
  display a list of recent BlogEntries for the sidebar
  display a list of recent comments in the current web
   
  sidebar for the blog app
  display a list of related BlogEntries
   
   
1 BlogEntry TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic
2 BlogEntryEditTemplate TopicView, ApplicationTopic, WikiTopic
3 BlogEntryRenderIndexItem TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
4 BlogEntryRenderRss TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
5 BlogEntryViewTemplate TopicView, ApplicationTopic, WikiTopic
6 BlogSearchViewTemplate TopicView, ApplicationTopic, WikiTopic
7 CategoryViewTemplate TopicView, ApplicationTopic, WikiTopic
8 FrontPageViewTemplate TopicView, ApplicationTopic, WikiTopic
9 PatternSkinBlogEntryViewTemplate TopicView, ApplicationTopic, WikiTopic
10 PatternSkinCategoryViewTemplate TopicView, ApplicationTopic, WikiTopic
11 PatternSkinCompatibilityTemplate TopicView, ApplicationTopic, WikiTopic
12 PatternSkinFrontPageViewTemplate TopicView, ApplicationTopic, WikiTopic
13 RenderArchives TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
14 RenderAuthorTools TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
15 RenderBlogEntries TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
16 RenderBlogEntryPagination TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
17 RenderBlogEntryTitle TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
18 RenderCategories TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
19 RenderNumberOfComments TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
20 RenderRecentBlogEntries TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
21 RenderRecentComments TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
22 RenderRecentNews TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
23 RenderSideBar TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
24 RenderSimilarBlogEntries TopicFunction, DocuTopic, ApplicationTopic, WikiTopic
25 WebHome ApplicationTopic, WikiTopic
26 WebPreferences WebTool, ApplicationTopic, WikiTopic