Robby Findler
531ad440b7
add dictat about predicates as nouns
2017-01-04 09:18:00 -06:00
Matthew Flatt
f224034a1f
"Mac OS X" -> "Mac OS"
2016-12-23 12:37:32 -07:00
Jay McCarthy
6564d5999c
Adding docs for doc-binding
2016-11-30 13:55:52 -05:00
Leif Andersen
6b261eb6f8
Add an example for defstruct*
2016-11-14 15:58:56 -05:00
Ben Greenman
1676671ee0
update HTML tags, add scribble/html/extra
...
This commit adds:
+ a few tags to `scribble/html` (by extending the list in `scribble/html/html`)
+ even more tags to `scribble/html/extra`,
these tags are "likely" to cause namespace issues (time, map)
or are uncommon / esoteric (rb, ruby, svg)
+ a test in `scribble/html.rkt` that the tags from
- `scribble/html/html`
- and `scribble/html/extra`
match a master list from the whatwg specification*
* https://html.spec.whatwg.org/multipage/#toc-semantics
2016-11-07 12:23:19 -05:00
Vincent St-Amour
fc57dd624a
Move doc example for raw @ sign.
...
At Eli's suggestion.
2016-10-24 10:54:35 -05:00
Vincent St-Amour
f9cc826d5b
Add example for a raw @ sing in the at-exp docs.
2016-10-13 15:10:34 -05:00
Ben Greenman
724b522f3b
typo: render-date keywords to define-cite macro
...
Changes documentation for `define-cite` macro;
the keyword names now match the implementation.
2016-10-09 13:18:55 -04:00
Matthew Flatt
30ae71202d
fix references lifted to table of contents
...
Certain lifted reference forms carried the prefix of the original
section, but in general the section needs to be similarly carried for
rendering elements that may contain references.
Also, fix the contract on `elemref` and `elemtag` to use
`taglet?` instead of `tag?`.
Thanks to Dupéron Georges.
2016-10-01 10:51:18 -06:00
Vincent St-Amour
cce1eff495
Extend special characters using a function rather than a dict.
...
Based on feedback from David Van Horn.
2016-08-24 16:14:03 -05:00
Vincent St-Amour
525b72ca4c
Make the list of special characters user-extensible .
2016-08-24 16:14:03 -05:00
Vincent St-Amour
78a517a34d
setup-plt -> raco setup
...
Survived unnoticed for 6+ years.
2016-08-24 15:27:58 -05:00
Benjamin Greenman
f488ed28f3
typo: "for and"
2016-08-09 13:25:39 -04:00
Asumu Takikawa
f4f3354466
Add doc examples for history form
2016-07-21 13:50:01 -04:00
ben
7836b78809
scribble/jfp: affiliation-mark example
2016-07-11 14:53:30 -04:00
Ben Greenman
2b972d9cc9
doc: add missing index-desc field descriptions
2016-07-08 22:28:53 -04:00
Ben Greenman
5505a5557a
Add language-index-desc and reader-index-desc
...
Subtypes of module-index-desc.
Used to tell if a module implements a #lang or a #reader module.
2016-07-08 17:56:35 -04:00
Leif Andersen
c34a69c623
Update the docs to mention the search-box
parameter in the html mixin.
2016-06-15 15:24:36 -04:00
Matthew Flatt
e92229f481
doc: explain indentation and workaround for racketresultblock
2016-03-07 19:21:39 -07:00
Sam Caldwell
f6460dac5e
fix typo in how-to
2016-03-04 16:41:35 -05:00
ben
d51825b95e
example usage of 'other-doc'
2016-01-25 11:51:31 -05:00
Matthew Flatt
798155c4f9
add make-numberer
to generalize section numbering
2016-01-09 20:21:18 -07:00
Spencer Florence
2881ef290d
Allow for manipulating scribble.tex imports
2016-01-09 11:48:21 -06:00
Matthew Flatt
0f0d662b14
scribble/lp2: strip code:comment
, etc.
2015-12-30 07:22:15 -06:00
Matthew Flatt
bbbd68b3c2
declare-exporting: allow escaped module-path expressions
2015-12-30 06:54:51 -06:00
Matthew Flatt
f09604f097
scribble/lp2: declare doc
submodule with module*
...
Using `module*` allows the documentation submodule to refer to the
implementation module.
2015-12-30 06:24:17 -06:00
Vincent St-Amour
63f8793e78
Move scriblib docs to the "Scribble Libraries" category.
2015-12-19 18:03:37 -06:00
Matthew Flatt
d2bf2e49c5
move scribble/examples
to scribble/example
...
Use singular to follow the naming convention of the style guide.
2015-12-18 06:28:27 -07:00
Matthew Flatt
90455e2d6a
add tests for examples
2015-12-13 09:09:33 -07:00
Matthew Flatt
ad9a465ab1
Latex: 'inset style renders through a SInsetFlow
environment
2015-12-13 07:40:26 -07:00
Matthew Flatt
50f835c4f1
add scribble/examples
...
The `scribble/examples` library provides a cleaner and more modern
interface for evaluation compared to `scribble/eval`.
2015-12-11 11:54:07 -07:00
Matthew Flatt
f1f47c5f16
scribble/examples: revert logging change, add options
...
The error-logging change in 81aeab1687
didn't work well for me
in further experiments. Change `interactions`, etc., to have a
`#:no-errors?` argument, instead. Also, add `eval:no-prompt`,
which provides an alternative to `def+int`.
Improve the documentaiton by correcting mistakes and filling
in some missing exports.
2015-12-11 10:03:31 -07:00
Matthew Flatt
81aeab1687
scribble/eval: add eval:error
and logging of other exceptions
...
When an expression in `examples` or `interactions` raises an
exception, the error message is rendered as part of the documentation.
Now, however, unless the expression is wrapped with `eval:error`, an
error is also logged.
Logging an error is a compromise between backward compatibility (for
documents that rely on undeclared but expected errors) and making a
document fail completely (which would be nicer when an error is not
expected).
2015-12-10 08:33:00 -07:00
Matthew Flatt
6b8490b78b
scribble/sigplan: add to-appear
2015-11-23 12:22:31 -07:00
Vincent St-Amour
9c26539b71
Add missing history annotations.
...
Please merge to 6.3.
2015-10-12 14:41:11 -05:00
Matthew Flatt
296e55d0e0
correct docs on code:contract
...
Unfortunately, `scribble/manual` and `pict/code` differ on how they
color `code:contract` content.
2015-10-02 15:36:12 -06:00
Matthew Flatt
a2f430020a
scribble/eval: strip away code:contract
s
...
Make `code:contract` handled like `code:comment` for evaluation.
Relevant to PR 15161
2015-10-02 15:24:08 -06:00
Matthew Flatt
26eff4c03a
fix racketblock
docs on code:comment
and code:contract
2015-10-02 15:24:08 -06:00
William J. Bowman
ea01ae2f68
Added example of @tech with #:doc
...
I never remember how to use this.
2015-09-17 11:14:09 -05:00
Leif Andersen
94804a1579
Fix types in sigplan documentation
2015-09-09 13:18:07 -04:00
Matthew Flatt
e0a14fa28d
tabular: fix insertion of separator before 'cont
...
Use 'cont before a 'cont cell instead of adding a separator.
2015-08-04 09:44:36 -06:00
Matthew Flatt
0ea9922784
fix doc typo
2015-07-30 14:54:48 -06:00
Vincent St-Amour
ea70707036
Merge unstable/sandbox with scribble/eval.
2015-07-23 15:04:44 -05:00
Matthew Flatt
4e96e99344
docs: clarify (under)specification of nested
default style
2015-05-28 16:22:57 -06:00
Alexis King
d895edf530
Fix typo in scriblib conditional content docs
2015-05-13 03:09:39 -07:00
Eli Barzilay
117218dc3e
Two bugfixes.
...
* Fix contract on `with-writer`.
* The default writer is initially `write-string`, not `display`.
2015-05-11 16:44:44 -06:00
Robby Findler
c84c1cf6cc
document typeset-code
...
also adjust contract on context-expr to admit that #f is allowed
2015-05-11 08:04:40 -05:00
Matthew Flatt
ea6de4535d
fix terminilogy: "Scribble" vs. "@-form"
2015-04-28 10:12:11 -06:00
Robby Findler
3ea5bd2e31
add some missing docs and @history annotations from commits e6630f0e9
and 39e0f6aec
2015-04-17 05:47:28 -05:00
Robby Findler
39e0f6aecd
add some tag predicates and tag manipulation functions
2015-04-15 03:39:32 -05:00