From 2c8f1b1585dca2921648068391f69443c31d5bb3 Mon Sep 17 00:00:00 2001 From: John Clements Date: Tue, 28 Aug 2018 12:39:37 -0400 Subject: [PATCH] add docs for acmart options --- .../scribblings/scribble/acmart.scrbl | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/scribble-doc/scribblings/scribble/acmart.scrbl b/scribble-doc/scribblings/scribble/acmart.scrbl index fca73465..773754ce 100644 --- a/scribble-doc/scribblings/scribble/acmart.scrbl +++ b/scribble-doc/scribblings/scribble/acmart.scrbl @@ -74,6 +74,54 @@ number of options may be used: }| If multiple font size options are used, all but the last are ignored. + +The @link["https://www.acm.org/binaries/content/assets/publications/consolidated-tex-template/acmart.pdf" + ]{ACM documentation} (version 1.54, 2018-07-16, by Boris +Veytsman) provides these defaults and descriptions: + +@tabular[#:style 'boxed + #:sep @hspace[1] + ;#:column-properties '(left left left) + #:row-properties '(bottom-border ()) + (list + (list @bold{name} @bold{default} @bold{description}) + (list "review" "false" + "A review version: lines are numbered and\ + hyperlinks are colored") + (list "screen" "see text" + "A screen version: hyperlinks are colored") + (list "natbib" "true" + "Whether to use the natbib package") + (list "anonymous" + "false" + "Whether to make author(s) anonymous") + (list "authorversion" + "false" + "Whether to generate a special version\ + for the authors’ personal use or posting") + ;; these options are documented in ACM docs but don't + ;; appear to exist in the scribble acmart format: + #;( + (list "nonacm" "false" + "Use the class typesetting options for a non-ACM\ + document, which will not include the conference/journal\ + header and footers or permission statements") + (list "timestamp" "false" + "Whether to put a time stamp in the footer\ + of each page") + (list "authordraft" "false" + "Whether author’s-draft mode is enabled") + (list "acmthm" "true" + "Whether to define theorem-like environments")))] + +Further details for some of these are provided by the full +documentation for the acmart LaTeX class. + +In order to disable a default-true option (e.g. @racket[natbib]), call +the option as a function with the value @racket[#false]: + +@code|{#lang scribble/acmart @natbib[#f] @sigplan}| + } @defproc[(abstract [pre-content pre-content?] ...) block?]{