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
Matthew Flatt
0b1b3772f5
change Scribble HTML renderer to typeset em dashes with &8212;
...
Closes PR 11049
Closes PR 11539
2010-12-14 06:48:25 -07:00
Matthew Flatt
0f86dc15af
scribble: render `pict' content directly
...
--- actually, any value that is convertible to PNG/PDF
2010-11-26 20:40:43 -07:00
Robby Findler
747c735eb3
adjusted scribble's sigplan setup so that the times.sty and qcourier.sty packages can be disabled.
2010-11-19 17:57:13 -06:00
Sam Tobin-Hochstadt
82437faa18
Fix docs.
2010-11-16 14:02:47 -05:00
Sam Tobin-Hochstadt
2dbbd1b58e
Add @onecolumn option to scribble/sigplan
2010-11-16 12:38:48 -05:00
Matthew Flatt
aa7c4b53d9
add `codeblock' to Scribble
2010-10-31 07:09:27 -06:00
Matthew Flatt
8c2ba47fa5
move style guide up a section (to its own page)
2010-08-30 14:35:18 -06:00
Matthew Flatt
c1bf118cb5
new guidance in the documentation style guide
2010-08-30 14:35:17 -06:00
Matthew Flatt
a19899898f
change Scribble's interaction', etc. to use non-default
current-print'
...
to format results, if one is installed in a sandboxed evaluator
2010-08-24 20:50:46 -06:00
Robby Findler
46e9a3b79b
improved the image docs slightly
2010-08-21 15:07:43 -05:00
Matthew Flatt
4945851df6
doc clarification
2010-08-17 17:42:11 -06:00
Matthew Flatt
2f9431552e
fix typo
2010-08-11 10:29:49 -06:00
Matthew Flatt
656321dbcb
add optional #:key' argument to
tech' and `techlink'
...
to specify the defined technical term separate from the link content
2010-08-03 12:48:03 -06:00
Matthew Flatt
33e3dac94e
add example to scribble/bnf docs
2010-07-29 06:56:30 -05:00
Sam Tobin-Hochstadt
dba04c8aea
Add @nocopyright option to scribble/sigplan.
2010-07-26 11:43:33 -04:00
Matthew Flatt
8dfe2a6a91
fix doc typo
...
Closes PR 10917
Merge to 5.0.1
2010-07-20 10:24:34 -06:00
Matthew Flatt
4bd97ae80e
fix uses of `scheme' in the Scribble style guide
...
Closes PR 10999
Merge to 5.0.1
2010-07-20 09:33:15 -06:00
Eli Barzilay
14d181ddef
minor typo fix
2010-07-12 21:38:52 -04:00
Jay McCarthy
ba31d8c429
Fixing contracts and a little less allocation
2010-06-25 07:10:52 -06:00
Matthew Flatt
c18603f767
add racketresultblock, etc. to Scribble
2010-05-31 13:55:16 -06:00
Matthew Flatt
5592dd1489
doc corrections
...
Merge to 5.0
2010-05-31 13:17:11 -06:00
Matthew Flatt
f5a0b9e613
fix scribble/xref
2010-05-22 08:46:43 -06:00
Matthew Flatt
1e9aa3b132
document scriblib/footnote
2010-05-21 19:40:33 -06:00
Matthew Flatt
18b06a9297
add `margin-note*' for putting a single-para note in the middle of a para
2010-05-21 19:40:33 -06:00
Matthew Flatt
8b7c8d08bd
add fix-point finding traverse pass to Scribble
2010-05-21 19:40:33 -06:00
Eli Barzilay
28946a0a43
More reformatting
2010-05-21 20:41:35 -04:00
Eli Barzilay
c4f67b3e74
Small typos, some reformatting.
...
Fixes PR10920
2010-05-21 16:30:16 -04:00
Matthew Flatt
ed1c74108f
fix Scribble doc reference to element
2010-05-18 00:21:46 -06:00
Eli Barzilay
a46743211b
A lot of "plt-scheme.org" -> "racket-lang.org"s.
2010-05-17 00:53:12 -04:00