CompleteDocumentation Complete documentation for the BlogApp
02 May 2019 - 20:32
|
Version 1
|
UnknownUser
Description
...Documentation
Type Hierarchy
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
BlogEntryRenderRss
renders an item for a blog posting in an rss feed
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
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
RenderCategories
display a list of categories in the sidebar
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
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
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
RenderSideBar
sidebar for the blog app
RenderSimilarBlogEntries
display a list of related BlogEntries
Installation
...Manifest
| # | Name | Type |
|---|---|---|
| 1 | BlogEntry | TopicType, DataForm, DocuTopic, ApplicationTopic, WikiTopic |
| a posting published in a blog web | ||
| 2 | BlogEntryEditTemplate | TopicView, ApplicationTopic, WikiTopic |
| Editor for BlogEntries | ||
| 3 | BlogEntryRenderIndexItem | TopicFunction, DocuTopic, ApplicationTopic, WikiTopic |
| Render a summary for a BlogEntries | ||
| 4 | BlogEntryRenderRss | TopicFunction, DocuTopic, ApplicationTopic, WikiTopic |
| renders an item for a blog posting in an rss feed | ||
| 5 | BlogEntryViewTemplate | TopicView, ApplicationTopic, WikiTopic |
| TopicView for BlogEntries | ||
| 6 | BlogSearchViewTemplate | TopicView, ApplicationTopic, WikiTopic |
| Solr search for blogs | ||
| 7 | CategoryViewTemplate | TopicView, ApplicationTopic, WikiTopic |
| special category view for blogs | ||
| 8 | FrontPageViewTemplate | TopicView, ApplicationTopic, WikiTopic |
| 9 | PatternSkinBlogEntryViewTemplate | TopicView, ApplicationTopic, WikiTopic |
| TopicView for BlogEntries (PatternSkin variation) | ||
| 10 | PatternSkinCategoryViewTemplate | TopicView, ApplicationTopic, WikiTopic |
| TopicView for categories (PatternSkin variation) | ||
| 11 | PatternSkinCompatibilityTemplate | TopicView, ApplicationTopic, WikiTopic |
| some basic mappings into PatternSkin | ||
| 12 | PatternSkinFrontPageViewTemplate | TopicView, ApplicationTopic, WikiTopic |
| 13 | RenderArchives | TopicFunction, DocuTopic, ApplicationTopic, WikiTopic |
| display a list of months and the numbers of BlogEntries in it for the sidebar | ||
| 14 | RenderAuthorTools | TopicFunction, DocuTopic, ApplicationTopic, WikiTopic |
| tools visible to blog authors | ||
| 15 | RenderBlogEntries | TopicFunction, DocuTopic, ApplicationTopic, WikiTopic |
| Render a set of postings to leaf through | ||
| 16 | RenderBlogEntryPagination | TopicFunction, DocuTopic, ApplicationTopic, WikiTopic |
| renders a navigation to link to the prev and next posting on the timeline | ||
| 17 | RenderBlogEntryTitle | TopicFunction, DocuTopic, ApplicationTopic, WikiTopic |
| renders the heading section of a BlogEntry | ||
| 18 | RenderCategories | TopicFunction, DocuTopic, ApplicationTopic, WikiTopic |
| display a list of categories in the sidebar | ||
| 19 | RenderNumberOfComments | TopicFunction, DocuTopic, ApplicationTopic, WikiTopic |
| 20 | RenderRecentBlogEntries | TopicFunction, DocuTopic, ApplicationTopic, WikiTopic |
| display a list of recent BlogEntries for the sidebar | ||
| 21 | RenderRecentComments | TopicFunction, DocuTopic, ApplicationTopic, WikiTopic |
| display a list of recent comments in the current web | ||
| 22 | RenderRecentNews | TopicFunction, DocuTopic, ApplicationTopic, WikiTopic |
| 23 | RenderSideBar | TopicFunction, DocuTopic, ApplicationTopic, WikiTopic |
| sidebar for the blog app | ||
| 24 | RenderSimilarBlogEntries | TopicFunction, DocuTopic, ApplicationTopic, WikiTopic |
| display a list of related BlogEntries | ||
| 25 | WebHome | ApplicationTopic, WikiTopic |
| 26 | WebPreferences | WebTool, ApplicationTopic, WikiTopic |
Sitemap
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems regarding AustLII Communities? Send feedback
This website is using cookies. More info.
That's Fine