Commit Graph

403 Commits

Author SHA1 Message Date
Matthew Flatt
3fb42cf3f1 scribble/html-properties: allow URLs in css-addition' and js-addition' 2012-09-11 18:52:59 -06:00
Matthew Flatt
9162fc2504 racket/html-properties: add `js-addition' 2012-09-11 17:39:12 -06:00
Matthew Flatt
dc925d2d8c scribble HTML: add head-extra' and support for attributes'
For a part that corresponds to an HTML page.
2012-09-11 17:18:14 -06:00
John Clements
9a884c84fa nused -> used 2012-09-07 16:37:28 -07:00
Matthew Flatt
7b2e18afc5 scribble: for Latex output, use `\Ssection', etc. for section
A style override might change `\section' to `\chapter', etc.
2012-08-31 16:07:10 -06:00
Matthew Flatt
d841ec1bd0 propagate prefix repair to to scribble/jfp' and scribble/lncs' 2012-08-31 07:33:08 -06:00
Matthew Flatt
5e5e503859 scribble/manual: add #:normalize?' option to deftech' et al. 2012-08-20 17:37:24 -06:00
Matthew Flatt
1ca5767684 fix docs for `deftech': mention case folding 2012-08-20 17:37:19 -06:00
Robby Findler
d96d920cf9 rename contract-blueboxes.rktd to blueboxes.rktd 2012-08-14 16:20:47 -05:00
Robby Findler
0c6734f782 Add the contents of the "blue boxes" in the docs to the upper-right
corner of the definitions window, based on the information that check
syntax computes

This commit contains two separate changes to make this work:

  - adding a new renderer, based on the text renderer, that
    pulls out the contents of the blue boxes and saves them
    in the doc/ directories (specifically in the files named
    contract-blueboxes.rktd)

  - extend check syntax to use and display the information
    build by the new renderer
2012-08-12 08:41:46 -05:00
Robby Findler
8ee76c9547 Add index entries for @defconstructor (and friends). Also add
code that skips over them when building the search indices.
Overall, this means that the only change most people would see
is that multiple constructors in the same class will get a warning
(and there was one of those, so fixed that too).

Also, Rackety. Specifically, transformed this surprising combination
of constructs (where all caps are placeholders for something specific):

((if PRED
     (λ (c mk) BODY2)
     (λ (c mk) BODY1))
 content
 (lambda (tag) BODY3))

into this one:

(define (mk tag) BODY3)
(if PRED
    BODY1{c:=content}
    BODY2{c:=content})
2012-08-11 21:52:48 -05:00
Matthew Flatt
f11450d601 scribble/base: generalize `itemlist' to splice/coerce some arguments
Also, add a `spliceof' contract constructor to `scribble/decode'.
2012-08-03 13:43:23 -06:00
Matthew Flatt
aa5b1e192c scribble/sigplan: add guidance for `category', etc.
Include the URL to ACM's explanation of how to use categories,
and add some other formatting guidance that is otherwise
difficult to track down.
2012-07-31 07:50:46 -06:00
Matthew Flatt
f9b4c6b226 scribble: add --dest-base flag
Also add the option to `render' from `racket/render', and
document the existing `render%' initialization argument.
2012-07-06 16:48:36 -06:00
Matthew Flatt
2b9f57b01d scribble/*-properties: allow literal bytes in *-additions
For example, a `tex-addition' structure can have literal bytes
to include in the generated Latex, instead of a path to a file that
holds the content.
2012-07-06 13:17:35 -06:00
Asumu Takikawa
9f83ba1c6f Fix doc typos 2012-07-03 15:54:25 -04:00
Matthew Flatt
4ed8a88969 doc correction
Closes PR 12844
2012-07-02 09:08:05 -06:00
Matthew Flatt
6028a60f65 scribble/manual: add #:id' option to defproc'
Also, convert the implementation of `defproc', `defform', etc. to
use `syntax-parse'.
2012-06-25 23:16:33 -06:00
Matthew Flatt
303aaec2b4 update docs related to definition-box labels 2012-06-21 07:15:09 +08:00
Robby Findler
411aeb99b8 a bunch of fixes to the diagram:
- added some color (mostly to try to disambiguate the lines)

- several of the things named '*-element' actually belong under content, not element.

- element has 'content', not the substructs.

- convertible?s are content's.

- the 'content' field in an element is not a list, but simply a content.

- there are a bunch of things under target-element.

- image-element was missing fields

- collect-element was missing the collect field
2012-06-20 08:22:58 -05:00
Robby Findler
ac8a4f23e5 Fixed up and added in the struct hierarchy diagram from the Scribble paper 2012-06-18 11:26:27 -05:00
Matthew Flatt
5ff3087677 scribble: adjust `def...' box to show a background label in HTML
For example, a syntactic form box is labeled with "SYNTAX". Forms
such as `defform' and `defthing' now support a `#:kind' option
for setting the label.
2012-06-17 09:19:58 +08:00
Matthew Flatt
c5f821b641 clarifications and additions to style guide 2012-06-03 04:50:06 +08:00
Asumu Takikawa
94545a7cd7 Fix doc breakage.
`abstract` from racket/class conflicted with `abstract`
in scribble paper modules.
2012-05-22 19:55:44 -04:00
Matthew Flatt
964020f288 implement scribble/srcdoc' via submodules instead of expand'
Also add a `for-doc' require form, make `proc-doc' et al. provide
forms, make `provide/doc' an alias for `provide'.
2012-05-12 01:37:50 -06:00
Matthew Flatt
2d027e7ee5 scribble/eval: add eval:result' and eval:results' 2012-05-09 19:11:21 -06:00
Robby Findler
f2816e72b4 fix proc-doc/names documentation
closes PR 12739
2012-05-03 11:36:09 -05:00
Matthew Flatt
fc1089c842 scribble: change Latex rendering of empty hidden part titles 2012-04-29 10:37:11 -06:00
Matthias Felleisen
9ef66b80ea add a form to declare a module/library deprecated 2012-04-28 13:25:32 -04:00
Danny Yoo
a067380622 small typo 2012-04-28 05:27:34 -04:00
Matthew Flatt
563909c328 scribble/bnf: add `BNF-seq-lines' 2012-04-26 17:59:19 -06:00
Matthew Flatt
c5e5a0349a add #:line-number-sep' to codeblock' 2012-04-11 11:49:01 -06:00
Matthew Flatt
20256a3f15 scribble: add 'block style for `table' 2012-04-05 06:58:53 -06:00
Matthew Flatt
2d87d48ebd make HTML rednering work when a `part' has not tags 2012-03-25 19:25:35 -06:00
Matthew Flatt
a1fd742ed0 change Scribble xref formats, so that HTML info works for Latex
There's no particular reason that any one format will have all
the information that other formats need, but it conveniently works
for now that HTML info can subsume Latex info.
2012-01-11 16:39:52 -07:00
Matthew Flatt
ff41a896bc add ffi/com', ffi/unsafe/com' 2012-01-10 18:35:32 -07:00
Matthew Flatt
fb46daafa0 fix typo
Reported by J. Ian Johnson
2011-12-31 06:32:13 -07:00
Matthew Flatt
17504a960e more interning related to Scribble xref 2011-12-10 11:43:58 -07:00
Matthew Flatt
fe3b6ea003 at-exp, scribble: remove distinctness of @{}-introduced newlines 2011-11-24 09:17:34 -07:00
Matthew Flatt
3885f4683b add missing `render%' init argument doc 2011-11-02 08:12:58 -06:00
Matthew Flatt
932ef94cb3 fix contract 2011-10-28 06:43:20 -06:00
Ryan Culpepper
eed6016793 scribble/eval: pretty-print results by default 2011-10-16 05:41:58 -06:00
Eli Barzilay
16cd1ad78d Make `defproc' throw an error if two arguments have the same name.
Related to the already fixed PR 12114 and PR 12133, which motivated the
error, and a few additional typos of the same kind.

(Note that it uses the symbols, but that's how they'll render anyway.)
2011-09-16 11:14:18 -04:00
Matthew Flatt
0b2beace40 add `schemecommentfont' 2011-09-03 14:57:57 -06:00
Matthew Flatt
e7ec9f5eb7 document `scribble/pdf-render; 2011-09-01 07:14:03 -06:00
Eli Barzilay
0e31b37aa4 Documentation typo. 2011-08-29 15:13:01 -04:00
Matthew Flatt
f082919f0b doc style adjustments; reorg cmdline+editors docs in Guide 2011-08-24 09:07:12 -06:00
Matthew Flatt
853e47f05e fix broken-link reporting by `scribble' 2011-08-22 07:58:05 -06:00
Matthew Flatt
39edc5a599 `scribble' reports broken cross references by default 2011-08-18 13:05:37 -06:00
Matthew Flatt
099a0eebed improve codeblock' and racketblock' docs
including an explanation of the advantages and drawbacks of each
2011-08-16 08:02:50 -06:00