EXT: Sixpack-4-T3¶

What does it do?¶

This extension provides a new Typo3 content element which displays a publication lists. Such publication lists are useful in research facilities such as universities or research institutes. Sixpack-4-T3 allows to extract

• *Publications of 1 person:* The single-person-view is useful for personal homepages. A member of a research facility can extract his/her publications directly from the database
• *Publications of a set of persons:* That view can be used to extract all publications of the members of a research group or a department.
• *The output of the entire database.* This full view is used to provide a full overview about the scientific outcome of the entire research facility.

The extension Sixpack-4-T3 provides a content element to output the query results. In the backend form of this content element the author can choose between several visualization options, such as

• *View mode:* Choose between Author View , Department View , or Full View
• *Show/Hide abstracts:* If abstracts are given the author can decide whether they are printed or not.
• *Include unpublished work:* Sixpack-4-T3 offers handling also unpublished work. Unpublished work refers to publications marked as ' unpublished ', ' submitted ', or ' accepted '. This feature is particularily interesting for the personal homepages ( Author View )
• *Navigation bars:* In case of a huge set of publications Sixpack-4-T3 provides two navigation bars to split up the content into smaller pieces: (a) the year navigation bar and (b) the page navigation bar. The year navigation bar splits up the results into pages with 1 page per year. The page navigation bar can subdivide the output even further. The author can specify the maximum number of publications to be shown on one page.

Sixpack-4-T3 is based on the bibliography and reference manager SIXPACK ( http://sourceforge.net/projects/sixpack/ ). The extension is based on an interface to BibTeX. Hence, Sixpack-4-T3 offers all bibliography types which come with BibTeX.

Screenshots¶

The following screenshot is taken from the web page http://www.mpie.de . The first line is the year navigation bar whereas the second line subdivides the content as a page navigation bar. The content is organized into sections for each bibliography type.

The following screenshot demonstrates how the visualization modes can be easily controlled in the backend form of the content element:

The Sixpack-4-T3 extension offers also an intuitive frontend editor in order to manipulate the database entries. The following example demonstrates how the frontend editor functionalities of Typo3 have been extended to this extension:

Every entry can be manipulated in the frontend editor of Sixpack-4-T3. Also new entries can be comfortably added to the database. The editor offers a preview functionality:

Mode¶

Show Abstracts¶

Include¶

Items per page (0=all)¶

Split up years¶

Split up bibliography types¶

Add debug information¶

Export BibTeX¶

If your web page administrator has been added data to the database already you should be able to see some content elements similar to the first screenshot now. Otherwise the output is empty. The following section contains information how to add entries to the publication database.

The Sixpack-4-T3 frontend editor¶

Controlling the output¶

The generated output can be controlled in the content element input mask in the backend interface of Typo3. Hence, please proceed to the backend interface and edit the page content, namely the Sixpack-4-T3 plugin.

In this section all input fields of the above input form are explained in detail:

Doe, J.

Baggins, B; Baggins, F; Gamgee, S.

Installation¶

The extension Sixpack-4-T3 can be installed as all Typo3 extension. As administrator go to the Ext Manager module and Import extensions from online repository . Download Sixpack-4-T3 (extension key is sixpack ).

Storage Concepts¶

Before the extension can be used, the administrator should create a storage page on which the publication records are stored. Alternatively, the publications can also be saved on seperate pages (e.g., on the member's homepages). However, it is discouraged to apply this way of storing data as it is possible to create doubled entries: Assuming two members of the staff have written a shared publication. Both members would add the same publication on their homepages, respectively. In this case this publication would be stored twice! In order to solve this problem it is recommended to save the publictions on a single storage page. Only a limited set of people should have writing permissions to this page.

The following steps are based on this storage approach.

Preparations¶

As administrator create a storage page anywhere in your page tree. The actual position does not matter. The storage page can be created as follows:

Create a new empty page

Click on Edit Page Header

Change the page type to SysFolder

Choose a proper page name, such as “Publications”.

Note the page id (PID). It is written in the top of the form. That PID will be needed later.

Save page and Exit

Grant users access to the frontend editor of Sixpack-4-T3¶

Normally, the content element Publication List is a print-only feature. However, the administrator can grant writing permissions to the database and editor privileges to certain backend users. In order to do so a new backend user group has to be created:

Enter the backend module List

Click on your web site logo (usually to top node of the page tree)

Create a new backend group, and call it for example “Sixpack Editor”.

Note the group id (GID) of the newly created backend user group. It will be needed later.

Add all users which should get writing permissions to this backend group.

Enter the backend module Template

Select the page carrying the typoscript template

In the constant editor choose the section “PLUGIN.Sixpack”

Enter the backend GID in the field BE gid .

Backend users which have been added to the “Sixpack Editor” group are now able to access the frontend editor of Sixpack-4-T3. They can add new publication records and edit them.

Importing publication data¶

If many items have to be entered into the database it might be more convencient to import them from another data source. A simple way to accomplish such an data import is the usage of SIXPACK. SIXPACK is a free bibliography and reference manager and can be downloaded from http://sourceforge.net/projects/sixpack/ . SIXPACK supports the most important bibliography file formats such as

• BibTeX
• refer / BibIX
• EndNote
• tib
• Procite
• RFC1807/1357
• text
• CS Tech Report
• Inspec “Doc Type”
• MEDLINE, Entrez
• Melvyl
• (old) IEEE catalog
• Powell's

Using SIXPACK datasets can be exported in the SIXPACK file format *.bref. A converter bref->sql is shipped with this extension. The conversion can be done in the following steps

Figure out the PID of the storage page(Module Page , Click on the storage page, Edit Page Header , PID is given in the first line of the form)

Copy the converter from TYPO3ROOT/typo3conf/ext/sixpack/scripts/bref2sql(cp TYPO3ROOT/typo3conf/ext/sixpack/scripts/bref2sql ~)

Make it executable(chmod u+rx ~/brefsql)

Edit the converter and modify the variable $pid. Assuming that the PID of your storage page is 1415 the code reads:...my $pid = 1415;...

Convert bref to SQL(cat filename.bref | ~/brefsql > ~/sixpack.sql)

Import the SQL datamysql -u root -p> source ~/sixpack.sql

Check the imported data in the List module of Typo3. See section Edit existing publications .

TypoScript¶

As a web portal usually has a corporate design certain output modes should be controlled globally by the administrator. To do so, Sixpack-4-T3 can be finetuned in the page template. As administrator go to the page template

Module Template

Click on the page that keeps the template

Choose the Constant Editor

Go to the category PLUGIN.SIXPACK .

Customizing the output / Modifying the BibTeX Style¶

The actual output can be controlled in the template file which can be specified in the TypoScript. Copy the original file, e.g., EXT:sixpack/sample_templates/plain.html and edit it according to your wishes. Specify the new location in the template:

Copy the original template file somewhere to your fileadmin foldercp typo3conf/ext/sixpack/sample_templates/plain.html fileadmin/mybibstyle.html

Edit the page template (Backend module Template)

Register the new path “fileadmin” (Template -> Constant Editor -> PLUGIN.Sixpack -> Path to template files)

Specify the filename of the new file (Template -> Constant Editor -> PLUGIN.Sixpack -> template file)

In your own copy of the template file (e.g. fileadmin/mybibstyle.html) you can now start to customize the output. This file is nothing but an ordinary html file except that the dynamic content is replacing certain markers. The file is the following structure:

Only text between <!-- ###SIXPACK### begin --> and <!-- ###SIXPACK### end --> is considered

The part between <!-- ###HAS_YEARNAVI### begin --> and <!-- ###HAS_YEARNAVI### end --> defines how the year navigation bar looks like (if it is activated)

The part between <!-- ###HAS_PAGENAVI### begin --> and <!-- ###HAS_PAGENAVI### end --> corresponds to the page navigation bar (if it is activated)

The dynamic part (section title and publication records) can be found between the markers <!-- ###ITEMS### begin --> and <!-- ###ITEMS### end -->

If the output is organized in sections according to bibtex types the section header can be controlled using the part between <!-- ###ITEM_TITLE### start --> and <!-- ###ITEM_TITLE### start -->

The actual publication records are placed within the markers <!-- ###BIBTYPE### begin --> and <!-- ###BIBTYPE### end -->, where BIBTYPE is the BibTeX type of the given record. The markers to describe an article whould hence read <!-- ###ARTICLE### begin --> and <!-- ###ARTICLE### end --> whereas those of a book would be <!-- ###BOOK### begin --> and <!-- ###BOOK### end -->. A list of all markers can be found below.

The BibTeX content is replacing makers with the same BibTeX names, i.e., ###AUTHOR### replaces the author entry, ###VOLUME### the volume, ###BOOKTITLE### the book title and so on.

It is posible to check whether the BibTeX content exists at all. Imagine for example the BibTeX style plain for the type Book: It is “[###AUTHOR###]. [###TITLE###] , volume [###VOLUME###] or [###SERIES###], ... In case of the Lord of the Rings it would be “Tolkin, J.R.R.. The Lord of the Rings , volume 1 of 3, ...”. The problem now is what would happen if no series would be given in the database? In this case the volume string would read “volume 1 of”. Thus, the extension should offer a possibility to check whether an BibTeX entry is empty or not. The solution is to place such “critical” items in <!-- ###HAS_*### begin --> and <!-- ###HAS_*### end --> markers. A better solution would now read

<!-- ###HAS_SERIES### begin -->of ###SERIES###, <!-- ###HAS_SERIES### -- end -->

In the following table all supported markers are listed:

Languages¶

The extension is currently available in English.

Reference (TypoScript)¶