DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: BibTex publication¶

Author:	Kasper Skårhøj
Created:	2002-11-01T00:32:00
Changed by:	Walter Karlen
Changed:	2010-03-19T10:16:15
Classification:	si_bibtex
Description:	The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ----
Keywords:	BibTex, import
Author:	Walter Karlen
Email:	walter.karlen@gmail.com
Info 4:
Language:	en

EXT: BibTex publication - si_bibtex

EXT: BibTex publication¶

Extension Key: si_bibtex

Language: en

Keywords: BibTex, import

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.org

Table of Contents¶

EXT: BibTex publication 1

`Introduction 3 <#1.1.Introduction|outline>`_

What does it do? 3

Screenshots 3

`Users manual 4 <#1.2.Users%20manual|outline>`_

How to upload a BibTex file 4

FAQ 4

`Administration 5 <#1.3.Administration|outline>`_

Setting up the plugin (Installation) 5

`Configuration 6 <#2.1.Configuration|outline>`_

Frontend Plugin Configuration 6

TS Reference 6

HTML Template configuration 7

`Tutorial 9 <#8.1.Tutorial|outline>`_

`Known problems 10 <#8.2.Known%20problems|outline>`_

`To-Do list 11 <#8.3.To-Do%20list|outline>`_

`ChangeLog 12 <#8.4.ChangeLog|outline>`_

Introduction¶

What does it do?¶

“BibTex Publications” allows you to import Bibtex files from the front-end and store them in a sysfolder. The front-end plug-in generates list and single views of entries and provides a simple search tool. It allows also the automatic import of BibTex files that were for example exported from Mendeley or JabRef. BibTex files that are containing all database entries and individual entries are also generated for front-end download. OpenURL COinS (ContextObjects in Spans) reference objects for easy export of the BibTex reference entries to Mendeley or Zotero are generated as well. PDF files can be added to the entries in the back-end and downloaded in the front-end.

Screenshots¶

llustration 1: Font-end form for BibTex upload.

llustration 2: Example of the front-end publication list with group sorting and display of sorting list

Users manual¶

How to upload a BibTex file¶

Navigate to the page where the import plug-in is installed.
Browse for your BibTex file. Be sure the file has mime-type “text/x-bibtex”
Upload.

FAQ¶

Q:I get an error message “ERROR: Sorry, that's not a BibTeX file. Can't work with that file! Please ...”

A:Most probably, the plug-in did not recognize the correct mime-type of the file you wanted to upload. The mime-type should be “text/x-bibtex”. Some browser do not support this mime-type by default (e.g. Opera). If you get the error message, add manually the “text/x-bibtex” mime-type in the browser settings .

Administration¶

Setting up the plug-in (Installation)¶

Create a sysfolder for storing the records.
Create a new page for showing the records.
Create a new content element on this page by choosing “Insert plug-in” and then “BibTex Publications”
On the general setting sheet, choose what the plug-in should show in the front-end (What to show?): List, Search or Import. If you choose Import make sure to restrict access to the page or the content element to a special front-end user group that you trust. You may want to create a new group for this purpose.
On the same sheet for Database, select the previously created sysfolder.
Configure the plug-in with the features on the other sheets (List View, Import, and Template). For configuration details, please see section Configuration.
Add static template si_bibtex or set TS if required (see Configuration).

Configuration¶

front-end plug-in Configuration¶

Currently there are four flexform sheets for configuration of the front-end plug-in.

General Settings¶

What to show?¶

Property

What to show?

Description

Select what to show in front-end: list, search, or import

Database¶

Property

Database

Description

Link to sysfolder with BibTex database

recursive¶

Property

recursive

Description

List View¶

Order by¶

Property

Order by

Description

Select criteria to use for sorting list

Direction¶

Property

Direction

Description

Sorting order?

Show BibTex download link¶

Property

Show BibTex download link

Description

Adds a global BibTex file download link to the list

Add COinS (easy export)?¶

Property

Add COinS (easy export)?

Description

Embeds a CoinS for each entry on the webpage

Display Browser Results?¶

Property

Display Browser Results?

Description

Show Sort Links?¶

Property

Show Sort Links?

Description

front-end user can select sorting

Group the listed entries?¶

Property

Group the listed entries?

Description

Grouped list view

Lock list to APA style?¶

Property

Lock list to APA style?

Description

Enforce APA style for list view

Highlight Search?¶

Property

Highlight Search?

Description

Sets search words in bold

Import¶

Prevent from importing duplicates¶

Property

Prevent from importing duplicates

Description

Enable duplicate check

Template¶

templateFile¶

Property

templateFile

Description

Locate or upload a template file

TS Reference¶

See also the static TS file for examples (pi1/static/setup.txt).

templateFile¶

Property

templateFile

Data type

resource

Description

The HTML-template. Find example at pi1/templates.html in the ext/si_bibtex folder.

You can define a template either in your TS setup or in the content element.

Example:

plug-in.tx\_sibibtex {

templateFile = fileadmin/my\_templates/sibibtex\_template.html

}

pidList¶

Property

pidList

Data type

Description

recursive¶

Property

recursive

Data type

Description

results_at_a_time¶

Property

results_at_a_time

Data type

int

Description

Maximum number of results to show in list view

maxPages¶

Property

maxPages

Data type

int

Description

Maximum number of browsing pages

pagefloat¶

Property

pagefloat

Data type

e.g. CENTER

Description

Position of list table

sword¶

Property

sword

Data type

IEEE,transactions

Description

Do a search by default, useful for displaying only publications from one author. For faster results, set 'searchFieldList' to 'author' only. Comma separated list will be combined with AND

searchFieldList¶

Property

searchFieldList

Data type

author,abstract

Description

Table field names to seach in

_LOCAL_LANG.default¶

Property

_LOCAL_LANG.default

Data type

Description

Overwrite local language

Example in TS: plugin.tx_sibibtex_pi1.listView.sword =IEEE,Transactions

Avoid empty spaces after the comma when setting lists.

HTML Template configuration¶

You may want to change the default html template to configure the citation style of your reference list. If you select APA style in the configuration, you can define different styles for different entry types. APA styles for the most common types are available: Journal, book, conference proceedings and default.

The easiest way to configure your template is to look at the example template given in the p1/template/ folder.

For an example using APA style, check http://www.karliwalti.ch/home/publications.html

Currently, following placeholders are available for inclusion into your template:

Element definitions¶

Name

Element definitions

Description

All these definitions are used with

###LIST_VIEW###¶

Name

###LIST_VIEW###

Description

###SINGLE###¶

Name

###SINGLE###

Description

###GROUP_SECTION###¶

Name

###GROUP_SECTION###

Description

###LIST_ITEMS###¶

Name

###LIST_ITEMS###

Description

###APA_JOURNAL###¶

Name

###APA_JOURNAL###

Description

APA style predefinition for journal

###APA_CONF###¶

Name

###APA_CONF###

Description

APA style predefinition for conference proceedings

###APA_BOOK###¶

Name

###APA_BOOK###

Description

APA style predefinition for books

###APA_DEFAULT###¶

Name

###APA_DEFAULT###

Description

APA style predefinition for all other styles

###LIST_ITEM###¶

Name

###LIST_ITEM###

Description

###GROUP###¶

Name

###GROUP###

Description

Format for group header

Template for single fields¶

Name

Template for single fields

Description

###T fieldname ###¶

Name

###T fieldname ###

Description

See Fieldnames for available template definitions.use as

Fieldnames¶

Name

Fieldnames

Description

(most are self-explanatory)

###AUTHOR###¶

Name

###AUTHOR###

Description

###YEAR###¶

Name

###YEAR###

Description

###PAGES###¶

Name

###PAGES###

Description

###TITLE###¶

Name

###TITLE###

Description

###JOURNAL###¶

Name

###JOURNAL###

Description

###VOLUME###¶

Name

###VOLUME###

Description

###NUMBER###¶

Name

###NUMBER###

Description

###KEYWORDS###¶

Name

###KEYWORDS###

Description

###CITATIONKEY###¶

Name

###CITATIONKEY###

Description

Bibtex key

###UID###¶

Name

###UID###

Description

Unique identifier for the entry

###MONTH###¶

Name

###MONTH###

Description

###NOTE###¶

Name

###NOTE###

Description

###EDITOR###¶

Name

###EDITOR###

Description

###PUBLISHER###¶

Name

###PUBLISHER###

Description

###SERIES###¶

Name

###SERIES###

Description

###ISBN###¶

Name

###ISBN###

Description

###EDITION###¶

Name

###EDITION###

Description

###ADDRESS###¶

Name

###ADDRESS###

Description

###BOOKTITLE###¶

Name

###BOOKTITLE###

Description

###HOWPUBLISHED###¶

Name

###HOWPUBLISHED###

Description

###CHAPTER###¶

Name

###CHAPTER###

Description

###SCHOOL###¶

Name

###SCHOOL###

Description

###INSTITUTION###¶

Name

###INSTITUTION###

Description

###ORGANISATION###¶

Name

###ORGANISATION###

Description

###ABSTRACT###¶

Name

###ABSTRACT###

Description

###URL###¶

Name

###URL###

Description

Web link

###PMID###¶

Name

###PMID###

Description

PubMed database ID

###DOI###¶

Name

###DOI###

Description

Digital Object Identifier

###COINS###¶

Name

###COINS###

Description

Placeholder for the openURL COinS (ContextObjects in Spans)

###ARXIVID###¶

Name

###ARXIVID###

Description

ArXiv ID

Link placeholders¶

Name

Link placeholders

Description

###ABSTRACT_LINK###¶

Name

###ABSTRACT_LINK###

Description

Link to abstract / single entry view

###PMID_LINK###¶

Name

###PMID_LINK###

Description

###URL_LINK###¶

Name

###URL_LINK###

Description

###BIB_LINK###¶

Name

###BIB_LINK###

Description

Link to the BibTex file of the individual entry, if activated

###PDF_LINK###¶

Name

###PDF_LINK###

Description

Link to the pdf, if available

###DOI_LINK###¶

Name

###DOI_LINK###

Description

DOI link: <a href=”http://dx.doi.org/###DOI###”>[doi]</a>

###ARXIVID_LINK###¶

Name

###ARXIVID_LINK###

Description

Arvix ID link: <a href:”http://arxiv.org/abs/###ARXIVID###”>[ArXiv]</a>

Tutorial¶

N/A yet. Not much to say anyway.

Known problems¶

Latex encoding of special characters is not interpreted. The coding will be stored in record.
Caching is completely deactivated for extension.
Second pair of brackets in title field containing double {} is not removed at import. (typical for BibTex files from Mendeley)

To-Do list¶

Solving known problems.
Cache cacheable parts of the front-end.
Pdf files can only be added in the back-end

ChangeLog¶

10-03-18 WK

updated manual
fixed bug in sort fields
added option of setting sword and searchFieldList in TS

added option to highlight search words in output text

09-10-24 WK

updated manual
added APA_DEFAULT placeholder
changed error messages
added ArXiv field and placeholders
abstracts were not imported

09-10-13 WK

bug fix BibTex export. comma after citation-key was missing
updated manual
moved to beta.

09-09-17 WK

bug fix COins support. openURL is now UTF-8 encoded. Zotero and Mendeley are now supported and tested.
###COINS### is the new placeholder for COinS. Needs to be enabled in flexform.

09-09-16 WK

added COins support.

09-09-10 WK

added url to export field.
###URL### was not generated
new BE flexform field to enable browser results at bottom of list
fixed bug with static TS configuration
added pagefloat field to static setup and code

09-09-03 WK

tca.php was missing a pmid entry.
added citationkey field also to the be editables

09-09-01 WK

Corrected error in export function. Thanks to Adrian Wilke for giving the hint.
Added PMID field (pub med identifier) new fields: ###PMID### and ###PMID_LINK###
cleaned up some code
Addded changes to manual

09-05-05 WK

added quite some stuff:
new fields (doi, url, pdf,..);
import compatible with jabref;
new display mode in ASA style;

07-12-05 SS

Corrected error in export.

07-12-03 SS

Added export
corrected checking of doubles during importing

07-10-30 SS

Added language Files

07-10-29 SS

Pieter Dumon from Ghent University;Dept. of Information Technology (INTEC)
added citation key support. Thanks for that!
cleaned up code a bit and corrected TCA
if there's no citation key, uid is used instead.
added get parameter for citationkey &tx_sibibtex_pi1[citKey]=

07-10-26 SS

added very easy search
added TS configuration for templateFile
removed the bibtex Style thing. Now simply choose templates via TS or plug-in configuration

07-10-25 SS

Turned off caching thus importing works without being logged in in the back-end.
Added first simple version of manual.

07-10-23 SS

0.0.2
List and Single View are in a useable state now. First version of import works. Error checking not yet implemented.

07-10-16 SS

Initial release