Commit Graph

1379 Commits

Author SHA1 Message Date
Robby Findler
c456ffef40 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

original commit: 0c6734f782867b0401db15eb687fd246552e17b5
2012-08-12 08:41:46 -05:00
Robby Findler
dcb258ac6c correct spelling error
original commit: 5d81b80736779360f5000d17fb422b19679c3352
2012-08-11 22:50:49 -05:00
Robby Findler
8799cd2137 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})

original commit: 8ee76c9547899f62e6f28eba1cdbba1f4d54c399
2012-08-11 21:52:48 -05:00
Matthew Flatt
9dd4dddb90 scribble/base: generalize `itemlist' to splice/coerce some arguments
Also, add a `spliceof' contract constructor to `scribble/decode'.

original commit: f11450d6019924f38bc523967cab1384514f2163
2012-08-03 13:43:23 -06:00
Matthew Flatt
989d851497 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.

original commit: aa5b1e192c5d38ada197a488f9817ed7ad9df861
2012-07-31 07:50:46 -06:00
Matthew Flatt
e285bfb53b scriblib/figure: support references to multiple figures at once
original commit: 4a6bfacc27f81bb757001694dd5250eedbd728fd
2012-07-31 07:50:46 -06:00
Matthias Felleisen
8f8f8315c5 fixed small mistake in defform/none from conversion to syntax/parse
merge into v5.3 but ask Matthew for second opinion

original commit: bf8c30727d4cb8def581f63e43cb79a1111ad8ff
2012-07-23 11:35:59 -04:00
Robby Findler
11fd5a91ed use a more descriptive name in the identifier generated by define-on-demand
so when it shows up in an error message it doesn't take forever to figure
out which 'val' that is

original commit: 0ee8155527bf0118c1b035efdcc5a6a2fac4828a
2012-07-15 08:07:11 -05:00
Vincent St-Amour
0d977a560c Add scribble support for additional letters from the Czech alphabet.
original commit: f036b0bd12faf7bcad812f516d938ce5afaf0bc1
2012-07-12 17:40:01 -04:00
Matthew Flatt
570f682b23 scriblib/autobib: first cut at configurable style
Adds `number-style' as an alternative to `author+date-style'.

original commit: 48e154e3cb3eae280a82116933ddf0b03a7dd4d1
2012-07-10 00:21:56 -06:00
Matthew Flatt
83e4a20c8e scriblib/autobib: fixes in docs and related to disambiguation
Fixed problems related to sorting, more than two references for
one citation, and "specific" additions like page numbers.

Also, removed a set of parentheses around disambiguated dates
in the bibliography, because I don't think they belong there.

The doc format was confused; for example, square brackets don't mean
optional in a syntactic form documentation, but instead mean square
brackets.

original commit: 71fe28e5dcf33f33a1afbb810b0cf6cc439e6629
2012-07-10 00:21:56 -06:00
Matthew Flatt
d23768ba32 scribble: add --dest-base flag
Also add the option to `render' from `racket/render', and
document the existing `render%' initialization argument.

original commit: f9b4c6b2268440e9e74b414e6e0b1487981c70df
2012-07-06 16:48:36 -06:00
Eli Barzilay
5cb1ba3a4a Some styling.
original commit: 75f710dc62c8c5a1ce04f22b6c37a4c611a3445e
2012-07-06 16:07:30 -04:00
Matthew Flatt
9650c4767b 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.

original commit: 2b9f57b01d55a39a70f0d0df22bc97b1874727ea
2012-07-06 13:17:35 -06:00
Danny Yoo
e48b814b17 Correcting type error in latex-match: target-url-addr can be a path, which can't be consumed by regexp-replace
original commit: 0a5e92c299c7f2edd8540d1d127f5c887ce750c7
2012-07-06 12:03:47 -04:00
Asumu Takikawa
793a83e339 Fix doc typos
original commit: 9f83ba1c6f450790d99f734779c07a775aefb104
2012-07-03 15:54:25 -04:00
Matthew Flatt
54e7b17c5e improve error handling for `defproc'
Closes PR 12780

original commit: e8d9d4e9ca5149398ead0a3a664405d8aa7a5b70
2012-07-02 10:07:52 -06:00
Matthew Flatt
d7bf77fba7 doc correction
Closes PR 12844

original commit: 4ed8a889695c59bfa9deba3fdce616d49e125938
2012-07-02 09:08:05 -06:00
Matthew Flatt
0190c2702d scribble: adjust `subsubsub*section' font size
Closes PR 12868

original commit: b5189c823216fda8ea68b7254a2a4df5cc4ee5f3
2012-07-02 09:00:08 -06:00
Matthew Flatt
3d84458aa7 scribble Latex: add \SNumberOfAuthors{} in output
original commit: 814c974d015b647e8482a46720f0728d3b318175
2012-07-01 10:00:58 -06:00
Matthew Flatt
607f02a331 scribble HTML render: avoid intermediate XML structure
As pointed out by Danny Yoo to save time during the rendering phase

original commit: 612c4ff5240594b8d884ce2d68701cd40ba50fc1
2012-06-28 09:15:57 -06:00
Matthew Flatt
2c7e58dd70 tweaks to Danny's Scribble changes
original commit: 130618e946640d749a81312fa951acd43ec1c66a
2012-06-28 08:57:58 -06:00
Danny Yoo
31c6e16944 Correcting content->string so that it does not concatenate strings in quadratic time
original commit: d926f89cbe316f9c5e481841a80f905a9da3228c
2012-06-28 08:39:14 -06:00
Danny Yoo
db64a47dd7 Changing decode-string so it avoids allocation and interns the individual string components.
original commit: 2f4671235c322f3450b0633cd866f18b95f58f13
2012-06-28 08:39:03 -06:00
Matthew Flatt
1efd01584e scribble/eval: remove bogus top-level `namespace-require'
original commit: 5f3f3e8c54f843338feb7a5fdf76eed0240f1aa9
2012-06-27 12:28:17 -06:00
Matthew Flatt
937d4f0e59 scribble/manual: add #:id' option to defproc'
Also, convert the implementation of `defproc', `defform', etc. to
use `syntax-parse'.

original commit: 6028a60f6588f11dfe1b466df24513256e1b84c4
2012-06-25 23:16:33 -06:00
Robby Findler
378f9c3bae adjust defproc* so that it only shows the white background label once, instead
of once per different identifier that it is documenting

original commit: 3afba2d833bbe2349621f4851f4f41569007ed53
2012-06-25 13:42:09 -05:00
Matthew Flatt
0ca77cb9f5 CSS tweak for whute label on blue boxes
This tweak avoids adding extra space when the white-label font is
taller than the line it's attached to. It also makes the label
disappear in IE 6, but I think we can live with that.

original commit: c2924ef926c3ed62e61e5deff72f15f3065bb0ab
2012-06-25 09:02:51 -06:00
Matthew Flatt
c836acca01 fix some error-message tests
original commit: 5433d2302a5c7a6aa588d3aa107bd72e19359862
2012-06-23 05:21:52 -07:00
Robby Findler
6137f803b2 strengthen contract on blockss field of table struct in scribble
original commit: f7185bec91d04a28289887947c5a394fd94914fe
2012-06-22 22:12:54 -05:00
Eli Barzilay
e4b6652f27 Random pickiness.
Spaces at EOFs, indentation, etc.

original commit: 7d6e79023cf9872e6f6af2f89961b742c6296f1d
2012-06-22 12:00:48 -04:00
Matthew Flatt
381505ade5 update docs related to definition-box labels
original commit: 303aaec2b45ff2e42b2353820572dc93c275d8a3
2012-06-21 07:15:09 +08:00
Robby Findler
ed8baf5d79 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

original commit: 411aeb99b845823aa5f9bcaebe6b686ad478ab75
2012-06-20 08:22:58 -05:00
Robby Findler
87197b53ca remove uppercasing of the tag names
original commit: c13a88915a226d4cb67c19c1386841d2e549344b
2012-06-20 08:22:58 -05:00
Robby Findler
2fed399324 make scribble's part/document/element/etc structs all be #:transparent
original commit: 4d7f6d79353fc818d847de6bd99c224c50005689
2012-06-20 08:22:58 -05:00
Robby Findler
c77b67ea80 Fixed up and added in the struct hierarchy diagram from the Scribble paper
original commit: ac8a4f23e5df50d1e7cc579fd8cbcd6606b8dc6d
2012-06-18 11:26:27 -05:00
Matthew Flatt
4fc0b01398 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.

original commit: 5ff3087677ec98ea626cca25b085f3c32138d5ca
2012-06-17 09:19:58 +08:00
Matthew Flatt
f1aa676101 misc changes to speed up doc search generation
Cuts about 30% of the time on my machine.

original commit: 815fd1b49c7b7857aa08fd15c5ec77655ac84859
2012-06-08 16:08:55 +08:00
Matthew Flatt
3ac30a1f35 scribble: fix duplicate call to `render-element' callback
This change should cut the time to generate the search index
roughly in half.

original commit: 00e1ed9369d8401ef349f9c9fb9475d30ab2cda1
2012-06-08 16:08:55 +08:00
Matthew Flatt
8f6b31924c clarifications and additions to style guide
original commit: c5f821b6415a4ad0f073b66b9bbf6455d801ff01
2012-06-03 04:50:06 +08:00
Jay McCarthy
e690d99f57 Fixing PR12779
original commit: 8b035f3c736d92c5e8ae896b3044eb2e32f44c8a
2012-05-28 11:52:56 -06:00
Matthew Flatt
b5f09c0d39 more error-message conversions and repairs
original commit: a137459b65b54d65595e854101aae7440d9e65f6
2012-05-27 11:29:21 -06:00
Matthew Flatt
625ee5db99 fix misc tests for error-message change
original commit: b5ab6cec7e3038cfd917af16e082c8bc98384807
2012-05-26 08:18:19 -06:00
Matthew Flatt
45e9a0fd33 scribble/eval: fix error line wrapping
The `wrap-line' function from `scribble/text/wrap' wants a
string that's a single line, so break the initial string
based on explicit lines, first.

original commit: 9b7ef7bf699c7997ad2c254827ca6528491a6f10
2012-05-25 12:47:39 -06:00
Asumu Takikawa
aaad158068 Fix doc breakage.
`abstract` from racket/class conflicted with `abstract`
in scribble paper modules.

original commit: 94545a7cd7c108688c2299bb5f0e0f2e0a63c025
2012-05-22 19:55:44 -04:00
Matthew Flatt
e1f816952c fix Scribble module languages to allow submodules
That is, recognize `module' and `module*' as top-level forms.

original commit: ec85dd913d75250e5be244bc07789604dfe5fd34
2012-05-20 07:39:05 -06:00
Matthew Flatt
2cdcf15d24 fixes for `scribble/srcdoc'
Use the new `relative-in' form to make imports
resolve correctly when they are shifted among modules.

original commit: 0c95475f4ffbc343291e5529a6f4b32a91159ef1
2012-05-15 20:03:41 -06:00
Matthew Flatt
24acfab0ad 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'.

original commit: 964020f288a73340052b471327bfe873d804eea8
2012-05-12 01:37:50 -06:00
Jay McCarthy
757b462154 Better error messages, plus fix for the tag syntax
original commit: 93d8e89b66a3e1f659a6c4e59a6d8086debe0d0a
2012-05-11 20:13:29 -06:00
Jay McCarthy
ec73f42c1b scribble/lp on racket/base vs scheme/base
original commit: f675514a2b47fdf3cb1b1c9447c96bea468a401c
2012-05-10 10:36:29 -06:00