Commit Graph

383 Commits

Author SHA1 Message Date
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
Matthew Flatt
4555254380 add code' to scribble/manual' 2011-08-16 07:53:05 -06:00
Matthew Flatt
c7e7d0d8ff make racket' preserve #t' versus `#true' 2011-08-16 07:53:05 -06:00
Matthew Flatt
a1eaecb337 add an #:escape' clause to all schemeblock'-like forms 2011-08-16 07:53:05 -06:00
Eli Barzilay
d61eb53686 Lots of documentation formatting.
Started as fixing misindented definitions, then more indentations, then
a bunch of similar things (square brackets, huge spaces at end-of-lines,
etc).
2011-08-15 07:50:04 -04:00
Matthew Flatt
cc78030cd2 download LNCS and JFP class files on demand 2011-08-10 08:28:13 -06:00
Matthew Flatt
f34c0329bf scribble/manual: add `current-display-width' parameter 2011-08-08 17:10:54 -06:00
Matthew Flatt
ad7fddf878 add column-attributes' support and use it to fix struct' rendering 2011-08-05 10:03:38 -06:00
Matthew Flatt
b7afb3cf8f Scribble: support for "boxable" blocks in Latex output
For example, if you make a multi-column table with a
`racketblock' in each column, then the columns size
to fit the code --- instead of forcing the table width
to match the page width and forcing each column to take
an equal share width.
2011-08-05 10:03:38 -06:00
Matthew Flatt
4ac85de974 Scribble: style adjustments to deter code wrapping
For HTML, the style used in the output of `racketblock' now
disables line wrapping, and the Rkt text styles inherit
line-wrap behavior. This doesn't solve the general problem
of code overflowing the horizontal space, but it makes the
failure mode usefully better.

A new 'vertical-inset nested-flow style is used by
`defproc', `defform', etc. It has no effect for HTML,
but it introduces suitable vertical space for Latex output
(in case you want to use `defproc' in a SIGPLAN-format
paper, for example).
2011-08-05 10:03:37 -06:00
Matthew Flatt
3ffa731f80 fix docs
Closes PR 12011
2011-08-02 17:07:39 -06:00
Matthew Flatt
7977d1817e expose the scribble' command-line driver as racket/render' 2011-08-01 14:40:49 -06:00
Matthew Flatt
e1b02e08f7 generalize `defform' & co. to better support abstraction 2011-07-07 10:45:43 -06:00
Matthew Flatt
d8352d5890 allow lists of pre-content to `decode-content', etc.
and improve docs for `scribble/decode'
2011-07-06 09:07:19 -06:00
Matthew Flatt
5d06476cb3 scribble: clarify intent of `#:use-sources' 2011-07-05 07:03:26 -06:00
Ryan Culpepper
1b702a2ae3 docs reorganization
added tutorial, racket categories
  relabeled some other categories
  normalized manual names: de-bolded, changed some names
2011-07-01 17:16:53 -06:00
Eli Barzilay
0af236dc2f Add block' to scribble/text', to explicitly ask for an indentation block.
* Lists are now either blocks or splices depending on whether they
  appear inside a block or a splice (default to block).

* Adjusted the docs and a single test where this mattered.

* Change the documentation to be "text.html" and to be titled "text
  generation".
2011-06-28 18:16:07 -04:00
Eli Barzilay
a38f384a00 Finish converting scheme' -> racket'.
Everything compiles fine now even if the compatibility bindings are
gone.
2011-06-28 00:45:38 -04:00
Eli Barzilay
ac26fe7554 A ton of @scheme*' -> @racket*' and related updates.
Also, updates some of the mzlib files to point at `racket/*' libraries
rather than to `scheme/*' ones.
2011-06-25 04:08:47 -04:00
Matthew Flatt
3f95fabf7c add --latex-section' mode to scribble' 2011-06-22 07:49:15 -06:00
Matthew Flatt
73f6a2b392 document `scribble' command-line use 2011-06-21 06:45:44 -06:00