sbromle / refbase-fork Goto Github PK

refbase 0.9.5 README
====================

About refbase
-------------
  refbase is a web-based solution for managing scientific literature,
  references and citations.
  
  Currently, the following features have been implemented for:
  EVERYONE
    - search the database using different search forms
    - search within results
    - browse found records and sort results by any database field
    - view results in different views (list view, citations, details,
      print view)
    - display results in different citation styles & output formats
    - export selected records to XML (Atom, MODS, OAI_DC, ODF) and (via
      the GPLed Bibutils programs) to ADS, BibTeX, EndNote, ISI, RIS and
      Word XML
    - display rich text (i.e., italics, super/sub-script, greek letters)
    - extract citations from a text & build an appropriate reference list
    - track additions via RSS and generate custom RSS feeds from searches
    - web services (SRU & OpenSearch) that allow clients to access a
      refbase database using a standard query syntax and retrieve results
      in structured XML format
    - dissemination of bibliographic data via standard methods (COinS &
      unAPI) allowing clients to automatically discover and extract data
      from refbase
    - search a refbase online database from the command line and retrieve
      results in various export & citation formats
  LOGGED IN USERS
    - user-specific fields which are stored individually for each user
    - import of records from common bibliographic formats and online
      databases via the web interface or the command line
    - automatic email announcements for newly added records
    - save and recall search queries
    - adding records to user-specific groups
    - add/edit/delete records as well as file upload & download links
  ADMINISTRATOR
    - user management interface provided to the database admin
    - set access permissions on a per-user basis

  More information is given at:
    <http://features.refbase.net>

Credits
-------
  See AUTHORS

Requirements
------------
  refbase requires:
  - a web server (like the Apache HTTP Server <http://httpd.apache.org/>)
  - PHP <http://www.php.net/> (version 4.4.0 or greater) with enabled
    session support & installed PHP MySQL module
  - MySQL <http://www.mysql.com/> (version 4.1.x or greater required for
    Unicode support)
  
  - for import and export of various formats (e.g., Endnote & BibTeX):
    Bibutils <http://www.scripps.edu/~cdputnam/software/bibutils/>
    (version 3.21 or greater)

  More detailed information is available at:
    <http://requirements.refbase.net>

Installation & Import
---------------------
  See INSTALL

Update
------
  See UPDATE

New Features
------------
  See NEWS

Changelog
---------
  See ChangeLog

Known issues
------------
  See BUGS

What is missing?
----------------
  See TODO

License
-------
  See COPYING

Further information
-------------------
  For more information about the refbase project and pointers to working
  examples of refbase please visit:
    <http://www.refbase.net/>  or  <http://refbase.sourceforge.net/>