webpage/index.text

   1 % Ebib: a BibTeX database manager for Emacs
   2 % Joost Kremers
   3 % @@date
   4
   5
   6 <div id="menu">
   7
   8 <div class="centering">
   9 <a href="http://sourceforge.net"><img style="width:88px;height:31px"
  10 src="http://sourceforge.net/sflogo.php?group_id=115723&amp;type=1"
  11 alt="SourceForge.net Logo" /></a>
  12 </div>
  13
  14 [Features](#features)
  15
  16 [Screenshots](#screenshots)
  17
  18 [Manual](manual/ebib-manual.html)
  19
  20 [Download](#download)
  21
  22 [Mailing list](#mailing-list)
  23
  24 <div class="bottom-dweller">
  25
  26 Last modified: <br/>
  27 @@date
  28
  29
  30 <!-- [[http://validator.w3.org/check?uri=referer][images/valid-xhtml10-blue.png]] -->
  31
  32 <!-- [[http://jigsaw.w3.org/css-validator/][images/valid-css-blue.png]] -->
  33
  34 </div>
  35
  36 </div>
  37
  38
  39 <div id="main">
  40
  41 Ebib is a program for managing BibTeX databases. There are already quite a
  42 few such programs, but Ebib has a special property: it runs inside
  43 Emacs. If you are used to doing everything LaTeX from within Emacs, you may
  44 appreciate that you can manage your `.bib` files in Emacs as well. One
  45 distinct advantage of Ebib is that you do not need to switch to another
  46 window and copy/paste a BibTeX key into your LaTeX file with the
  47 mouse. Ebib provides functions with which you can select a key from the
  48 database and have it inserted directly into your LaTeX text.
  49
  50 Ebib is fully keyboard-operated. Unlike other BibTeX database managers, you
  51 do not need the mouse at all. Everything Ebib can do can be accomplished
  52 with simple one-key commands. This makes using Ebib much faster than other
  53 similar programs, which are usually mouse-operated. And because Emacs does
  54 not have to run under X, Ebib can be used without X as well.
  55
  56 Ebib provides the standard capabilities that one would expect from a BibTeX
  57 database manager: `.bib` files can be opened, modified (adding, deleting,
  58 modifying entries), searched, and saved. Apart from the basics, Ebib has
  59 quite a few extra features that make managing your BibTeX files easier.
  60
  61
  62 ## Features ##
  63
  64 ### General ###
  65
  66  - runs in GNU Emacs and XEmacs.
  67  - visual representation distinguishing obligatory, optional and
  68    additional fields.
  69  - copy/cut/paste mechanism for quickly copying field values. (This fully
  70    integrates with Emacs' kill ring.)
  71  - automatic loading of `.bib` files upon start-up.
  72  - extensive user manual.
  73
  74
  75 ### BibTeX ###
  76
  77  - format of the `.bib` file is not restricted: everything that BibTeX
  78    accepts is also accepted by Ebib.
  79  - creating and editing `@string` and `@preamble` definitions is supported.
  80  - BibTeX entry and field types can be customised, allowing adaptation for
  81    non-standard and personal bibliography styles.
  82  - field values containing newlines are supported, allowing the creation
  83    of annotated bibliographies.
  84  - the database can be saved with the entries in the `.bib` file sorted on
  85    user-specified fields (useful in ConTeXt).
  86  - alternatively, the database can be saved with all entries containing a
  87    `crossref` field at the top of the `.bib` file, allowing you to make use of
  88    BibTeX's cross-referencing facility.
  89
  90
  91 ### Databases ###
  92
  93  - multiple `.bib` files can be opened at the same time.
  94  - merging of a second `.bib` file with an already loaded database.
  95  - single or multiple entries can be exported to another file, or to
  96    another open database, allowing the creation of a new specialised `.bib`
  97    file from an existing one. `@preamble` and `@string` definitions can also
  98    be exported.
  99
 100
 101 ### Searching ###
 102
 103
 104  - incremental search for BibTeX keys is supported.
 105  - simple regexp searches can be performed on a database, searching the
 106    contents of all fields of each entry.
 107  - complex search queries with logical `and`, `or` and `not` operators, built up
 108    interactively, can be performed, with the possibility of searching only
 109    specific fields.
 110
 111
 112 ### LaTeX integration ###
 113
 114  - from within a LaTeX document, it is possible to select (using
 115    TAB-completion) and insert a BibTeX key into the document.
 116  - inside Ebib, it is possible to push entries to a LaTeX buffer.
 117  - quick summary of entries into a `*Help*` buffer.
 118
 119
 120 ### Miscellaneous ###
 121
 122  - entries can be imported from text buffers or from the `*scratch*` buffer
 123    (allowing copy & paste of BibTeX entries, e.g. from the Internet).
 124  - a URL stored in a BibTeX field can be extracted and sent to a browser.
 125  - a time stamp can be added to each new entry, allowing you to keep track
 126    of new additions in the database.
 127  - (parts of) databases can be printed, either as a list of references
 128    typeset by BibTeX, or directly as database entries.
 129
 130
 131 ## Screenshots ##
 132
 133 Visually, Ebib is not very spectacular. But to get an impression of what it
 134 looks like, you can view the following two screenshots. The first shows
 135 Ebib's standard lay-out, with the list of entry keys in the top window and
 136 the fields of the currently highlighted entry in the bottom window. The
 137 string `Reuland' is highlighted as the result of a text search. The second
 138 screenshot shows the strings buffer, where you can edit the `@string`
 139 definitions in the database. (By the way, the color theme here is Blue Sea,
 140 it has nothing to do with Ebib.)
 141
 142 <a href="images/ebib-1.png"> <img style="width:153px;height:108px"
 143 src="images/tn_ebib-1.png" alt="screenshot 1" /></a>
 144
 145 <a href="images/ebib-2.png"> <img style="width:153px;height:108px"
 146 src="images/tn_ebib-2.png" alt="screenshot 2" /></a>
 147
 148
 149 ## Manual ##
 150
 151 The complete user manual for Ebib is available in html format
 152 [here](manual/ebib-manual.html).
 153
 154
 155 ## Download ##
 156
 157 Tar balls of Ebib releases can be downloaded from the
 158 [Sourceforge Project Page](http://sourceforge.net/projects/ebib). The tar ball
 159 contains the source code, and the manual in info and html format. Installation
 160 instructions can be found in the manual.
 161
 162 There is also a public [git repository](https://github.com/joostkremers/ebib.git) for Ebib.
 163 From there, you can get the latest sources, provided you have
 164 [git](http://git.or.cz/) installed.
 165
 166
 167 ## Mailing list ##
 168
 169 Ebib has a mailing list:
 170 [ebib-users](https://lists.sourceforge.net/lists/listinfo/ebib-users). Here, you
 171 can ask any questions regarding Ebib, send bug reports or feature requests.
 172
 173 </div>
 174