Commit Graph

130 Commits

Author SHA1 Message Date
Matthew Flatt
431bb95c7b improve markdown renderer, including support for section links 2019-10-16 05:36:48 -06:00
Dominik Joe Pantůček
97078b60ed scribble/srcdoc: add class*-doc and class-doc provide forms (#213)
* scribble/srcdoc: add `class*-doc` and `class-doc` provide forms.

* Add missing require of racket/class which contains the class? predicate.

* Add @history stanza to class*-doc and class-doc scribblings and bump version number in scribble-lib/info.rkt to 1.30.
2019-10-01 23:01:06 -04:00
Ben Greenman
6097c6aff6 typo: 'to registered' -> 'to be registered' 2019-09-02 20:34:47 -04:00
Ben Greenman
77b26d736a doc: remove srcdoc reference to 'gif.rkt' 2019-06-05 17:18:06 -04:00
Ilnar Salimzianov
7e2bce57ad Add https://blog.racket-lang.org/2012/06/submodules.html as an example for in-source documentation
I couldn't locate gif.rkt in the `file' collection. See a complete working example was helpful to get started. I think it will be as useful for
other Racketeers .(especially beginners like myself).

If gif.rkt is indeed gone due to refactorings, I guess the reference to it should removed.
2019-06-05 17:10:03 -04:00
mlemmer
dce36bfc18 Add book-chapter-location to autobib (#182) 2019-05-01 23:36:11 -04:00
Ben Greenman
441e97ec27
doc: use 'scribble/acmart' as Getting Started example (#193)
Chagne the Getting Started guide to suggest `scribble/acmart` instead of
`scribble/sigplan` for a PL workshop paper.
2019-05-01 23:34:52 -04:00
Leif Andersen
0905c3d6a3 Line 1 got messed up during the commit, reverting. 2019-04-10 13:17:51 -04:00
Leif Andersen
51c1c2ed47 Minor typo:
each expression is are duplicated -> each expression is duplicated
2019-04-10 13:14:07 -04:00
Matthew Flatt
5460642214 make verbatim suppress line breaks in HTML output 2019-02-27 14:53:49 -07:00
Ben Greenman
ac37653988 doc: explain typeset-code's #:block argument 2019-02-24 18:20:11 -05:00
Paulo Matos
3349b13825 Add block? contract to typeset-code (#196)
I think something should be said about what `block?` does but I am not comfortable enough with the scribble code to write it down.
2019-02-24 17:55:03 -05:00
Matthew Flatt
5f44d7dd55 scribble: document methods of base render% class 2019-02-01 16:41:50 -07:00
Paulo Matos
599da42d47 Fix typo in 'adition' 2019-01-17 15:06:59 -06:00
Ben Greenman
490bbcc7b3 typo: 'multi-file' -> 'multi-page'
closes #190
2019-01-06 11:31:51 -05:00
rxg
548d494dd0 typo (#189) 2019-01-04 19:30:25 -05:00
rxg
53d6354910 typo. (#188) 2019-01-04 19:30:18 -05:00
shuhung
194e4d15cd Sync the doc of author #:email with the contract (#186) 2019-01-02 15:40:27 -05:00
shuhung
31ff97f502 Add email-string to typeset email with exact-chars (#187)
Closes #185.
2019-01-02 14:44:57 -05:00
Ben Greenman
c63d3e7ccb typo: fix function name in link 2018-11-01 19:51:34 -04:00
Matthew Flatt
150de96b64 update docs with a working URL for --redirect 2018-10-08 19:14:28 -06:00
Ben Greenman
1a5f2a44bd
add optional #:note to 'bib-entry' (#176)
Add an optional argument to bib-entry to typeset a comment directly
after a citation --- with no punctuation between the end of the citation
and start of the comment.

Example: making an annotated bibliography, with an element that appears just
below each citation
2018-09-12 22:03:51 -04:00
Leif Andersen
d9e0462393 Add an identifier for acmart's nonacm flag. (#181)
* Add an identifier for acmart's nonacm flag.

* Add defidform of nonacm to docs.

* Add the rest of the missing flags

* Forgot one more line.
2018-09-12 22:03:04 -04:00
Ben Greenman
16cddd7276 typo: 'uncollapsable' -> 'uncollapsible' 2018-09-02 20:16:52 -04:00
Ben Greenman
858743b679 typo: 'regonized' 2018-09-02 20:16:52 -04:00
Ben Greenman
52334a508b acmart: add 'shortauthors' function 2018-09-02 20:16:52 -04:00
Ben Greenman
290b3ac370 doc: Benjamin -> Ben 2018-09-02 20:16:52 -04:00
John Clements
2c8f1b1585 add docs for acmart options 2018-08-28 15:35:39 -04:00
Philip McGrath
a2d2f0472f scribble/bnf: Add contracts & correct docs 2018-06-12 08:44:09 -06:00
Leif Andersen
67bfe3af4a
Parameterize figure captions by language. (#173)
* Acmart font requirements
* Parameterize for different languages.
* Update acmart to v1.53
* Added three new document types to match acmart 1.53
2018-05-11 17:25:24 -04:00
Ben Greenman
86cfc8b7f9 doc: typo, 'it if it' 2018-05-07 19:18:36 -04:00
Ben Greenman
e07fac631c typo: 'line-number-sep' => 'line-number-sep-expr' 2018-02-11 20:24:04 -05:00
Ben Greenman
ed0e87d54d doc: example include-section for scribble/lp2 2018-02-11 20:24:04 -05:00
Matthew Flatt
00739632cf tabular: add #:sep-properties
Also, correct the documentation about the interaction of
`#:sep` and property lists, and make the previous column's
properties used consistently for a separator column.
2018-01-04 11:03:36 -07:00
Matthew Flatt
9c5a45985b html-properties: add xexpr-property
For injecting literal HTML (or, using `cdata`, literal anything) into
the rendered HTML of a document. If you must.
2017-12-28 16:22:07 -06:00
Matthew Flatt
5f29095f02 scribble/book-index: more book-like index style for Latex/PDF
Merge index entries that have the same key and use cleveref to
render the page-number sequence.
2017-12-18 11:07:02 -07:00
Leif Andersen
564f441d99 Add authorsaddresses field to acmart
This was added in a recent version of the acmart style and is
required to set (or remove) the addresses field at the bottom of
the first page in some styles.
2017-10-18 20:38:03 -04:00
Matthew Flatt
7278568040 section links plus scriblib/{autobib,figure}: better match acmart
Add a `link-render-style` syntax property to control the rendering of
section links --- so that HTML output can say "section <number>", and
so that Latex/PDF output can have just the section number hperlinked
(as in acmart).

It seems unfortunate that the link rendering is so hardwired into each
rendering back-end, but maybe this can be made even more configurable
in the future. Meanwhile, Latex macros already provide an additional
layer of rendering control (but not enough, it turns out, to easily
perform the same adjustments as the 'number mode that matches acmart).

For `scriblib/figure` make `figure-ref` and `Figure-ref` similarly
sensitive to the link-rendering style.

For `scriblib/autobib`, change the hyperlinking of references
so that the color can be overridden, and make `scribble/acmart`
override it.
2017-10-11 11:19:44 -06:00
Matthew Flatt
1e81f0005a scribble/decode: add 'no-index to avoid part titles in index
Using 'no-index makes sense for a book, for example.
2017-10-09 08:34:23 -07:00
Matthew Flatt
84f5301ac0 scriblib/figure: more configuration of style 2017-09-26 08:13:03 -06:00
Matthew Flatt
dd92ebd2d9 acmart: fix contract on nested-flow forms, like acks
A nested flow's argument to be decoded a pre-flow instead of a
pre-content.
2017-09-08 16:37:24 -06:00
Asumu Takikawa
77a46f46c7 Add doc examples for @author and @author+email 2017-09-08 12:35:18 -07:00
Ben Greenman
9fc96fc56e doc: require 'scribble/example' in 'examples' example
Also increase the memory limit in the example.
(On my machine, this example fails if the memory limit is 37MB or less.)
2017-08-31 00:29:40 -04:00
Matthew Flatt
9f5fe0859d change base handling of convertible values as content
If a value is convertible to 'text, then use that conversion.

Otherwise, convert using `write` instead of always using "???".

Also, correct documentation to include convertible values among
the valid forms of content, and document the new conversion rules
there.
2017-08-21 08:41:09 -06:00
Robby Findler
01b279d5ba added author+date-square-bracket-style 2017-08-14 07:23:29 -05:00
Matthew Flatt
6587e4f5ea index style-property symbols 2017-07-27 08:20:59 -06:00
Ben Greenman
c4b4e4c929 acmart: a little better for empty documents
1. Change `add-acmart-styles` to add an element WITHOUT the `pretitle` style
   for the collects phase. With this, an empty `#lang scribble/acmart` document
   builds an empty PDF.
2. Add documentation for a "minimal" `scribble/acmart` document.
2017-06-22 20:11:37 -04:00
Ben Greenman
800d08fbef doc: fix 'scribble-eval-handler' order of arguments
Change the documented order of arguments to match the implementation / uses
 in `scribble/eval.rkt` and `scriblib/gui-eval.rkt`
2017-06-11 12:21:58 -04:00
Ben Greenman
b289b76536 autobib: add contracts to *-location functions
add contracts to location-formatting functions,
and make sure those functions convert their inputs to strings,
and fix a documentation bug in `techrpt-location`
2017-05-23 23:34:02 -04:00
Leif Andersen
4c8ac8e021
Fix contract docs for departments in scribble/acmart.
(I placed the wrong contract in the docs. The correct one is the one
defined in the module.)
2017-05-23 14:22:39 -04:00