suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
28,574 Commits 17 Branches 54 Tags 278 MiB
caad82f91e
Commit Graph

443 Commits

Author SHA1 Message Date
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
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
Eli Barzilay
debd1f9f1e Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 
(Some other minor things here and there.)
 2011-06-20 04:27:14 -04:00
Matthew Flatt
f34a31cac9 "under <platform>" -> "on <platform>"; "X" -> "Unix" 
I originally picked "under" as the preposition to go before
 a platform name, but obviously you should build "on" a
 platform, and "under" suddenly annoys me. The choice of "on"
 is now codified in the documentation style guide. Meanwhile,
 "Unix" insted of "X" seems more clear and consistent in the
 `racket/gui' docs.

 More usefully, this patch also fixes a few out-of-date
 platform-specific claims.
 2011-06-17 18:54:43 -06:00
Vincent St-Amour
8f092e8330 These changes break with bad sandboxes. 
Revert "Fix interface."
Revert "Add more scribble forms that evaluate code and display the results."

This reverts commit a621eaf041.
This reverts commit 7e9dbded4c.
 2011-06-17 15:18:48 -04:00
Vincent St-Amour
a621eaf041 Fix interface. 2011-06-17 14:47:16 -04:00
Vincent St-Amour
7e9dbded4c Add more scribble forms that evaluate code and display the results. 2011-06-17 14:04:38 -04:00
Danny Yoo
e35e005a1c added example of making an evaluator for interaction 2011-06-16 12:09:55 -04:00
Eli Barzilay
80f0d57cdd Revise this comment 2011-06-14 19:02:30 -04:00
Matthew Flatt
fbbb30f7b0 try to clarify intent of #:contracts' in defform' 2011-05-30 08:58:11 -06:00
Matthew Flatt
66178570b6 scribble: add support for setting a document date 
in Latex output, and also document and generalize
 the 'pretitle paragraph style
 2011-05-15 19:42:22 -06:00
Matthew Flatt
c5816ab6f9 fix doc typo 2011-05-13 08:55:03 -06:00
Matthew Flatt
4671b5f2ba fix `scribble/lncs' docs 2011-05-10 20:34:28 -06:00
Robby Findler
a1217107b2 added the scribble/lncs language 2011-05-10 14:10:28 -05:00
Robby Findler
2fe1c3b80d document the help collection's top-level modules 2011-05-06 17:29:03 -05:00
Robby Findler
551c6866d1 add in the supported ->i forms 2011-05-01 14:15:57 -05:00
Matthew Flatt
c38118f0e5 Scribble: add `alt-tag' HTML property to set HTML tag in output 2011-04-04 14:33:38 -06:00
Matthew Flatt
ef4ea23646 fix `secref' docs; document some Latex macros available for redefinition 2011-04-04 11:26:41 -06:00
Matthew Flatt
df2a875ff4 Scribble: simplify content that is conditioned on the render mode 
including a new `scriblib/render-cond' library
 2011-04-04 10:45:02 -06:00
Kevin Tew
0c4d90b1db codeblock line numbers 2011-04-02 16:01:21 -06:00
Matthew Flatt
bbc5533938 Scribble: change the way `racketblock' etc. indent/inset works 
- introduce 'code-inset style for nested blocks
 - use style instead of spaces for code indentation
 - sigplanconf adds vertical space around 'code-inset
 - more ...0 variants to compose better
 2011-03-30 15:12:30 -06:00
Matthew Flatt
cbca2f395b Scribble: add 'multicommand support to `nested-flow' 2011-03-19 09:26:41 -06:00
Eli Barzilay
64e4b73a9f Minor typo and other small things. 2011-03-15 11:46:16 -04:00
Matthew Flatt
3fb4561a62 scribble/manual: document `this-obj' 2011-03-13 09:02:39 -06:00
Matthew Flatt
0b496d5275 a round of doc corrections from Gwyth 2011-03-10 06:34:33 -06:00
Matthew Flatt
ec2a917749 Scribble: add #:left?' optional argument to margin-note' 2011-03-02 11:00:21 -07:00
David Van Horn
760a58b65d Fixes more spelling errors. 2011-02-04 19:44:13 -07:00
Matthew Flatt
d704f9565b fix typo 2011-02-02 16:09:45 -07:00
Matthew Flatt
46dc2d6683 Scribble: improve interaction', examples', etc. for non-text 
by setting the default output port in the sandbox to support
 content as "specials" when `current-print' is changed
 2011-01-29 09:55:40 -06:00
Matthew Flatt
e94f7e0039 fix doc typos 2011-01-20 07:10:05 -07:00
Matthew Flatt
0e0f88be00 Scribble docs: clarify 'hidden v.s 'toc-hidden and "on this page" 
Closes PR 11554
 2011-01-17 16:25:09 -07:00
Matthew Flatt
c8e3d45dae make `codeblock' work without a #lang line 
but revise docs to clarify that a #lang line is really expected
 Closes PR 11385
 2011-01-16 19:12:38 -07:00
Matthew Flatt
68e60df7db fix docs for `image-element' 2011-01-10 16:44:10 -07:00
Matthew Flatt
b2877336f7 support ".svg" in scribble/base' image' for HTML output 2011-01-10 16:41:16 -07:00
Matthew Flatt
e6fd878e14 doc `Secref' 
Closes PR 11309
 2011-01-08 10:29:31 -07:00
Matthew Flatt
21d324a169 Scribble soft-hyphen support for Latex rendering; ?-' in scribble/base' 2011-01-07 09:48:03 -07:00
Matthew Flatt
315fdf071a better Scribble support for disabling line breaks 
- make 'no-break element style work consistently
 - document 'no-break
 - add `nonbreaking' to `scribble/base'
 2011-01-07 09:48:03 -07:00
Matthew Flatt
8f23d9dc1a fix reference hyphen and some abbreviations 2011-01-07 09:48:03 -07:00
Matthew Flatt
163d10cab3 Scribble LaTeX rendering of non-breaking hyphen; add ~' and -~-' 2011-01-07 09:48:03 -07:00
Matthew Flatt
5998c0ac95 add ._' and .__' to `scribble/base' for abbrev- and setence-ending periods 2011-01-07 09:48:03 -07:00
Matthew Flatt
6a34dce36d style guide: use v' for "any value" (as opposed to x') 2011-01-04 09:52:14 -07:00
Matthew Flatt
78b54a7324 more Scribble "---" doc fixes 2010-12-14 07:45:15 -07:00