.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ======================= 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 |img-1| |img-2| EXT: BibTex publication - si\_bibtex .. _EXT-BibTex-publication: EXT: BibTex publication ======================= Extension Key: si\_bibtex Language: en Keywords: BibTex, import Copyright 2008-2010 Walter Karlen, Copyright 2007-2008, Stefan Siebel, 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: Table of Contents ----------------- `EXT: BibTex publication 1 <#1.EXT:%20BibTex%20publication|outline>`_ **`Introduction 3 <#1.1.Introduction|outline>`_** `What does it do? 3 <#1.1.1.What%20does%20it%20do_|outline>`_ `Screenshots 3 <#1.1.2.Screenshots|outline>`_ **`Users manual 4 <#1.2.Users%20manual|outline>`_** `How to upload a BibTex file 4 <#1.2.1.How%20to%20upload%20a%20BibTex%20file|outline>`_ `FAQ 4 <#1.2.2.FAQ|outline>`_ **`Administration 5 <#1.3.Administration|outline>`_** `Setting up the plugin (Installation) 5 <#2.Setting%20up%20the%20plugin%20(Installation)|outline>`_ **`Configuration 6 <#2.1.Configuration|outline>`_** `Frontend Plugin Configuration 6 <#3.Frontend%20Plugin%20Configuration|outline>`_ `TS Reference 6 <#7.0.1.TS%20Reference|outline>`_ `HTML Template configuration 7 <#8.HTML%20Template%20configuration|outline>`_ **`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: Introduction ------------ .. _What-does-it-do: 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: Screenshots ^^^^^^^^^^^ |img-3| *llustration 1: Font-end form for BibTex upload.* |img-4| *llustration 2: Example of the front-end publication list with group sorting and display of sorting list* .. _Users-manual: Users manual ------------ .. _How-to-upload-a-BibTex-file: 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: 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: Administration -------------- .. _Setting-up-the-plug-in-Installation: 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: Configuration ------------- .. _front-end-plug-in-Configuration: front-end plug-in Configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Currently there are four flexform sheets for configuration of the front-end plug-in. .. _General-Settings: General Settings """""""""""""""" .. ### BEGIN~OF~TABLE ### .. _What-to-show: What to show? ~~~~~~~~~~~~~ .. container:: table-row Property What to show? Description :code:`Select what to show in front-end: list, search, or import` .. _Database: Database ~~~~~~~~ .. container:: table-row Property Database Description Link to sysfolder with BibTex database .. _recursive: recursive ~~~~~~~~~ .. container:: table-row Property recursive Description .. ###### END~OF~TABLE ###### .. _List-View: List View """"""""" .. ### BEGIN~OF~TABLE ### .. _Order-by: Order by ~~~~~~~~ .. container:: table-row Property Order by Description Select criteria to use for sorting list .. _Direction: Direction ~~~~~~~~~ .. container:: table-row Property Direction Description Sorting order? .. _Show-BibTex-download-link: Show BibTex download link ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property Show BibTex download link Description Adds a global BibTex file download link to the list .. _Add-COinS-easy-export: Add COinS (easy export)? ~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property Add COinS (easy export)? Description Embeds a CoinS for each entry on the webpage .. _Display-Browser-Results: Display Browser Results? ~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property Display Browser Results? Description .. _Show-Sort-Links: Show Sort Links? ~~~~~~~~~~~~~~~~ .. container:: table-row Property Show Sort Links? Description front-end user can select sorting .. _Group-the-listed-entries: Group the listed entries? ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property Group the listed entries? Description Grouped list view .. _Lock-list-to-APA-style: Lock list to APA style? ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property Lock list to APA style? Description Enforce APA style for list view .. _Highlight-Search: Highlight Search? ~~~~~~~~~~~~~~~~~ .. container:: table-row Property Highlight Search? Description Sets search words in bold .. ###### END~OF~TABLE ###### .. _Import: Import """""" .. ### BEGIN~OF~TABLE ### .. _Prevent-from-importing-duplicates: Prevent from importing duplicates ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property Prevent from importing duplicates Description :code:`Enable duplicate check` .. ###### END~OF~TABLE ###### .. _Template: Template """""""" .. ### BEGIN~OF~TABLE ### .. _templateFile: templateFile ~~~~~~~~~~~~ .. container:: table-row Property templateFile Description :code:`Locate or upload a template file` .. ###### END~OF~TABLE ###### .. _TS-Reference: TS Reference ^^^^^^^^^^^^ See also the static TS file for examples (pi1/static/setup.txt). .. ### BEGIN~OF~TABLE ### .. _templateFile: templateFile """""""""""" .. container:: table-row 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: :code:`plug-in.tx\_sibibtex {` :code:`templateFile = fileadmin/my\_templates/sibibtex\_template.html` :code:`}` .. _pidList: pidList """"""" .. container:: table-row Property pidList Data type Description .. _recursive: recursive """"""""" .. container:: table-row Property recursive Data type Description .. _results-at-a-time: results\_at\_a\_time """""""""""""""""""" .. container:: table-row Property results\_at\_a\_time Data type int Description Maximum number of results to show in list view .. _maxPages: maxPages """""""" .. container:: table-row Property maxPages Data type int Description Maximum number of browsing pages .. _pagefloat: pagefloat """"""""" .. container:: table-row Property pagefloat Data type e.g. CENTER Description Position of list table .. _sword: sword """"" .. container:: table-row 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: searchFieldList """"""""""""""" .. container:: table-row Property searchFieldList Data type author,abstract Description Table field names to seach in .. _LOCAL-LANG-default: \_LOCAL\_LANG.default """"""""""""""""""""" .. container:: table-row Property \_LOCAL\_LANG.default Data type Description Overwrite local language .. ###### END~OF~TABLE ###### Example in TS: plugin.tx\_sibibtex\_pi1.listView.sword =IEEE,Transactions Avoid empty spaces after the comma when setting lists. .. _HTML-Template-configuration: 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: .. ### BEGIN~OF~TABLE ### .. _Element-definitions: Element definitions """"""""""""""""""" .. container:: table-row Name Element definitions Description All these definitions are used with .. _LIST-VIEW: ###LIST\_VIEW### """""""""""""""" .. container:: table-row Name ###LIST\_VIEW### Description .. _SINGLE: ###SINGLE### """""""""""" .. container:: table-row Name ###SINGLE### Description .. _GROUP-SECTION: ###GROUP\_SECTION### """""""""""""""""""" .. container:: table-row Name ###GROUP\_SECTION### Description .. _LIST-ITEMS: ###LIST\_ITEMS### """"""""""""""""" .. container:: table-row Name ###LIST\_ITEMS### Description .. _APA-JOURNAL: ###APA\_JOURNAL### """""""""""""""""" .. container:: table-row Name ###APA\_JOURNAL### Description APA style predefinition for journal .. _APA-CONF: ###APA\_CONF### """"""""""""""" .. container:: table-row Name ###APA\_CONF### Description APA style predefinition for conference proceedings .. _APA-BOOK: ###APA\_BOOK### """"""""""""""" .. container:: table-row Name ###APA\_BOOK### Description APA style predefinition for books .. _APA-DEFAULT: ###APA\_DEFAULT### """""""""""""""""" .. container:: table-row Name ###APA\_DEFAULT### Description APA style predefinition for all other styles .. _LIST-ITEM: ###LIST\_ITEM### """""""""""""""" .. container:: table-row Name ###LIST\_ITEM### Description .. _GROUP: ###GROUP### """"""""""" .. container:: table-row Name ###GROUP### Description Format for group header .. _Template-for-single-fields: Template for single fields """""""""""""""""""""""""" .. container:: table-row Name Template for single fields Description .. _T-fieldname: ###T *fieldname* ### """""""""""""""""""" .. container:: table-row Name ###T *fieldname* ### Description See Fieldnames for available template definitions.use as .. _Fieldnames: Fieldnames """""""""" .. container:: table-row Name Fieldnames Description (most are self-explanatory) .. _AUTHOR: ###AUTHOR### """""""""""" .. container:: table-row Name ###AUTHOR### Description .. _YEAR: ###YEAR### """""""""" .. container:: table-row Name ###YEAR### Description .. _PAGES: ###PAGES### """"""""""" .. container:: table-row Name ###PAGES### Description .. _TITLE: ###TITLE### """"""""""" .. container:: table-row Name ###TITLE### Description .. _JOURNAL: ###JOURNAL### """"""""""""" .. container:: table-row Name ###JOURNAL### Description .. _VOLUME: ###VOLUME### """""""""""" .. container:: table-row Name ###VOLUME### Description .. _NUMBER: ###NUMBER### """""""""""" .. container:: table-row Name ###NUMBER### Description .. _KEYWORDS: ###KEYWORDS### """""""""""""" .. container:: table-row Name ###KEYWORDS### Description .. _CITATIONKEY: ###CITATIONKEY### """"""""""""""""" .. container:: table-row Name ###CITATIONKEY### Description Bibtex key .. _UID: ###UID### """"""""" .. container:: table-row Name ###UID### Description Unique identifier for the entry .. _MONTH: ###MONTH### """"""""""" .. container:: table-row Name ###MONTH### Description .. _NOTE: ###NOTE### """""""""" .. container:: table-row Name ###NOTE### Description .. _EDITOR: ###EDITOR### """""""""""" .. container:: table-row Name ###EDITOR### Description .. _PUBLISHER: ###PUBLISHER### """"""""""""""" .. container:: table-row Name ###PUBLISHER### Description .. _SERIES: ###SERIES### """""""""""" .. container:: table-row Name ###SERIES### Description .. _ISBN: ###ISBN### """""""""" .. container:: table-row Name ###ISBN### Description .. _EDITION: ###EDITION### """"""""""""" .. container:: table-row Name ###EDITION### Description .. _ADDRESS: ###ADDRESS### """"""""""""" .. container:: table-row Name ###ADDRESS### Description .. _BOOKTITLE: ###BOOKTITLE### """"""""""""""" .. container:: table-row Name ###BOOKTITLE### Description .. _HOWPUBLISHED: ###HOWPUBLISHED### """""""""""""""""" .. container:: table-row Name ###HOWPUBLISHED### Description .. _CHAPTER: ###CHAPTER### """"""""""""" .. container:: table-row Name ###CHAPTER### Description .. _SCHOOL: ###SCHOOL### """""""""""" .. container:: table-row Name ###SCHOOL### Description .. _INSTITUTION: ###INSTITUTION### """"""""""""""""" .. container:: table-row Name ###INSTITUTION### Description .. _ORGANISATION: ###ORGANISATION### """""""""""""""""" .. container:: table-row Name ###ORGANISATION### Description .. _ABSTRACT: ###ABSTRACT### """""""""""""" .. container:: table-row Name ###ABSTRACT### Description .. _URL: ###URL### """"""""" .. container:: table-row Name ###URL### Description Web link .. _PMID: ###PMID### """""""""" .. container:: table-row Name ###PMID### Description PubMed database ID .. _DOI: ###DOI### """"""""" .. container:: table-row Name ###DOI### Description Digital Object Identifier .. _COINS: ###COINS### """"""""""" .. container:: table-row Name ###COINS### Description Placeholder for the openURL COinS (ContextObjects in Spans) .. _ARXIVID: ###ARXIVID### """"""""""""" .. container:: table-row Name ###ARXIVID### Description ArXiv ID .. _Link-placeholders: Link placeholders """"""""""""""""" .. container:: table-row Name Link placeholders Description .. _ABSTRACT-LINK: ###ABSTRACT\_LINK### """""""""""""""""""" .. container:: table-row Name ###ABSTRACT\_LINK### Description Link to abstract / single entry view .. _PMID-LINK: ###PMID\_LINK### """""""""""""""" .. container:: table-row Name ###PMID\_LINK### Description [pmid] .. _URL-LINK: ###URL\_LINK### """"""""""""""" .. container:: table-row Name ###URL\_LINK### Description [www] .. _BIB-LINK: ###BIB\_LINK### """"""""""""""" .. container:: table-row Name ###BIB\_LINK### Description Link to the BibTex file of the individual entry, if activated .. _PDF-LINK: ###PDF\_LINK### """"""""""""""" .. container:: table-row Name ###PDF\_LINK### Description Link to the pdf, if available .. _DOI-LINK: ###DOI\_LINK### """"""""""""""" .. container:: table-row Name ###DOI\_LINK### Description DOI link: [doi] .. _ARXIVID-LINK: ###ARXIVID\_LINK### """"""""""""""""""" .. container:: table-row Name ###ARXIVID\_LINK### Description Arvix ID link: [ArXiv] .. ###### END~OF~TABLE ###### .. _Tutorial: Tutorial -------- N/A yet. Not much to say anyway. .. _Known-problems: 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: To-Do list ---------- - Solving known problems. - Cache cacheable parts of the front-end. - Pdf files can only be added in the back-end .. _ChangeLog: 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 See also changelog file. 13 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. |img-2| image:: img-2.png .. :border: 0 .. :height: 21 .. :hspace: 9 .. :id: Grafik2 .. :name: Grafik2 .. :width: 87 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 130 .. :id: graphics1 .. :name: graphics1 .. :width: 311 .. |img-4| image:: img-4.png .. :align: left .. :border: 0 .. :id: graphics2 .. :name: graphics2 .. :width: 100%