Difference between revisions of "Manual:Extension/Blog"

<bs:bookshelf src="Book:User manual" />
        
        
        
        __TOC__
        
        
        
        ==What is Blog?==
        
        
        
        ''' Blog''' extension allows creating news feeds on the wiki. These news feeds can be shown on any page, and users can be allowed to add their own news.
        
        
        
        ==Blog by default==
        
        
        
        By default, there is a link to the Blog page in the TopMenuBar, which then opens the blog, a page containing a form for writing a new blog entry and a list of previous entries.
        
        
        
        
        
        ::: [[File:Blg1.jpg|500x304px]]
        
        
        
        
        
        
        
        ===Display Blog on any wiki page===
        
        
        
        
        
        This blog news feed can be displayed on any wiki page by adding the blog tag to the page.
        
        
        
        
        
        ::: [[File:Blg2.jpg|500x309px]]
        
        
        
        
        
        ::: [[File:Blg3.jpg|500x308px]]
        
        
        
        
        
        ::: [[File:Blg4.jpg|500x309px]]
        
        
        
        
        
        ::: [[File:Blg5.jpg|500x306px]]
        
        
        
        
        
        This also displays a  "Create new blog entry"-form on the page, unless it is disabled to use blog tag [[Extensions/Blog#Blog tags|attributes]].
        
        
        
        A blog entry consists of a title, revision information (date and author of first revision), the entry itself and possibly links for comments and a permalink.<br /><br />If a blog entry is too long, the link "continue reading" is displayed.
        
        
        
        
        
        ==Blog tags==
        
        
        
        Blog extension offers several tags. These tags can be added to a page using InsertMagic functionality, or writing tag syntax directly to wiki code editor.
        
        
        
        {| class="contenttable" border="0" cellspacing="0" cellpadding="0"
        
        |-
        
        !|'''Wiki tag'''
        
        !|'''Description'''
        
        |-
        
        ||<nowiki><bs:blog /></nowiki>
        
        ||Displays blog news feed on the page. It can be extended with multiple attributes. For more on attubutes read section "Blog tag attibutes" below.
        
        |-
        
        ||<nowiki><bs:blog:more /></nowiki>
        
        ||This tag should be placed inside the content of a blog entry (pages in Blog namespace) to define at which point in text "continue reading" link should be placed. This will override default cut-off length of an entry.
        
        |-
        
        ||<nowiki><bs:blog:time time="YYYYMMDDHHmm" /></nowiki>
        
        ||
        
        This tag also should be placed inside the content of a blog entry. It allows manually defining timestamp for that particular blog entry. Timestamp is used in sorting and displaying blog entries.
        
        
        
        |}
        
        
        
        ===Write an entry or create a new entry===
        
        
        
        New blog entries can be created through the form on the page containing a blog tag, on Blog special page (Special:Blog), or by directly creating new pages in the Blog namespace.
        
        
        
        ===Creating a second blog===
        
        
        
        As described the default blog feed consists of "normal" wiki pages stored in the Blog namespace. Other blog feeds can exist in addition to this feed, and they can be defined by category.<br />For example, the category "Company news" can be designated for a second blog. In that case all pages in this category will be considered entries of this blog and will be displayed on page as blog entries. By adding  <nowiki><bs:blog /></nowiki> tag to the page, attribute "cat" must be set to "Company news"  like  <nowiki><bs:blog cat="Company news" /></nowiki>
        
        
        
        Another option is to designate a namespace for this purpose. Using example from above, namespace "Company news" must be created and all pages inside this namespace (Company news:News1, Company news:News2) will be considered blog entries.  The syntax that should be used for the blog tag in this case is: <nowiki><bs:blog ns="Company news" /></nowiki><br /><br />Keep in mind that when blog tags with "cat"  or "ns" are used, all pages from that category/namespace will be shown, so those categories/namespaces should be used for that purpose only.
        
        
        
        ===<nowiki><bs:blog /></nowiki> attributes===
        
        
        
        The following tag arguments can be used with the tag <nowiki><bs:blog /></nowiki>:
        
        
        
        {| class="contenttable" style="width: 784px; height: 297px;" border="0"
        
        |-
        
        !|'''Attribute'''
        
        !|'''Description'''
        
        !|Value
        
        |-
        
        ||count
        
        ||Number of blog entries to be displayed.
        
        ||number
        
        |-
        
        ||cat
        
        ||Category from which to show pages as blog entries
        
        ||category name
        
        |-
        
        ||ns
        
        ||Namespace from which to show pages as blog entries
        
        ||namespace name or ID
        
        |-
        
        ||newentryfield
        
        ||Should "Create new blog entry" be shown?
        
        ||0 or 1
        
        |-
        
        ||newentryfieldposition
        
        ||Position of the "Create new blog entry" form.
        
        ||"bottom" or "top"
        
        |-
        
        ||renderimages
        
        ||Should images be displayed
        
        ||0 or 1
        
        |-
        
        ||maxchars
        
        ||Number of characters that should be shown before the "Continue reading" link is shown.
        
        ||number
        
        |}
        
        
        
        Default values for these attributes for the whole wiki can be set in the global BlueSpice preferences. See [https://en.helpwiki.bluespice.com/wiki/Blog Reference page.]
        
        
        
        ==Tips for working with blogs==
        
        
        
        Put a link to the blog in the left hand navigation menu. Then your colleagues will be able to find the blog whenever they want.
        
        
        
        ==See also==
        
        Our [[Blog|reference page.]]