This is the source file of the documentation of bibtexbrowser.
This is the source file of the documentation of bibtexbrowser.
It uses the Wiki syntax similar to dokuwiki and mediawiki.
It uses the Wiki syntax similar to dokuwiki and mediawiki.
Is is rendered as HTML on http://www.monperrus.net/martin/bibtcomexbrowser/.
Is is rendered as HTML on http://www.monperrus.net/martin/bibtcomexbrowser/.
@ -11,6 +11,7 @@ This documentation is collaborative, you can improve it using a [[https://github
+++TOC+++
+++TOC+++
=====Features=====
=====Features=====
* **(01/2017)** support basic composer support
* **(02/2016)** support for [[http://ogp.me/|OpenGraph metadata]]
* **(02/2016)** support for [[http://ogp.me/|OpenGraph metadata]]
* **(10/2015)** support for filtering bibtex fields
* **(10/2015)** support for filtering bibtex fields
* **(10/2013)** support for localization (see below)
* **(10/2013)** support for localization (see below)
@ -26,7 +27,7 @@ This documentation is collaborative, you can improve it using a [[https://github
* **(10/2009)** bibtexbrowser is now independent of the configuration of register_globals
* **(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&type=inproceedings&year=20013|demo]]
* **(01/2009)** bibtexbrowser allows multi criteria search, e.g. [[http://www.monperrus.net/martin/bibtexbrowser.php?bib=monperrus.bib&type=inproceedings&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://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 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 replaces constants defined in @STRING
* bibtexbrowser is very fast because it keeps a compiled version of the bibtex file (PHP object serialized)
* 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 is compatible with PHP 4.x and PHP 5.x
@ -46,7 +47,7 @@ This documentation is collaborative, you can improve it using a [[https://github
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]]:)
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]]:)
Don't hesitate to contact me to be added in the [[http://www.monperrus.net/martin/bibtexbrowser/users|lists of bibtexbrowser users]]:-)
Don't hesitate to contact me to be added in the [[http://www.monperrus.net/martin/bibtexbrowser/users|lists of bibtexbrowser users]]:-)
@ -56,7 +57,7 @@ Don't hesitate to contact me to be added in the [[http://www.monperrus.net/marti
The following uses bibtexbrowser under the hood:
The following uses bibtexbrowser under the hood:
* [[http://www.monperrus.net/martin/bibtex-prettyprint|A pretty-printer and cleaner for Bibtex]]
* [[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)]]
* [[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]]
* 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]]
* [[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]]
* 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]]
* [[http://www.monperrus.net/martin/publication-lists-with-hal-and-bibtexbrowser|Publication lists with HAL and bibtexbrowser]]
@ -96,10 +97,10 @@ $db->load('biblio.bib');
// can also be $query = array('year'=>'.*');
// can also be $query = array('year'=>'.*');
$query = array('year'=>'2014');
$query = array('year'=>'2014');
$entries=$db->multisearch($query);
$entries=$db->multisearch($query);
uasort($entries, 'compare_bib_entries');
uasort($entries, 'compare_bib_entries');
foreach ($entries as $bibentry) {
echo $bibentry->toHTML()."<br/>";
foreach ($entries as $bibentry) {
echo $bibentry->toHTML()."<br/>";
}
}
?>
?>
</pre>
</pre>
@ -189,7 +190,7 @@ For contributing with a new style, [[http://www.monperrus.net/martin/|please dro
====How to change the link style?====
====How to change the link style?====
By default each bibliographic entry is followed by
By default each bibliographic entry is followed by
[bibtex] [pdf] [doi], etc.
[bibtex] [pdf] [doi], etc.
This can be tailored by configuring as follows (in the file ''bibtexbrowser.local.php'')
This can be tailored by configuring as follows (in the file ''bibtexbrowser.local.php'')
// bib is a special type of link. without the url argument or with an invalid image, it prints '[bibtex]'
// bib is a special type of link. without the url argument or with an invalid image, it prints '[bibtex]'
$result = $bibentry->getBibLink();
$result = $bibentry->getBibLink();
$result .= ' '.$bibentry->getLink('url');
$result .= ' '.$bibentry->getLink('url');
// Google Scholar ID. empty string if no gsid field present
// Google Scholar ID. empty string if no gsid field present
$result .= ' '.$bibentry->getGSLink();
$result .= ' '.$bibentry->getGSLink();
// returns an empty string if no doi field present
// returns an empty string if no doi field present
$result .= ' '.$bibentry->getDoiLink();
$result .= ' '.$bibentry->getDoiLink();
return $result;
return $result;
}
}
?>
?>
@ -262,7 +263,7 @@ You may create your own one in ''bibtexbrowser.local.php'' (see also "creating a
<pre>
<pre>
define('BIBLIOGRAPHYSECTIONS','my_sectioning');
define('BIBLIOGRAPHYSECTIONS','my_sectioning');
function my_sectioning() {
function my_sectioning() {
return
return
array(
array(
// Books
// Books
array(
array(
@ -313,7 +314,7 @@ Add in ''bibtexbrowser.local.php'':
global $BIBTEXBROWSER_LANG;
global $BIBTEXBROWSER_LANG;
$BIBTEXBROWSER_LANG=array();
$BIBTEXBROWSER_LANG=array();
$BIBTEXBROWSER_LANG['Refereed Conference Papers']="Conférences avec comité de lecture";
$BIBTEXBROWSER_LANG['Refereed Conference Papers']="Conférences avec comité de lecture";
...
...
$BIBTEXBROWSER_LANG['Year']="Année";
$BIBTEXBROWSER_LANG['Year']="Année";
?>
?>
</pre>
</pre>
@ -345,9 +346,9 @@ $db = new BibDataBase();
$db->load('biblio.bib');
$db->load('biblio.bib');
$query = array('year'=>'2014');
$query = array('year'=>'2014');
$entries=$db->multisearch($query);
$entries=$db->multisearch($query);
uasort($entries, 'compare_bib_entries');
foreach ($entries as $bibentry) {
echo $bibentry->getYear().'<br/>';
uasort($entries, 'compare_bib_entries');
foreach ($entries as $bibentry) {
echo $bibentry->getYear().'<br/>';
}
}
?>
?>
</pre>
</pre>
@ -409,7 +410,7 @@ and then in ''bibtexbrowser.after.php'':
class PgmDispatcher extends Dispatcher {
class PgmDispatcher extends Dispatcher {
function getDB() {
function getDB() {
$db = new BibDataBase();
$db = new BibDataBase();
// builds the first entry
// builds the first entry
$entry = new BibEntry();
$entry = new BibEntry();
$entry->setType("article");
$entry->setType("article");
@ -417,7 +418,7 @@ class PgmDispatcher extends Dispatcher {
$entry->setField("year", "2014");
$entry->setField("year", "2014");
$entry->setKey("kolp");
$entry->setKey("kolp");
$db->addEntry($entry);
$db->addEntry($entry);
// builds the second entry
// builds the second entry
$entry2 = new BibEntry();
$entry2 = new BibEntry();
$entry2->setType("article");
$entry2->setType("article");
@ -425,13 +426,13 @@ class PgmDispatcher extends Dispatcher {
$entry2->setField("year", "2013");
$entry2->setField("year", "2013");
$entry2->setKey("tili");
$entry2->setKey("tili");
$db->addEntry($entry2);
$db->addEntry($entry2);
return $db;
return $db;
}
}
}
}
?>
?>
</pre>
</pre>
====How to remove fields from the bibtex text?====
====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'':
If you want to remove some fields (e.g. abbrv and comment) from the resulting bibtex, add in ''bibtexbrowser.local.php'':
@ -480,7 +481,7 @@ include('bibtexbrowser.php');
''output.php'':
''output.php'':
<pre>
<pre>
OUTPUT (no header sent)
OUTPUT (no header sent)
<?php
<?php
define('BIBTEXBROWSER_URL','elem.php');
define('BIBTEXBROWSER_URL','elem.php');
include('bibtexbrowser.php');
include('bibtexbrowser.php');
?>
?>
@ -489,8 +490,8 @@ include('bibtexbrowser.php');
''elem.php'':
''elem.php'':
<pre>
<pre>
ELEM (no header sent)
ELEM (no header sent)
<?php
include('bibtexbrowser.php');
<?php
include('bibtexbrowser.php');
?>
?>
</pre>
</pre>
@ -499,7 +500,7 @@ include('bibtexbrowser.php');
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:
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: