More about this Plugin
Autogenerates a blog consisting of pages with a specific category.
Administrators
No special actions required.
Note however that this plugin creates it's own help and test pages inside your wiki, for your benefit.
These pages cannot be deleted without disabeling the formatter first.
Markup Usage
What can you do?
- Generate a blog with posts for a certain category
- Set the number of posts to display
- Choose wether to use create date or last modified for post order
- Choose to display an about section
- Choose to display a cloud based on page keywords
- Choose to display an archive section
- Choose how many recent posts to list
- Choose to display a bottom section
- Choose custom layout using stylesheet and images
- 1 predefined stylesupplied in \Keeper.Garrett.Formatters\BlogFormatter\BlogStyle.css
- Choose one or more Namespaces to fetch posts from, all must have the same category
How does it work?
- Create a new page called ex. MyBlog.
- Do not makes this page, the about page or the bottom page, a member of the MyBlogCategory, if you do you will create a self refering loop, which the BlogFormatter will detect, display a warning and deny blog generation.
- Insert the Blog tag { Blog cat=MyBlogCategory } and all posts shown in the blog will be pages marked with the category MyBlogCategory.
- Default the current Namespace is used to fetch pages from.
- The keyword cloud is generated based on the keywords attached to each wiki page.
That's it! :).
The rest is purely customization of the look.
Usage:
{ Blog cat= posts= recent= usemod= cloud= archive= avatar= about= bottom= css=}
Where:
- Required:
- cat - Name of a valid category, to generate Blog from
- Optional (applies only for tables as output):
- ns - Namespace(s) to search for posts in, ex. ns=root or ns='root,ProjectX'.
- Default the current Namespace is used
- posts - No of posts to show, default 7
- recent- No of most recent posts to show, default 15
- usemod- Use last modified date instead of create date as post ordering, default false
- If false create date and create user is used for post, if true latest mod date and mod user is displayed
- avatar - Show gravatars for post creator, only works when DisplayGravatars have been enabled in the wiki configuration, default false
- This feature only really make any meaning when used with Blogs where multiple users can create posts
- cloud - Show keyword cloud, default false
- archive - Show archive (most recent blogs), default false
- about - Name of page to include and display as the about section, must be encapsulated in ' ' ex. 'MyBlogAboutMe'
- If the about page is not being shown it is most likelly because you did not supply the correct, case-sentive page name in ' '
- bottom - Name of page to include and display as the bottom section, must be encapsulated in ' ' ex. 'MyBlogBottom'
- If the bottom page is not being shown it is most likelly because you did not supply the correct, case-sentive page name in ' '
- style - Name of stylesheet to use other than the default, must be encapsulated in ' ' ex. 'MyBlogCustomStylesheet.css'
- The stylesheet must be placed in at the \Keeper.Garrett.Formatters\BlogFormatter\ folder.
- All args which have a value that contains whitespaces, must be encapsulated in ' ', ex. 'My About Page'.
Examples
Any of the following examples can be combined to generate your desired look.
A typical Blog would have the following setup:
Standard ¶
Markup:
{ Blog cat=MyBlogCat posts=7 recent=15 cloud=true archive=true about='MyAboutPage' bottom='MyBottomPage' }
Which will yeild:
- At most 7 posts displayed
- At most 15 recent posts displayed
- Posts are displayed and ordered using create date
- No Gravatars
- Cloud shown
- Archive shown
- About shown
- Bottom shown
- No custom stylesheet
Standard Draw From Another Namespace Than The Current ¶
Markup:
{ Blog cat=MyBlogCat ns=ProjectX posts=7 recent=15 cloud=true archive=true about='MyAboutPage' bottom='MyBottomPage' }
Which will yeild:
- In this Namespace posts will be fetched from Namespace 'ProjectX'
- At most 7 posts displayed
- At most 15 recent posts displayed
- Posts are displayed and ordered using create date
- No Gravatars
- Cloud shown
- Archive shown
- About shown
- Bottom shown
- No custom stylesheet
Standard Draw From Several Namespaces Other Than The Current ¶
Markup:
{ Blog cat=MyBlogCat ns='ProjectX,ProjectY' posts=7 recent=15 cloud=true archive=true about='MyAboutPage' bottom='MyBottomPage' }
Which will yeild:
- In this Namespace posts will be fetched from Namespaces 'ProjectX' and 'ProjectY'
- At most 7 posts displayed
- At most 15 recent posts displayed
- Posts are displayed and ordered using create date
- No Gravatars
- Cloud shown
- Archive shown
- About shown
- Bottom shown
- No custom stylesheet
Default
Markup:
{ Blog cat=MyBlogCategory }
Result:
- At most 7 posts displayed
- No recent posts displayed
- Posts are displayed and ordered using create date
- No Gravatars
- No Cloud
- No Archive
- No About
- No Bottom
- No custom stylesheet
Max No Of Posts To Show
Markup:
{ Blog cat=MyBlogCategory posts=3 }
Result:
- At most 3 posts displayed
- No recent posts displayed
- Posts are displayed and ordered using create date
- No Gravatars
- No Cloud
- No Archive
- No About
- No Bottom
- No custom stylesheet
Max No Of Most Recent Posts To Show
Markup:
{ Blog cat=MyBlogCategory recent=3 archive=true }
Result:
- At most 7 posts displayed
- At most 3 posts displayed
- Posts are displayed and ordered using create date
- No Gravatars
- No Cloud
- Archive shown
- No About
- No Bottom
- No custom stylesheet
Use Modified Date+User To Display And Order Posts ¶
Markup:
{ Blog cat=MyBlogCategory usemod=true }
Result:
- At most 7 posts displayed
- No recent posts displayed
- Posts are displayed and ordered using modified date + last mod user
- No Gravatars
- No Cloud
- No Archive
- No About
- No Bottom
- No custom stylesheet
Show Gravatars
Markup:
{ Blog cat=MyBlogCategory avatar=true }
Result:
- At most 7 posts displayed
- No recent posts displayed
- Posts are displayed and ordered using create date
- Gravatars are shown
- No Cloud
- No Archive
- No About
- No Bottom
- No custom stylesheet
Show Keyword Cloud
Markup:
{ Blog cat=MyBlogCategory cloud=true }
Result:
- At most 7 posts displayed
- No recent posts displayed
- Posts are displayed and ordered using create date
- No Gravatars
- Cloud shown
- No Archive
- No About
- No Bottom
- No custom stylesheet
Show Archive
Markup:
{ Blog cat=MyBlogCategory archive=true }
Result:
- At most 7 posts displayed
- At most 15 posts displayed
- Posts are displayed and ordered using create date
- No Gravatars
- No Cloud
- Archive shown
- No About
- No Bottom
- No custom stylesheet
Show About Section
Markup:
{ Blog cat=MyBlogCategory about='AboutPage' }
Result:
- At most 7 posts displayed
- No recent posts displayed
- Posts are displayed and ordered using create date
- No Gravatars
- No Cloud
- No Archive
- About shown using the wiki page 'AboutPage'
- No Bottom
- No custom stylesheet
Show Bottom Section
Markup:
{ Blog cat=MyBlogCategory bottom='BottomPage' }
Result:
- At most 7 posts displayed
- No recent posts displayed
- Posts are displayed and ordered using create date
- No Gravatars
- No Cloud
- No Archive
- No About
- Bottom shown using the wiki page 'BottomPage'
- No custom stylesheet
Use Custom Stylesheet
Markup:
{ Blog cat=MyBlogCategory style='MyStyleSheet.css') }
Result:
- At most 7 posts displayed
- No recent posts displayed
- Posts are displayed and ordered using create date
- No Gravatars
- No Cloud
- No Archive
- No About
- No Bottom
- Custom stylesheet 'MyStyleSheet.css' placed in /Keeper.Garrett.Formatter/BlogFormatter is used for layout and design of the blog
About styling
To create a custom stylesheet examine the supplied BlogDefault.css stylesheet placed in /Keeper.Garrett.Formatter/BlogFormatter.
This file contains all the nessasary div's tags etc to create your own style.
Discuss
No Messages for this Page. Be the first!