% tmpl.tex        -*- LaTeX -*-
% Last edited: Sun Oct 27 00:22:52 1991 by tompe@diag7 (Tommy Persson)
%
\documentstyle[a4]{article}

\setlength{\parindent}{0pt}
\setlength{\parskip}{1.5ex plus 0.3ex}


\title{Users Guide to Bibframe}
\author{
Tommy Persson \\
{\small Department of Computer and}\\
{\small Information Science}\\
{\small Link\"{o}ping University}\\
{\small S-581 83  Link\"{o}ping}\\
{\small Sweden}\\
tpe@ida.liu.se
}

\date{}

\begin{document}

\maketitle

\section{Introduction}

This is a local userguide to bibframe.

BibFrame makes it possible to deal with references in FrameMaker in a
general way. You do not have to enter your reference list by hand
every time you write a document. Instead, the reference list is
automatically generated from a data base with references. This ensure
that your reference entries are in the right format. You do not have
to bother with how things should be emphasized, abbreviated and so on.

You have a database with references. The format of the references is
the same format that is used by BibTeX. That means that people using
\LaTeX\ and FrameMaker can use the same data base. People interested
in a copy of the description of the BibTeX format can ask me (Tommy
Persson) for it.

Currently it is possible to use the bibliography styles ``plain'', ``alpha''
and ``mapalike''.

\section{How to use it}

It is possible to declare where you have your reference data bases.
You put the path in the variable \verb|TEXINPUT|. The places where
bibframe looks for your reference files is first the path (directory or
directory:directory:...) given by the user variable \verb!bf-refdir!
in FrameMaker.  Then bibframe looks in the directory where the 
current file is saved.  Then bibframe use the path given by 
\verb|TEXINPUT|.

The files with your
references must have the extension \verb!bib!. The variable
\verb!BIBFRAMEREF! could contain a list of your reference files. The
names are separated by a comma and they should not have any extension.
The files used is the files given by \verb!BIBFRAMEREF! and by the
FrameMaker user variable \verb!bf-reffiles!.

The variable \verb!BFBIN! must be be set to 
\verb!~tompe/bibframe/bin!. This is declared
in your \verb!.login!-file. 

For example:
\begin{verbatim}
setenv BFBIN ~tompe/bibframe/bin
setenv TEXINPUTS '.:/home/brutalix/ida/tompe/rkl'
setenv BIBFRAMEREF 'tompe-ref,xref'
\end{verbatim}

If you are using the window system X you must read in the keyboard macros 
in the file \verb!~tompe/bibframe/Xbibframe.kbm!.
If you are using Suntools you must use
the file \verb!~tompe/bibframe/bibframe.kbm2! for FrameMaker 2 and 
\verb!~tompe/bibframe/bibframe.kbm2! for FrameMaker 3.


To create a key entry in FrameMaker you write the ``key'' and then
\verb!ESC-bk!. The ``key'' is the name you have used in your reference
database to identify the entry. The point must be directly after the
key and there must be a space or no character at all directly after
the key.  This does not work if the key contains non-letter characters.
So there is an alternative way to create a key entry.  Select the key
and type \verb!ESC-bm!.

To generate a ``shortcite''-key (only for mapalike) type \verb!ESC-bsk!
respectively \verb!ESC-bsm!.

To generate the reference list in ``plain''-style and get the right
reference number in the document you type \verb!ESC-bb!.

To get the document in ``draft mode'' you type \verb!ESC-bd!.

If you for some reason want to use the ``alpha''-style you type
\verb!ESC-ba!  and if you want to use the ``mapalike''-style you type
\verb!ESC-bp!.


To insert the reference list in the document you place the point
where you want the list. Then you type \verb!ESC-bi!. If the 
reference list is not in the correct font you change that by changing
the font in the paragraph \verb!Reference!.

If you need another format or discover a bug in the system or want
another feature, send your a note to \verb!tpe@ida.liu.se!.

\section{Limitations}

If the shell script version is used there seems to be a limitation in
the number of references in the document.  The limit seems to be 196.
This can maybe be solved by using gsed instead of sed.

If the instructions above is followed you are not using the shell
script version.

\end{document}


