Thursday, April 11, 2013

Feature of the week: Add CSL styled publication lists to your TYPO3 webpages

TYPO3 is, along with Drupal, Joomla and Wordpress, among the most popular content management systems worldwide, (although it is most widespread in Europe). Due to its features, scalability and maturity, TYPO3 is used by to build and manage websites of different types and size ranges, from small sites for individuals or nonprofit organizations to multilingual enterprise solutions for large corporations or universities (read more @Wikipedia).

In past we had built an very rudimentary BibSonomy extension for TYPO3, which is not longer supported by TYPO3 v6 and is not further developed by us. But we are proud to present to you the new BibSonomy CSL (ext_bibsonomy_csl) extension, based on TYPO3 Flow.

With our new Extension BibSonomy CSL you can add a list of publications from BibSonomy to your pages. You can style your bibliography with CSL Stylesheets (Citation Style Language). For this you can choose from a set of pre-installed styles, or you can choose a custom style from the web. Additional you have the option to add your BibSonomy tag cloud to your website.

Installation

To install BibSonomy CSL, log into your TYPO3 installation as an administrator and search in the Extension Manager => Import Extensions for ext_bibsonomy_csl and import them.



After import is finished the extension will be shown in the section "Available Extensions". Press the + symbol for installation.



Add publication lists with Frontend Plugin

Now you can create a new page in the usual way. If you create a new content record you find in plugins section two new entries: Bibsonomy Publication List and Bibsonomy Tag Cloud.

Choose Bibsonomy Publications List to add a list of publications. In "General" tab insert a headline for your list.

In tab Plugin you can setup your publication list. You can choose between user, group or viewable to select the content from BibSonomy. Detailed information about the scheme you can find at http://www.bibsonomy.org/help_en/URL%20Scheme%20Semantics.

Ok, let's go through an example: Assume, you wanna publish your own publications in a blog post (and in BibSonomy all own publications are tagged with myown). Choose user as content source type and enter your BibSonomy user name as content type value (in this example we've choosed the user dbenz). Now you have to filter your selection by using the tag myown. For this, enter myown in the input field for tags. If you want to select more than one tag you have to separate them by a space character. Optionally, you can limit the number of publications.

There is also the possibility to filter the content by using freetext search field.  

Warning: Be aware, that you are using your own account to retrieve the posts from BibSonomy. That means, that all posts, that are visible to you in BibSonomy (your private ones too), will be made visible on your oage, if they fit the description in the plugin record. (In our example: all posts you have tagged with myown.)

In the subtab Layout you can choose one of the (pre-)installed citation styles to layout your publication list. If your desired CSL style isn't contained in the default selection, then you can insert a custom style, by entering the XML code of the stylesheet. The Citation Style Language (CSL) is an open XML-based language to describe the formatting of citations and bibliographies. A large list of freely available styles can be found on http://www.zotero.org/styles/.


In the third subtab 'Login' you have to enter your BibSonomy API credentials. For this you need your username and your API key.

Add your BibSonomy Tag Cloud with Frontend Plugin

Choose Bibsonomy Tag Cloud as plugin while creating new record. Typically, a tag cloud will be placed in the sidebar. So you can choose the right or left content area for inserting.
For tag cloud content you can also choose between user, group or viewable to select the content from BibSonomy. Assume you want to add your personal BibSonomy tag cloud choose user as content type and insert your username for content type value. In subtab Login you have to enter again your API credentials.


Manage your CSL styles with the Backend Plugin

Typo3 extensions are divided into Frontend Plugins and Backend Modules. The both frontend plugins Bibsonomy Publication List and Bibsonomy Tag Cloud, I've already presented. To manage your Citation Stylesheets you can use the Backend Module CSL Styles.

By default there are a lot of styles pre-installed. To add your own custom styles, create a new folder 'CSL Styles' in the page tree. Choose CSL Styles in menu sidebar and select the Folder CSL Styles in page tree. An empty page with two buttons will be shown. Click on Create New Style to add a custom style.

There are three ways to add a new Citation Style
  1. Direct input: Enter the XML source of your style in the text area and press Save to add the style
  2. Import from URL: Enter the URL of an Citation Style file and press Import 
  3. Upload CSL file: Select a CSL XML file from your filesystem and press Upload

Now you can take a preview of your new style: Click on Show Styles.

To delete styles click on the paper trash icon, left of the style.
I hope this introduction was helpful. 

Happy tagging,
Sebastian!

Popular Posts