Commit Graph

1851 Commits

Author SHA1 Message Date
Georges Dupéron
3a929934be Succinct documentation for mutable-match-element-id-transformer 2017-04-28 00:07:03 +02:00
Georges Dupéron
a5119a7b15 Added mutable-match-element-id-transformer 2017-04-28 00:06:58 +02:00
Georges Dupéron
49de4c776a Merged in existing changes from scribble-enhanced 2017-04-28 00:06:46 +02:00
Georges Dupéron
bbe51a11aa Extracted manual-scheme.rkt and racket.rkt from upstream scribble repository 2016-09-20 18:35:21 +02:00
Vincent St-Amour
a69f6c6982 Add missing character to the table.
Used by the DrRacket docs, and was broken when making the table extensible.
2016-08-25 09:53:19 -05: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
Matthew Flatt
267fd52984 fix test to reflect previous scribble/example repair 2016-08-23 07:45:54 -06:00
Matthew Flatt
3e1c63c93a improve rendering of titles with empty numbers 2016-08-13 12:45:50 -06:00
Matthew Flatt
495630e001 avoid bad substring when something goes weird with section numbers 2016-08-13 07:31:58 -06:00
Benjamin Greenman
f488ed28f3 typo: "for and" 2016-08-09 13:25:39 -04:00
Matthew Flatt
5b37a3ac72 examples: avoid generating an empty nested table for empty output
For something like

 #lang scribble/manual
 @(require scribble/eval)
 @interaction[(define x 2)
              x]

the `interaction` form generated an empty nested table for the zero
results from `define`. When rendering via Latex, that empty table
could create vertical whitespace. Produce zero lines in the enclosing
table, instead.
2016-08-05 09:25:37 -06:00
Matthew Flatt
aca15dcc85 Fix use of namespace-require that can create conflicts
The current expader's `namespace-require` has a bug that prevents
it from reporting a conclict when `(for-label <lib>)` creates
a conflict due to different provided bindings of the same name
at different phases from <lib>. Avoid depending on that bug.
2016-08-01 13:23:24 -06: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
Jay McCarthy
06e254f169 Adding elsarticle 2016-06-16 16:37:07 -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
Robby Findler
0ca977aecd fix scribble/jfp 2016-05-28 02:32:40 -05:00
Robby Findler
5edbe0fc85 fix error message 2016-05-27 14:00:59 -05:00
Robby Findler
79e74d3b59 add (hopefully correct) missing case to the contract/bluebox renderer
closes #34
2016-03-17 09:08:43 -05:00
Robby Findler
468744bdf5 add latex equivalent for recently added mrlib/tex-table shortcuts
also correct ε to \varepsilon instead of \epsilon
2016-03-11 19:28:46 -06: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
Matthew Flatt
4d62fba7f2 fix scribble --redirect-main with indirect links 2016-02-25 08:53:42 -07:00
Matthew Flatt
17acde5a1f fix default external-URL redirection
Use an installation's current configuration and get a corrected
default by using `setup/dirs`.
2016-02-25 08:49:22 -07:00
ben
58b662ab77 typo: 'unrecognzied' -> 'unrecognized' 2016-02-20 18:18:02 -05:00
Jens Axel Søgaard
28e7d932c7 Merge pull request #29 from sorawee/patch-1
Add /Library/TeX/texbin as another candidate-dir
2016-02-17 19:00:44 +01:00
sorawee
249265102e Add /Library/TeX/texbin as another candidate-dir
MacTeX, TeX for Mac, will install the binaries at `/Library/TeX`. Hence, we should add this path to the candidate-dirs.
2016-02-15 22:52:23 -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
1db48e6fc6 fix test to allow a doc submodule 2016-01-01 14:36:09 -07: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
Matthew Flatt
668e3799bd HTML output: refine handling of a table in a bullet
Avoid a blank bullet line when an item start with a "boxed"
table for `defform` and similar.
2015-12-21 15:35:34 -07: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
Robby Findler
a64dc617f8 bump version number so there is a version that's post the existence of
the scribble/examples library (version 1.14 came with the
eval logging change but at the time there was no scribble/examples
library)
2015-12-17 22:05:21 -06: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
141d818675 adjust tests for change to examples label typesetting
There's now a blank line between "Examples:" and the example
interaction.
2015-12-12 16:50:46 -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
0bd9a0d070 examples: add "Examples:" label as compound para
Instead of creating a table to combine "Examples:" with the exmaple
content, use a compound paragraph (which didn't exist when `examples`
was first implemented). A compound paragraph provides better and more
consistent typesetting; for example, it doesn't make the word
"Examples:" use a fixed-width font in HTML output.
2015-12-10 09:24:34 -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
f637b94a61 evaluate expression only once for eval:check 2015-12-10 08:06:41 -07:00