Community Central
Don't have an account?
Register
Register
Community Central
Community Central
35,367
pages
in: Extensions, Extensions under development, Help

Changes: Help:Blogs/Bloglist

< Help:Blogs
Back to page
Sign in to edit
No edit summary
No edit summary
Line 1: Line 1:
  +
{{new feature}}
⚫
The '''bloglist''' feature allows you to embed a blog listing within a normal wiki article. It's like a blog listing page to go, and uses the <code><nowiki><bloglist></nowiki></code> extension.
  
  +
{{beta}}
  +
{{tocright}}
  ⚫
The '''bloglist''' feature from [[Help:Blog article|blog articles]] allows you to embed a blog listing within a normal wiki article. It's like a blog listing page to go, and uses the <code><nowiki><bloglist></nowiki></code> extension.
   
−
There are a number of parameters you can define to format the embedded list to fit within different content pages - e.g. the main page, the community portal, a contest page, etc. - and it is extremely customizable.
 +
There are a number of parameters you can define to format the embedded list to fit within different content pages - e.g. the main page, the community portal, a contest page, etc. In addition, it is extremely customizable.
   
 
==Basic form==
  
==Basic form==
Line 7: Line 10:
   
 
<pre>
  
<pre>
−
<bloglist parameter1=setting1 p2=s2 p3=s3 p4=s4>
 +
<bloglist parameter1=setting1 parameter2="setting with spaces" p3=s3 p4=s4>
−
<category>Cat1</category>
 +
<category>Category1</category>
−
<category>Cat2</category>
 +
<category>Category2</category>
−
<author>Wikian1</author>
 +
<author>Author1</author>
−
<author>Wikian2</author>
 +
<author>Author2</author>
 
</bloglist>
  
</bloglist>
 
</pre>
  
</pre>
   
  +
===Categories and authors===
 
Note how the category and author sections are written differently to other inputs - this is because they can take multiple inputs.
  
Note how the category and author sections are written differently to other inputs - this is because they can take multiple inputs.
   
−
Using author and category together gives you posts by the selected authors from the selected categories.
 +
In addition, using author and category together gives you posts by the selected authors from the selected categories.
   
  +
==Valid extension inputs==
−
==Inputs==
  
 
;category
  
;category
  +
:This specifies which categories posts are pulled from.
−
:This is "or" selector - i.e. give it several categories, and it will collate posts from each category together. Defaults to all categories (even uncategorized posts).
 +
:It is an "or" selector - i.e. give it several categories, and it will collate posts from each category together. If unspecified, it defaults to show all categories (even uncategorized posts).
 
:To use it type:
  
:To use it type:
 
<pre>
  
<pre>
Line 30: Line 35:
   
 
;author
  
;author
  +
:This specifies which authors posts are collated from.
−
:This is "or" selector - i.e. give it several authors, and it will collate posts from each author together. Defaults to all authors.
 +
:It is an "or" selector - i.e. give it several authors, and it will collate posts from each author together. If unspecified, it defaults to all authors.
 
:To use it type:
  
:To use it type:
 
<pre>
  
<pre>
Line 39: Line 45:
   
 
;count
  
;count
−
:This is the number of posts shown. Takes a number (integer) input. Defaults to 5.
 +
:This specifies the number of posts shown.
  +
:Takes a number (integer) input. If unspecified, it defaults to 5.
 
:For example: <code><bloglist count=3></code>
  
:For example: <code><bloglist count=3></code>
   
 
;summary
  
;summary
−
:Whether a section of the blog post is shown on the listing. Boolean, defaults to false. If true, shows first 200 characters.
 +
:This specifies whether a section of the blog post is shown on the listing.
  +
:Inputs are <code>true</code> or <code>false</code>, defaulting to false. If true, it shows first 200 characters of the blog post.
 
:For example: <code><bloglist summary=true></code>
  
:For example: <code><bloglist summary=true></code>
   
 
;summarylength
  
;summarylength
−
:Allows you to specify length of the text quoted in characters, if summary=true.
 +
:This allows you to specify length of the text quoted in characters, if <code>summary=true</code>.
 
:For example: <code><bloglist summary=true summarylength=300></code>
  
:For example: <code><bloglist summary=true summarylength=300></code>
   
 
;type
  
;type
−
:Choose the output style - either box or plain. Defaults to box. Plain is just the content, without box styling.
 +
:Choose the general output style.
  +
:Inputs are either <code>box</code> or </code>plain. If unspecified, it defaults to box. Plain is just the content, without any box styling.
 
:For example: <code><bloglist type=plain></code>
  
:For example: <code><bloglist type=plain></code>
   
Line 59: Line 68:
   
 
;style
  
;style
−
:This allows the addition of extra style parameters for the listing, and works like normal CSS styling. Defaults to nothing.
 +
:This allows the addition of extra style parameters for the listing, and works like normal CSS styling.
  +
:If unspecified, it defaults to blank.
 
:For example :<code><bloglist style="float:right;clear:left;"></code>
 
:For example :<code><bloglist style="float:right;clear:left;"></code>
   
 
;order
  
;order
−
:How the post are sorted. Inputs are date, author. Defaults to date.
 +
:This specifies how the post are sorted.
  +
:Inputs are <code>date</code> or <code>author</code>. If unspecified, it defaults to date.
 
:For example :<code><bloglist order=date></code>
 
:For example :<code><bloglist order=date></code>
   
 
;ordertype
  
;ordertype
−
:What direction to sort in. Inputs are descending, ascending. Defaults to descending.
 +
:This specifies what direction to sort in.
  +
:Inputs are <code>descending</code>, <code>ascending</code>. If unspecified, it defaults to descending.
 
:For example :<code><bloglist ordertype=descending></code>
 
:For example :<code><bloglist ordertype=descending></code>
   
 
;timestamp
  
;timestamp
−
:Whether a timestamp is shown. Boolean, defaults to false.
 +
:This specifies whether a timestamp is shown.
  +
:Inputs are <code>true</code> or <code>false</code>. If unspecified, it defaults to false.
 
:For example :<code><bloglist timestamp=true></code>
 
:For example :<code><bloglist timestamp=true></code>
   
 
<!--
  
<!--
 
;comments
  
;comments
−
:Whether comments are shown. Boolean, defaults to false.
 +
:This specifies whether comments are shown.
  +
:Inputs are <code>true</code> or <code>false</code>. If unspecified, it defaults to false.
 
:For example :<code><bloglist comments=true></code>
 
:For example :<code><bloglist comments=true></code>
 
-->
  
-->

Revision as of 17:48, 5 December 2008

Template:New feature

This feature or extension is currently under development - it may be in beta testing on specific communities, but may not be widely available for some time.

The bloglist feature from blog articles allows you to embed a blog listing within a normal wiki article. It's like a blog listing page to go, and uses the <bloglist> extension.

There are a number of parameters you can define to format the embedded list to fit within different content pages - e.g. the main page, the community portal, a contest page, etc. In addition, it is extremely customizable.

Basic form[]

The basic form of the extension is as following: 

<bloglist parameter1=setting1 parameter2="setting with spaces" p3=s3 p4=s4>
<category>Category1</category>
<category>Category2</category>
<author>Author1</author>
<author>Author2</author>
</bloglist>

Categories and authors[]

Note how the category and author sections are written differently to other inputs - this is because they can take multiple inputs.

In addition, using author and category together gives you posts by the selected authors from the selected categories.

Valid extension inputs[]

category
This specifies which categories posts are pulled from.
It is an "or" selector - i.e. give it several categories, and it will collate posts from each category together. If unspecified, it defaults to show all categories (even uncategorized posts).
To use it type:
<author>Category1</author>
<author>Category2</author>
<author>Category3</author>
author
This specifies which authors posts are collated from.
It is an "or" selector - i.e. give it several authors, and it will collate posts from each author together. If unspecified, it defaults to all authors.
To use it type:
<category>Author1</category>
<category>Author2</category>
<category>Author3</category>
count
This specifies the number of posts shown.
Takes a number (integer) input. If unspecified, it defaults to 5.
For example:

Other notes[]

  • If no valid posts are found, the following message will be displayed: "No posts found. Write one!"
Community content is available under CC-BY-SA unless otherwise noted.