
       *********************************

        BibCard v0.7

        (c) 1995 Matthijs Luger
        
       *********************************


The programs and files in this distribution are freely distributable, but
are also copyright (c) Matthijs Luger. They may be freely distributed as
long as no more than a nominal fee is charged to cover time and copying
costs.

No commercial usage is permitted without written permission from the
author. Everything in this distribution must be kept together, in original
unmodified form.

The above is generally known as freeware.

If you have suggestions or remarks about this program, or if you find any
bugs, please let me know.

   Contacting the author:

     Fido:     2:280/509.4 (Matthijs Luger)

     Internet: mluger@bio.vu.nl

     Mail:     Matthijs Luger
               J. Bernardusstraat 7-2
               1091 TR Amsterdam
               Holland


Contents
========

    1. Introduction

    2. Usage

    3. Help

    4. Future

    5. History




1. Introduction
===============



! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !

!  First I want to say that this program is not finnished yet, and that !
   I'm still working at it. So it is possible to give comments and
!  sugestions for the next release.                                     !

!  I have tested it well before releasing this and I hope that there    !
   are no nasty bugs in it, but be warned. Keep a copy of your valuable
!  datafiles.                                                           !

! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !



BibCard is a database program to control BibTeX files. These are files
with references to articles, books, conferences etc. and are used in
combination with LaTeX.


It requires minimal v2.04 (kickstart V37) of the operating system. It has
been written and tested under v3.1 (V40), but should run under 2.04 and
higher. There were no enforcer hits during the final stage


BibCard has the following features:

  - BibCard opens on the Workbench, a public screen or his
    own (public) screen.

  - It can handle multiple bib files at once. It opens for
    every bib file a new window.

  - It has an Annotation option.

  - It has an @preamble option

  - It supports @string entries.

  - Every entry that is unknown for this version of BibCard
    will be stored and saved, but is not (yet) editable.

  - For every entry and field is some help, explaining where
    it is used for.

  - It can read "" and {} pair's for field delimeters.

  - Sensitive help.

  - You name it, I make it...

The source for reading and saving the bib files comes from the 1.11
distribution from BibCard for XWindows from The Department of Computer
Science and Applied Mathematics of Berne, Switzerland, written by Bruno
Grossniklaus. It is changed by me in some degree to suit the Amiga. (All
XView calls are removed and the Reference structure is replaced by my
own.)



2. Usage
========


The usage of BibCard is simple and need not much to explain. The menu's
are self explaining.

There are four menu's which are explained below.

  Project
  -------

    New         - Opens a new bibcard window.

    Open        - Load a bib file.

    Save        - Save a bib file.

    Save As     - Save a bib file specifying a new name.

    Merge       - Combines two bib files.

    Preferences - To set some preferences.

    About       - Tells it all.

    Quit        - Quit BibCard.



 Edit
 ----

    Add            - Add a new bib item at the end of the list.

    Duplicate      - Duplicate the current item without the Cite Key.

    Delete         - Delete the current item.

    Annotation     - Edit the annotation for the current item.

    Preamble       - Edit the preamble for the current file.

    Abbrevations   - Edit the Abbrevations for the current file

    Unknown Fields - Edit unknown fields for the current item.

    Cut            - Removes the current item and store's it in its 
                     internal buffer.

    Copy           - Copy the current item to the internal buffer.

    Paste          - Inserts the internal buffer after the current item.



  Entry
  -----

    Here you can select the entry type for the current item.



  Cite
  ----

    List Cites - Show a ListView with all the Cite Keys.



Saving and Loading
------------------

Every new opened BibWindow has a default name `bibcard-<n>.bib' where <n>
is a number. When you select <Save> that name will be used to store the
bibfile. There will be NO WARNING if that file already exist so the file
will be overwritten.

If the CiteKey field is empty you will be notified about it. If there are
empty Citekey fields it is not possible to save a bib file with empty
CiteKeys.


When using Merge, the loaded bib file will be appended to the one in memory.


Window and fields
-----------------

The window adapts itself to the entry kind, and it will grow or shrink
accordingly. (This behaviour can be changed in the prefrences.) 
Despite that not all the entries share the same fields you can fill in
every field for every entry, by changing the entry type to a type that
supports the field and then switch back to the original field. Although
you can not see the field it will be saved with the entry.

For every entry there are required and optional fields. These fields are
not required by BibCard, but are required for BiBTeX to work. The optional
fields are only used by BiBTeX if they have a value.

The only field that has to be filled in for BibCard is the CiteKey field.

The window title shows the window number, the number of the current entry,
the total entries and the name of the bib file.


Cite List
---------

When the Cite List is opened you get a list of all the cite keys in the
bib file. When an entry is selected the BibWindow is updated, when you
change the entry in the bibwindow in any way, the selection in the Cite
Window will not change, except for the CiteKey.


Find Window
-----------

For now there's a primitive Find routine. In the Find panel you can enter
a search expression. Every bin entry that matches the search criterium get
tagged. With the menu `Find Next' you can go from tagged item to tagged
item. 

The UnTag button in the Find panel clears all tags.

By selecting the CheckBoxes there can be choosen in which fields there
will be searched. The state of the CheckBoxes will be remembered between
different calls.



Preferences
-----------

Field delimeters:

    The field delimiters can be set here.  When saving a bib file the
    field strinfs will be surrounded with a pair of braces {} or a pair of
    double quotes "".  Default is ""


Fixed window size:

    When this is set, the window size will not change between the
    different entry types.  Default is off.



3. Help
=======

When the Help key is pressed inside a string gadget you get some
information explaining the use of the field.

When selecting an entry type under the Entry menu and then pressing the
Help key gives also some information about the entry type.
gives



4. Future
=========


There are still many things to do, but I want to release a minimal usable
version as quickly as possible and later add more features as:

 - A more sophsticated Find option.

 - Screen select for own screen.

 - Choose public screen from within BibCard.

 - Font selection.

 - More (user) fields as in BibCard v1.11 for XWindows.

 - Multi-select for Cite window.

 - Locale support.

 - Set some more preferences (ideas?).

 - Saving of preference file.
 


5. History
==========

  v0.7 (11.6.95)
  --------------

    o Added editting of unknown fields.

    o Added Cut/Copy/Paste functions using an internal buffer.

    o A line will be drawn between the required and the optional fields.

    o Field delimeters can be set between "" and {} pairs.
    
    o The main window can be set at fixed size.

    o Added Find option.


  v0.6 (8.5.95)
  --------------

    o Initial release
