Commit Graph

1897 Commits

Author SHA1 Message Date
Matthew Flatt
b2a12216d4 break various documentation dependencies by making them indirect
An "indirect" reference is resolved when HTML is loaded,
instead of at document-build time.

original commit: 3b89a05d46468a4e287c7c12c74bca324c9c21b8
2013-07-12 14:52:42 -06:00
Matthew Flatt
79ed4b0d10 fix doc typo
original commit: 8cf13c3f468d9776cc41b24a3fa2ce57ea8fbcb0
2013-07-12 14:52:42 -06:00
Matthew Flatt
8c1953bf47 raco setup and scribble: fix problems tracking document changes
Some non-transparent but serializable data structures broke
the comparison between previous and new outputs, which caused
too many document rebuilds.

Includes a change to make module path indexes work with `equal?'.

original commit: d5558a4fe0a0405140a6a44473f3000aef275685
2013-07-12 14:52:42 -06:00
Matthew Flatt
7308e4cc10 scribble: prefer dest-relative paths to collection-relative paths
Documentation for a user-scoped package is rendered inside a
collection path but moved outside of the collection path when
later installed in installation-wide, so it's important to
try a destination-relative path first.

original commit: 301bdf9764d898fdadd6105a97462d1c87fb625e
2013-07-08 18:23:08 -06:00
Matthew Flatt
54a1dbc33f misc changes to avoid absolute paths in bytecode files
In many cases, `path->collects-relative' is used instead of
`path->main-collects-relative' to generalize existing support
for collection-relative paths.

original commit: f87981f96057c26cb311e786a91229bf4a874e5b
2013-07-08 12:24:17 -06:00
Sam Tobin-Hochstadt
8f7ca80e7d Use #lang info instead of #lang setup/infotab.
original commit: 5a7ca7ebb56b2215f2d395ed052c03ea740817ea
2013-07-04 16:46:32 -04:00
Sam Tobin-Hochstadt
7dad71a579 Create info collection for "info.rkt" files.
original commit: 14207682d37c220a7a4755d5243878a6842fcccb
2013-07-04 16:46:31 -04:00
Sam Tobin-Hochstadt
133beeeed2 Fix dependencies.
original commit: 88e4715406f16de1cb58f634790be6e146a825da
2013-07-03 13:11:33 -04:00
Sam Tobin-Hochstadt
e7ad5dc165 Add scribble-text-lib package.
original commit: 92143dcb3acf774416386ac86a52e3e3d9eadf89
2013-07-02 18:28:42 -04:00
Sam Tobin-Hochstadt
ceb7b6087b Move most of the net collection out of the core.
- Most units and signatures from the `net` collection
  are now in `compatibility-lib`.
- Most of the actual libraries are in the `net-lib`
  package.

original commit: 2b1fb036c63639bc5dbb65348c4f4e5802c95b53
2013-07-01 11:27:14 -04:00
Matthew Flatt
2ceea4ea7b auto-fix dependencies in "pkgs"
Left one dependency broken: "drracket" currently depends on "htdp" for
a test. That needs to be fixed by removing the dependency (moving the
test to "htdp?), instead of changing the declared dependencies.

original commit: 51290fd2a95def6bb3b6d3d735cb62444e157553
2013-06-29 06:51:19 -06:00
Matthew Flatt
d96417e795 fill in some pkg `implies'
original commit: 5c42f46158248130a8179e7a563d16c5fc9d0d35
2013-06-29 06:51:18 -06:00
Matthew Flatt
95776e21cd link development-mode packages in a separate pkg database
Use `PKGS' with the top-level makefile to select packages for
a development-mode build. The default is "main-distribution",
which includes all packages in "pkgs".

original commit: d450ee97075ef92e3356b6ae27e8a53419dd9732
2013-06-27 21:52:23 -06:00
Matthew Flatt
d07ff0ebc3 scribble: add tests for traverse-element' and traverse-block'
original commit: d2ec0bf5cc259538bbad06752f65fe92dd885ff6
2013-06-27 17:04:16 -06:00
Sam Tobin-Hochstadt
83c01c200f Move help collection out of the core.
original commit: 45f3fddee5cf8532d5a410f04e700036d454cd9d
2013-06-27 13:53:52 -04:00
Matthew Flatt
a6e135c75c catch up on documentation for some library changes
The library changes were made as part of the package reoganization.

original commit: 4dc8050f757c529b30ee9960f9ec8c01c7f61ca5
2013-06-26 13:00:17 -07:00
Matthew Flatt
93c904b2b5 a step toward single-collection packages as default
A package's "info.rkt" file should define `collection' as a
string to name a single-collection package's collection, or as
the symbol 'multi to declare the package as multi-collection.
If `collection' is 'same-as-pkg, then the package name is used
as the collection name.

The default for `collection' is 'multi for now, but the intent
is to change the default to 'same-as-pkg after a conversion
period. Also, support for a `single-collection' definition remains
in place, but it wil be removed.

original commit: c738a6aa3eee89a82d577dd35c70eca8ed32f5b4
2013-06-25 22:46:23 +02:00
Matthew Flatt
86f7170151 move release notes in appropriate packages
A collection declares release notes with a `release-notes' field in
"info.rkt".

The "doc" directory is now populated exclusively by generated content,
instead of having a static "release-notes" directory (and a "keep-dirs.rktd"
file to record the static directories).

original commit: fa6f56fcb118a99a803697de6cdc7ee7fd9688a4
2013-06-19 21:01:52 -06:00
Matthew Flatt
b79fa2c540 reorganize into core plus packages
The "racket" directory contains a pared-back version of the
repository, roughly.

The "pkgs" directory everything else in the repository, but
organized into packages.

original commit: b2ebb0a28bf8136e75cd98316c22fe54c30eacb2
2013-06-19 09:01:37 -06:00
Matthew Flatt
cc2436bac6 doc repair
Fix "style" where it should be "style property".

original commit: 0c235c36c3f2dc589f9ce3a80b411d7551345c3e
2013-06-06 17:14:08 -06:00
Andrei Mikhailov
4e94e7750a Add 'no-sidebar style property as a style for the main part of a document
The new style property causes the HTML output to not include an ``on this
page'' margin box.

original commit: 131ce83b32a8336d935ed35b8457522ad51e7262
2013-06-06 17:14:08 -06:00
Stephen Chang
3640f0b25d scribble docs typos
original commit: 0680bb6a3d526688d3f8283850f51501fc28d904
2013-06-05 13:06:08 -04:00
Stephen Chang
55ccb7ab28 scribble docs typo
original commit: 20137ab5284572a295e4daefd14c6d728222c1eb
2013-05-31 13:58:53 -04:00
Matthew Flatt
262055da0e scriblib/footnote: adjust environment to make output empty
Paragraph breaks within the footnote environment created whitespace
output, but the intent is to have no output.

original commit: bc0b50be961044c8c845221c61a5d67f8cbd9665
2013-05-24 14:55:38 -06:00
Matthew Flatt
ca96ca2c2e scriblib/autbib: add `#:note' support
original commit: 7645bacec1e9c9455a1c08f17b251cabdf1a3ebc
2013-05-24 14:55:38 -06:00
Matthew Flatt
d8f2cc1bd9 raco pkg create: support "source" and "binary" bundling
Adds `--from-dir' and `--from-install' flags to select the interpretation
of the argument as a directory or as the name of an installed package.
Relevant to PR 13669

Adds `--as-is' (the default), `--source', and `--binary' flags to
select a pruning mode.

The `raco setup' tool recognizes a `rendered-scribblings' specification
in "info.rkt" to trigger moving rendered documentation into place,
registering its tags in the cross-reference database, and fixing up
references to "local-redirect.js"; the presence of a "synced.rktd"
indicates when those fixups have been performed (since, if the package
is installed in a user-specific scope, the documentation doesn't actually
move anywhere). Finally, "out<n>.sxref" needs to report paths relative to
the documentation's directory, and then the relative-directory references
need to be suitably resolved at derserialization; some support for such
relative paths was in place, but it wasn't quite general enough before.

original commit: 198a65a5fc79649ec167d2407c35815768a119ba
2013-05-16 11:50:04 -06:00
Matthew Flatt
03c6b006e8 scribble HTML rendering: unreserved-encode "on this page" links
In other words, replace "(...)" with "%28...%29" in links.

original commit: 7c0ab55cbccd4e1b257d7b47a3bc2637328280ec
2013-05-16 11:04:23 -06:00
Matthew Flatt
378d6ee9c9 scribble/base: handle special characters in URLs
For characters in the URL that give LaTeX trouble, convert
them to % encoding.

original commit: 967021ca6305dc70488a277c90bed0bb4d6b3e02
2013-05-16 11:04:23 -06:00
Robby Findler
b66e924310 move the slideshow/pict library to its own collection
also, adjust all of the requires in the tree to point to the pict
collection

original commit: 9932ef33f77ab8bd9751568b4ef2d1b1e3cf4254
2013-05-12 22:07:58 -05:00
Jay McCarthy
bb9ffefd74 Adding customization of command-char to web-server/template
This entails adding it to include/text and read-syntax-inside as well.

original commit: 73232afd9934f5b7918d29414d835f33f21aa57c
2013-05-08 10:52:40 -06:00
Matthew Flatt
fff0344f4e render non-installaction-scoped package docs with an indirection
The indirection uses a "local-redirect.js" script to rewrite
the document links to local links within the browser. This mechanism
is a step towards distributing compiled packages that include
already-built documentation, where paths to other documentation
can be different than in the build environment.

If the links are not rewritten, they are queries to
"pkg-docs.racket-lang.org", with the idea tha such a server will exist
for reading all package documentation online. Also, a package's
documentation that refer to documentation for uninstalled packages,
in which case the corresponding links will not get rewritten and
will continue to point to the server.

Rendering the "local-redirect.js" script spends a lot of time just
converting among different path formats. Various library changes in
this commit are aimed at speed up those conversions, but the big
improvement came from a `path->url-string' that shortcuts conversion
os simple Unix paths.

original commit: 9361b1e709bc7a75822c7da68530cbe0fef4ae28
2013-05-08 09:54:30 -04:00
Matthew Flatt
76a79e3536 scribble: fix `--redirect{-main}' and non-HTML mode
original commit: 4ac6a6b3e3d381bc0e20ecb19258cf8b520a8437
2013-05-07 12:00:13 -04:00
Matthew Flatt
8a3c287eb6 scribble: fix binding search for phase 1 through initial import
Changing the implementation of `racket' in terms of `racket/base'
exposed this bug.

original commit: f3a7833dcf7a87b885ab562f06727fde050cb95a
2013-05-07 08:31:16 -04:00
Matthew Flatt
9097b87aca make scribble' (and raco scribble') use a `doc' submodule when present
original commit: f60803c300e5c208d80b8e2567a2622f114758b5
2013-05-07 08:31:16 -04:00
Matthew Flatt
e2578af0ef scribble/manual: make `defmodule' more flexible
original commit: eb924d75b638f10780fad46126072311e54d88ed
2013-04-30 09:36:48 -06:00
Asumu Takikawa
9f4dba7886 Note that Markdown mode now uses ```racket in docs
original commit: 16d3ad7fe5bd4b4f4c25fc4cad8a0e492e992df0
2013-04-29 17:06:02 -04:00
Eli Barzilay
bba5d06448 Remove some redundant "www."s.
original commit: ef0f610ca73207fe661994677129d456493e47f9
2013-04-28 12:53:07 -04:00
Robby Findler
21a7b4ed08 add missing for-label require
original commit: f07e18361721072485309fd14bca54b5bfcd46b2
2013-04-25 17:32:00 -05:00
Robby Findler
80b8bbd686 add an example with html tags and attributes
original commit: 5db7715b279991ae2e9581fc824fb9424b9b2c47
2013-04-21 20:46:44 -05:00
Matthew Flatt
8876f00787 scribble/manual: add #:link-target?' to defproc', `defform', etc.
Specifying `#:link-target? #f' gets blue-box typesetting without
declaring documentaton for a binding.

original commit: 5c4a7db828b1e1d7d43047b6ba32b8a00297df44
2013-04-21 09:49:14 -06:00
Robby Findler
8ae2827b2d typo in proc-docs docs.
original commit: eb4e89f3ffd865cabd3b66ae68c4856ca126f56e
2013-04-20 22:22:06 -05:00
Asumu Takikawa
b1496888d3 Fix doc contracts
original commit: a9286ce7262ba3b39b63fc859ca93132cda84e5c
2013-04-20 23:17:59 -04:00
Matthew Flatt
6d84b17b7c scribble/reader: allow escape character to be non-ASCII
original commit: 96c5521196dc1fe19c401950775b2c8f8e80991f
2013-04-19 20:46:25 -06:00
Robby Findler
4ab5a49c99 extend proc-doc to support optional arguments in an ->i contract
also refactor to be able to add some unit tests

original commit: 8ce213bf1c17d38cab651634b2892d15916ca301
2013-04-06 19:04:05 -05:00
David Van Horn
0808c21415 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.

original commit: 213430f728b33486fcc8334058a833f9d8c9de78
2013-04-06 09:00:41 -06:00
Ryan Culpepper
d16c59f097 added with-eval-preserve-source-locations to scribble/eval
Makes it possible to show examples of redex term->pict, etc.

original commit: 516f56fc83653558d3b3bfea8cb471a213dcbe25
2013-04-04 13:28:01 -04:00
Ryan Culpepper
af5721a887 added optional #:grammar clause to defform, etc
original commit: 293b208af72c53b5bb2b625650b19a52d1cf256d
2013-03-30 10:00:44 -04:00
Matthew Flatt
6b54708a39 scriblib/footnote: fix for non-Latex output
Also, fix warnings generated even for Latex mode.

original commit: 45f74eafe59df40ac7682e37aecce3b46ac05f06
2013-03-29 07:23:49 -06:00
Greg Hendershott
58fab5c3a6 Combine adjacent code spans into one.
These result from something like

    @racket[(x y)]

being treated by Scribble as multiple RktXXX items rather than one. As
a result the Markdown emitted was:

    `(``x`` ``y``)`

But obviously instead we want:

    `(x y)`

Kludgosity alert: Although it would probably be more-correct to
consolidate the RktXXX items at the Scribble structure level, I don't
easily see how. `@racket` is baking in the concept of Racket
lexing (classifying text as various kinds of Racket elements). This is
handy when the render will be HTML or Latek, and is benignly N/A when
it will be plain text. But it's a bit square-peg/round-hole when the
render will be Markdown. Rather than attempt to "un-lex" the Scribble
structures (I'm having trouble seeing how), I'm handling it
"after-the-fact" -- adjusting the generated Markdown text.

If anyone thinks the preceding is an elaborate rationalization for an
ugly kludge, I wouldn't argue, but I would need some help
understanding the preferable way to go about it.

original commit: 59bba2d197a42448d21c7f899d197b890adc7c9e
2013-03-29 07:23:49 -06:00
Greg Hendershott
3f1ebb9565 Fix problem handling examples and interaction.
Unlike plain `racketblock`, `examples` and `interaction` are
"nested". As a result we emitted bad Markdown like:

    ```racket
    Examples:
    ```racket
    some-code
    ```
    ```

Markdown code blocks can't nest, so this needs to be:

    ```racket
    Examples:
    some-code
    ```

Also: Updated the unit test with examples of `examples` and
`interaction`.

original commit: a5f6686270239484a5e7b2e6864c9bd5627d937d
2013-03-29 07:23:49 -06:00