4.2.9 Bibliography

► |  | Scribble: The Racket Documentation Tool

1 | Getting Started
2 | @ Syntax
3 | High-Level Scribble API
4 | Scribbling Documentation
5 | Literate Programming
6 | Low-Level Scribble API
7 | Running scribble
| Index

► | 4 | Scribbling Documentation

4.1 | Getting Started with Documentation
4.2 | Manual Forms
4.3 | Racket
4.4 | Evaluation and Examples
4.5 | In-Source Documentation
4.6 | BNF Grammars
4.7 | Compatibility Libraries

▼ | 4.2 | Manual Forms

4.2.1 | Typesetting Code
4.2.2 | Documenting Modules
4.2.3 | Documenting Forms, Functions, Structure Types, and Values
4.2.4 | Documenting Classes and Interfaces
4.2.5 | Documenting Signatures
4.2.6 | Various String Forms
4.2.7 | Links
4.2.8 | Indexing
4.2.9 | Bibliography
4.2.10 | Version History
4.2.11 | Miscellaneous
4.2.12 | Index-Entry Descriptions
4.2.13 | Manual Rendering Style

On this page:

cite
bibliography
bib-entry
bib-entry?

top ← prev up next →

##### 4.2.9`` Bibliography

> > > See also scriblib/autobib.

> procedure (cite key ...+) → element?
> key : string?

Links to a bibliography entry, using the keys both to indicate the bibliography entry and, in square brackets, as the link text.

> procedure (bibliography [#:tag tag] entry ...) → part?
> tag : string? = "doc-bibliography"
> entry : bib-entry?

Creates a bibliography part containing the given entries, each of which is created with bib-entry. The entries are typeset in order as given.

> > procedure
> > (bib-entry |  | #:key key |  |  |  |
> > |  | #:title title |  |  |  |
> > | [ | #:is-book? is-book? |  |  |  |
> > |  | #:author author |  |  |  |
> > |  | #:location location |  |  |  |
> > |  | #:date date |  |  |  |
> > |  | #:url url |  |  |  |
> > |  | #:note note]) |  | → |  | bib-entry?
> key : string?
> title : (or/c #f pre-content?)
> is-book? : boolean? = #f
> author : (or/c #f pre-content?) = #f
> location : (or/c #f pre-content?) = #f
> date : (or/c #f pre-content?) = #f
> url : (or/c #f pre-content?) = #f
> note : (or/c #f pre-content?) = #f

Creates a bibliography entry. The key is used to refer to the entry via cite. The other arguments are used as elements in the entry:

- title is the title of the cited work. It will be surrounded by quotes in typeset form if is-book? is #f, otherwise it is typeset via italic.

- author lists the authors. Use names in their usual order (as opposed to “last, first”), and separate multiple names with commas using “and” before the last name (where there are multiple names). The author is typeset in the bibliography as given, or it is omitted if given as #f.

- location names the publication venue, such as a conference name or a journal with volume, number, and pages. The location is typeset in the bibliography as given, or it is omitted if given as #f.

- date is a date, usually just a year (as a string). It is typeset in the bibliography as given, or it is omitted if given as #f.

- url is an optional URL. It is typeset in the bibliography using tt and hyperlinked, or it is omitted if given as #f.

- note is an optional comment about the work. It is typeset in the bibliography as given, and appears directly after the date (or URL, if given) with no space or punctuation in between.

Changed in version 1.29 of package scribble-lib: Added the #:note option.

> procedure (bib-entry? v) → boolean?
> v : any/c

Returns #t if v is a bibliography entry created by bib-entry, #f otherwise.
top ← prev up next →