BibTeX Translator for FrameMaker

See the download page to obtain this program

Installation and Test

In this directory you will find:
README.htmlan HTML description of the program
fbibthis programme
fbib-test.framemifa MIF file with sample input for FrameMaker
fbib-test.biba sample BibTeX file for fbib
mml*.bstBibTeX style files modified for fbib
fbib should go in the shell's search path (e.g. /usr/local/bin). mml*.bst should go in BibTeX's search path (defined by TEXINPUTS). The other files are just for test purposes.

The following refers to NEXTSTEP/OPENSTEP; for other systems, the extension for MIF files should be mif. Open fbib-test.framemif in FrameMaker and save it; it will become document fbib-test.frame. Now save it as a MIF file (this is important) with extension bib, i.e. fbib-test.bib; it will become fbib-test.bib.framemif. Now run fbib fbib-test; the result will be a revised version of the original fbib-test.framemif, so you might wish to save this first. Finally open this revised file to find that the references have been included.

Environment variable FMHOME must contain the FrameMaker home directory (e.g. /LocalApps/FrameMaker.app). Environment variable BIBFRAMEREF may contain a comma-separated list of bibliography data files to be added to bibdata if defined. Environment variable BIBINPUTS may optionally contain a colon-separated list of directories for bibliography style files. This is added to environment variable TEXINPUTS used by bibtex.

Program Usage

This utility may be invoked from FrameMaker by saving the document as a MIF file with some name and extension .bib. When processed, the file can be opened as a FrameMaker document with the same name. If the current document name is used when saving, the new version will replace the old one.

If necessary, save the original FrameMaker file in MIF format first. Supply this on the command line to fbib. A bibliography style may optionally be supplied as a second parameter (with default "plain"):

fbib file[.bib.framemif] [abbrv|alpha|draft|mapalike|plain|unsrt]
fbib file[.bib.mif] [abbrv|alpha|draft|mapalike|plain|unsrt]
The result will be an updated version of the input file called file.[frame]mif, which can be read into FrameMaker again. Note that the extension for MIF files is .framemif under NEXTSTEP/OPENSTEP and .mif on other systems.

If the bibliography itself contains citations, fbib must be run again (perhaps several times to fix the list). It is also possible to run fbib again just to update citations. In either case, the old reference list should be deleted from the file.

Citation Format

The input file contains citations in the following form, where key cannot contain braces or brackets but may contain other punctuation symbols including space:

cite[qualification]{key}
citation with qualification (e.g. pages)
cite{key,...}
citation(s)
nocite{key,...}
citation(s) to appear in references not text

These may be split across a line due to hyphenation (but font changes within a citation will cause a failure). scite may be used instead of cite for short citations. Citations in the input are converted into references to FrameMaker variables [S]Cite{key} with the appropriate citation identifier. Subsequent changes may be made by editing the variable definitions.

If a citation key is given incorrectly, its value will be given as ?. Click on ?, edit the name of the citation variable, and replace the original with it. Alternatively, replace the ? and its surrounding brackets with a new cite{key} command. Once a citation has been included, the corresponding variable must be deleted in order to remove it.

After all citations, but not necessarily at the end of the document, there may be definitions of the bibliographic data files, directories and style:

bibdata{file,...}
bibliography data files
bibdir{dir:...}
bibliography directories
bibstyle{style}
bibliography style

These must not be split across a line due to hyphenation. They are converted into FrameMaker variables with the same name and removed from the source. Subsequent changes may be made by editing the variable definitions. Internal FrameMaker variables bibleft and bibright hold the left and right delimiters of citations (usually [ and ] brackets).

The reference list is placed after the paragraph containing bibdata, but can be moved if required. If references are processed again, the original references are replaced. References are generated in the default font of Times. If necessary, change the default font for the Reference paragraph format (leaving Angle and Weight as is). Note that the existing document must not contain a paragraph tag called Reference.

Small capitals can be used in the BibTeX file, but care must be used when BibTeX might reduce letters to lower case. To achieve the effect of {\sc Fred} use {F}{\sc red}.

fbib does not support FrameMaker book format. This is largely because this format is best used with fmbatch, which is supplied with only some versions of FrameMaker. Instead, use fbib to collect references at the end of each chapter. If it desired to move these to a single References chapter, import the variables from each chapter to this chapter (`Use Formats From'). Then delete the text of the references in each chapter and run fbib on the References chapter to include the references.

History

Original due to Tommy Persson <tpe@ida.liu.se>, 14th December 1992

Version 1.0, first public version, Ken Turner, 15th December 1994

Version 1.1, minor improvements, Ken Turner, 30th January 1996

Version 1.2, warning of possible problems, Ken Turner, 30th September 1996 Version 1.3, minor bug fixes, Ken Turner, 6th May 1997 Version 1.4, minor bug fixes, Ken Turner, 22nd April 1998 Version 1.5, minor bug fixes, Ken Turner, 20th July 1998 Version 1.6, minor fixes/changes, Ken Turner, 21st July 1999


Up one level to FrameMaker Utilities

Web Ken Turner Home   Email    Search Search Web Pages

Last Update: 28th July 2006
URL: http://www.cs.stir.ac.uk/~kjt/software/framemaker/fbib.html