Configuring BibORB

This page presents configuration options that are available in BibORB 1.3.2 (config.php).

Internationalization

/**
 * Localization
 * Available: en_US, fr_FR
 */
$language = "en_US";

/**
 * Show available languages on BibORB pages
 * TRUE/FALSE
 */
$display_language_selection = TRUE;

Use the $language variable to select the default language that should be used in BibORB.

Use the $display_language_selection to enable people to select their language within the BibORB interface. If this variable is set to FALSE then the interface is localized using the value of $language.

Authentication

/**
 * If TRUE, this will disable authentification.
 * All users will have the administrator status
 */
$disable_authentication = TRUE;

If you want to share your bibliography within a local network, you may not want other people to edit or even delete your data. If $disable_authentication is set to FALSE, user must login to be able to add, delete or update references.

At the moment, only a MySQL authentication is supported. If you want to use authentication, you have to set MySQL variables in php/auth.php:

/**
    The database configuration
*/
$host = "localhost";
$dbuser = "biborb-admin";
$pass = "biborbdev";
$db = "biborb";
$table = "biborb_users";
$auth_table = "biborb_auth";

data/biborb.sql contains SQL instructions to create the needded tables. You then have to add manually users to the database.

Delete entries

/**
 *  Should a confirmation may be displayed when deleting entries
 */
$warn_before_deleting = TRUE;

When a user has the authorization to delete entries, a confirmation message may be display when deleting entries. Set this variable to TRUE if you want this message to be displayed.

Display icons/text actions

/**
 * Should action be represented by icons or not.
 */
$display_images = TRUE;

/**
 *  Sould action be represented by text or not.
 */
$display_text = FALSE;

Actions on a reference (edit, delete, get ps, ps.gz, pdf ...) are available in both text format or icons. Set $display_images and $display_text to display both or only one of them.

Display abstract

/**
 * Should the abstract be present for each entry.
 */
$display_abstract = FALSE;

Set the $display_abstract variable to TRUE if you want the abstract to be always displayed. If FALSE, the abstract is displayed only if you click on the abstract action.

Sorting entries

/**
 * Display sort in all/group/search view
 * If no, displayed only on search
 * TRUE/FALSE
 */
$DISPLAY_SORT=TRUE;

/**
 * Default sort method: ID,title,year
 * and order: ascending/descending
 */
$DEFAULT_SORT="ID";
$DEFAULT_SORT_ORDER="ascending";

It is possible to select which is the default sort method to display references. Presently, three sort method are provided: title, year and bibtex key.

Set $DISPLAY_SORT to TRUE if you want to choose the sort method to use in BibORB.

Export entries to BibTeX

/**
 * 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');

When exporting the basket to bibtex, you can select which BibTeX fields are exported. Add/remove the name of fields that you want/don't want to be exported by default.