Commit Graph

443 Commits

Author SHA1 Message Date
Robby Findler
8ce213bf1c extend proc-doc to support optional arguments in an ->i contract
also refactor to be able to add some unit tests
2013-04-06 19:04:05 -05:00
David Van Horn
213430f728 Add #:lang and input-program inputs to make-base-eval and friends.
This commit extends make-base-eval, make-base-eval-factory, and
make-eval-factory with an #:eval and input-program inputs so that
these functions are more like racket/sandbox make-evaluator.
2013-04-06 09:00:41 -06:00
Ryan Culpepper
516f56fc83 added with-eval-preserve-source-locations to scribble/eval
Makes it possible to show examples of redex term->pict, etc.
2013-04-04 13:28:01 -04:00
Ryan Culpepper
293b208af7 added optional #:grammar clause to defform, etc 2013-03-30 10:00:44 -04:00
Robby Findler
e5d91baa2c add interaction/no-prompt and clarify that interaction-eval
doesn't catch errors
2013-03-20 22:51:39 -05:00
Robby Findler
a29f37f18b added scribble-exn->string 2013-03-20 22:51:39 -05:00
Matthew Flatt
dfcf50e165 scribble/manual: add a #:key' argument to deftech' 2013-03-19 15:48:21 -07:00
Matthew Flatt
9e0e2b932d scribble/srcdoc: add `begin-for-doc' 2013-03-07 21:46:48 -07:00
Matthew Flatt
8d03995b62 scribble/manual: add #:id' option to defthing'
Use this open in the HtDP language documentation in the same
way as for `defproc', which fixes the docs for `pi', `e', etc.
2013-03-05 07:48:26 -07:00
Danny Yoo
61db1d6405 Add link to the syntax of the @-reader.
Also defines the "@-form" term in the @-syntax section due to its
frequency.

Closes PR-12589.
2013-02-21 15:03:01 -07:00
Matthew Flatt
c9c4d33a2f scribble/sigplan: add `subtitle'
Based on David Van Horn's suggestion.

Also, make both `author' and `authorinfo' work (even when mixed).
2013-02-19 14:03:00 -07:00
Matthew Flatt
23d0627acc scribble: improve HTML handling of 'unnumbered and 'toc-hidden
A part with style property 'toc-hidden no longer
hides child sections, which makes it consistent with Latex/PDF
rendering.

A part with style 'grouper and 'unnumbered does not make its
child parts render as more nested, which is consistent with
'gruper without 'unnumbered. An unnumbered grouper is represented
as "" in a section-number list (while #f is still used for
unnumbered non-grouper layers).
2013-02-15 20:11:18 -07:00
Matthew Flatt
80a22493bd doc clarification 2013-02-15 16:02:53 -07:00
Robby Findler
4494788017 fix rendering of example in Guide
closes PR 13517
2013-02-13 07:25:36 -06:00
Matthew Flatt
318c45a772 Scribble: fix docs on Latex commands for parts and part references 2013-02-01 11:00:14 -08:00
Matthew Flatt
09d4aa3d79 Scribble: add scribble/book' and scribble/report' languages
These languages set the default class for Latex rendering, and also
adjust Latex commands so that top-level sections are chapters, etc.
2013-02-01 10:15:53 -08:00
Matthew Flatt
c0c2eda628 Scribble: add 'grouper and 'hidden-number part style properties
Also, clean up documentation and implementation of 'unnumbered and
'hidden.
2013-02-01 10:15:53 -08:00
Danny Yoo
74a0252b24 Fix typo. 2013-01-31 14:27:22 -07:00
Matthew Flatt
17865bfa84 scribble/latex-properties: add `command-extras'
This style property is a way to add to the Latex output that is
ignored for HTML and other output.
2013-01-24 06:43:10 -05:00
Matthew Flatt
5134bc0888 scribble doc corrections
Merge to v5.3.2
2013-01-09 18:52:16 -07:00
Matthew Flatt
3e8b6b9866 scribble: add +m' / ++main-xref-in' flag
The `+m' flag is a long-overdue shorthand for `++xref-in setup/xref
load-collections-xref', which links to installed documentation in
the same way as DrRacket's "Scribble HTML" button.

That is, use `+m' to link to installed documentation,

  scribble +m mine.scrbl

instead of the previously recommended

  scribble ++xref-in setup/xref load-collections-xref mine.scrbl

Merge to 5.3.2
2013-01-08 16:25:28 -07:00
Robby Findler
353da62843 added make-module-language-tag and use it and make-section-tag
in a few places
2012-12-27 11:10:40 -06:00
Matthew Flatt
2d12431c0d move and fixup docs for the "help" collection 2012-12-27 09:24:15 -06:00
Matthew Flatt
f29230f8f2 add `scribble/tag' and clean up some tag-related documentation and functions
Includes the addition of `make-section-tag' and `taglet?' to
`scribble/base'.
2012-12-27 09:24:14 -06:00
Matthew Flatt
6eef00a312 raco setup: fix problem with doc index database
When a tag is serializable but not `write'--`read' invariant,
then it needs to be serialized and deserialized.

Also, clarify and check in `tag?' that a tag should be
serializable.
2012-12-13 15:45:48 -07:00
Danny Yoo
f374cb184d Add separate section to avoid conflict at scribble time. 2012-12-13 13:00:06 -07:00
Danny Yoo
db280d0941 Add scribble/doclang2 with keyword support for customization, and documentation. 2012-12-13 12:50:27 -07:00
Greg Hendershott
6aa6dc0400 Add a Markdown rendering mode to Scribble.
Uses "Github flavored markdown". Specifically, code blocks are opened
using ```scheme so that Github will lex and format them as Scheme code
rather than generic monospace.

Note: I would have used ```racket, but we are still waiting for the
pygments.rb project to pull again from pygments-main -- to which I
contributed a Racket lexer back in August. After pygments.rb pulls,
can update this to use ```racket instead.
2012-12-09 15:17:36 -07:00
Asumu Takikawa
8c91decc8a Index raco scribble command
Relevant to PR 12956
2012-11-26 17:52:43 -05:00
Matthew Flatt
a73dc50224 break cross-reference info for document into pieces
For example, the cross-reference information for the
Reference is now broken into about 16 pieces, so that
resolving a cross-reference into the Reference doesn't
require loading all cross-reference information for
the Reference.

Every document is split into two pieces, so that the title
of a document is roughly in its own piece. That way,
re-building the page of all installed documentation can be more
scalable (after some further changes).
2012-11-23 18:44:51 -07:00
Matthew Flatt
8c1b5db815 raco setup: build database mapping doc tags to "out.sxref"s
The `xref' produced by `setup/xref' uses the database to delay
loading "out.sxref"s, which cuts 64-bit DrRacket's initial
footprint by around 50MB (i.e., about 20%).
2012-11-23 18:44:50 -07:00
Matthew Flatt
a830f77403 scribble: more control over version formatting
Add "Version" in front of a version name via `.version:before' or
`.versionNoNav:before' and `\SVersionBefore', so that they can
be configured through overriding CSS or Latex macro declarations.

Also, improve the documentation for how the `#:version' argument
of `title' is propagated to a `part' style property.

Closes PR 13227
2012-11-02 07:45:57 -06:00
Asumu Takikawa
b56574e4d5 scribble: add examples for most def* forms 2012-10-27 07:01:02 -04:00
Eli Barzilay
cbfb1fdb37 A whole bunch of missing newlines at EOFs (and a few other spaceages). 2012-10-19 06:47:24 -04:00
Asumu Takikawa
be21153818 Fix typesetting of code:blank in the Scribble docs 2012-10-14 07:34:55 -04:00
Samuel Bronson
88e6e5bcf6 Fix a couple of doc typos. 2012-10-10 11:06:40 -04:00
Danny Yoo
444aaf6eb7 Small typo fix 2012-10-09 14:00:34 -04:00
Asumu Takikawa
7826efcdf5 Add examples for tabular in scribble reference 2012-10-08 23:10:52 -04:00
Matthew Flatt
44e55689a2 Scribble overview: mention tables comments, and pictures 2012-09-23 11:53:30 -05:00
Matthew Flatt
cb041850f4 scribble: decode a lone ` as a left "curly quote"
Also, add 'lsquo as allowed content.

Omitting the ` conversion in the first place was over-conservative.
There's a backward-compatibility issue with this addition (i.e., a
document might contain a backquote in a decoded context that is
meant to be rendered as a backquote), but the potential problems
seem minor.
2012-09-21 07:37:30 -06:00
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