Commit Graph

1880 Commits

Author SHA1 Message Date
Matthew Flatt
7dd9a13ad6 fix references to subdirectories of a rendered manual
For example, fix the resolution of a link to a binding in the R5RS
or R6RS spec.

original commit: 4216f3b66615ed5f63ff2f8350e9e1f778cd141b
2014-04-19 11:14:37 -06:00
Matthew Butterick
3e8ac59cfb missing semicolon in Scribble CSS
original commit: 481d19fbdd18510b3d3274d2ee4d4d061a5d2317
2014-04-05 19:25:06 -06:00
Matthew Butterick
cc68354488 further dehackify .toptoclink style in Scribble CSS
original commit: 7a1fe139a587800d2af76ce7eb09250247e9feea
2014-04-05 16:30:35 -06:00
Matthew Flatt
1bca3ea18c scribble manual style: remove toc hack
At mbutterick's recommendation:

 it's causing a strange display problem in TOC listings when the
 cursor is hovering over the link (namely, the underlined space
 dangling from the right edge)

original commit: cc26a86cb1975bdbb1ed3f816b6a50decfdec510
2014-04-05 08:07:48 -06:00
Matthew Flatt
0fd78b8ca8 scribble/base: add #:{column,row,cell}-properties arguments to tabular
The new arguments greatly simplify adding properties such as alignment
and (HTML) background colors to table cells. For example, to make a
table with 'right alignment for the left-hand column, 'center alignment
for the second column, and 'left alignment for all remaining columns:

 (tabular cells
          #:sep (hspace 1)
          #:column-properties '(right center left))

Also, make `color-property` and `background-color-property` recognized
as table-cell style properties.

Finally, implement horizontal alignment for text rendering.

original commit: 316fc0dbf5e26061245d815c992cc54d9738aa79
2014-03-25 14:23:22 -06:00
Sam Tobin-Hochstadt
87201fe4e0 Fix description of citet requirements.
original commit: b961b55bb2dd13f46d84c300f6536e49c1d0494a
2014-03-18 16:28:41 -04:00
Matthew Flatt
b36443dc6a scribble: #:doc-id argument to load-xref and associated plumbing
Keep track of the target document name (i.e., the name of the
directory that will contain the target document) for a cross
reference, when known. This identification enables a simpler dynamic
resolution of a hyperlink in almost all cases, istead of requiring
a search for an arbitrary corss-reference key.

Indirect links still need a mapping of cross-reference keys
to document locations, but the mapping can be pruned to just
section and module-name keys.

This change cuts a generated "local-redirect.js" for the main
distribution to 1/8 of its size.

original commit: a956918adb1ffe69b7cefea00f3c9d594f58734a
2014-03-16 12:40:52 -06:00
Matthew Flatt
1666108800 scribble/manual docs: corrections on #:link-target? and #:indirect
original commit: c429032d7e4631742a04076962cfa1ca2439f80e
2014-03-16 09:18:40 -06:00
Matthew Flatt
fdb4bb99d0 scribble docs: tweak language related to collections and packages
original commit: f94dc32329e7b303e92feba736f33b3484b281b3
2014-03-16 09:18:40 -06:00
Asumu Takikawa
7c81ef7f75 Revise Scribble docs for the new package system
Replaced mentions of PLaneT with the new package system
in sec 4.1 of the Scribble docs.

original commit: 01ed4fa480cdf5f32e20459091778b75414389eb
2014-03-14 10:22:12 -04:00
Matthew Flatt
1ef30a5715 scribble/html docs: clarify the effect of 'abs un url-roots
original commit: d168e5953d8001d981458e5ebb0ed0b3fc2669b8
2014-03-07 14:32:55 -07:00
Stephen Chang
b2d05d8a2f add tests for scribble/eval
original commit: cd50d0077675adf2d73f064326cf28f461866ebc
2014-03-05 16:41:56 -05:00
Stephen Chang
b11717253d fix scribble make-base-eval racket/pretty namespace error
closes pr 14066

original commit: b7360c76d7bdda4d6973bc09f0266b4dc0c9dc84
2014-03-05 16:41:56 -05:00
Matthew Flatt
3d40e770ef scribble/render: fix contract on render to include #:warn-undefined?
original commit: fb20706213dc5ece7894afff46763428bee346f0
2014-03-05 10:33:35 -07:00
Matthew Flatt
09cfb6ce12 LGPL by reference
original commit: 981701d2378179d4ada54b7fd2608df3b89748fd
2014-02-27 15:56:11 -07:00
Matthew Flatt
0bbee2d93e typos and notes
Thanks to Eli.

original commit: c64142ce24c3773eb4c3d4603588de286f1032d3
2014-02-12 18:47:04 -07:00
Matthew Flatt
e34cf22278 scribble/manual: delay expressions that require collection-based files
This changed make `(require scribble/manual)` work in an executable,
although actually rendering documents requires the "scribble"
collection.

original commit: 9ca0aa52250c18dd05c2a19bea654ca770aecf0c
2014-02-11 10:07:03 -07:00
Matthew Flatt
1bac8f0057 scribble/html: add 'index flag in url-roots
This flag can be used to make "file://..."-rendered pages easier
to inspect.

original commit: 2f469a06cd56c5be1ddab2a169428cd2099a2cbb
2014-02-11 05:50:04 -07:00
Matthew Flatt
b669a390ff scribble/text: fix contract and docs on with-writer
original commit: 964e9d128fd44da01ff1eea3efe9b02566f28530
2014-02-11 05:50:04 -07:00
Matthew Flatt
460c6323e0 scribble/text: add outputable/c and contract checks
The `outputable/c` contract is currently just an alias for
`any/c`, however, because checking the contract seems to be
too expensive.

original commit: 416b680d742afafe7f5632ca94cb36bac25534b8
2014-02-09 06:39:39 -07:00
Asumu Takikawa
ec6eb40ce8 Adjust prose in how-to-doc section of Scribble docs
original commit: 50711f7a6e570300cbdcb2b8979c93878bacac68
2014-02-08 09:49:11 -05:00
Matthew Flatt
2064749fa2 scribblings/html/resource: allow #f renderer for URL conversion
original commit: f1521de96b52a0f52ec23a02c5016622524086e5
2014-02-07 22:36:01 -07:00
Matthew Flatt
19ea3a7194 split "scribble-html-lib" package out of "scribble-lib" package
original commit: 0ad3a6a7f6c897b4fe7d3d2dfdceb3a8831e293a
2014-02-07 22:36:01 -07:00
Matthew Flatt
e7adecfd59 Scribble docs: split preprocessor variants into a separate manual
original commit: ce31b5965c4680ca53cb85d6ec6731e2f949878f
2014-02-07 22:36:01 -07:00
Matthew Flatt
b23fb873f5 scribble-{doc,lib}: fix package dependencies
original commit: 01ca4933895cadb3e0d6cdf8c170fdf06624dcff
2014-02-06 05:47:56 -07:00
Matthew Flatt
f7db2c37c2 scribble/html: first cut at documentation
original commit: f943d37d7d30507c8b76fd358d568f361bc0f2ec
2014-02-05 21:58:48 -07:00
Matthew Flatt
702b3e6702 scribble/text: finish documentation
original commit: cdb5c9dfdb50f6cb4dab09be11f3f46b81c32d59
2014-02-05 21:54:14 -07:00
Matthew Flatt
7889e768c8 scribble/sigplan: fix problem that makes doi required
Closes PR 14311

original commit: af28d4175d07113b3ba788fd03a6c5df9f384508
2014-02-04 17:59:26 -07:00
Matthew Flatt
eb4e22904a scribble: ++args for passing command-line arguments to documents
original commit: 392ea2e91d6c51157daa35dd1aa72cca951b6ac9
2014-01-22 20:04:13 -07:00
Eli Barzilay
78728a728e 2013 -> 2014
original commit: c61a549840ee0ba5f2e5da56523fd3b26efeb895
2014-01-21 15:02:21 -05:00
Asumu Takikawa
40e12781cd Fix doc typos
original commit: 54e24e42c61e265158dc1be883b27f09fe95231d
2014-01-17 10:22:33 -05:00
Matthew Flatt
ca59988ba0 scribble/manual: improve defstruct layout
The old layout used column spans that created ugly space around parentheses
for some combinations of field-name and keyword-modifier lengths. The new
layot avoids the problem by breaking the keyword modifiers into their
own table.

original commit: a391556faa2d2b43f39b2d48a139085704a865ec
2014-01-15 10:31:11 -07:00
Matthew Flatt
1665fec8c2 scribble/manual: break defthing output lines if needed
If the defined identifier plus contract doesn't fit on a single
line, put them on separate lines.

original commit: 77392cd02752d868e1c8363779ada62b9431df7f
2014-01-15 10:31:11 -07:00
Matthew Flatt
db1a3b4139 scribble/manual: fix history for Latex/PDF
original commit: c1af595c1bc0071b4fcbcf56fa77715f0e09a9bf
2014-01-11 19:30:39 -07:00
Matthew Flatt
40d6caf08a Scribble Latex/PDF: avoid new "stabular.sty" by embedding a copy of old
original commit: f78a25ce41b15d53f710c4c93abfa2e446213ac6
2014-01-11 19:27:15 -07:00
Neil Toronto
d49e86f13e Added #:value keyword to defproc', defparam', `defthing' and related
Also fixed `defproc*' example

original commit: 9ca8c71aadebf741c6ac799b7b78ecf2113d4b16
2014-01-11 17:41:15 -07:00
Matthew Butterick
32fe554534 adjust CSS selector for blue boxes in documentation
original commit: 258aa82282118345b4ca7011c715c53763ce93f1
2014-01-09 13:03:28 -06:00
Matthew Flatt
929b10f1bf scribble: document all scribble/manual CSS style classes
Includes a few Scrible bug and documentation repairs.

original commit: bf3fa13bb8bce224aac3c07a05d8740791d32058
2014-01-08 23:08:14 -06:00
Matthew Flatt
dae3560a76 scribble: document all scribble/base CSS style classes
A demo document (linked from the Scribble manual) demonstrates how
to trigger each style class and what it looks like with the default
and manual styles.

original commit: 5e0182029fea2d79e22d515305654a79a881e6d3
2014-01-08 07:50:27 -07:00
Matthew Flatt
cf3e0ef3eb scribblings config: 'keep-style and 'no-search flag, 'omit-start section
The 'keep-style avoids imposing the Racket manual style on a
document, while 'no-search omits the search box. The 'omit-start
section is like 'omit, but the document is still indexed and
available for cross-references.

Also, recognize a 'prefixable tag shape so that the set of tags
hat support prefixing is extensible.

original commit: c4f4ba4ca38c05e8beff1546a8df69617c25821c
2014-01-08 07:33:28 -07:00
Matthew Flatt
949c5776c8 scribble/manual: make racketblock fall back to racket-style spacing
When source-location information isn't available, usually due to macros
in compiled modules, make `racketblock` fall back to `racket`-like
spacing. This improvement is visible, for example, in the documentation
for functions like `recycle-icon`.

Using `quote-syntax/srcloc` in a macro is probably a better solution,
because that will preserve the original layout including line breaks,
but the default-spacing fallback seems like an improvement over
unreadable output.

original commit: 86df55a877feca51680aaab9b955ea9220229c14
2014-01-07 16:22:07 -07:00
Matthew Flatt
2828cef1d8 scribble: doc repair
Closes PR 14219

original commit: 60f5f512e82158bd7a5416257bd43365a3ed5cf0
2014-01-07 14:38:03 -07:00
Matthew Butterick
ee3118c5f1 switch to unitless line-heights
original commit: bfa5e72816e455a976e3d1458dd9abaa50d60a8e
2014-01-06 19:41:14 -07:00
Matthew Flatt
4014cb57b6 file/convertible: declare 'png@2x-bytes conversion variant
The 'png@2x-bytes variant is like 'png-bytes, but where the decoded
bytes are intended to be scaled by 1/2.

Consumers:

 - DrRacket's print handler

 - Scribble's HTML renderer

Producers:

 - `bitmap%`s where the scaling factor is 2

 - picts

Examples: Quick docs, docs for `images/icons/misc`, DrRacket interactions
for results of `images/icons/misc` functions.

original commit: eda4f357463fc8803726881f57cdd1cec6822660
2014-01-06 19:02:20 -07:00
Sam Tobin-Hochstadt
baded0251a Minor doc fixes.
original commit: ade6ebff9916fcf8e4566c69b431d86644721abc
2014-01-04 17:56:28 -05:00
Matthew Flatt
11d290e2c7 racket-style.css: move margin-note img formatting to Guide/Ref icon
Setting image with to 1.5em seems to be aimed specifically at
the cross-reference icons in the Guide and Reference, and the
width should not apply to just any image in a margin note.

original commit: 463b81780a6e870d1f201e1b2408424bb02bfe77
2014-01-03 10:22:53 -07:00
Matthew Flatt
1775ef6a14 copy responsible info to "info.rkt" files
It seems more ideal that `pkg-authors` would be specific enough
responsibility, but our existing allocations of responsibility are
more fine-grained, and we keep them for now.

original commit: 19f8f30f63ece380105f69796c046c7a00aa4f97
2014-01-01 07:27:15 -07:00
Matthew Flatt
f0fd7106e3 move "props" test configs to test submodules or "info.rkt" files
The "props" file still has

 * ".rkt" `drdr:timeout` entries, needed until DrDr uses submodules and
   "info.rkt" files; although timeout information has been put in
   submodules for `raco test`, DrDr uses `raco test` in a way that does not
   enable timeouts, so that DrDr can implement timeouts itself (and record
   when a test times out)

 * ".rkt" `drdr:random #t` entries; not sure what to do with these, yet

 * ".rkt" `responsible` entries; not sure what to do with these, yet

 * ".rktl" `drdr:command-line #f` entries, needed until all ".rktl" files
   are disabled in DrDr

The following files were previously disabled for DrDr testing, but were
intentionally left as enabled with these changes:

pkgs/racket-pkgs/racket-test/tests/pkg/shelly.rkt
pkgs/racket-pkgs/racket-test/tests/pkg/util.rkt
pkgs/racket-pkgs/racket-test/tests/pkg/info.rkt
pkgs/racket-pkgs/racket-test/tests/pkg/basic-index.rkt
pkgs/racket-pkgs/racket-test/tests/racket/link.rkt
pkgs/racket-pkgs/racket-test/tests/racket/embed-in-c.rkt
pkgs/racket-pkgs/racket-doc/ffi/examples/use-c-printf.rkt
pkgs/racket-pkgs/racket-doc/ffi/examples/c-printf.rkt
pkgs/parser-tools-pkgs/parser-tools-lib/parser-tools/private-lex/error-tests.rkt
pkgs/mysterx/mysterx.rkt
pkgs/mysterx/main.rkt
pkgs/games/gobblet/test-model.rkt
pkgs/games/gobblet/test-explore.rkt
pkgs/games/gobblet/robot.rkt
pkgs/games/gobblet/check.rkt
pkgs/db-pkgs/db-lib/db/private/odbc/main.rkt
pkgs/db-pkgs/db-lib/db/private/odbc/ffi.rkt
pkgs/db-pkgs/db-lib/db/private/odbc/dbsystem.rkt
pkgs/db-pkgs/db-lib/db/private/odbc/connection.rkt
pkgs/distributed-places-pkgs/distributed-places-lib/racket/place/distributed/examples/hello-world.rkt
pkgs/redex-pkgs/redex-lib/redex/private/compiler/match.rkt
pkgs/redex-pkgs/redex-lib/redex/private/compiler/match.rkt
pkgs/htdp-pkgs/htdp-test/2htdp/utest/balls.rkt
pkgs/gui-pkgs/gui-test/framework/tests/test-suite-utils.rkt
pkgs/games/paint-by-numbers/raw-problems/size-calculation.rkt
pkgs/db-pkgs/db-lib/db/odbc.rkt
pkgs/compatibility-pkgs/compatibility-lib/mzlib/traceld.rkt
pkgs/cext-lib/dynext/private/stdio.rkt
pkgs/db-pkgs/db-lib/db/odbc.rkt
racket/collects/ffi/unsafe/objc.rkt
racket/collects/ffi/objc.rkt
pkgs/racket-pkgs/racket-test/tests/pkg/tests-db.rkt
pkgs/racket-pkgs/racket-test/tests/pkg/test-docs.rkt
pkgs/racket-pkgs/racket-test/tests/pkg/test-catalogs-api.rkt
pkgs/gui-pkg-manager-pkgs/gui-pkg-manager-lib/pkg/gui/main.rkt
pkgs/redex-pkgs/redex-lib/redex/private/compiler/redextomatrix.rkt
pkgs/typed-racket-pkgs/typed-racket-lib/typed-racket/base-env/base-special-env.rkt
pkgs/planet-pkgs/planet-test/tests/planet/version.rkt
pkgs/planet-pkgs/planet-test/tests/planet/test-docs-complete.rkt
pkgs/planet-pkgs/planet-test/tests/planet/lang.rkt
pkgs/planet-pkgs/planet-test/tests/planet/docs-build.rkt
pkgs/drracket-pkgs/drracket-test/tests/drracket/follow-log.rkt
pkgs/drracket-pkgs/drracket/drracket/private/dock-icon.rkt
pkgs/drracket-pkgs/drracket-test/tests/drracket/tool-lib-and-sig.rkt

original commit: e226ad66c5fb6095d5702e5c47f5c7cf73e914f5
2013-12-30 12:15:18 -07:00
Matthew Flatt
beca6fbcf1 scribble & slideshow: move detail-change notes into docs
original commit: 4fbea1376e328f64108f8b7b6f669ce78b874f30
2013-12-24 18:00:38 -06:00
Matthew Flatt
760370e7da scribble/manual: add history
Also, show supplying package in providing-package hover at
definition sites.

original commit: 3f30400a59329a547aa47e80a1e0b592b9e8a73b
2013-12-24 18:00:37 -06:00