NAME

refdbnd - creates a skeleton document and a Makefile for RefDB

SYNOPSIS

Interactive mode:

refdbnd

Non-interactive mode:

refdbnd basename doctype pubtype database style encoding css-file

DESCRIPTION

This script should be the first choice for novices to create new SGML or XML documents for use with RefDB(7). If called without arguments, the script runs in an interactive mode and collects a few answers about the new document. Based on these answers it will create skeleton documents for both the short and full citation formats, as well as a custom-tailored Makefile that performs all necessary steps to create formatted output from the document.

Alternatively you can call this script from a directory that contains an existing SGML or XML file. Pass the full name to the script when it asks for a filename, and the script will try to guess some of the settings from the existing file.

The script can create the following document types:

DocBook SGML: Versions 3.1, 4.0, 4.1
DocBook XML: Version 4.1.2, 4.2, 4.3
TEI XML: Version P4

The skeleton documents created by the script contain the appropriate prolog for the selected document type. The only extension is the declaration of an external entity in the internal subset which is required to include the bibliography.

OPTIONS

basename: The basename of the document, i.e. sans extension. If you want to end up with foo.pdf, use foo
doctype: Available options are db31, db40, and db41 for DocBook SGML; db41x, db42x, and db43x for DocBook XML; and teix for TEI XML
pubtype: This is one of set, book, or article for DocBook, and TEI.2 for TEI
database: The name of the database that contains your references.
style: The name of the bibliography style.
encoding: The character encoding of the document.
css-file: The name of a CSS file for the HTML output.

MAKEFILE TARGETS

The Makefile is set up to process your document properly depending on its type. The following targets are available to be called like make target:

html: Creates a set of HTML files.
pdf: Creates a PDF file.
ps: Creates a Postscript file (SGML documents only).
rtf: Creates a RTF file. The Rich Text Format can be edited by most Word Processors.
Note
Not all FO processors offer RTF output, so this target may not work for XML documents with your setup.
all: This is the default if you call make without specifying a target. It will build all of the above targets.
htmldist: Creates a .tar.gz archive of the HTML files.
pdfdist: Creates a .tar.gz archive of the PDF file.
ps: Creates a .tar.gz archive of the Postscript file (SGML documents only).
rtf: Creates a .tar.gz archive of the RTF file.
dist: This will build all of the above archives.
clean: This will remove all built files, except for the source document using the full citation format.
shortclean: This will remove all built files, including the source document using the full citation format.

FILES

/usr/local/share/refdb/db/examples/Makefile.template

The template used to create the Makefile.

AUTHOR

refdbnd was written by Markus Hoenicka <markus@mhoenicka.de>.

REFERENCES

1. http://refdb.sourceforge.net/manual/index.html: http://refdb.sourceforge.net/manual/index.html
2. http://refdb.sourceforge.net/: http://refdb.sourceforge.net/