Blogging for Integrators¶
TypoScript Reference¶
This section covers all settings, which can be defined by TypoScript.
Settings (plugin.tx_blog.settings)¶
| Property | Title | Type | Default |
|---|---|---|---|
| blogUid | UID of the blog start page | int | 0 |
| categoryUid | UID of the category page | int | 0 |
| tagUid | UID of the tag page | int | 0 |
| archiveUid | UID of the archive page | int | 0 |
| authorUid | UID of the author page | int | 0 |
| storagePid | UID of the storage folder | int | 0 |
| sidebarWidgets | List of active sidebar widgets | array | see description |
| lists.posts.maximumDisplayedItems | Maximum posts to be displayed in list | int | 0 |
| lists.posts.dateFormat | The date format for post lists | string | %d.%m.%Y |
| widgets | Widget specific configuration | array | see description |
| relatedPosts.limit | Number of related posts to show | int | 5 |
| relatedPosts.categoryMultiplier | Weight of a matching category | int | 1 |
| relatedPosts.tagMultiplier | Weight of a matching tag | int | 1 |
| comments.active | Activate comments feature | int | 1 |
| comments.moderation | Activate comments moderation | int | 0 |
| comments.respectPostLanguageId | Respect language of post | int | 1 |
| comments.google_recaptcha | Activate google re-captcha | int | 0 |
| comments.google_recaptcha.website_key | website key of the re-captcha | string | |
| comments.google_recaptcha.secret_key | secret key of the re-captcha | string | |
| authors.avatar.provider | AvatarProvider specific settings | array | see description |
blogUid¶
Property
blogUid
Data type
int
Description
Define the uid of the blog start page.
categoryUid¶
Property
categoryUid
Data type
int
Description
Define the uid of the category page.
tagUid¶
Property
tagUid
Data type
int
Description
Define the uid of the tag page.
archiveUid¶
Property
archiveUid
Data type
int
Description
Define the uid of the archive page.
authorUid¶
Property
authorUid
Data type
int
Description
Define the uid of the author page.
storagePid¶
Property
storagePid
Data type
int
Description
Define the uid of the storage folder, which contains the categories and tags.
sidebarWidgets¶
Property
sidebarWidgets
Data type
array
Description
Define all active sidebar widgets and the ordering.
The default active widgets:
plugin.tx_blog.settings.sidebarWidgets {
10 = tt_content.list.20.blog_recentpostswidget
20 = tt_content.list.20.blog_categorywidget
30 = tt_content.list.20.blog_tagwidget
40 = tt_content.list.20.blog_commentswidget
50 = tt_content.list.20.blog_archivewidget
}
You can simply add and remove widgets, also pure TypoScript widgets are possible. All you need is to add the TypoScript path to this setting.
lists.posts.maximumDisplayedItems¶
Property
lists.posts.maximumDisplayedItems
Data type
int
Description
Defines how many blog posts will be displayed in lists. Default is 0, which means no limit is applied.
lists.posts.dateFormat¶
Property
lists.posts.dateFormat
Data type
string
Description
Define the date format for blog posts in lists. Default: %d.%m.%Y
widgets¶
Property
widgets
Data type
array
Description
Define widgets specific configuration. Please see the separate table Settings (plugin.tx_blog.settings.widgets).
comments.active¶
Property
comments.active
Data type
int
Description
Activate the comments feature generally. Default: 1
comments.moderation¶
Property
comments.moderation
Data type
int
Description
Activate the comments moderation feature generally. Default: 0 This means, any comment must be approved, before it is visible in the frontend.
comments.respectPostLanguageId¶
Property
comments.respectPostLanguageId
Data type
int
Description
In case of a multi language setup, the comments created in the frontend will be stored with a relation to the blog post (page) and with an relation to the current language. If this value is 0, all comments will we shown on all blog posts in each language. If this value is 1, comments will only be shown if blog post language id AND comment language id match or comment language id is -1 (which means all).
comments.google_recaptcha¶
Property
comments.google_recaptcha
Data type
int
Description
Activate the google re-captcha for the comment form. More information can be found on https://www.google.com/recaptcha/admin#list
comments.google_recaptcha.website_key¶
Property
comments.google_recaptcha.website_key
Data type
string
Description
The website key of the google re-captcha. Get this key from google: https://www.google.com/recaptcha/admin#list
comments.google_recaptcha.secret_key¶
Property
comments.google_recaptcha.secret_key
Data type
string
Description
The secret key of the google re-captcha, this is required for the validation of the captcha Get this key from google: https://www.google.com/recaptcha/admin#list
authors.avatar.provider¶
Property
authors.avatar.provider
Data type
array
Description
Define AvatarProvider specific configuration. Please see the separate table for the default GravatarProvider GravatarProvider Settings (plugin.tx_blog.settings.authors.avatar.provider). To get more info about AvatarProviders, please see the AvatarProviders section in Blogging for Administrators
Settings (plugin.tx_blog.settings.widgets)¶
| Property | Title | Type | Default |
|---|---|---|---|
| comments.limit | Limit of visible comments | int | 5 |
| comments.blogSetup | blog setup pid for this widget | int | null |
| tags.limit | Limit of visible tags | int | 20 |
| tags.minSize | Minimum size in percent | int | 100 |
| tags.maxSize | Maximum size in percent | int | 200 |
| archive.showCounter | Show count of posts | int | 1 |
| archive.groupByYear | Group by year | int | 1 |
| archive.groupByMonth | Group by month | int | 1 |
| archive.yearDateFormat | Format of the year | string | %Y |
| archive.monthDateFormat | Format of the month | string | %B |
| recentposts.limit | Maximum number of posts to be shown | int | 5 |
comments.limit¶
Property
comments.limit
Data type
int
Description
Define the limit of visible comments.
comments.blogSetup¶
Property
comments.blogSetup
Data type
int
Description
Define the blogSetup (storage pid) of blog to show comments from.
tags.limit¶
Property
tags.limit
Data type
int
Description
Define the limit of visible tags.
tags.minSize¶
Property
tags.minSize
Data type
int
Description
Define the minimum size in percent for a tag.
tags.maxSize¶
Property
tags.maxSize
Data type
int
Description
Define the maximum size in percent for a tag.
archive.showCounter¶
Property
archive.showCounter
Data type
int
Description
Define if the count of posts is visible in the links or not.
archive.groupByYear¶
Property
archive.groupByYear
Data type
int
Description
Define if the widget should show links for each year or not. This setting can be used in combination with :typoscript:`plugin.tx_blog.settings.widgets.archive.groupByMonth`
archive.groupByMonth¶
Property
archive.groupByMonth
Data type
int
Description
Define if the widget should show links for each month or not. This setting can be used in combination with :typoscript:`plugin.tx_blog.settings.widgets.archive.groupByYear`
archive.yearDateFormat¶
Property
archive.yearDateFormat
Data type
int
Description
Define the format of the year link.
archive.monthDateFormat¶
Property
archive.monthDateFormat
Data type
int
Description
Define the format of the year link.
recentposts.limit¶
Property
recentposts.limit
Data type
int
Description
Define a maximum number of posts shown in the recent posts widget. Default: 5 There is no limit if the setting is not present or set to: 0.
GravatarProvider Settings (plugin.tx_blog.settings.authors.avatar.provider)¶
| Property | Title | Type | Default |
|---|---|---|---|
| size | Size in pixel | int | 64 |
| default | Default image | string | mm |
| rating | Gravatar rating | string | g |
size¶
Property
size
Data type
int
Description
Define the size of the gravatar icon.
default¶
Property
default
Data type
string
Description
Define the default image, can be an absolute URL or one of the default gravatar icons: 404, mm, identicon, monsterid, wavatar, retro, blank
rating¶
Property
rating
Data type
string
Description
Define the gravatar rating for images: g: suitable for display on all websites with any audience type. pg: may contain rude gestures, provocatively dressed individuals, the lesser swear words, or mild violence. r: may contain such things as harsh profanity, intense violence, nudity, or hard drug use. x: may contain hardcore sexual imagery or extremely disturbing violence.