zrd-bibtexbrowser/bibtexbrowser-documentation.wiki

<!-- 
This is the source file of the documentation of bibtexbrowser.
It uses the Wiki syntax similar to dokuwiki and mediawiki.
Is is rendered as HTML on http://www.monperrus.net/martin/bibtcomexbrowser/.
-->

bibtexbrowser is a PHP script that creates publication lists from Bibtex files. bibtexbrowser is stable, mature and easy to install. It is used in [[http://www.monperrus.net/martin/bibtexbrowser/users|100+ different universities]] around the globe (in 329 different domains according to Google).

This documentation is collaborative, you can improve it using a [[https://github.com/monperrus/bibtexbrowser/|pull request on GitHub]] (file ''bibtexbrowser-documentation.wiki'').

+++TOC+++

=====Features=====
* **(02/2016)** support for [[http://ogp.me/|OpenGraph metadata]]
* **(10/2015)** support for filtering bibtex fields
* **(10/2013)** support for localization (see below)
* **(07/2012)** new label types (see config value ABBRV_TYPE)
* **(10/2011)** if a bibtex entry contains a field gsid (like Google Scholar ID), bibtexbrowser includes a link [cites] to the cited-by page of Google Scholar (e.g. [[http://scholar.google.com/scholar?cites=15080874515065717592]])
* **(03/2011)** bibtexbrowser includes a hide/show mechanism for bibtex entries (in Javascript, see configuration variable BIBTEXBROWSER_USE_PROGRESSIVE_ENHANCEMENT)
* **(10/2010)** bibtexbrowser now supports cross-references (Bibtex crossref)
* **(09/2010)** bibtexbrowser now supports multiple bibtex files (''bibtexbrowser.php?bib=file1.bib;file2.bib'')
* **(05/2010)** bibtexbrowser adds links to your co-author pages if you define the corresponding @string (see function addHomepageLink)
* **(01/2010)** bibtexbrowser can handle user-defined bibliographic styles
* bibtexbrowser generates publication RSS feeds (simply add &#38;rss at the end of the URL)! [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=monperrus.bib&amp;all&amp;rss|demo]]
* **(10/2009)** bibtexbrowser is able to generate a bibtex file containing only the selected entries (simply add &#38;astext at the end of the link)
* **(10/2009)** bibtexbrowser is now independent of the configuration of register_globals
* **(01/2009)** bibtexbrowser allows multi criteria search, e.g.  [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=monperrus.bib&amp;type=inproceedings&amp;year=20013|demo]]
* bibtexbrowser generates [[http://ocoins.info/|COinS]] for automatic import of bibliographic entries with [[http://www.zotero.org/|Zotero]] and [[http://www.mendeley.com/|Mendeley]].
* bibtexbrowser generates [[http://www.monperrus.net/martin/accurate+bibliographic+metadata+and+google+scholar|Google Scholar metadata]] so as to improve the visibility of your papers on Google Scholar. 
* bibtexbrowser replaces constants defined in @STRING
* bibtexbrowser is very fast because it keeps a compiled version of the bibtex file (PHP object serialized)
* bibtexbrowser is compatible with PHP 4.x and PHP 5.x
* bibtexbrowser can display the menu and all entries with framesets [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=monperrus.bib|demo]]
* bibtexbrowser can display all entries  out of a bibtex file [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=monperrus.bib&amp;all|demo]]
* bibtexbrowser can display all entries for a given year [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=monperrus.bib&amp;year=2014|demo]]
* bibtexbrowser can display a single bibtex entry [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=monperrus.bib&amp;key=monperrus08d|demo]]
* bibtexbrowser can display found entries with a search word (it can be in any bib field) [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=monperrus.bib&amp;search=repair|demo]]
* bibtexbrowser can display all entries with a bib keyword e.g. "?keywords=components". It matches against the "keywords" bibtex field. [[http://bibtexbrowser.sourceforge.net/bibtexbrowser.php?bib=monperrus.bib&keywords=repair|demo]]
* bibtexbrowser outputs valid XHTML 1.0 Transitional
* bibtexbrowser can display all entries for an author [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=monperrus.bib&amp;author=Bartel|demo]]
* bibtexbrowser can be used with different encodings (change the default iso-8859-1 encoding if your bib file is in UTF-8 ''define('BIBTEX_INPUT_ENCODING','UTF-8')'' )
* bibtexbrowser is easy to install: just a single file.


=====Download=====
For feature requests or bug reports, please comment this page below; patches can be contributed as pull requests on [[https://github.com/monperrus/bibtexbrowser|github]]:)

<!-- //Release Candidate//: [[http://www.monperrus.net/martin/bibtexbrowser/bibtexbrowser-rc.php.txt]] -->
'''Stable Version''':  [[http://www.monperrus.net/martin/bibtexbrowser.php.txt|bibtexbrowser.php]]  
[[https://github.com/monperrus/bibtexbrowser/commits/master|Changelog]]

Don't hesitate to contact me to be added in the [[http://www.monperrus.net/martin/bibtexbrowser/users|lists of bibtexbrowser users]]:-)

=====Bibtexbrowser Ecosystem=====

The following uses bibtexbrowser under the hood:
* [[http://www.monperrus.net/martin/bibtex-prettyprint|A pretty-printer and cleaner for Bibtex]]
* [[http://github.com/KaiBi/IEEEStyleForBibtexbrowser|A custom citation style for bibtexbrowser adhering to the IEEE citations guidelines (on github)]]
* Generating publication lists in Latex using [[http://www.monperrus.net/martin/bibtex2latex]] 
* [[http://www.monperrus.net/martin/feeding-mysql-database-with-bibtexbrowser|Feeding a MySQL database from the content of a bibtex file]]
* Publication lists in Wordpress with [[http://www.monperrus.net/martin/wp-publications|wp-publications]]
* [[http://www.monperrus.net/martin/publication-lists-with-hal-and-bibtexbrowser|Publication lists with HAL and bibtexbrowser]]

=====Demo and screenshot=====

Demo: [[http://bibtexbrowser.sourceforge.net/bibtexbrowser.php?bib=metrics.bib|Here, you can browse a bibtex file dedicated to software metrics]]

<a href="bibtexbrowser-screenshot.png"><img height="500" src="bibtexbrowser-screenshot.png" alt="bibtexbrowser screenshot"/></a>

=====Basic installation=====
Create a bib file with the publication records (e.g. csgroup2008.bib) and upload it to your server.
* Use the link ''bibtexbrowser.php?bib=csgroup2008.bib'' (frameset based view)
* Use the link ''bibtexbrowser.php?bib=csgroup2008.bib&amp;all'' (pub list sorted by year)
* Use the link ''bibtexbrowser.php?bib=csgroup2008.bib&amp;all&amp;academic'' (pub list  sorted by publication type, then by year, see "Sectioning in academic mode" below)

'''Warning''': bibtexbrowser maintains a cached version of the parsed bibtex, for high performance, check that PHP can write in the working directory of PHP.

'''Handling mutliple bibtex files''': If you want to include several bibtex files, just give bibtexbrowser the files separated by semi-columns e.g:
''bibtexbrowser.php?bib=strings.bib;csgroup2008.bib''

=====FAQ=====

====How to embed Bibtexbrowser into a website?====
To embed Bibtexbrowser into a website, you car use it as a library:

<pre>
&lt;?php
$_GET['library']=1;
define('BIBTEXBROWSER_BIBTEX_LINKS',false); // no [bibtex] link by default
require_once('bibtexbrowser.php');
global $db;
$db = new BibDataBase();
$db->load('biblio.bib');

// printing all 2014 entries
// can also be $query = array('year'=>'.*');
$query = array('year'=>'2014');
$entries=$db->multisearch($query);
uasort($entries, 'compare_bib_entries'); 

foreach ($entries as $bibentry) { 
  echo $bibentry->toHTML()."&lt;br/>"; 
}
?>
</pre>


====How to embed a publication list in an home page?====

<table border="1">
<tr><th></th><th>Sorted by year </th><th>Sorted by publication type</th></tr>
<tr><td>For a group/team/lab</td>
<td>
&#60;?php
$_GET&#91;'bib'&#93;='csgroup2008.bib';
$_GET&#91;'all'&#93;=1;
include( 'bibtexbrowser.php' );
?>
</td>
<td>
&#60;?php
$_GET&#91;'bib'&#93;='csgroup2008.bib';
$_GET&#91;'all'&#93;=1;
$_GET&#91;'academic'&#93;=1;
include( 'bibtexbrowser.php' );
?>
</td>
</tr><!-- end group -->
<tr><td>For an individual</td>
<td>
  &#60;?php
$_GET&#91;'bib'&#93;='mybib.bib';
$_GET&#91;'author'&#93;='Martin Monperrus';
include( 'bibtexbrowser.php' );
?>
</td>
<td>
&#60;?php
$_GET&#91;'bib'&#93;='mybib.bib';
$_GET&#91;'author'&#93;='Martin Monperrus';
$_GET&#91;'academic'&#93;=1;
include( 'bibtexbrowser.php' );
?>
</td>
</tr><!-- end individual -->
</table>


====How to change the reference style?====

'''By modifying the CSS'''

If bibtexbrowser.css exists, it is used, otherwise bibtexbrowser uses its own embedded CSS style (see function bibtexbrowserDefaultCSS). An example of CSS tailoring is:
<pre>
.date {   background-color: blue; }
.btb-header { }
.rheader {  font-size: large }
.bibref {  padding:3px; padding-left:15px;  vertical-align:top;}
.bibtitle { font-weight:bold; }
.bibbooktitle { font-style:italic; }
</pre>
&nbsp;

For instance, one can tweak the output by disabling the display of some headers and pieces of information.
<pre>
.bibmenu {display:none} /* disables the [bibtex] and the like */
.bibanchor {display:none} /* disables the index [1] or [Name2010], etc. depending on the value of the configuration value ABBRV_TYPE and BIBTEXBROWSER_LAYOUT
.theader {display:none}
.sheader {display:none} /* disables the year header e.g., 2001 */
</pre>
&nbsp;

'''By setting your own style function'''
The bibliography style is encapsulated in a function. If you want to modify the bibliography style, you can copy the default style in a new file, say ''bibtexbrowser-yourstyle.php'', and rename the function ''DefaultBibliographyStyle'' in say ''MyFancyBibliographyStyle''.
Then, add in the file ''bibtexbrowser.local.php'':
<pre>
&#60;?php
function MyFancyBibliographyStyle(&$bibentry) {
  return $bibentry->getTitle().' ('.$bibentry->formattedAuthors(.')';
}
define('BIBLIOGRAPHYSTYLE','MyFancyBibliographyStyle');
?>
</pre>
&nbsp;

See Janos Tapolcai's style, which looks like IEEE references (see function JanosBibliographyStyle), and Kai's one [[http://github.com/KaiBi/IEEEStyleForBibtexbrowser|another custom citation style for bibtexbrowser adhering to the IEEE citations guidelines (on github)]].

For contributing with a new style, [[http://www.monperrus.net/martin/|please drop me an email ]]

====How to change the link style?====

By default each bibliographic entry is followed by 
[bibtex] [pdf] [doi], etc.

This can be tailored by configuring as follows (in the file ''bibtexbrowser.local.php'')
<pre><?php
define('BIBTEXBROWSER_LINK_STYLE','MyFancyBib2links');
function MyFancyBib2links(&$bibentry) {
  // bib is a special type of link. without the url argument or with an invalid image, it prints '[bibtex]'
  $result = $bibentry->getBibLink();
  
  $result .= ' '.$bibentry->getLink('url');
  
  // Google Scholar ID. empty string if no gsid field present
  $result .= ' '.$bibentry->getGSLink();
  
  // returns an empty string if no doi field present
  $result .= ' '.$bibentry->getDoiLink();
  
  return $result;
}
?>
</pre>
&nbsp;

You can use your personalized function to add support for new fields in bibtex (''pdf'', ''file'', etc.). Check-out the documentation of functions ''getLink()'', ''getBibLink()'', ''getGSLink()'' and ''getDoiLink()'': they accept an optional argument for providing an image/icon instead of printing text.

<pre>
  // returns an empty string if no pdf field present
  $result .= $bibentry->getLink('pdf','http://url.to/icons/pdf.png');
  // returns an empty string if no slides field present
  $result .= $bibentry->getLink('slides');
  // returns an empty string if no poster field present
  $result .= $bibentry->getLink('poster');
</pre>


====How to specify the encoding of bibtex files (UTF-8/ISO-8859-1/etc.)? ====
By default, bibtexbrowser assumes that the bibtex file is UTF-8 encoded. If you want to change it to e.g. ISO-8859-1, add into ''bibtexbrowser.local.php'':
<pre>define('BIBTEX_INPUT_ENCODING','ISO-8859-1');</pre>

Note that if the bibtex only contains latex-encoded diacritics (e.g. ''\'e''), it does not matter. The encoding of the bibtex file and the one of the generated HTML is identical.


====How to disable Javascript progressive enhancement?====
add into ''bibtexbrowser.local.php'':
''define('BIBTEXBROWSER_USE_PROGRESSIVE_ENHANCEMENT',false);''

====How to remove the "[bibtex]" links?====
''@define('BIBTEXBROWSER_BIBTEX_LINKS',false);''

====How to change the reference indices?====
<pre>

// index => [1] The essence of metamodeling
// year => [2005] The essence of metamodeling
// x-abbrv => [SoSyM] The essence of metamodeling if the bibtex entry contains a field x-abbrv
define('ABBRV_TYPE','year');// may be year/x-abbrv/key/none/index
</pre>


====How to use the "Academic style"?====

The default academic mode creates four sections:

- books
- articles and book chapters
- workshop papers (for entries containing "workshop" in the field booktitle)
- others

You may create your own one in ''bibtexbrowser.local.php'' (see also "creating a bibtexbrowser.local.php" below):
<pre>
define('BIBLIOGRAPHYSECTIONS','my_sectioning');
function my_sectioning() {
return  
  array(
  // Books
    array(
      'query' => array(Q_TYPE=>'book'),
      'title' => 'Books'
    ),
  // Articles
    array(
      'query' => array(Q_TYPE=>'article'),
      'title' => 'Refereed Articles'
    ),
  // Conference and Workshop papers
    array(
      'query' => array(Q_TYPE=>'inproceedings'),
      'title' => 'Conference and Workshop  Papers'
    ),
  // others
    array(
      'query' => array(Q_TYPE=>'misc|phdthesis|mastersthesis|bachelorsthesis|techreport'),
      'title' => 'Other Publications'
    )
  );
}
</pre>

====How to get the  individual bib pages embedded as well?====
''define('BIBTEXBROWSER_URL',""); ''


====How to add links to the slides of a conference/workshop paper?====
You can simply fill the ''comment'' field of the bib entry with an HTML link:
<code>
@inproceedings{foo,
author="Jean Dupont",
title="Bibtexbrowser",
year=2009,
booktitle="Proceedings of the BIB conference",
comment={&lt;a href="myslides.pdf">[slides]&lt;/a>}
}
</code>

This comment field can also be used to add acceptance rates and impact factors.

====How to localize bibtexbrowser?====
Add in ''bibtexbrowser.local.php'':
<pre>
&lt;?php
global $BIBTEXBROWSER_LANG;
$BIBTEXBROWSER_LANG=array();
$BIBTEXBROWSER_LANG['Refereed Conference Papers']="Conférences avec comité de lecture";
... 
$BIBTEXBROWSER_LANG['Year']="Année";
?>
</pre>

====How to change the default frame?====
Add in ''bibtexbrowser.local.php'':
<pre>
&lt;?php
// or any valid query: year=2010, author=Jane, etc.
@define('BIBTEXBROWSER_DEFAULT_FRAME','all');
?>
</pre>

====How to configure the order of Bibtex entries?====
You can set the default order function in ''bibtexbrowser.local.php'':
<pre>
&lt;?php
// can be @define('ORDER_FUNCTION','compare_bib_entry_by_title');
define('ORDER_FUNCTION','compare_bib_entry_by_bibtex_order');
?>
</pre>

Or programmatically:
<pre>
&lt;?php
$_GET['library']=1;
require_once('bibtexbrowser.php');
$db = new BibDataBase();
$db->load('biblio.bib');
$query = array('year'=>'2014');
$entries=$db->multisearch($query);
uasort($entries, 'compare_bib_entries'); 
foreach ($entries as $bibentry) { 
  echo $bibentry->getYear().'<br/>'; 
}
?>
</pre>

====How to change the title of the result page?====

You may create your own title function in ''bibtexbrowser.local.php'' (see "creating a bibtexbrowser.local.php" below):
<pre>
define('BIBLIOGRAPHYTITLE','my_title_function');
function my_title_function($query) {
  return "Publications of the Nuclear Research Group";
}
</pre>
See function DefaultBibliographyTitle for inspiration.

====How to disallow crawler indexing?====

Add in ''bibtexbrowser.local.php'' (see "creating a bibtexbrowser.local.php" below):
<pre>
define('BIBTEXBROWSER_ROBOTS_NOINDEX', true);
</pre>

====How to load Bibtex from a dynamic string?====

You can use the special ''php://memory'' feature in a new dispatcher.
Add in ''bibtexbrowser.local.php'':
<pre>
define("BIBTEXBROWSER_MAIN", 'DynamicDispatcher');
</pre>

and then in ''bibtexbrowser.after.php'':
<pre>
&lt;?php
class DynamicDispatcher extends Dispatcher {
  function getDB() {
    $data = fopen('php://memory','x+');
    $dynamic_string = "@book{aKey,title={A Book},author={Jan Doe},publisher={Springer},year=2009}\n";
    fwrite($data, $dynamic_string);
    fseek($data,0);
    $db = new BibDataBase();
    $db->update_internal("inline", $data);
    return $db;
  }
}
?>
</pre>

====How to load bibliographic data in other formats?====

If your bibliographic data comes from XML or a database, you can still browse it with bibtexbrowser as follows:
Add in ''bibtexbrowser.local.php'':
<pre>
define("BIBTEXBROWSER_MAIN", 'PgmDispatcher');
</pre>

and then in ''bibtexbrowser.after.php'':
<pre>
&lt;?php
class PgmDispatcher extends Dispatcher {
  function getDB() {
    $db = new BibDataBase();
    
    // builds the first entry
    $entry = new BibEntry();
    $entry->setType("article");
    $entry->setField("title", "foo");
    $entry->setField("year", "2014");
    $entry->setKey("kolp");
    $db->addEntry($entry);
    
    // builds the second entry
    $entry2 = new BibEntry();
    $entry2->setType("article");
    $entry2->setField("title", "bar");
    $entry2->setField("year", "2013");
    $entry2->setKey("tili");
    $db->addEntry($entry2);
    
    return $db;
  }
}
?>
</pre>
    
====How to remove fields from the bibtex text?====

If you want to remove some fields (e.g. abbrv and comment) from the resulting bibtex, add in ''bibtexbrowser.local.php'':
<pre>
&lt;?php
define('BIBTEXBROWSER_BIBTEX_VIEW','reconstructed');
define('BIBTEXBROWSER_BIBTEX_VIEW_FILTEREDOUT','abbrv|comment');
?>
</pre>

====How to activate page numbering in the output?====

Add in ''bibtexbrowser.local.php'':
<pre>
&lt;?php
bibtexbrowser_configure('BIBTEXBROWSER_DEFAULT_DISPLAY','PagedDisplay');
bibtexbrowser_configure('PAGE_SIZE','3');
?>
</pre>

====How to override framesets and headers?====

You can customize every view as follows, in particular by playing with ''BIBTEXBROWSER_URL''.

''frameset.html'':
<pre>
&lt;html>
&lt;frameset cols="15%,*">
&lt;frame name="menu" src="menu.php" />
&lt;frame name="main" src="output.php" />
&lt;/frameset>
&lt;/html>
</pre>

''menu.php'':
<pre>
MENU (no header sent)
&lt;?php
define('BIBTEXBROWSER_URL','output.php');
$_GET['menu']=1;
$_GET['bib']='foo.bib';
include('bibtexbrowser.php');
?>
</pre>

''output.php'':
<pre>
OUTPUT (no header sent)
&lt;?php 
define('BIBTEXBROWSER_URL','elem.php');
include('bibtexbrowser.php');
?>
</pre>

''elem.php'':
<pre>
ELEM (no header sent)
&lt;?php 
include('bibtexbrowser.php'); 
?>
</pre>

====How to add hyperlink to the authors' web pages?====

You must add a ''@string'' block in the bibtex file, which contains the links. The key is a concatenation of ''hp_'' and then ''FirstNameLastName'' (no space). For instance:

<pre>
@String { 
  hp_ericfoo      = {http://www.foo.de/},
  hp_joebar      = {http://www.joebar.me/},
}
</pre>

====How to modify bibtex entries on the command line?====

Use ''bibtexbrowser-cli.php''. For instance:

<pre>
php bibtexbrowser-cli.php mybib.bib --id classical --set-title \"a new title\" --id with_abstract --set-title \"a new title\" --set-year 1990
</pre>

=====Related tools=====

Old-fashioned:
[[http://nxg.me.uk/dist/bibhtml/|bibhtml]], [[http://www.litech.org/~wkiri/bib2html/|bib2html]], [[http://ilab.usc.edu/bibTOhtml/|bibtohtml]], [[http://people.csail.mit.edu/rahimi/bibtex/|bibtextohtml]], [[http://www.lri.fr/~filliatr/bibtex2html/|bibtex2html]], [[http://people.csail.mit.edu/mernst/software/bibtex2web.html |bibtex2web]], [[http://strategoxt.org/Stratego/BibtexTools|stratego bibtex module]]
Unlike them, bibtexbrowser is dynamic, i.e. generates the HTML pages on the fly. Thus, you do not need to regenerate the static HTML files each time the bib file is changed.

Heavyweight:
[[http://www.rennes.supelec.fr/ren/perso/etotel/PhpBibtexDbMng/|PHP BibTeX Database Manager]], [[http://gforge.inria.fr/projects/bibadmin/|bibadmin]], [[http://artis.imag.fr/Software/Basilic/|basilic]], [[http://phpbibman.sourceforge.net/|phpbibman]], [[http://www.aigaion.nl/|aigaion]], [[http://www.refbase.net/|refbase]], [[http://wikindx.sourceforge.net/|wikindx]], [[http://refdb.sourceforge.net/|refdb]]
Unlike them, bibtexbrowser does not need a MySQL database.


Main competitor:
[[http://code.google.com/p/simplybibtex/|SimplyBibtex]] has the same spirit, but the project seems dead since 2006

Misc:
[[http://www.sat.ltu.se/publications/publications.m|This matlab script is similar]]

=====Copyright=====

This script is a fork from an excellent script of Joel Garcia, Leonardo Ruiz, and Yoonsik Cheon from the University of Texas at El Paso.

Bibtexbrowser is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

=====Discussion/Comments/Feedback=====
<!-- rendered on http://www.monperrus.net/martin/bibtexbrowser/users -->