fm/zrd-bibtexbrowser
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

refactored the excellent commit of M. Guillaumin

Browse Source 
- LAYOUT -> BIBTEXBROWSER_LAYOUT by convention
- BIBTEXBROWSER_LAYOUT has non-abbreviated values (for sake of intuitiveness)
- BIBTEXBROWSER_LAYOUT has no complex interplay with ABBRV_TYPE  (for sake of intuitiveness)
- ordered lists are responsible for the indices
- no new line at the end of the file
- renamed or moved some functions
This commit is contained in:
Martin Monperrus
2013-03-10 09:48:36 +01:00
parent f9b2f7a62a
commit 2d3f27015d
1 changed files with 115 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bibtexbrowser.php
+113 -90
View File
@@ -4,7 +4,7 @@ URL: http://www.monperrus.net/martin/bibtexbrowser/
Feedback & Bug Reports: martin.monperrus@gmail.com Feedback & Bug Reports: martin.monperrus@gmail.com
(C) 2013 Matthieu Guillaumin (C) 2013 Matthieu Guillaumin
(C) 2006-2012 Martin Monperrus (C) 2006-2013 Martin Monperrus
(C) 2005-2006 The University of Texas at El Paso / Joel Garcia, Leonardo Ruiz, and Yoonsik Cheon (C) 2005-2006 The University of Texas at El Paso / Joel Garcia, Leonardo Ruiz, and Yoonsik Cheon
This program is free software; you can redistribute it and/or This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as modify it under the terms of the GNU General Public License as
@@ -80,6 +80,12 @@ define('BIBTEXBROWSER','v__GITHUB__');
// their publication lists according to this bibtex // their publication lists according to this bibtex
@define('BIBTEXBROWSER_AUTHOR_LINKS','homepage'); @define('BIBTEXBROWSER_AUTHOR_LINKS','homepage');
// BIBTEXBROWSER_LAYOUT defines the HTML rendering layout of the produced HTML
// may be table/list/ordered_list/definition (for <table>, <ol>, <dl> resp.).
// for list/ordered_list, the abbrevations are not taken into account (see ABBRV_TYPE)
// for ordered_list, the index is given by HTML directly (in increasing order)
@define('BIBTEXBROWSER_LAYOUT','table');
@define('BIBTEXBROWSER_DEBUG',false); @define('BIBTEXBROWSER_DEBUG',false);
@define('COMMA_NAMES',false);// do have authors in a comma separated form? @define('COMMA_NAMES',false);// do have authors in a comma separated form?
@@ -118,8 +124,6 @@ define('BIBTEXBROWSER','v__GITHUB__');
@define('METADATA_DC',true); @define('METADATA_DC',true);
@define('METADATA_EPRINTS',false); @define('METADATA_EPRINTS',false);
@define('LAYOUT','table'); // may be table/list/deflist. defines the HTML rendering options (<table>, <ol>/<ul>, <dl>, resp.). 'list' only works with 'ABBRV_TYPE'='index' (ordered list) and 'none' (unordered list, the default if another choice than 'list' is made).
// in embedded mode, we still need a URL for displaying bibtex entries alone // in embedded mode, we still need a URL for displaying bibtex entries alone
// this is usually resolved to bibtexbrowser.php // this is usually resolved to bibtexbrowser.php
// but can be overridden in bibtexbrowser.local.php // but can be overridden in bibtexbrowser.local.php
@@ -243,7 +247,7 @@ function _zetDB($bibtex_filenames) {
&& is_readable($compiledbib) && is_readable($compiledbib)
&& filesize($compiledbib)>0 && filesize($compiledbib)>0
) { ) {
$f = fopen($compiledbib,'r+'); // my Unix seems to consider flock as a writing operation $f = fopen($compiledbib,'r+'); // some Unix seem to consider flock as a writing operation
//we use a lock to avoid that a call to bibbtexbrowser made while we write the object loads an incorrect object //we use a lock to avoid that a call to bibbtexbrowser made while we write the object loads an incorrect object
if (flock($f,LOCK_EX)) { if (flock($f,LOCK_EX)) {
$s = filesize($compiledbib); $s = filesize($compiledbib);
@@ -1245,7 +1249,7 @@ class BibEntry {
return $this->fields; return $this->fields;
} }
/** Returns the abbreviation. */ /** Returns the raw, undecorated abbreviation depending on ABBRV_TYPE. */
function getRawAbbrv() { function getRawAbbrv() {
if (ABBRV_TYPE == 'index') return $this->index; if (ABBRV_TYPE == 'index') return $this->index;
if (ABBRV_TYPE == 'none') return ''; if (ABBRV_TYPE == 'none') return '';
@@ -1260,10 +1264,10 @@ class BibEntry {
return $f($this); return $f($this);
} }
/** Returns the abbreviation. */ /** Returns the abbreviation, etc [1] if ABBRV_TYPE='index'. */
function getAbbrv() { function getAbbrv() {
$abbrv = $this->getRawAbbrv(); $abbrv = $this->getRawAbbrv();
if ( ABBRV_TYPE == 'key' || ABBRV_TYPE == 'year' || ( ABBRV_TYPE == 'index' && LAYOUT != 'list' ) ) { if ( ABBRV_TYPE != 'none' ) {
$abbrv = '['.$abbrv.']'; $abbrv = '['.$abbrv.']';
} }
return $abbrv; return $abbrv;
@@ -1309,44 +1313,48 @@ class BibEntry {
/** Outputs HTML line according to layout */ /** Outputs HTML line according to layout */
function toHTML() { function toHTML() {
switch(LAYOUT) { // open row switch(BIBTEXBROWSER_LAYOUT) { // open row
case 'list': case 'list':
echo '<li class="bibline" value="'.$this->getAbbrv().'">'; echo '<li class="bibline">';
break;
case 'ordered_list':
echo '<li class="bibline">';
break; break;
case 'table': case 'table':
echo '<tr class="bibline"><td class="bibref">'; echo '<tr class="bibline"><td class="bibref">';
break; break;
case 'deflist': case 'definition':
echo '<dl class="bibline"><dt class="bibref">'; break; echo '<dl class="bibline"><dt class="bibref">';
if (ABBRV_TYPE=='none') { die ('Cannot define an empty term!'); }
break;
} }
$this->anchor(); echo $this->anchor();
switch(LAYOUT) { // close bibref and open bibitem switch(BIBTEXBROWSER_LAYOUT) { // close bibref and open bibitem
case 'table': case 'table':
echo $this->getAbbrv().'</td><td class="bibitem">'; echo $this->getAbbrv().'</td><td class="bibitem">';
break; break;
case 'deflist': case 'definition':
echo $this->getAbbrv().'</dt><dd class="bibitem">'; echo $this->getAbbrv().'</dt><dd class="bibitem">';
break; break;
} }
echo bib2html($this); echo bib2html($this);
echo bib2links($this); echo $this->bib2links();
switch(LAYOUT) { // close row switch(BIBTEXBROWSER_LAYOUT) { // close row
case 'list': case 'list':
echo '</li>'; echo '</li>'."\n";
break;
case 'ordered_list':
echo '</li>'."\n";
break; break;
case 'table': case 'table':
echo '</td></tr>'; echo '</td></tr>'."\n";
break; break;
case 'deflist': case 'definition':
echo '</dd></dl>'; echo '</dd></dl>'."\n";
break; break;
} }
} }
/** Create the entry anchor */
function anchor() {
echo '<a name="'.$this->getAbbrv().'"></a>';
}
/** Outputs an coins URL: see http://ocoins.info/cobg.html /** Outputs an coins URL: see http://ocoins.info/cobg.html
* Used by Zotero, mendeley, etc. * Used by Zotero, mendeley, etc.
@@ -1409,6 +1417,40 @@ class BibEntry {
} }
/** Returns an anchor for this entry. */
function anchor() {
return '<a name="'.$this->getRawAbbrv().'"></a>';
}
/** returns a collection of links for the given bibtex entry
* e.g. [bibtex] [doi][pdf]
*/
function bib2links() {
$href = 'href="'.$this->getURL().'"';
$str = '';
if (BIBTEXBROWSER_BIBTEX_LINKS) {
// we add biburl and title to be able to retrieve this important information
// using Xpath expressions on the XHTML source
$str .= " <a".(BIBTEXBROWSER_BIB_IN_NEW_WINDOW?' target="_blank" ':'')." class=\"biburl\" title=\"".$this->getKey()."\" {$href}>[bibtex]</a>";
}
// returns an empty string if no url present
$str .= $this->getUrlLink();
if ($this->hasField('doi')) {
$str .= ' <a href="http://dx.doi.org/'.$this->getField("doi").'">[doi]</a>';
}
// Google Scholar ID
if ($this->hasField('gsid')) {
$str .= ' <a href="http://scholar.google.com/scholar?cites='.$this->getField("gsid").'">[cites]</a>';
}
return $str;
}
/** /**
@@ -1454,32 +1496,36 @@ class BibEntry {
} }
} }
/** returns an HTML tag depending on BIBTEXBROWSER_LAYOUT e.g. <TABLE> */
function layoutHeaderHTML() { function get_HTML_tag_for_layout() {
$tag = ''; switch(BIBTEXBROWSER_LAYOUT) { /* switch for different layouts */
switch(LAYOUT) { /* switch for different layouts */ case 'list':
case 'list': $tag='ul';
if (ABBRV_TYPE=='index') { break;
$tag='ol'; case 'ordered_list':
} else { // assume none $tag='ol';
$tag='ul'; break;
} case 'table':
break; $tag = 'table';
case 'table': break;
$tag = 'table'; case 'definition':
break; $tag = 'div';
case 'deflist': break;
$tag = 'div'; default:
break; die('Unknown BIBTEXBROWSER_LAYOUT');
default: }
die('Unknown LAYOUT'); return $tag;
}
echo '<' . $tag . ' class="result">';
return $tag;
} }
function layoutFooterHTML($tag) {
echo '</' . $tag . '>'; /** prints the header of a layouted HTML, depending on BIBTEXBROWSER_LAYOUT e.g. <TABLE> */
function print_header_layout() {
echo '<' . get_HTML_tag_for_layout() . ' class="result">'."\n";
}
/** prints the footer of a layouted HTML, depending on BIBTEXBROWSER_LAYOUT e.g. </TABLE> */
function print_footer_layout() {
echo '</' . get_HTML_tag_for_layout() . '>';
} }
/** this function encapsulates the user-defined name for bib to HTML*/ /** this function encapsulates the user-defined name for bib to HTML*/
@@ -1488,30 +1534,6 @@ function bib2html(&$bibentry) {
return $function($bibentry); return $function($bibentry);
} }
function bib2links(&$bibentry) {
$href = 'href="'.$bibentry->getURL().'"';
if (BIBTEXBROWSER_BIBTEX_LINKS) {
// we add biburl and title to be able to retrieve this important information
// using Xpath expressions on the XHTML source
$str .= " <a".(BIBTEXBROWSER_BIB_IN_NEW_WINDOW?' target="_blank" ':'')." class=\"biburl\" title=\"".$bibentry->getKey()."\" {$href}>[bibtex]</a>";
}
// returns an empty string if no url present
$str .= $bibentry->getUrlLink();
if ($bibentry->hasField('doi')) {
$str .= ' <a href="http://dx.doi.org/'.$bibentry->getField("doi").'">[doi]</a>';
}
// Google Scholar ID
if ($bibentry->hasField('gsid')) {
$str .= ' <a href="http://scholar.google.com/scholar?cites='.$bibentry->getField("gsid").'">[cites]</a>';
}
return $str;
}
/** encapsulates the user-defined sections. @nodoc */ /** encapsulates the user-defined sections. @nodoc */
function _DefaultBibliographySections() { function _DefaultBibliographySections() {
$function = BIBLIOGRAPHYSECTIONS; $function = BIBLIOGRAPHYSECTIONS;
@@ -1727,7 +1749,7 @@ function DefaultBibliographyStyle(&$bibentry) {
} }
// add the Coin URL // add the Coin URL
$result .= "\n".$bibentry->toCoins(); $result .= $bibentry->toCoins();
return $result; return $result;
} }
@@ -2371,7 +2393,7 @@ class SimpleDisplay {
echo 'Options: '.@implode(',',$this->options).'<br/>'; echo 'Options: '.@implode(',',$this->options).'<br/>';
} }
$tag = layoutHeaderHTML(); print_header_layout();
$count = count($this->entries); $count = count($this->entries);
$i=0; $i=0;
@@ -2382,7 +2404,7 @@ class SimpleDisplay {
$bib->toHTML(); $bib->toHTML();
} // end foreach } // end foreach
layoutFooterHTML($tag); print_footer_layout();
} // end function } // end function
} // end class } // end class
@@ -2438,21 +2460,21 @@ class AcademicDisplay {
uasort($entries, ORDER_FUNCTION); uasort($entries, ORDER_FUNCTION);
if (count($entries)>0) { if (count($entries)>0) {
echo "\n".'<div class="btb-header">'.$title.'</div>'."\n"; echo "\n".'<div class="btb-header">'.$title.'</div>'."\n";
$tag = layoutHeaderHTML(); print_header_layout();
// by default the abbreviation is incremented over all searches // by default the abbreviation is incremented over all searches
// since we don't know before hand all section, we can not index in decreasing order // since we don't know before hand all section, we can not index in decreasing order
static $count; static $count;
if ($count == NULL) { $count = 1; } // init if ($count == NULL) { $count = 1; } // init
$id = $count; $id = $count;
foreach ($entries as $bib) { foreach ($entries as $bib) {
$bib->setIndex($id++); $bib->setIndex($id++);
$bib->toHTML(); $bib->toHTML();
} // end foreach } // end foreach
$count = @$count + count($entries); $count = @$count + count($entries);
layoutFooterHTML($tag); print_footer_layout();
} }
} }
@@ -3243,7 +3265,7 @@ class PagedDisplay {
} }
$this->menu($less, $more); $this->menu($less, $more);
$tag = layoutHeaderHTML(); print_header_layout();
for ($i = 0; $i < PAGE_SIZE; $i++) { for ($i = 0; $i < PAGE_SIZE; $i++) {
$index = ($this->page-1)*PAGE_SIZE + $i; $index = ($this->page-1)*PAGE_SIZE + $i;
if (isset($this->entries[$index])) { if (isset($this->entries[$index])) {
@@ -3254,7 +3276,8 @@ class PagedDisplay {
//break; //break;
} }
} // end foreach } // end foreach
layoutFooterHTML($tag);
print_footer_layout();
$this->menu($less, $more); $this->menu($less, $more);
} }