BibORB Help

Index

Display Icons/Text
Actions for an entry (edit, delete, get ps, ps.gz, pdf ...) are available in both text format or icons. By default, icons are displayed. This can be modified by editing the config.php file and changing these two variables:
$display_images = TRUE;
$display_text = FALSE;
Display abstract
By default, abstract are not displayed. If you browser supports javascript, clicking on the abstract link or icons will show it in the same page. If the browser doesn't support javascript, a new page will be open to display the abstract. To always show abstract, change the value of $display_abstract to TRUE in the config.php file.
Authentication
If you want to share your bibliography within a local network, you may not want other people to edit or even delete your data. A simple authentication is available with biborb to manage authorized "admin" users. Unauthorized visitor may consult bibliographies but won't be able to modify it.
You will need a database and adapt the different variables in the config.php file:
$disable_authentication = FALSE;
$host = xxx;
$dbuser = xxx;
$pass = xxxx;
$db = xxxx;
$table = xxxx;
biborb.sql in admin directory contains SQL instructions to create the needded table. You then have to add manually users to the database.
Sorting entries.
It is possible to select which is the default sort method to display entries. Presently, three sort method are provided: title, year, bibtex id. This can be configure in the config.php file:
/**
 * Default sort method: ID,title,year
 */
$DEFAULT_SORT="ID";
You can also choose to display the sort function when entries are displayed.
/**
 * Display sort in all/group/search view
 * If no, displayed only on search
 * true/no
 */
$DISPLAY_SORT="no";
Export entries to BibTeX
When exporting the basket to bibtex, you can select which BibTeX fields are exported. Default fields to export can be set up in the config.php file. Add the name of fields you want to export by default.
/**
 * Choose which fields to save when exporting an entry to bibtex
 * By default all fields are exported
 */
$fields_to_export = array('author',
                          'address',
                          'annote',
                          'author',
                          'booktitle',
                          'chapter',
                          'crossref',
                          'edition',
                          'editor',
                          'howpublished',
                          'institution',
                          'journal',
                          'key',
                          'month',
                          'note',
                          'number',
                          'organisation',
                          'pages',
                          'publisher',
                          'school',
                          'series',
                          'title',
                          'type',
                          'volume',
                          'year');
Add new fields
It is possible to customize BibORB by adding new fields. This can be realize in two steps. Let's assume you want to add an ISBN field for the BibTeX entry "book":
  • Add '_isbn' to the bibtex_entries variable in the config.php file.
        $bibtex_entries = array(
        "_id",
        ...
        "_link",
        "_isbn" // <-- add the "_isbn" value
    );
        
  • Add the XML field tag <isbn/> to the book entry in model.xml. For this example, I want it to be an optional field:
    <entry type="book">
        <required>
          <id/>
          <exalternative>
            <author/><editor/>
          </exalternative>
          <title/><publisher/><year/>
          <!-- place here if isbn is a required field -- >
        </required>
        <optional>
          <exalternative>
            <volume/><number/>
          </exalternative>
          <series/><address/><edition/><month/><note/>
          <!-- place here if isbn is an optional field -- >
          <isbn/> 
        </optional>
        <additional>
          <groups/><abstract/><keywords/>
          <url/><urlzip/><pdf/><website/><link/><longnotes/>
          <!-- place here if isbn is an additional field -- >
        </additional>
      </entry>