Directory 0.98 User's Guide

January 30, 1998

1.  Introduction

directory is a macro package for LaTeX2e and BibTeX that facilitates the construction, the maintenance and the exploitation of an address book like database. It consists of five BibTeX style files (address.bst, phone.bst, email.bst, birthday.bst and letter.bst) designed to be used in conjunction with the LaTeX2e style file directory.sty. According to the bibliographical style used, the package has two main applications:

1. the construction of a list of informations (address, phone number, etc) about selected persons, companies or places;

2. the inclusion of selected informations concerning a person, a place or a company at a desired location in a document.

In the first case, directory behaves just like standard bibliographical packages do with lists of information concerning books, articles, proceedings, etc. For example, the name in the title of this guide refers to the corresponding entry in the directory listed in section . The first four BibTeX files permit several handlings of these informations.

In the second case, the package enables the extraction of information of the database to be put in your document. It can for example be used to put the address of your correspondent in the address field of a letter.

An archive of the package is available here: directory-0.98.tar.gz. The separate files are also available through the CTAN mirror sites in the bibliography/bibtex/contrib/directory/ subdirectory.

Any questions, comments or suggestions? Send me an e-mail.

2.  General description

2.1  Package inclusion and options

The package is included by the usual \usepackage[option]{directory}command at the top of the document, where option stands for one of the following:

symbol:

a symbol is produced in the text after a directory cited key. The labels are typeset in the default document font;

underline, bold or emphase:

the directory entries are underlined, typeset in bold format or emphasized (both in the main text and in the directory);

bracket:

the directory entries are enclosed in brackets, just the way they are in the standard BibTeX formats.

The directory is produced by the \directory[extension]{filename} command, where filename represents the name of the bib file (without the bib extension) and where the optional argument extensionrepresents, if necessary, the extension of the file output by BibTeX (see section ). As usual, multiple bib files can be included, a comma separating the different filenames.

2.2  Making a citation

An entry is cited in the text by a \dir{key}, \pdir{key}, \rdir{key} or \wdir{key} command, equivalent to the standard \cite{key} command, where key is used in the same way as ever (referring to an entry in a bib file). The differences between the four citation commands will be explained in the next section. A \nodir{key} command exists and acts exactly like \nocite{key} for standard bibliographies.

2.3  The bst styles

The style of the directory is chosen by a \directorystyle{style} command, where style is one of the following:

address:

full listing in the directory of all fields corresponding to the key entry in the bib file. The \dir{key}command also prints the name field of the entry in the document;

phone:

only the phone and fax fields corresponding to the cited entry are displayed in the directory. The \dir{key} command acts in the same way as with the address style, except that the names are abbreviated;

email:

only e-mail addresses are displayed in the directory. The \dir{key} command acts in the same way as with the address style;

birthday:

only the birthdays are displayed, sorting the entries in chronological order. The \dir{key} command acts in the same way as with the address style;

letter:

acts in a slightly different way than the four preceding styles. No directory is produced with the \directory command. The \dir{key} command results in the name field of the key entry to be printed in the document. The \pdir{key} (respectively \rdir{key}or \wdir{key}) command prints the name and the private (respectively residence or work) address in the document in a tabular way.

2.4  The bib file fields

In all entry types, name is the only obligatory field, since it serves as a key for sorting the entries.

person:

besides the name, nickname, birthday, birthyear and note fields, the available fields for the person entry in a bib file are divided in three main categories. The first one (its associated keys begin with `p.', which stands for `private') refers to the person's private information: p.address, p.phone, p.fax, p.email, p.url and p.account. The second one (for which all the keys begin with `r.') refers to stuff relative to a person's residence (i.e. a secondary or temporary address, which is for example useful for students): r.address, r.phone, r.fax, r.email and r.url. The last one (associated keys begin with `w.', standing for `work') refers to professional informations: w.title, w.name, w.address, w.phone, w.fax, w.email, w.url and w.account.

company:

the available fields for the company entry are: name, address, phone, fax, email, url, account and note.

place:

the available fields for the place entry are: name, address, phone, fax and note.

2.5  Customization

The symbol produced in the text after a directory label when the symbol option is chosen can be easily redefined. The value used in this user's guide is:

\renewcommand{\dirsymbol}
   {\raisebox{1ex}{\tiny\textit{(p.\pageref{directory})}}}

\renewcommand{\birthdayflag}{\footnotesize$\heartsuit$}
\renewcommand{\privateflag}{\emph{home}}
\renewcommand{\residenceflag}{\emph{residence}}
\renewcommand{\workflag}{\emph{work}}
\renewcommand{\noteflag}{\emph{note}}

\setlength{\dirindent}{6em}
\setlength{\dirsep}{3ex}

3.  Using both directory and bibliography

Since BibTeX always produces an output file of the form ` filename.bbl', it is necessary-in order to use both directory and bibliography entries-, after generating the bbl file corresponding to the directory, to rename it with a new extension (for example dir), and to give this new extension as an optional argument to the \directory command. The normal procedure can then be followed during the rest of the bibliography processing. Remember that changing the directory (adding an entry or suppressing one) forces you to restart from the beginning.

4.  Example

Despite the option described in section 3, one of the most interesting way of using directory is to build a separate address book, including several bib files referring to several categories of people, companies or places, as in the example shown in this document:

\nodir{*}
\directory{family,business}

\begin{letter}{\protect\wdir{c.geuzaine}}

Here are four bib entries (taken from family.bib and business.bib):

@Person{c.geuzaine,
  name      = "Christophe Geuzaine",
  w.title   = "Ir., Research Assistant",
  w.name    = "University of Li\`ege \\
               Department of Electrical Engineering",
  w.address = "Institut Montefiore (B28, P32, I21) \\ 
               Sart Tilman, B-4000 Li\`ege, Belgium",
  w.phone   = "+32-(0)4-366.37.10",
  w.fax     = "/29.10",
  w.email   = "Christophe.Geuzaine@ulg.ac.be",
  w.url     = "http://www.montefiore.ulg.ac.be/~geuzaine",
  birthday  = "06 02",
  p.email   = "Christophe.Geuzaine@advalvas.be",
}

@Person{d.d.knu,
  name      = "Knudson, Daffy D. and Bugs Bunny",
  nickname  = "gnat and gnu",
  birthday  = "10 02 and 05 11",
  p.address = "Haight Street 512, 80214 Novosibirsk, Gnuland",
  p.phone   = "+01-(0)2-765.43.21",
  p.account = "010-1234567-05",
  r.address = "Manor Lane 2, 80214 Novosibirsk, Gnuland",
  r.phone   = "+01-(0)2-876.54.32",
  w.name    = "University of Novosibirsk \\
               Department of Octopus Parthenogenesis",
  w.address = "Planck Institut (V1-V2, Park. U-67) \\ 
               Hessenberg Road, 80214 Novosibirsk, Gnuland",
}

@Company{knudsoft,
  name      = "The Knudsoft Company",
  email     = "knud@knudsoft.com", 
  url       = "http://knudsoft.com/hole/gates.htm", 
}

@Place{knudsoft:rs.2,
  name      = "Knudsoft (RS.2 Cmptr Room)",
  phone     = "+01-(0)2-434.23.23",
}

5.  Versions

0.95

First distributed version.

0.96

New documentation. Introduction of customization commands. New alignment mechanism in the addressbook and phonebookenvironments.

0.97

Entries ccp and p.ccp changed to accountand p.account.

0.98

New style letter.bst. New commands \pdir, \rdir and \wdir to produce in-text addresses when used with the letter.bst style. New internal key generation.