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
Matthew Flatt
bb26115591
add 'filebox' Scribble function
2010-05-16 17:28:55 -06:00
Matthew Flatt
b072d85107
adjust Slideshow to not re-export printable<%>; improve docs for both Slideshow and Scribble
2010-05-14 11:33:08 -06:00
Matthew Flatt
ce21cf9fd8
rackety slideshow doc
2010-05-02 12:19:25 -06:00
Matthew Flatt
fb4af54436
rackety Scribble doc
2010-05-02 12:00:44 -06:00
Matthew Flatt
cb5c83c5a7
add custom-print to printable<%>; redirect printable<%> to writable and pretty-print to pretty-write in 'scheme'
2010-05-01 08:43:20 -06:00
Matthew Flatt
17c1dc1ab9
SHA-1-based checking of doc dependencies
2010-04-30 16:30:11 -06:00
Matthew Flatt
2f5b166073
more rackty guide, through the contracts section
2010-04-29 17:11:42 -06:00
Matthew Flatt
b61a99c433
add defidform/inline and use it to document on-draw
2010-04-28 06:41:43 -06:00
Matthew Flatt
28b4043077
rename all files .ss -> .rkt
2010-04-27 16:50:15 -06:00
Matthew Flatt
a6694a08b7
fix make-base-namespace in scheme/base (PR 10870)
2010-04-26 06:47:02 -06:00
Matthew Flatt
616080c7c4
change 'define-struct' to bind the type name as a constructor, add an #:extra-constructor-name option, etc.
2010-04-25 12:10:36 -06:00
Matthew Flatt
f6d62763b4
fix typo (PR 10856)
...
svn: r18793
2010-04-12 14:00:23 +00:00
Matthew Flatt
c5ac9f23ec
better compiler handling of unused local bindings where the RHS either doesn't obviously produce a single value or is discovered to be unused late in bytecode compilation; initial Scribble support for printing qq-style results
...
svn: r18737
2010-04-06 15:52:36 +00:00
Matthew Flatt
73807aef24
chaperones (v4.2.5.3)
...
svn: r18650
2010-03-28 01:10:33 +00:00
Robby Findler
c74849dc2e
added support for the 10pt option to the sigplan scribble support
...
svn: r18593
2010-03-21 22:56:26 +00:00
Matthew Flatt
e0c0645479
doc Scribble 'exact-chars and 'tt-chars style propeties
...
svn: r18533
2010-03-14 12:14:32 +00:00
Matthew Flatt
826fbdf16f
add scribble/jfp
...
svn: r18507
2010-03-10 22:17:51 +00:00
Matthew Flatt
911d80a144
scribble: use 'attributes' properties when rendering table cells
...
svn: r18488
2010-03-08 21:31:31 +00:00
Robby Findler
195d608fe5
added scheme/fixnum
...
svn: r17391
2009-12-23 15:41:40 +00:00
Sam Tobin-Hochstadt
fcd4c4e38d
Fix prop values for DrDr.
...
Add plt-responsible props.
Add hash-union to unstable.
Fix doc for compound-paragraph.
Fix unstable/scribblings/util.
svn: r16811
2009-11-16 13:59:13 +00:00
Eli Barzilay
44d88cee6b
newlines at EOFs
...
svn: r16630
2009-11-09 03:49:50 +00:00
Danny Yoo
c84296c42d
Correcting spelling error in Scribble doc.
...
svn: r16430
2009-10-26 16:14:13 +00:00
Matthew Flatt
01d15eb9b6
add unsafe-fx->fl; avoid some gcc warnings
...
svn: r16221
2009-10-02 19:45:41 +00:00
Matthew Flatt
c28ed519a0
turn off Scribble e-mail address obfuscation
...
svn: r15989
2009-09-13 01:12:55 +00:00
Robby Findler
390145821a
PR 10431, plus support for ->* with keywords in proc-doc
...
svn: r15926
2009-09-08 22:53:12 +00:00
Jay McCarthy
3432cf282f
Adding more specific contracts
...
svn: r15709
2009-08-11 22:31:44 +00:00
Jay McCarthy
d8bc61ae41
Adding more specific contracts
...
svn: r15708
2009-08-11 22:10:47 +00:00
Matthew Flatt
bdeaa475b3
Scribble latex output and 'never-indents
...
svn: r15695
2009-08-10 22:01:32 +00:00
Matthew Flatt
a47d94f75f
add file-or-directory-identity (4.1.2.5)
...
svn: r15623
2009-07-29 17:39:03 +00:00
Eli Barzilay
d0f8970add
@foo@bar' will now parse as a
foo@bar' identifier. This used to be
...
the case in Scheme mode but not in text mode, and this commit makes
the text mode behave as the Scheme mode. (Seems like a convenience
point that is not useful since people won't remember the difference.)
svn: r15622
2009-07-29 17:00:29 +00:00
Matthew Flatt
970a796bc6
defmodulelang and schememodlink changes to split lang text and module path
...
svn: r15619
2009-07-29 13:15:50 +00:00
Matthew Flatt
1ba7cf0926
#lang syntax coloring; Scribble syntax coloring
...
svn: r15607
2009-07-28 18:06:14 +00:00
Matthew Flatt
229e2636de
change scribble 'variant' to 'property'; add contracts in scribble/decode
...
svn: r15581
2009-07-27 03:55:43 +00:00
Eli Barzilay
9fab3b085a
removed redundant @s
...
svn: r15578
2009-07-26 22:54:36 +00:00
Jay McCarthy
1f97344aa9
A few more typos I noticed
...
svn: r15577
2009-07-26 19:44:03 +00:00
Jay McCarthy
029fc31b34
Fixing a small typo
...
svn: r15576
2009-07-26 19:05:41 +00:00
Matthew Flatt
f777ae61a0
fix generated HTML name for the getting-started section of the Scribble manual
...
svn: r15573
2009-07-26 03:23:40 +00:00
Eli Barzilay
c73cb3330a
typo
...
svn: r15572
2009-07-26 03:02:00 +00:00
Matthew Flatt
bc9eef93f6
Scribble manual typos and up-to-date scribble/sigplan docs
...
svn: r15571
2009-07-26 02:52:37 +00:00
Matthew Flatt
3cb5bf1835
more improvements to the Scribble manual
...
svn: r15570
2009-07-26 02:25:07 +00:00
Matthew Flatt
345c17e85c
major Scribble revision (v4.2.1.2)
...
svn: r15569
2009-07-25 20:25:33 +00:00
Eli Barzilay
19462e97c4
prefix -> add-prefix
...
svn: r15456
2009-07-16 12:21:52 +00:00
Eli Barzilay
fdd99a0b0e
svn: r15441
2009-07-14 03:48:28 +00:00
Eli Barzilay
b7b143120b
added set-prefix
...
svn: r15440
2009-07-14 03:33:38 +00:00
Eli Barzilay
bb32de3560
add with-writer
...
svn: r15426
2009-07-11 02:10:02 +00:00
Eli Barzilay
83c356ff21
fix width issue
...
svn: r15413
2009-07-09 05:23:18 +00:00
Eli Barzilay
4239d22ded
rename verbatim and unverbatim to disable-prefix and restore-prefix
...
svn: r15411
2009-07-08 21:28:55 +00:00
Eli Barzilay
a70bf64fd9
Newlines at EOFs
...
svn: r15380
2009-07-04 02:28:31 +00:00
Matthew Flatt
bcfb69b21f
add compound-paragraphs to Scribble, improve Latex rendering for unnested single-column tables
...
svn: r15378
2009-07-04 00:52:03 +00:00
Matthew Flatt
c25ca25320
change get-info to use a separate namespace; add make-eval-factory and make-base-eval-factory
...
svn: r15205
2009-06-18 10:35:13 +00:00
Eli Barzilay
84730719b9
minor revisions
...
svn: r15122
2009-06-08 16:48:42 +00:00
Eli Barzilay
4240ac8cfc
New `make-at-reader' in the API, update docs, adapt tests.
...
svn: r15121
2009-06-08 16:43:01 +00:00
Eli Barzilay
28efb47c90
better
...
svn: r15115
2009-06-08 07:48:24 +00:00
Eli Barzilay
092d97690b
accidental typo
...
svn: r15114
2009-06-08 01:29:08 +00:00
Eli Barzilay
4288c6c2c7
The Scribble reader was improved to make it pull out the syntax
...
punctuations outside of the form, as it does with quote punctuations.
So things like this
#, @foo{...}
that required the space to make the @foo read as a scribble form are
now better written as
@#,foo{...}
This changes all such occurrences. (In case you see this change in
your files and are worried that there might be changes: I mechanically
verified that the result of `read'ing the modified files is identical
to the previous version.)
svn: r15111
2009-06-07 10:12:32 +00:00
Eli Barzilay
2104900bb6
pull out syntax punctuations too
...
svn: r15099
2009-06-05 22:19:23 +00:00
Eli Barzilay
9362b20ff2
typo
...
svn: r15086
2009-06-05 06:38:53 +00:00
Eli Barzilay
2be3ac0178
* Reorganize the -inside readers in the scribble reader
...
* #:start-inside? is gone -- it never made sense
* Instead, there's a new `make-at-reader/inside' (with the same
arguments) that returns an inside syntax reader.
svn: r15073
2009-06-04 03:51:22 +00:00
Matthew Flatt
77843f5e8e
add 'url style to Scribble
...
svn: r15059
2009-06-02 19:13:23 +00:00
Robby Findler
237b225249
svn: r14873
2009-05-19 19:21:48 +00:00
Eli Barzilay
ff73a5395e
removed lots of "the the"s
...
svn: r14679
2009-05-01 21:02:51 +00:00
Matthew Flatt
f6c389d0ec
fix Scribble Latex rendering of prefixed tags; add #:tag-prefixes argument to secref and tech
...
svn: r14610
2009-04-25 15:19:58 +00:00
Matthew Flatt
22864b594d
fix Scribble rendering of links when tag-prefixed sub-sections appear in the same output anchor scope
...
svn: r14608
2009-04-25 13:46:54 +00:00
Matthew Flatt
d49e36d983
fix margin-note typo
...
svn: r14536
2009-04-17 01:46:19 +00:00
Matthew Flatt
8aa8b938a0
change margin-note to generate a blockquote insteda of a single paragraph
...
svn: r14535
2009-04-17 01:30:15 +00:00
Matthew Flatt
3a297ed003
constract on decode-flow (PR 10175)
...
svn: r14444
2009-04-07 17:02:18 +00:00
Eli Barzilay
c4e2e9af6d
fix name clash
...
svn: r14437
2009-04-06 12:48:07 +00:00
Eli Barzilay
c0a8a01222
Changed @itemize{...} to @itemize[...] (done after comparing the doc
...
tree and verifying that there are no changes).
(Also fixed a few bugs that were in the code)
svn: r14427
2009-04-05 17:46:20 +00:00
Eli Barzilay
2af626972d
There is a problem with empty lines: having a line (= a row) in the
...
code tables with empty contents makes the row not appear. Usually,
we'd put an there so it does show, but that would be bad for
the preprocessor examples where I really want to have the table
contents reflect the exact file contents.
So another solution is to use a 'newline element, but then latex barfs
because it's not happy with a \\ inside a tt macro. The hacked
"solution" is to have the newline element not be inside a tt element
-- latex doesn't barf now, but it does have one extra newline as a
result since it doesn't hide the newline to begin with.
A better solution is to find a way to make table cells in html not be
hidden when they have no contents, maybe through some css magic.
svn: r14206
2009-03-22 01:26:15 +00:00
Eli Barzilay
1db2b65978
Finished the docs+tests, added some minor utilities.
...
svn: r14199
2009-03-21 15:06:48 +00:00
Eli Barzilay
6d31100a89
Start a proper preprocessor documentation, with tests included.
...
(proper "literate testing".)
svn: r14112
2009-03-15 22:05:52 +00:00