suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

simple bibliography support in Scribble

Browse Source 
svn: r7929
This commit is contained in:
Matthew Flatt 2007-12-09 17:40:40 +00:00
parent 525f967b78
commit 8e68038c83
11 changed files with 193 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
collects/scribble/manual.ss
View File

@ -1546,27 +1546,67 @@
;; ----------------------------------------
(provide cite)
(provide cite
bib-entry
(rename-out [a-bib-entry? bib-entry?])
bibliography)
(define (cite #:key key #:title title #:author author #:location location #:date date #:url [url #f])
"[...]"
#;
(make-bibliography-element
#f
(list "[...]")
key
(list (string-append
(content->string (list author))
", "
(content->string (list title))))
(list (make-element #f (list author
", "
title
", "
date
". "
location
".")))))
(define (cite key)
(make-link-element
#f
(list (format "[~a]" key))
`(cite ,key)))
(define-struct a-bib-entry (key val))
(define (bib-entry #:key key #:title title #:author author #:location location #:date date #:url [url #f])
(make-a-bib-entry
key
(make-element
#f
(list author
", "
'ldquo
title
"," 'rdquo " "
location
", "
date
"."
(if url
(make-element #f
(list " "
(link url
(tt url))))
"")))))
(define (bibliography #:tag [tag "doc-bibliography"] . citations)
(make-unnumbered-part
#f
(list `(part ,tag))
(list "Bibliography")
'()
null
(make-flow
(list
(make-table
"bibliography"
(map (lambda (c)
(let ([key (a-bib-entry-key c)]
[val (a-bib-entry-val c)])
(list
(make-flow
(list
(make-paragraph
(list
(make-target-element
#f
(list "[" key "]")
`(cite ,key))))))
(make-flow (list (make-paragraph (list (hspace 1)))))
(make-flow (list (make-paragraph (list val)))))))
citations))))
null))
;; ----------------------------------------

4
collects/scribble/scribble.css
View File

@ -419,6 +419,10 @@
font-family: Consolas, Courier, monospace; font-size: 13px;
}
.bibliography td {
vertical-align: top;
}
.imageleft {
float: left;
margin-right: 0.3em;

13
collects/scribble/struct.ss
View File

@ -50,13 +50,24 @@
(let-values ([(v ext?) (resolve-get/where part ri key)])
v))
(define (resolve-get-keys part ri key-pred)
(let ([l null])
(hash-table-for-each
(collected-info-info
(part-collected-info part ri))
(lambda (k v)
(when (key-pred k)
(set! l (cons k l)))))
l))
(provide
(struct-out collect-info)
(struct-out resolve-info)
part-collected-info
collect-put!
resolve-get
resolve-get/tentative)
resolve-get/tentative
resolve-get-keys)
;; ----------------------------------------

11
collects/scribblings/reference/cont.scrbl
View File

@ -3,13 +3,10 @@
@title[#:tag "cont"]{Continuations}
See @secref["cont-model"] and @secref["prompt-model"] for
general information about continuations. PLT Scheme's support for
prompts and composable continuations most closely resembles Dorai
Sitaram's @scheme[\%] and @scheme[fcontrol] operator @cite[#:key
"cite:fcontrol" #:title "Handling Control" #:author "Dorai Sitaram"
#:location "Programming Language Design and Implementation" #:date
1993].
See @secref["cont-model"] and @secref["prompt-model"] for general
information about continuations. PLT Scheme's support for prompts and
composable continuations most closely resembles Dorai Sitaram's
@scheme[\%] and @scheme[fcontrol] operator @cite["Sitaram93"].
Scheme installs a @defterm{continuation barrier} around evaluation in
the following contexts, preventing full-continuation jumps across the

9
collects/scribblings/reference/exns.scrbl
View File

@ -4,12 +4,9 @@
@title[#:tag "exns"]{Exceptions}
See @secref["exn-model"] for information on the PLT Scheme
exception model. It is based on @cite[#:key "friedman-exns" #:title
"Exception system proposal" #:author "Daniel P. Friedman and
C. T. Haynes and R. Kent Dybvig" #:location
"http://www.cs.indiana.edu/scheme-repository/doc.proposals.exceptions.html"
#:date ""].
See @secref["exn-model"] for information on the PLT Scheme exception
model. It is based on a proposal by Friedman, Haynes, and Dybvig
@cite["Friedman95"].
Whenever a primitive error occurs in PLT Scheme, an exception is
raised. The value that is passed to the current @tech{exception

6
collects/scribblings/reference/for.scrbl
View File

@ -6,11 +6,7 @@
@guideintro["for"]{iterations and comprehensions}
The PLT Scheme iteration forms are based on SRFI-42
@cite[#:key "srfi-42"
#:title "SRFI-42: Eager Comprehensions"
#:author "Sebastian Egner"
#:location "http://srfi.schemers.org/srfi-42/"
#:date "2003"].
@cite["SRFI-42"].
@section{Iteration and Comprehension Forms}

4
collects/scribblings/reference/parameters.scrbl
View File

@ -5,9 +5,7 @@
See @secref["parameter-model"] for basic information on the
parameter model. Parameters correspond to @defterm{preserved thread
fluids} in Scsh @cite[#:key "cite:thread-fluids" #:title "Processes
vs. User-Level Threads in Scsh" #:author "Martin Gasbichler and
Michael Sperber" #:date 2002 #:location "Scheme Workshop"].
fluids} in Scsh @cite["Gasbichler02"].
To parameterize code in a thread- and continuation-friendly manner,
use @scheme[parameterize]. The @scheme[parameterize] form introduces a

32
collects/scribblings/reference/reference.scrbl
View File

@ -48,4 +48,36 @@ This chapter provides some temporary hyper-link targets.
@;------------------------------------------------------------------------
@(bibliography
(bib-entry #:key "Sitaram93"
#:title "Handling Control"
#:author "Dorai Sitaram"
#:location "Programming Language Design and Implementation"
#:date 1993)
(bib-entry #:key "Friedman95"
#:title "Exception system proposal"
#:author "Daniel P. Friedman, C. T. Haynes, and R. Kent Dybvig"
#:location "web page"
#:url "http://www.cs.indiana.edu/scheme-repository/doc.proposals.exceptions.html"
#:date "1995")
(bib-entry #:key "SRFI-42"
#:title "SRFI-42: Eager Comprehensions"
#:author "Sebastian Egner"
#:location "SRFI"
#:url "http://srfi.schemers.org/srfi-42/"
#:date "2003")
(bib-entry #:key "Gasbichler02"
#:title "Processes vs. User-Level Threads in Scsh"
#:author "Martin Gasbichler and Michael Sperber"
#:date 2002
#:location "Scheme Workshop")
)
@;------------------------------------------------------------------------
@index-section[]

59
collects/scribblings/scribble/manual.scrbl
View File

@ -690,6 +690,65 @@ key for the index iterm does not include quotes.}
@defproc[(indexed-envvar [pre-content any/c] ...) element?]{A
combination of @scheme[envvar] and @scheme[as-index].}
@; ------------------------------------------------------------------------
@section{Bibliography}
@defproc[(cite [key string?]) element?]{
Links to a bibliography entry, using @scheme[key] both to indicate the
bibliography entry and, in square brackets, as the link text.}
@defproc[(bibliography [#:tag string? "doc-bibliography"]
[entry bib-entry?] ...)
part?]{
Creates a bibliography part containing the given entries, each of
which is created with @scheme[bib-entry]. The entries are typeset in
order as given}
@defproc[(bib-entry [#:key key string?]
[#:title title any/c]
[#:author author any/c]
[#:location location any/c]
[#:date date any/c]
[#:url url any/c #f])
bib-entry?]{
Creates a bibliography entry. The @scheme[key] is used to refer to the
entry via @scheme[cite]. The other arguments are used as elements in
the entry:
@itemize{
@item{@scheme[title] is the title of the cited work. It will be
surrounded by quotes in typeset form.}
@item{@scheme[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 @scheme[author] is typeset in
the bibliography as given.}
@item{@scheme[location] names the publication venue, such as a
conference name or a journal with volume, number, and
pages. The @scheme[location] is typeset in the bibliography as
given.}
@item{@scheme[date] is a date, usually just a year (as a string). It
is typeset in the bibliography as given.}
@item{@scheme[url] is an optional URL. It is typeset in the
bibliography using @scheme[tt] and hyperlinked.}
}}
@defproc[(bib-entry? [v any/c]) boolean?]{
Returns @scheme[#t] if @scheme[v] is a bibliography entry created by
@scheme[bib-entry], @scheme[#f] otherwise.}
@; ------------------------------------------------------------------------
@section{Miscellaneous}

8
collects/scribblings/scribble/style.scrbl
View File

@ -1,6 +1,7 @@
#lang scribble/doc
@require[scribble/manual]
@require["utils.ss"]
@(require scribble/manual
"utils.ss"
(for-label scribble/manual))
@title[#:tag "reference-style"]{Style Guide}
@ -48,3 +49,6 @@ Use American style for quotation marks and punctuation at the end of
quotation marks (i.e., a sentence-terminating period goes inside the
quotation marks). Of course, this rule does not apply for quotation
marks that are part of code.
Do not use a citation reference (as created by @scheme[cite]) as a
noun. Use it as an annotation.

15
collects/scribblings/slideshow/slideshow.scrbl
View File

@ -14,10 +14,7 @@ To get started, run the @exec{slideshow} executable, and click the
@onscreen{Run Tutorial} link.
To learn more about why Slideshow is cool, see also ``Slideshow:
Functional Presentations'' @cite[#:key "slideshow" #:title "Slideshow:
Functional Presentations" #:author "Robert Bruce Findler and Matthew
Flatt" #:location @elem{@italic{Journal of Functional Programming},
16(4-5), pp. 583--619} #:date "2006" #:url paper-url].
Functional Presentations'' @cite["Findler06"].
@defmodulelang*/no-declare[(slideshow)]{Most of the bindings defined in
the manual are provided by the @schememodname[slideshow] language.}
@ -29,3 +26,13 @@ the manual are provided by the @schememodname[slideshow] language.}
@include-section["guide.scrbl"]
@include-section["picts.scrbl"]
@include-section["slides.scrbl"]
@(bibliography
(bib-entry #:key "Findler06"
#:title "Slideshow: Functional Presentations"
#:author "Robert Bruce Findler and Matthew Flatt"
#:location @elem{@italic{Journal of Functional Programming}, 16(4-5), pp. 583--619}
#:date "2006"
#:url paper-url))
@index-section[]