From a8dec74ffaa73f26b289736529fcdc63999a1027 Mon Sep 17 00:00:00 2001 From: Leif Andersen Date: Thu, 18 May 2017 13:07:20 -0400 Subject: [PATCH 01/13] Add commands for cite-author and cite-year to autobib. (#111) These commands work like natbib's citeauthor and citeyear commands, and facilities making possessive citations. For example: > Thanks to @(cite-author foo)'s (@(cite-year foo)) paper on stuff... These identifiers are added with `define-cite` as keywords, and thus can be omitted with no downside for backwards compatibility. @(define-cite cite citet generate-bib #:cite-author cite-author #:cite-year cite-year) Also in this commit: * Add documentation. * Add tests for autobib * Bump version and add history. --- .../scriblib/scribblings/autobib.scrbl | 42 ++++++++++++++++--- scribble-lib/info.rkt | 2 +- scribble-lib/scriblib/autobib.rkt | 18 ++++++-- scribble-test/tests/scriblib/autobib.rkt | 15 +++++++ 4 files changed, 66 insertions(+), 11 deletions(-) create mode 100644 scribble-test/tests/scriblib/autobib.rkt diff --git a/scribble-doc/scriblib/scribblings/autobib.scrbl b/scribble-doc/scriblib/scribblings/autobib.scrbl index d2ebfb06..787c6169 100644 --- a/scribble-doc/scriblib/scribblings/autobib.scrbl +++ b/scribble-doc/scriblib/scribblings/autobib.scrbl @@ -55,16 +55,19 @@ includes a citation to section 8 of the Racket reference. (code:line #:render-date-in-bib render-date-expr) (code:line #:render-date-in-cite render-date-expr) (code:line #:date exact-nonnegative-integer? element?))] [render-date-expr (or/c #f (-> date? element?))] [date-compare-expr (or/c #f (-> date? date? boolean?))])]{ -Binds @racket[~cite-id], @racket[citet-id], and -@racket[generate-bibliography-id], which share state to accumulate and -render citations. +Binds @racket[~cite-id], @racket[citet-id], +@racket[generate-bibliography-id], (optionally) +@racket[cite-author-id], and (optionally) @racket[cite-year-id] which +share state to accumulate and render citations. The function bound to @racket[~cite-id] produces a citation referring to one or more bibliography entries with a preceding non-breaking @@ -90,6 +93,30 @@ section for the bibliography. It has the contract (->* () (#:tag string? #:sec-title string?) part?) ] +If provided, the function bound to @racket[cite-author-id] +generates an element containing the authors of a paper. + +@racketblock[ + (->* (bib?) element?) +] + +If provided, the function bound to @racket[cite-year-id] +generates an element containing the year the paper was +published in, or possibly multiple years if multiple papers +are provided. + +@racketblock[ + (->* (bib?) #:rest (listof? bib?) element?) +] + +The functions bound to @racket[cite-author-id] and +@racket[cite-year-id] make it possible to create possessive textual citations. + +@codeblock[#:keep-lang-line? #f]|{ + #lang scribble/base + @citeauthor[scribble-cite]'s (@citeyear[scribble-cite]) autobib library is pretty nifty. +}| + The default value for the @racket[#:tag] argument is @racket["doc-bibliography"] and for @racket[#:sec-title] is @racket["Bibliography"]. @@ -110,7 +137,10 @@ to add an extra element after the date; the default disambiguator adds ambiguous raises an exception. Date comparison is controlled by @racket[date-compare-expr]s. Dates in citations and dates in the bibliography may be rendered differently, as specified by the -optionally given @racket[render-date-expr] functions.} +optionally given @racket[render-date-expr] functions. + +@history[#:changed "1.22" "Add optional ids for author-name and author-year"] +} @deftogether[( @defthing[author+date-style any/c] diff --git a/scribble-lib/info.rkt b/scribble-lib/info.rkt index 951b8c3b..308acee3 100644 --- a/scribble-lib/info.rkt +++ b/scribble-lib/info.rkt @@ -23,4 +23,4 @@ (define pkg-authors '(mflatt eli)) -(define version "1.21") +(define version "1.22") diff --git a/scribble-lib/scriblib/autobib.rkt b/scribble-lib/scriblib/autobib.rkt index 30bbad6e..ffe11d1e 100644 --- a/scribble-lib/scriblib/autobib.rkt +++ b/scribble-lib/scriblib/autobib.rkt @@ -365,15 +365,17 @@ (define-syntax (define-cite stx) (syntax-parse stx - [(_ (~var ~cite) citet generate-bibliography + [(_ (~var ~cite id) citet:id generate-bibliography:id (~or (~optional (~seq #:style style) #:defaults ([style #'author+date-style])) (~optional (~seq #:disambiguate fn) #:defaults ([fn #'#f])) (~optional (~seq #:render-date-in-bib render-date-bib) #:defaults ([render-date-bib #'#f])) (~optional (~seq #:spaces spaces) #:defaults ([spaces #'1])) (~optional (~seq #:render-date-in-cite render-date-cite) #:defaults ([render-date-cite #'#f])) (~optional (~seq #:datestring e))) diff --git a/scribble-test/tests/scriblib/autobib.rkt b/scribble-test/tests/scriblib/autobib.rkt new file mode 100644 index 00000000..22e65f02 --- /dev/null +++ b/scribble-test/tests/scriblib/autobib.rkt @@ -0,0 +1,15 @@ +#lang racket + +(require scriblib/autobib) + +(let () + (define-cite cite citet gen-bib) + cite citet gen-bib + (void)) + +(let () + (define-cite cite citet gen-bib + #:cite-author cite-author + #:cite-year cite-year) + cite citet gen-bib cite-author cite-year + (void)) From 47c94c3afcf7d2384d38aec4908be92939251a0d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Georges=20Dup=C3=A9ron?= Date: Fri, 19 May 2017 22:42:48 +0200 Subject: [PATCH 02/13] Last,First format for names in bibtex Handle comma-separated Last,First and Last,Jr,First format for names in bibtex, as well as "von", "de la", "van de", and other separators that start with lowercase letters --- scribble-lib/scriblib/bibtex.rkt | 186 ++++++++++++++++++++++++++++--- 1 file changed, 172 insertions(+), 14 deletions(-) diff --git a/scribble-lib/scriblib/bibtex.rkt b/scribble-lib/scriblib/bibtex.rkt index 82d3fb97..4aae40f4 100644 --- a/scribble-lib/scriblib/bibtex.rkt +++ b/scribble-lib/scriblib/bibtex.rkt @@ -1,7 +1,8 @@ #lang at-exp racket/base (require racket/function racket/match - racket/list) + racket/list + racket/string) (struct bibdb (raw bibs)) @@ -208,7 +209,7 @@ (λ (key) (and (not (string=? "\n" key)) (generate-bib bibtex-db key))) - (append-map (curry regexp-split #rx" +") + (append-map (curry regexp-split #px"\\s+") (cons f r))))) (define ~cite-id (make-citer autobib-cite)) (define citet-id (make-citer autobib-citet)))) @@ -216,14 +217,25 @@ (define (parse-author as) (and as (apply authors - (for/list ([a (in-list (regexp-split #rx" +and *" as))]) - (match (regexp-split #rx" +" a) - [(list one) (org-author-name one)] - [(list one two) (author-name one two)] - [(list-rest first rest) - (author-name (apply string-append (add-between (cons first (drop-right rest 1)) - " ")) - (last rest))]))))) + (for/list ([a (in-list (regexp-split #px"\\s+and\\s+" as))]) + (define (trim s) + (string-trim (regexp-replace #px"\\s+" s " "))) + (match a + [(pregexp #px"^(.*),(.*),(.*)$" (list _ two suffix one)) + (author-name (trim one) (trim two) #:suffix (trim suffix))] + [(pregexp #px"^(.*),(.*)$" (list _ two one)) + (author-name (string-trim one) (string-trim two))] + [(pregexp #px"^(.*?)\\s+(\\p{Ll}[^\\s]*(\\s+\\p{Ll}[^\\s]*)*)\\s+(.*)$" (list _ one von-like _ two)) + (author-name (string-trim one) + (string-append (string-trim von-like) " " (string-trim two)))] + [space-separated + (match (regexp-split #px"\\s+" space-separated) + [(list one) (org-author-name one)] + [(list one two) (author-name one two)] + [(list-rest first rest) + (author-name (apply string-append (add-between (cons first (drop-right rest 1)) + " ")) + (last rest))])]))))) (module+ test (require rackunit) @@ -235,8 +247,8 @@ (equal? (format "~s" a) (format "~s" b))) - (check - print-as-equal-string? + (check + print-as-equal-string? (parse-author "James Earl Jones") (authors (author-name "James Earl" "Jones"))) @@ -248,12 +260,158 @@ (author-name "Morgan" "Freeman"))) (check - print-as-equal-string? + print-as-equal-string? (parse-author "Edward L. Deci and Robert J. Vallerand and Luc G. Pelletier and Richard M. Ryan") (authors (author-name "Edward L." "Deci") (author-name "Robert J." "Vallerand") (author-name "Luc G." "Pelletier") - (author-name "Richard M." "Ryan")))) + (author-name "Richard M." "Ryan"))) + + (check + print-as-equal-string? + (parse-author "Lst, Fst") + (authors + (author-name "Fst" "Lst"))) + + (check + print-as-equal-string? + (parse-author "Lst,Fst") + (authors + (author-name "Fst" "Lst"))) + + (check + print-as-equal-string? + (parse-author "James, Earl Jones") + (authors + (author-name "Earl Jones" "James"))) + + (check + print-as-equal-string? + (parse-author "James,Earl Jones") + (authors + (author-name "Earl Jones" "James"))) + + (check + print-as-equal-string? + (parse-author "LstA LstB, Fst") + (authors + (author-name "Fst" "LstA LstB"))) + + (check + print-as-equal-string? + (parse-author "LstA LstB,Fst") + (authors + (author-name "Fst" "LstA LstB"))) + + (check + print-as-equal-string? + (parse-author "LstA LstB, FstA FstB") + (authors + (author-name "FstA FstB" "LstA LstB"))) + + (check + print-as-equal-string? + (parse-author "LstA LstB,FstA FstB") + (authors + (author-name "FstA FstB" "LstA LstB"))) + + (check + print-as-equal-string? + (parse-author "James, Jr, Earl Jones") + (authors + (author-name "Earl Jones" "James" #:suffix "Jr"))) + + (check + print-as-equal-string? + (parse-author "James,Jr, Earl Jones") + (authors + (author-name "Earl Jones" "James" #:suffix "Jr"))) + + (check + print-as-equal-string? + (parse-author "James, Jr,Earl Jones") + (authors + (author-name "Earl Jones" "James" #:suffix "Jr"))) + + (check + print-as-equal-string? + (parse-author "James,Jr,Earl Jones") + (authors + (author-name "Earl Jones" "James" #:suffix "Jr"))) + + (check + print-as-equal-string? + (parse-author "James, III, Earl Jones") + (authors + (author-name "Earl Jones" "James" #:suffix "III"))) + + (check + print-as-equal-string? + (parse-author "James,III, Earl Jones") + (authors + (author-name "Earl Jones" "James" #:suffix "III"))) + + (check + print-as-equal-string? + (parse-author "James, III,Earl Jones") + (authors + (author-name "Earl Jones" "James" #:suffix "III"))) + + (check + print-as-equal-string? + (parse-author "James,III,Earl Jones") + (authors + (author-name "Earl Jones" "James" #:suffix "III"))) + + (check + print-as-equal-string? + (parse-author "James Jack von Earl Jones") + (authors + (author-name "James Jack" "von Earl Jones"))) + + (check + print-as-equal-string? + (parse-author "James Jack de la Earl Jones") + (authors + (author-name "James Jack" "de la Earl Jones"))) + + (check + print-as-equal-string? + (parse-author "James Jack van der Earl Jones") + (authors + (author-name "James Jack" "van der Earl Jones"))) + + (check + print-as-equal-string? + (parse-author "James Jack von de la Earl Jones") + (authors + (author-name "James Jack" "von de la Earl Jones"))) + + (check + print-as-equal-string? + (parse-author "James Jack di Earl Jones") + (authors + (author-name "James Jack" "di Earl Jones"))) + + (check + print-as-equal-string? + (parse-author "First fOn bER Last") + (authors + (author-name "First" "fOn bER Last"))) + + (check + print-as-equal-string? + (parse-author "Deci, Edward L. and Robert J. Vallerand and Pelletier, Luc G. and Ryan, Jr, Richard M.") + (authors (author-name "Edward L." "Deci") + (author-name "Robert J." "Vallerand") + (author-name "Luc G." "Pelletier") + (author-name "Richard M." "Ryan" #:suffix "Jr"))) + + (check + print-as-equal-string? + (parse-author "Foo anderson") ;; Should not be parsed as the two authors "Foo" & "erson" + (authors + (author-name "Foo" "anderson")))) (define (parse-pages ps) (match ps From 71bd7ddae03682d8d8fcdfcd6f2637340174bd7f Mon Sep 17 00:00:00 2001 From: Ben Greenman Date: Sat, 20 May 2017 18:12:42 -0400 Subject: [PATCH 03/13] doc: point 'tabular #:style' to 'table' docs --- scribble-doc/scribblings/scribble/base.scrbl | 1 + 1 file changed, 1 insertion(+) diff --git a/scribble-doc/scribblings/scribble/base.scrbl b/scribble-doc/scribblings/scribble/base.scrbl index 276927ee..1231ca53 100644 --- a/scribble-doc/scribblings/scribble/base.scrbl +++ b/scribble-doc/scribblings/scribble/base.scrbl @@ -260,6 +260,7 @@ used for a new cell. A @racket['cont] must not appear as the first cell in a row. The @racket[style] argument is handled the same as @racket[para]. +See @racket[table] for a list of recognized @tech{style names} and @tech{style properties}. If @racket[sep] is not @racket[#f], it is inserted as a new column between every column in the table; note that any From 4c8ac8e021f27c30d446bef1c8a7136ea3b9965d Mon Sep 17 00:00:00 2001 From: Leif Andersen Date: Tue, 23 May 2017 14:22:39 -0400 Subject: [PATCH 04/13] 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.) --- scribble-doc/scribblings/scribble/acmart.scrbl | 2 +- scribble-lib/scribble/acmart.rkt | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/scribble-doc/scribblings/scribble/acmart.scrbl b/scribble-doc/scribblings/scribble/acmart.scrbl index 32528c36..25b9329b 100644 --- a/scribble-doc/scribblings/scribble/acmart.scrbl +++ b/scribble-doc/scribblings/scribble/acmart.scrbl @@ -146,7 +146,7 @@ screen version of the image links to the badge authority. @defproc[(affiliation [#:position position (or/c pre-content? #f) #f] - [#:institution institution (or/c pre-content? institution? #f) #f] + [#:institution institution (listof (or/c pre-content? institution?)) '()] [#:street-address street-address (or/c pre-content? #f) #f] [#:city city (or/c pre-content? #f) #f] [#:state state (or/c pre-content? #f) #f] diff --git a/scribble-lib/scribble/acmart.rkt b/scribble-lib/scribble/acmart.rkt index 3f7ee494..252dfeee 100644 --- a/scribble-lib/scribble/acmart.rkt +++ b/scribble-lib/scribble/acmart.rkt @@ -289,7 +289,6 @@ (define (mk-inst name #:department? [department? department?] #:level [level level]) - (displayln department?) (case department? [(#f) (make-element (make-style "institution" command-props) (decode-content name))] From b289b76536348cf0b8426ca7d9d17ab96f680a72 Mon Sep 17 00:00:00 2001 From: Ben Greenman Date: Tue, 23 May 2017 23:34:02 -0400 Subject: [PATCH 05/13] 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` --- .../scriblib/scribblings/autobib.scrbl | 5 +- scribble-lib/scriblib/autobib.rkt | 32 +++++---- scribble-test/tests/scriblib/autobib.rkt | 65 +++++++++++++++---- 3 files changed, 76 insertions(+), 26 deletions(-) diff --git a/scribble-doc/scriblib/scribblings/autobib.scrbl b/scribble-doc/scriblib/scribblings/autobib.scrbl index 787c6169..50baa4cd 100644 --- a/scribble-doc/scriblib/scribblings/autobib.scrbl +++ b/scribble-doc/scriblib/scribblings/autobib.scrbl @@ -212,9 +212,10 @@ describing a paper's location within a journal.} element?]{ Combines elements to generate an element that is suitable for -describing a book's location.} +describing a book's location. +Both arguments are optional, but at least one must be supplied.} -@defproc[(techrpt-location [#:institution institution edition any/c] +@defproc[(techrpt-location [#:institution institution any/c] [#:number number any/c]) element?]{ diff --git a/scribble-lib/scriblib/autobib.rkt b/scribble-lib/scriblib/autobib.rkt index ffe11d1e..4d102b71 100644 --- a/scribble-lib/scriblib/autobib.rkt +++ b/scribble-lib/scriblib/autobib.rkt @@ -16,11 +16,19 @@ (provide define-cite author+date-style number-style make-bib in-bib (rename-out [auto-bib? bib?]) - proceedings-location journal-location book-location - techrpt-location dissertation-location author-name org-author-name (contract-out - [authors (->* (content?) #:rest (listof content?) element?)]) + [authors (->* (content?) #:rest (listof content?) element?)] + [proceedings-location + (->* [any/c] [#:pages (or/c (list/c any/c any/c) #f) #:series any/c #:volume any/c] element?)] + [journal-location + (->* [any/c] [#:pages (or/c (list/c any/c any/c) #f) #:number any/c #:volume any/c] element?)] + [book-location + (->* [] [#:edition any/c #:publisher any/c] element?)] + [techrpt-location + (-> #:institution any/c #:number any/c element?)] + [dissertation-location + (->* [#:institution any/c] [#:degree any/c] element?)]) other-authors editor abbreviate-given-names) @@ -485,12 +493,12 @@ #:pages [pages #f] #:series [series #f] #:volume [volume #f]) - (let* ([s @elem{In @italic{@elem{Proc. @|location|}}}] + (let* ([s @elem{In @italic{@elem{Proc. @to-string[location]}}}] [s (if series - @elem{@|s|, @(format "~a" series)} + @elem{@|s|, @to-string[series]} s)] [s (if volume - @elem{@|s| volume @(format "~a" volume)} + @elem{@|s| volume @to-string[volume]} s)] [s (if pages @elem{@|s|, pp. @(to-string (car pages))--@(to-string (cadr pages))} @@ -502,7 +510,7 @@ #:pages [pages #f] #:number [number #f] #:volume [volume #f]) - (let* ([s @italic{@|location|}] + (let* ([s @italic{@to-string[location]}] [s (if volume @elem{@|s| @(to-string volume)} s)] @@ -518,12 +526,12 @@ #:edition [edition #f] #:publisher [publisher #f]) (let* ([s (if edition - @elem{@(string-titlecase edition) edition} + @elem{@(string-titlecase (to-string edition)) edition} #f)] [s (if publisher (if s - @elem{@|s|. @|publisher|} - publisher) + @elem{@|s|. @to-string[publisher]} + @elem{@to-string[publisher]}) s)]) (unless s (error 'book-location "no arguments")) @@ -532,12 +540,12 @@ (define (techrpt-location #:institution org #:number num) - @elem{@|org|, @|num|}) + @elem{@to-string[org], @to-string[num]}) (define (dissertation-location #:institution org #:degree [degree "PhD"]) - @elem{@|degree| dissertation, @|org|}) + @elem{@to-string[degree] dissertation, @to-string[org]}) ;; ---------------------------------------- diff --git a/scribble-test/tests/scriblib/autobib.rkt b/scribble-test/tests/scriblib/autobib.rkt index 22e65f02..2db86253 100644 --- a/scribble-test/tests/scriblib/autobib.rkt +++ b/scribble-test/tests/scriblib/autobib.rkt @@ -1,15 +1,56 @@ -#lang racket +#lang racket/base -(require scriblib/autobib) +(require rackunit scriblib/autobib) -(let () - (define-cite cite citet gen-bib) - cite citet gen-bib - (void)) +(test-case "define-cite" + ;; Check that `define-cite` binds the expected identifiers -(let () - (define-cite cite citet gen-bib - #:cite-author cite-author - #:cite-year cite-year) - cite citet gen-bib cite-author cite-year - (void)) + (let () + (define-cite cite citet gen-bib) + (check-pred values (void cite citet gen-bib))) + + (let () + (define-cite cite citet gen-bib + #:cite-author cite-author + #:cite-year cite-year) + (check-pred values (void cite citet gen-bib cite-author cite-year)))) + +(test-case "proceedings-location" + (check-not-exn + (λ () (proceedings-location "RacketCon" #:pages '(1 2) #:series 3 #:volume 4))) + (check-not-exn + (λ () (proceedings-location 'PLDI))) + (check-exn exn:fail:contract? + (λ () (proceedings-location "USENIX" #:pages "4--5")))) + +(test-case "journal-location" + (check-not-exn + (λ () (journal-location "CACM" #:pages '(1 2) #:number 3 #:volume 4))) + (check-not-exn + (λ () (journal-location 'JFP))) + (check-exn exn:fail:contract? + (λ () (journal-location "Journal of Chromatography" #:pages 30)))) + +(test-case "book-location" + (check-not-exn + (λ () (book-location #:edition 1 #:publisher "A.C. Clayton"))) + (check-not-exn + (λ () (book-location #:edition 'B #:publisher 'Elsiver))) + (check-exn exn:fail? + (λ () (book-location)))) + +(test-case "techrpt-location" + (check-not-exn + (λ () (techrpt-location #:institution "MIT" #:number 'AIM-353))) + (check-exn exn:fail:contract? + (λ () (techrpt-location #:institution 'UCB)))) + +(test-case "dissertation-location" + (check-not-exn + (λ () (dissertation-location #:institution "New College"))) + (check-not-exn + (λ () (dissertation-location #:institution 'Oberlin))) + (check-not-exn + (λ () (dissertation-location #:institution "Georgetown University" #:degree "BS"))) + (check-exn exn:fail:contract? + (λ () (dissertation-location #:degree "PhD")))) From f069b975fb99f1f21c5daf09d88127777a80a2d3 Mon Sep 17 00:00:00 2001 From: Ben Greenman Date: Wed, 31 May 2017 13:52:01 -0400 Subject: [PATCH 06/13] acmart: simplify `@title` implementation Change LaTeX implementation of `@title` to just use `\title` --- don't try to extract a subtitle. - - - This fixes a bug, where the `Title` meta-data in the PDF for a document titled "Foo" was "oo" (same title with first letter missing). So, e.g., Google chrome would show "oo" as the tab title for the document. - - - Why not try to fix subtitle extraction? 1. I don't think we need it in `scribble/acmart`, because there's a separate `@subtitle` command 2. Not sure how to extract a subtitle without using `\let` inside `\title`, but doing so generates 2 LaTeX warnings: ``` Package hyperref Warning: Token not allowed in a PDF string (PDFDocEncoding): (hyperref) removing `\-command' on input line 674. Package hyperref Warning: Token not allowed in a PDF string (PDFDocEncoding): (hyperref) removing `\SSubtitle' on input line 674. ``` The "visual" bug was probably due to this warning; after removing the `\let` and `\SSubtitle` then only `\SubtitleDrop` and the actual title are left. I guess `\SSubtitleDrop` removed the first character of the title. (Why only the first character? I don't know.) The LaTeX warning from `hyperref` is probably because acmart expects the argument to `\title` to be a raw string. Though, the docs don't explicitly say this. They only say "It is expected that this command [`\title`] is inserted by the author of the manuscript." --- scribble-lib/scribble/acmart/style.tex | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/scribble-lib/scribble/acmart/style.tex b/scribble-lib/scribble/acmart/style.tex index b06428e1..19f281a1 100644 --- a/scribble-lib/scribble/acmart/style.tex +++ b/scribble-lib/scribble/acmart/style.tex @@ -1,20 +1,11 @@ -% Define \SXtitle to lift \SSubtitle out: -\newcommand{\SXtitle}[2][]{\title#1{\let\SSubtitle\SSubtitleDrop#2}\SExtractSubtitle#2\SExtractSubtitleDone} -\def\SSubtitleDrop#1{} -\def\SExtractSubtitleDone {} -\def\SExtractSubtitle{\futurelet\next\SExtractSubtitleX} -\def\SExtractSubtitleX#1{\ifx{#1}\SSubtitle \let\Snext\SWithSubtitle \else \let\Snext\SExtractSubtitleY \fi \Snext} -\def\SExtractSubtitleY{\ifx\next\SExtractSubtitleDone \let\Snext\relax \else \let\Snext\SExtractSubtitle \fi \Snext} -\def\SWithSubtitle#1{\subtitle{#1}\SExtractSubtitle} - -\renewcommand{\titleAndVersionAndAuthors}[3]{\SXtitle{#1}#3\maketitle} +\renewcommand{\titleAndVersionAndAuthors}[3]{\title{#1}#3\maketitle} \renewcommand{\titleAndEmptyVersionAndAuthors}[3]{\titleAndVersionAndAuthors{#1}{#2}{#3}} -\renewcommand{\titleAndVersionAndEmptyAuthors}[3]{\SXtitle{#1}\author{Anonymous Author(s)}\maketitle} +\renewcommand{\titleAndVersionAndEmptyAuthors}[3]{\title{#1}\author{Anonymous Author(s)}\maketitle} \renewcommand{\titleAndEmptyVersionAndEmptyAuthors}[3]{\titleAndVersionAndEmptyAuthors{#1}{#2}{#3}} -\renewcommand{\titleAndVersionAndAuthorsAndShort}[4]{\SXtitle[[#4]]{#1}#3\maketitle} +\renewcommand{\titleAndVersionAndAuthorsAndShort}[4]{\title[#4]{#1}#3\maketitle} \renewcommand{\titleAndEmptyVersionAndAuthorsAndShort}[4]{\titleAndVersionAndAuthorsAndShort{#1}{#2}{#3}{#4}} -\renewcommand{\titleAndVersionAndEmptyAuthorsAndShort}[4]{\SXtitle[[#4]]{#1}\author{Anonymous Author(s)}\maketitle} +\renewcommand{\titleAndVersionAndEmptyAuthorsAndShort}[4]{\title[#4]{#1}\author{Anonymous Author(s)}\maketitle} \renewcommand{\titleAndEmptyVersionAndEmptyAuthorsAndShort}[4]{\titleAndVersionAndEmptyAuthorsAndShort{#1}{#2}{#3}{#4}} % Support plain `author' while enabling `authorinfo': for each From 37ee75d3bf9ea2227c4f925be42e98287de4fd49 Mon Sep 17 00:00:00 2001 From: Ben Greenman Date: Sat, 3 Jun 2017 15:31:07 -0400 Subject: [PATCH 07/13] add contracts to scribble/example Add contracts to `scribble/example` exports, and tests to make sure negative blame gets assigned as expected. Closes #117 --- scribble-lib/scribble/example.rkt | 30 +++++++++++----- scribble-test/tests/scribble/example.rkt | 45 ++++++++++++++++++++++++ 2 files changed, 67 insertions(+), 8 deletions(-) create mode 100644 scribble-test/tests/scribble/example.rkt diff --git a/scribble-lib/scribble/example.rkt b/scribble-lib/scribble/example.rkt index 986d112b..a50d9712 100644 --- a/scribble-lib/scribble/example.rkt +++ b/scribble-lib/scribble/example.rkt @@ -1,22 +1,36 @@ #lang racket/base (require "eval.rkt" + racket/contract (only-in "struct.rkt" make-paragraph) (for-syntax racket/base syntax/parse)) +(define lang-option/c + (or/c module-path? (list/c 'special symbol?) (cons/c 'begin list?))) + +(define eval-factory/c + (->* [(listof module-path?)] [#:pretty-print? any/c #:lang lang-option/c] any)) + (provide examples ;; Re-exports: - - make-base-eval - make-base-eval-factory - make-eval-factory - close-eval + (contract-out + [make-base-eval + (->* [] [#:pretty-print? any/c #:lang lang-option/c] #:rest any/c any)] + [make-base-eval-factory + eval-factory/c] + [make-eval-factory + eval-factory/c] + [close-eval + (-> any/c any)] - scribble-exn->string - scribble-eval-handler - make-log-based-eval) + [scribble-exn->string + (-> any/c string?)] + [scribble-eval-handler + (parameter/c (-> (-> any/c any) boolean? any/c any))] + [make-log-based-eval + (-> path-string? (or/c 'record 'replay) any)])) (define example-title (make-paragraph (list "Example:"))) diff --git a/scribble-test/tests/scribble/example.rkt b/scribble-test/tests/scribble/example.rkt new file mode 100644 index 00000000..1e7ec167 --- /dev/null +++ b/scribble-test/tests/scribble/example.rkt @@ -0,0 +1,45 @@ +#lang racket/base +(require rackunit scribble/example setup/path-to-relative + (only-in racket/contract exn:fail:contract:blame?)) + +(test-case "scribble/example contracts" + (define blames-this-module? + (let* ([this-module + (path->relative-string/library + (variable-reference->module-source (#%variable-reference)))] + [blame-rx (regexp (string-append "blaming: " this-module))]) + (λ (x) + (and (exn:fail:contract:blame? x) + (regexp-match? blame-rx (exn-message x)))))) + + (check-exn blames-this-module? + (λ () (make-base-eval #:lang #f '(+ 2 2)))) + (check-exn blames-this-module? + (λ () (make-base-eval #:lang '(+ 2 2)))) + + (check-exn blames-this-module? + (λ () (make-base-eval-factory 'racket/dict))) + (check-exn blames-this-module? + (λ () (make-base-eval-factory '() #:lang #f '(+ 2 2)))) + (check-exn blames-this-module? + (λ () (make-base-eval-factory '() #:lang '(+ 2 2)))) + + (check-exn blames-this-module? + ;; https://github.com/racket/scribble/issues/117 + (λ () (make-eval-factory 'racket/dict))) + (check-exn blames-this-module? + (λ () (make-eval-factory '() #:lang #f '(+ 2 2)))) + (check-exn blames-this-module? + (λ () (make-eval-factory '() #:lang '(+ 2 2)))) + + (check-exn blames-this-module? + (λ () (scribble-eval-handler #f))) + (check-exn blames-this-module? + (λ () (scribble-eval-handler (λ (ev t) t)))) + + (check-exn blames-this-module? + (λ () (make-log-based-eval #f 'record))) + (check-exn blames-this-module? + (λ () (make-log-based-eval "foo.rkt" 'bad-mode))) + +) From 800d08fbef537abc7e773dbe25f2ac3b8bba5e7d Mon Sep 17 00:00:00 2001 From: Ben Greenman Date: Sun, 11 Jun 2017 12:21:58 -0400 Subject: [PATCH 08/13] 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` --- scribble-doc/scribblings/scribble/examples.scrbl | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/scribble-doc/scribblings/scribble/examples.scrbl b/scribble-doc/scribblings/scribble/examples.scrbl index 8e1c167a..5e8fa620 100644 --- a/scribble-doc/scribblings/scribble/examples.scrbl +++ b/scribble-doc/scribblings/scribble/examples.scrbl @@ -282,13 +282,13 @@ an evaluator (e.g., because it is defined in a module body).} @defparam[scribble-eval-handler handler - ((any/c . -> . any) any/c boolean? . -> . any)]{ + ((any/c . -> . any) boolean? any/c . -> . any)]{ A parameter that serves as a hook for evaluation. The evaluator to use -is supplied as the first argument to the parameter's value, and the -second argument is the form to evaluate. The last argument is -@racket[#t] if exceptions are being captured (to display exception -results), @racket[#f] otherwise.} +is supplied as the first argument to the parameter's value. +The second argument is @racket[#t] if exceptions are being captured (to display +exception results), @racket[#f] otherwise. +The third argument is the form to evaluate.} @defparam[scribble-exn->string handler (-> (or/c exn? any/c) string?)]{ A parameter that controls how exceptions are rendered by From c3d4ebc73743d82ae82f09c9a02a10cdc4d3ff25 Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Tue, 20 Jun 2017 13:32:26 -0600 Subject: [PATCH 09/13] move `scribble/example` contracts to `scribble/eval` Moving the contracts to the original exports ensures that the bindings from both modules are the same. In particular, making the bindings different caused the documentation to have missing links. --- scribble-lib/scribble/eval.rkt | 30 +++++++++++++++++++++--------- scribble-lib/scribble/example.rkt | 30 ++++++++---------------------- 2 files changed, 29 insertions(+), 31 deletions(-) diff --git a/scribble-lib/scribble/eval.rkt b/scribble-lib/scribble/eval.rkt index 602f69da..7c41aac2 100644 --- a/scribble-lib/scribble/eval.rkt +++ b/scribble-lib/scribble/eval.rkt @@ -33,18 +33,30 @@ defexamples* as-examples - make-base-eval - make-base-eval-factory - make-eval-factory - close-eval + (contract-out + [make-base-eval + (->* [] [#:pretty-print? any/c #:lang lang-option/c] #:rest any/c any)] + [make-base-eval-factory + eval-factory/c] + [make-eval-factory + eval-factory/c] + [close-eval + (-> any/c any)] + + [scribble-exn->string + (-> any/c string?)] + [scribble-eval-handler + (parameter/c (-> (-> any/c any) boolean? any/c any))] + [make-log-based-eval + (-> path-string? (or/c 'record 'replay) any)]) - scribble-exn->string - scribble-eval-handler with-eval-preserve-source-locations) -(provide/contract - [make-log-based-eval - (-> path-string? (or/c 'record 'replay) (-> any/c any))]) +(define lang-option/c + (or/c module-path? (list/c 'special symbol?) (cons/c 'begin list?))) + +(define eval-factory/c + (->* [(listof module-path?)] [#:pretty-print? any/c #:lang lang-option/c] any)) (define scribble-eval-handler (make-parameter (lambda (ev c? x) (ev x)))) diff --git a/scribble-lib/scribble/example.rkt b/scribble-lib/scribble/example.rkt index a50d9712..9f0ccf6d 100644 --- a/scribble-lib/scribble/example.rkt +++ b/scribble-lib/scribble/example.rkt @@ -1,36 +1,22 @@ #lang racket/base (require "eval.rkt" - racket/contract (only-in "struct.rkt" make-paragraph) (for-syntax racket/base syntax/parse)) -(define lang-option/c - (or/c module-path? (list/c 'special symbol?) (cons/c 'begin list?))) - -(define eval-factory/c - (->* [(listof module-path?)] [#:pretty-print? any/c #:lang lang-option/c] any)) - (provide examples ;; Re-exports: - (contract-out - [make-base-eval - (->* [] [#:pretty-print? any/c #:lang lang-option/c] #:rest any/c any)] - [make-base-eval-factory - eval-factory/c] - [make-eval-factory - eval-factory/c] - [close-eval - (-> any/c any)] + make-base-eval + make-base-eval-factory + make-eval-factory + close-eval - [scribble-exn->string - (-> any/c string?)] - [scribble-eval-handler - (parameter/c (-> (-> any/c any) boolean? any/c any))] - [make-log-based-eval - (-> path-string? (or/c 'record 'replay) any)])) + make-log-based-eval + scribble-exn->string + scribble-eval-handler + make-log-based-eval) (define example-title (make-paragraph (list "Example:"))) From cf7f7f32b72a9ec828dd028304b549ba0697773f Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Thu, 22 Jun 2017 15:39:27 -0600 Subject: [PATCH 10/13] change `history` rendering to start each change on its own line Closes #114 --- scribble-lib/scribble/private/manual-history.rkt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/scribble-lib/scribble/private/manual-history.rkt b/scribble-lib/scribble/private/manual-history.rkt index c08283ea..08dbb23a 100644 --- a/scribble-lib/scribble/private/manual-history.rkt +++ b/scribble-lib/scribble/private/manual-history.rkt @@ -49,8 +49,7 @@ (define vers (history-entry-vers e)) (list (if (zero? i) null - (list null ; needed to avoid " " dropped as whitespace - " ")) + (list (linebreak))) (history-entry-what e) " in version " vers From c4b4e4c92951cc5f827c718467dbe119839004dc Mon Sep 17 00:00:00 2001 From: Ben Greenman Date: Sat, 17 Jun 2017 17:52:14 -0400 Subject: [PATCH 11/13] 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. --- scribble-doc/scribblings/scribble/acmart.scrbl | 13 ++++++++++++- scribble-lib/scribble/acmart.rkt | 5 +++++ scribble-lib/scribble/acmart/lang.rkt | 2 +- 3 files changed, 18 insertions(+), 2 deletions(-) diff --git a/scribble-doc/scribblings/scribble/acmart.scrbl b/scribble-doc/scribblings/scribble/acmart.scrbl index 25b9329b..ac0d45d9 100644 --- a/scribble-doc/scribblings/scribble/acmart.scrbl +++ b/scribble-doc/scribblings/scribble/acmart.scrbl @@ -13,6 +13,17 @@ LaTeX style defaults to use the @hyperlink[acmart-url]{@tt{acmart}} class for typesetting publications for the Association of Computing Machinery.} +@bold{Note:} a @racketmodname[scribble/acmart] document must include a +@racket[title] and @racket[author]. + +Example: + +@verbatim[#:indent 2]|{ + #lang scribble/acmart + @title{Surreal Numbers} + @author{Ursula N. Owens} +}| + @deftogether[( @defidform[manuscript] @defidform[acmsmall] @@ -277,4 +288,4 @@ sponsors, @racket[name] is the name of the sponsor. The grant No.: @grantnum["NSF7000"]{867-5309}.} }|} -@history[#:added "1.20"] \ No newline at end of file +@history[#:added "1.20"] diff --git a/scribble-lib/scribble/acmart.rkt b/scribble-lib/scribble/acmart.rkt index 252dfeee..f66f812b 100644 --- a/scribble-lib/scribble/acmart.rkt +++ b/scribble-lib/scribble/acmart.rkt @@ -80,6 +80,8 @@ [CCSXML (->* () () #:rest (listof pre-content?) any/c)]) +(provide + invisible-element-to-collect-for-acmart-extras) (define-syntax-rule (defopts name ...) (begin (define-syntax (name stx) @@ -136,6 +138,9 @@ (make-css-addition (abs "acmart.css")) (make-tex-addition (abs "acmart.tex"))))) +(define invisible-element-to-collect-for-acmart-extras + (make-element (make-style "invisible-element-to-collect-for-acmart-extras" acmart-extras) '())) + ;; ---------------------------------------- ;; Abstracts: diff --git a/scribble-lib/scribble/acmart/lang.rkt b/scribble-lib/scribble/acmart/lang.rkt index db84aff0..e2a2a5da 100644 --- a/scribble-lib/scribble/acmart/lang.rkt +++ b/scribble-lib/scribble/acmart/lang.rkt @@ -145,5 +145,5 @@ ;; Ensure that "acmart.tex" is used, since "style.tex" ;; re-defines commands. (struct-copy part doc [to-collect - (cons (terms) ; FIXME + (cons invisible-element-to-collect-for-acmart-extras (part-to-collect doc))])) From 5525db3c5e407c51bc6f0b031d90d64fb2dee311 Mon Sep 17 00:00:00 2001 From: Leif Andersen Date: Tue, 27 Jun 2017 10:49:37 -0400 Subject: [PATCH 12/13] Update the acmart.cls --- scribble-lib/scribble/acmart/acmart.cls | 586 +++++++++++++++++------- 1 file changed, 410 insertions(+), 176 deletions(-) diff --git a/scribble-lib/scribble/acmart/acmart.cls b/scribble-lib/scribble/acmart/acmart.cls index b97409fa..f6c56ed7 100644 --- a/scribble-lib/scribble/acmart/acmart.cls +++ b/scribble-lib/scribble/acmart/acmart.cls @@ -35,13 +35,17 @@ %% Right bracket \] Circumflex \^ Underscore \_ %% Grave accent \` Left brace \{ Vertical bar \| %% Right brace \} Tilde \~} - \NeedsTeXFormat{LaTeX2e} \ProvidesClass{acmart} -[2016/12/03 v1.25 Typesetting articles for Association of +[2017/05/14 v1.39 Typesetting articles for Association of Computing Machinery] \def\@classname{acmart} +\InputIfFileExists{acmart-preload-hook.tex}{% + \ClassWarning{\@classname}{% + I am loading acmart-preload-hook.tex. You are fully responsible + for any problems from now on.}}{} \RequirePackage{xkeyval} +\RequirePackage{xstring} \define@choicekey*+{acmart.cls}{format}[\ACM@format\ACM@format@nr]{% manuscript, acmsmall, acmlarge, acmtog, sigconf, siggraph, sigplan, sigchi, sigchi-a}[manuscript]{}{% @@ -83,16 +87,14 @@ Computing Machinery] \fi}{\PackageError{\@classname}{Option authorversion can be either true or false}} \ExecuteOptionsX{authorversion=false} -\newif\if@ACM@natbib@override -\@ACM@natbib@overridefalse \define@boolkey+{acmart.cls}[@ACM@]{natbib}[true]{% - \@ACM@natbib@overridetrue \if@ACM@natbib \PackageInfo{\@classname}{Explicitly selecting natbib mode}% \else \PackageInfo{\@classname}{Explicitly deselecting natbib mode}% \fi}{\PackageError{\@classname}{Option natbib can be either true or false}} +\ExecuteOptionsX{natbib=true} \define@boolkey+{acmart.cls}[@ACM@]{anonymous}[true]{% \if@ACM@anonymous \PackageInfo{\@classname}{Using anonymous mode}% @@ -101,6 +103,24 @@ Computing Machinery] \fi}{\PackageError{\@classname}{Option anonymous can be either true or false}} \ExecuteOptionsX{anonymous=false} +\define@boolkey+{acmart.cls}[@ACM@]{timestamp}[true]{% + \if@ACM@timestamp + \PackageInfo{\@classname}{Using timestamp mode}% + \else + \PackageInfo{\@classname}{Not using timestamp mode}% + \fi}{\PackageError{\@classname}{Option timestamp can be either true or + false}} +\ExecuteOptionsX{timestamp=false} +\define@boolkey+{acmart.cls}[@ACM@]{authordraft}[true]{% + \if@ACM@authordraft + \PackageInfo{\@classname}{Using authordraft mode}% + \@ACM@timestamptrue + \@ACM@reviewtrue + \else + \PackageInfo{\@classname}{Not using authordraft mode}% + \fi}{\PackageError{\@classname}{Option authordraft can be either true or + false}} +\ExecuteOptionsX{authordraft=false} \def\ACM@fontsize{} \DeclareOptionX{9pt}{\edef\ACM@fontsize{\CurrentOption}} \DeclareOptionX{10pt}{\edef\ACM@fontsize{\CurrentOption}} @@ -113,6 +133,11 @@ Computing Machinery] \newif\if@ACM@manuscript \newif\if@ACM@journal \newif\if@ACM@sigchiamode +\ifnum\ACM@format@nr=5\relax % siggraph + \ClassWarning{\@classname}{The format `siggraph' is now obsolete. + I am switching to sigconf.} + \setkeys{acmart.cls}{format=sigconf} +\fi \ifnum\ACM@format@nr=0\relax \@ACM@manuscripttrue \else @@ -140,9 +165,6 @@ Computing Machinery] \@ACM@journalfalse \@ACM@sigchiamodetrue \fi -\if@ACM@natbib@override\else - \@ACM@natbibtrue -\fi \ifx\ACM@fontsize\@empty \ifcase\ACM@format@nr \relax % manuscript @@ -158,7 +180,7 @@ Computing Machinery] \or % siggraph \def\ACM@fontsize{9pt}% \or % sigplan - \def\ACM@fontsize{9pt}% + \def\ACM@fontsize{10pt}% \or % sigchi \def\ACM@fontsize{10pt}% \or % sigchi-a @@ -257,7 +279,7 @@ Computing Machinery] \newcommand{\bibstyle@acmauthoryear}{% \setcitestyle{% authoryear,% - open={(},close={)},citesep={;},% + open={[},close={]},citesep={;},% aysep={},yysep={,},% notesep={, }}} \newcommand{\bibstyle@acmnumeric}{% @@ -265,7 +287,9 @@ Computing Machinery] numbers,sort&compress,% open={[},close={]},citesep={,},% notesep={, }}} +\if@ACM@natbib \citestyle{acmnumeric} +\fi \def\@startsection#1#2#3#4#5#6{% \if@noskipsec \leavevmode \fi \par @@ -283,6 +307,7 @@ Computing Machinery] {\@ssect{#3}{#4}{#5}{#6}}% {\@dblarg{\@sect{#1}{#2}{#3}{#4}{#5}{#6}}}} \def\@sect#1#2#3#4#5#6[#7]#8{% + \edef\@toclevel{\ifnum#2=\@m 0\else\number#2\fi}% \ifnum #2>\c@secnumdepth \let\@svsec\@empty \else @@ -297,6 +322,9 @@ Computing Machinery] \interlinepenalty \@M #8\@@par}% \endgroup \csname #1mark\endcsname{#7}% + \ifnum #2>\c@secnumdepth \else + \@tochangmeasure{\csname the#1\endcsname}% + \fi \addcontentsline{toc}{#1}{% \ifnum #2>\c@secnumdepth \else \protect\numberline{\csname the#1\endcsname}% @@ -307,6 +335,9 @@ Computing Machinery] #6{\hskip #3\relax \@svsec #8}% \csname #1mark\endcsname{#7}% + \ifnum #2>\c@secnumdepth \else + \@tochangmeasure{\csname the#1\endcsname\space}% + \fi \addcontentsline{toc}{#1}{% \ifnum #2>\c@secnumdepth \else \protect\numberline{\csname the#1\endcsname}% @@ -351,9 +382,30 @@ Computing Machinery] \def\@svsechd{#4{\hskip #1\relax #5}}% \fi \@xsect{#3}} +\def\@starttoc#1#2{\begingroup + \setTrue{#1}% + \par\removelastskip\vskip\z@skip + \@startsection{section}\@M\z@{\linespacing\@plus\linespacing}% + {.5\linespacing}{\centering\contentsnamefont}{#2}% + \@input{\jobname.#1}% + \if@filesw + \@xp\newwrite\csname tf@#1\endcsname + \immediate\@xp\openout\csname tf@#1\endcsname \jobname.#1\relax + \fi + \global\@nobreakfalse \endgroup + \addvspace{32\p@\@plus14\p@}% +} +\def\l@subsection{\@tocline{2}{0pt}{1pc}{3pc}{}} +\def\l@subsubsection{\@tocline{2}{0pt}{1pc}{5pc}{}} \let\@footnotemark@nolink\@footnotemark \let\@footnotetext@nolink\@footnotetext -\RequirePackage[bookmarksnumbered]{hyperref} +\RequirePackage[bookmarksnumbered,unicode]{hyperref} +\pdfstringdefDisableCommands{% + \def\unskip{}% + \def\textbullet{- }% + \def\textrightarrow{ -> }% + \def\footnotemark{}% +} \urlstyle{rm} \ifcase\ACM@format@nr \relax % manuscript @@ -385,14 +437,17 @@ Computing Machinery] \let\citeyearNP\citeyear \let\citeyear\citeyearpar \let\citeNP\citealt - \def\shortcite#1{\citeyear{#1}} \DeclareRobustCommand\citeA {\begingroup\NAT@swafalse \let\NAT@ctype\@ne\NAT@partrue\NAT@fullfalse\NAT@open\NAT@citetp}% \providecommand\newblock{}% \else - \providecommand\citename[1]{#1} + \AtBeginDocument{% + \let\shortcite\cite% + \providecommand\citename[1]{#1}} \fi +\newcommand\shortcite[2][]{% + \ifNAT@numbers\cite[#1]{#2}\else\citeyear[#1]{#2}\fi} \def\bibliographystyle#1{% \ifx\@begindocumenthook\@undefined\else \expandafter\AtBeginDocument @@ -409,54 +464,70 @@ Computing Machinery] \definecolor[named]{ACMGreen}{cmyk}{0.20,0,1,0.19} \definecolor[named]{ACMPurple}{cmyk}{0.55,1,0,0.15} \definecolor[named]{ACMDarkBlue}{cmyk}{1,0.58,0,0.21} +\if@ACM@authordraft + \RequirePackage{draftwatermark} + \SetWatermarkFontSize{0.5in} + \SetWatermarkColor[gray]{.9} + \SetWatermarkText{\parbox{12em}{\centering + Unpublished working draft\\ + Not for distribution}} +\fi \RequirePackage{geometry} \ifcase\ACM@format@nr \relax % manuscript - \geometry{letterpaper,head=1pc}% + \geometry{letterpaper,head=13pt, + marginparwidth=6pc}% \or % acmsmall \geometry{twoside=true, - includeheadfoot, head=1pc, foot=2pc, + includeheadfoot, head=13pt, foot=2pc, paperwidth=6.75in, paperheight=10in, - top=58pt, bottom=44pt, inner=46pt, outer=46pt + top=58pt, bottom=44pt, inner=46pt, outer=46pt, + marginparwidth=2pc }% \or % acmlarge - \geometry{twoside=true, head=1pc, foot=2pc, + \geometry{twoside=true, head=13pt, foot=2pc, paperwidth=8.5in, paperheight=11in, includeheadfoot, - top=78pt, bottom=114pt, inner=81pt, outer=81pt + top=78pt, bottom=114pt, inner=81pt, outer=81pt, + marginparwidth=4pc }% \or % acmtog - \geometry{twoside=true, head=1pc, foot=2pc, + \geometry{twoside=true, head=13pt, foot=2pc, paperwidth=8.5in, paperheight=11in, includeheadfoot, columnsep=24pt, - top=52pt, bottom=75pt, inner=52pt, outer=52pt + top=52pt, bottom=75pt, inner=52pt, outer=52pt, + marginparwidth=2pc }% \or % sigconf - \geometry{twoside=true, head=1pc, + \geometry{twoside=true, head=13pt, paperwidth=8.5in, paperheight=11in, includeheadfoot, columnsep=2pc, - top=57pt, bottom=73pt, inner=54pt, outer=54pt + top=57pt, bottom=73pt, inner=54pt, outer=54pt, + marginparwidth=2pc }% \or % siggraph - \geometry{twoside=true, head=1pc, + \geometry{twoside=true, head=13pt, paperwidth=8.5in, paperheight=11in, includeheadfoot, columnsep=2pc, - top=57pt, bottom=73pt, inner=54pt, outer=54pt + top=57pt, bottom=73pt, inner=54pt, outer=54pt, + marginparwidth=2pc }% \or % sigplan - \geometry{twoside=true, head=1pc, + \geometry{twoside=true, head=13pt, paperwidth=8.5in, paperheight=11in, includeheadfoot=false, columnsep=2pc, - top=1in, bottom=1in, inner=0.75in, outer=0.75in + top=1in, bottom=1in, inner=0.75in, outer=0.75in, + marginparwidth=2pc }% \or % sigchi - \geometry{twoside=true, head=1pc, + \geometry{twoside=true, head=13pt, paperwidth=8.5in, paperheight=11in, includeheadfoot, columnsep=2pc, - top=66pt, bottom=73pt, inner=54pt, outer=54pt + top=66pt, bottom=73pt, inner=54pt, outer=54pt, + marginparwidth=2pc }% \or % sigchi-a - \geometry{twoside=false, head=1pc, + \geometry{twoside=false, head=13pt, paperwidth=11in, paperheight=8.5in, includeheadfoot, marginparsep=72pt, marginparwidth=170pt, columnsep=20pt, @@ -479,6 +550,7 @@ Computing Machinery] \or % sigchi \or % sigchi-a \fi +\setlength\normalparindent{\parindent} \def\copyrightpermissionfootnoterule{\kern-3\p@ \hrule \@width \columnwidth \kern 2.6\p@} \RequirePackage{manyfoot} @@ -524,6 +596,14 @@ Computing Machinery] \rule\z@\footnotesep\ignorespaces#1\@finalstrut\strutbox}% \color@endgroup}} \def\@makefnmark{\hbox{\@textsuperscript{\normalfont\@thefnmark}}} +\def\@textbottom{\vskip \z@ \@plus 1pt} +\let\@texttop\relax +\RequirePackage{iftex} +\ifPDFTeX +\input{glyphtounicode} +\pdfgentounicode=1 +\fi +\RequirePackage{cmap} \newif\if@ACM@newfonts \@ACM@newfontstrue \IfFileExists{libertine.sty}{}{\ClassWarning{\@classname}{You do not @@ -535,11 +615,10 @@ Computing Machinery] have newtxmath package installed. Please upgrade your TeX}\@ACM@newfontsfalse} \if@ACM@newfonts -\RequirePackage[tt=false]{libertine} +\RequirePackage[tt=false, type1=true]{libertine} \RequirePackage[varqu]{zi4} \RequirePackage[libertine]{newtxmath} -\else -\RequirePackage{textcomp} +\RequirePackage[T1]{fontenc} \fi \if@ACM@sigchiamode \renewcommand{\familydefault}{\sfdefault} @@ -620,10 +699,50 @@ Computing Machinery] \or % sigchi \or % sigchi-a \fi -\renewcommand{\descriptionlabel}[1]{\hspace\labelsep \upshape\bfseries #1} +\newdimen\@ACM@labelwidth +\AtBeginDocument{% + \setlength\labelsep{4pt} + \setlength{\@ACM@labelwidth}{6.5pt} + + %% First-level list: when beginning after the first line of an + %% indented paragraph or ending before an indented paragraph, labels + %% should not hang to the left of the preceding/following text. + \setlength\leftmargini{\z@} + \addtolength\leftmargini{\parindent} + \addtolength\leftmargini{2\labelsep} + \addtolength\leftmargini{\@ACM@labelwidth} + + %% Second-level and higher lists. + \setlength\leftmarginii{\z@} + \addtolength\leftmarginii{0.5\labelsep} + \addtolength\leftmarginii{\@ACM@labelwidth} + \setlength\leftmarginiii{\leftmarginii} + \setlength\leftmarginiv{\leftmarginiii} + \setlength\leftmarginv{\leftmarginiv} + \setlength\leftmarginvi{\leftmarginv} + \@listi} +\newskip\listisep +\listisep\smallskipamount +\def\@listI{\leftmargin\leftmargini + \labelwidth\leftmargini \advance\labelwidth-\labelsep + \listparindent\z@ + \topsep\listisep} +\let\@listi\@listI +\def\@listii{\leftmargin\leftmarginii + \labelwidth\leftmarginii \advance\labelwidth-\labelsep + \topsep\z@skip} +\def\@listiii{\leftmargin\leftmarginiii + \labelwidth\leftmarginiii \advance\labelwidth-\labelsep} +\def\@listiv{\leftmargin\leftmarginiv + \labelwidth\leftmarginiv \advance\labelwidth-\labelsep} +\def\@listv{\leftmargin\leftmarginv + \labelwidth\leftmarginv \advance\labelwidth-\labelsep} +\def\@listvi{\leftmargin\leftmarginvi + \labelwidth\leftmarginvi \advance\labelwidth-\labelsep} +\renewcommand{\descriptionlabel}[1]{\upshape\bfseries #1} \renewenvironment{description}{\list{}{% - \itemindent-12\p@ - \labelwidth\z@ \let\makelabel\descriptionlabel}% + \labelwidth\@ACM@labelwidth + \let\makelabel\descriptionlabel}% }{ \endlist } @@ -638,7 +757,9 @@ Computing Machinery] JERIC,% JETC,% JOCCH,% + PACMHCI,% PACMPL,% + POMACS,% TAAS,% TACCESS,% TACO,% @@ -689,9 +810,9 @@ Computing Machinery] \def\@journalNameShort{ACM Comput. Surv.}% \def\@permissionCodeOne{0360-0300}% \or % IMWUT - \def\@journalName{PACM on Interactive, Mobile, Wearable and - Ubiquitous Technologies}% - \def\@journalNameShort{PACM Interact. Mob. Wearable Ubiquitous Technol.}% + \def\@journalName{Proceedings of the ACM on Interactive, Mobile, + Wearable and Ubiquitous Technologies}% + \def\@journalNameShort{Proc. ACM Interact. Mob. Wearable Ubiquitous Technol.}% \def\@permissionCodeOne{2474-9567}% \or % JACM \def\@journalName{Journal of the ACM}% @@ -716,10 +837,18 @@ Computing Machinery] \or % JOCCH \def\@journalName{ACM Journal on Computing and Cultural Heritage}% \def\@journalName{ACM J. Comput. Cult. Herit.}% +\or % PACMHCI + \def\@journalName{Proceedings of the ACM on Human-Computer Interaction}% + \def\@journalName{Proc. ACM Hum.-Comput. Interact.}% + \def\@permissionCodeOne{2573-0142}% \or % PACMPL - \def\@journalName{PACM on Programming Languages}% - \def\@journalName{PACM Progr. Lang.}% + \def\@journalName{Proceedings of the ACM on Programming Languages}% + \def\@journalName{Proc. ACM Program. Lang.}% \def\@permissionCodeOne{2475-1421}% +\or % POMACS + \def\@journalName{Proceedings of the ACM on Measurement and Analysis of Computing Systems}% + \def\@journalName{Proc. ACM Meas. Anal. Comput. Syst.}% + \def\@permissionCodeOne{2476-1249}% \or % TAAS \def\@journalName{ACM Transactions on Autonomous and Adaptive Systems}% \def\@journalNameShort{ACM Trans. Autonom. Adapt. Syst.}% @@ -940,6 +1069,20 @@ Computing Machinery] \if@ACM@anonymous\else \g@addto@macro\addresses{\affiliation{#1}{#2}}% \fi} +\define@boolkey+{@ACM@affiliation@}[@ACM@affiliation@]{obeypunctuation}% +[true]{}{\ClassError{\@classname}{obeypunctuation must be true or false}} +\def\additionalaffiliation#1{\authornote{\@additionalaffiliation{#1}}} +\def\@additionalaffiliation#1{\bgroup + \def\position##1{\ignorespaces}% + \def\institution##1{##1\ignorespaces}% + \def\department{\@ifnextchar[{\@department}{\@department[]}}% + \def\@department[##1]##2{\unskip, ##2\ignorespaces}% + \let\streetaddress\position + \let\city\position + \let\state\position + \let\postcode\position + \let\country\position + Also with #1\unskip.\egroup} \renewcommand{\email}[2][]{% \if@ACM@anonymous\else \g@addto@macro\addresses{\email{#1}{#2}}% @@ -967,10 +1110,16 @@ Computing Machinery] \def\@authornotes{} \def\authornote#1{% \if@ACM@anonymous\else - \g@addto@macro\addresses{\@authornotemark} + \g@addto@macro\addresses{\@authornotemark}% \g@addto@macro\@authornotes{% \stepcounter{footnote}\footnotetext{#1}}% \fi} +\newcommand\authornotemark[1][\relax]{% + \ifx#1\relax\relax\relax + \g@addto@macro\addresses{\@authornotemark}% + \else + \g@addto@macro\addresses{\@@authornotemark{#1}}% + \fi} \def\acmVolume#1{\def\@acmVolume{#1}} \acmVolume{1} \def\acmNumber#1{\def\@acmNumber{#1}} @@ -980,15 +1129,17 @@ Computing Machinery] \def\acmArticleSeq#1{\def\@acmArticleSeq{#1}} \acmArticleSeq{\@acmArticle} \def\acmYear#1{\def\@acmYear{#1}} -\acmYear{2016} +\acmYear{\the\year} \def\acmMonth#1{\def\@acmMonth{#1}} -\acmMonth{1} +\acmMonth{\the\month} \def\@acmPubDate{\ifcase\@acmMonth\or January\or February\or March\or April\or May\or June\or July\or August\or September\or October\or November\or December\fi~\@acmYear} \def\acmPrice#1{\def\@acmPrice{#1}} \acmPrice{15.00} +\def\acmSubmissionID#1{\def\@acmSubmissionID{#1}} +\acmSubmissionID{} \def\acmISBN#1{\def\@acmISBN{#1}} \acmISBN{978-x-xxxx-xxxx-x/YY/MM} \def\acmDOI#1{\def\@acmDOI{#1}} @@ -1012,20 +1163,20 @@ Computing Machinery] \def\@acmBadgeL@image{} \def\startPage#1{\def\@startPage{#1}} \startPage{} -\def\terms#1{\def\@terms{#1}} -\terms{} +\def\terms#1{\ClassWarning{\@classname}{The command \string\terms{} is + obsolete. I am going to ignore it}} \def\keywords#1{\def\@keywords{#1}} \keywords{} \renewenvironment{abstract}{\Collect@Body\@saveabstract}{} \long\def\@saveabstract#1{\long\gdef\@abstract{#1}} \@saveabstract{} \long\def\@lempty{} -\define@boolkey+{@ACM@topmatter@}[@ACM@]{printcss}[true]{% - \if@ACM@printcss - \ClassInfo{\@classname}{Printing CSS}% +\define@boolkey+{@ACM@topmatter@}[@ACM@]{printccs}[true]{% + \if@ACM@printccs + \ClassInfo{\@classname}{Printing CCS}% \else - \ClassInfo{\@classname}{Suppressing CSS}% - \fi}{\ClassError{\@classname}{printcss must be true or false}} + \ClassInfo{\@classname}{Suppressing CCS}% + \fi}{\ClassError{\@classname}{printccs must be true or false}} \define@boolkey+{@ACM@topmatter@}[@ACM@]{printacmref}[true]{% \if@ACM@printacmref \ClassInfo{\@classname}{Printing bibformat}% @@ -1038,8 +1189,12 @@ Computing Machinery] \else \ClassInfo{\@classname}{Suppressing folios}% \fi}{\ClassError{\@classname}{printfolios must be true or false}} +\define@cmdkey{@ACM@topmatter@}[@ACM@]{authorsperrow}[0]{% + \IfInteger{#1}{\ClassInfo{\@classname}{Setting authorsperrow to + #1}}{\ClassWarning{\@classname}{Parameter authorsperrow must be + numerical. Ignoring the input #1}\gdef\@ACM@authorsperrow{0}}} \def\settopmatter#1{\setkeys{@ACM@topmatter@}{#1}} -\settopmatter{printcss=true, printacmref=true} +\settopmatter{printccs=true, printacmref=true} \if@ACM@manuscript \settopmatter{printfolios=true} \else @@ -1049,6 +1204,7 @@ Computing Machinery] \settopmatter{printfolios=false} \fi \fi +\settopmatter{authorsperrow=0} \def\@received{} \newcommand\received[2][]{\def\@tempa{#1}% \ifx\@tempa\@empty @@ -1073,13 +1229,14 @@ Computing Machinery] \let\@concepts\@empty \newcommand\ccsdesc[2][100]{% \ccsdesc@parse#1~#2~} +\RequirePackage{textcomp} \def\ccsdesc@parse#1~#2~#3~{% \expandafter\ifx\csname CCS@#2\endcsname\relax - \expandafter\gdef\csname CCS@#2\endcsname{\textbullet\textbf{#2} $\to$ }% + \expandafter\gdef\csname CCS@#2\endcsname{\textbullet\ \textbf{#2} \textrightarrow\ }% \g@addto@macro{\@concepts}{\csname CCS@#2\endcsname}\fi \expandafter\g@addto@macro\expandafter{\csname CCS@#2\endcsname}{% - \ifnum#1>499\textbf{#3; }\else - \ifnum#1>299\textit{#3; }\else + \ifnum#1>499\textbf{#3}; \else + \ifnum#1>299\textit{#3}; \else #3; \fi\fi}} \newif\if@printcopyright \@printcopyrighttrue @@ -1104,11 +1261,13 @@ Computing Machinery] \fi \ifnum\acm@copyrightmode=3\relax % rightsretained \@acmownedfalse + \acmPrice{}% \fi \ifnum\acm@copyrightmode=4\relax % usgov \@printpermissiontrue \@printcopyrightfalse \@acmownedfalse + \acmPrice{}% \fi \ifnum\acm@copyrightmode=6\relax % cagov \@acmownedfalse @@ -1130,32 +1289,32 @@ Computing Machinery] \def\@copyrightowner{% \ifcase\acm@copyrightmode\relax % none \or % acmcopyright - ACM\@. + Association for Computing Machinery. \or % acmlicensed Copyright held by the owner/author(s). Publication rights licensed to - ACM\@. + Association for Computing Machinery. \or % rightsretained Copyright held by the owner/author(s). \or % usgov \or % usgovmixed - ACM\@. + Association for Computing Machinery. \or % cagov Crown in Right of Canada. \or %cagovmixed - ACM\@. + Association for Computing Machinery. \or %licensedusgovmixed Copyright held by the owner/author(s). Publication rights licensed to - ACM\@. + Association for Computing Machinery. \or %licensedcagovmixed Copyright held by the owner/author(s). Publication rights licensed to - ACM\@. + Association for Computing Machinery. \or % othergov - ACM\@. + Association for Computing Machinery. \or % licensedothergov Copyright held by the owner/author(s). Publication rights licensed to - ACM\@. + Association for Computing Machinery. \fi} -\def\@formatdoi#1{\url{http://dx.doi.org/#1}} +\def\@formatdoi#1{\url{https://doi.org/#1}} \def\@copyrightpermission{% \ifcase\acm@copyrightmode\relax % none \or % acmcopyright @@ -1282,8 +1441,9 @@ Computing Machinery] \let\@footnotemark\@footnotemark@nolink \let\@footnotetext\@footnotetext@nolink \renewcommand\thefootnote{\@fnsymbol\c@footnote}% - \@topnum\z@ % this prevents figures from falling at the top of page - % 1 + \global\@topnum\z@ % this prevents floats from falling + % at the top of page 1 + \global\@botnum\z@ % we do not want them to be on bottom either \hsize=\textwidth \def\@makefnmark{\hbox{\@textsuperscript{\@thefnmark}}}% \@mktitle\if@ACM@sigchiamode\else\@mkauthors\fi\@mkteasers @@ -1300,62 +1460,65 @@ Computing Machinery] \footnotetextcopyrightpermission{% \def\par{\let\par\@par}\parindent\z@\@setthanks}% \fi - \footnotetextcopyrightpermission{\parindent\z@\parskip0.1\baselineskip - \if@ACM@authorversion\else - \if@printpermission\@copyrightpermission\par\fi - \fi - \if@ACM@manuscript\else - \if@ACM@journal\else % Print the conference short name - {\itshape \acmConference@shortname, \acmConference@venue}\par + \footnotetextcopyrightpermission{% + \if@ACM@authordraft + \raisebox{-2ex}[\z@][\z@]{\makebox[0pt][l]{\large\bfseries + Unpublished + working draft. Not for distribution}}% + \color[gray]{0.9}% \fi - \fi - \if@printcopyright - \copyright\ \@copyrightyear\ \@copyrightowner\ - \else - \@copyrightyear.\ - \fi - \if@ACM@manuscript - Manuscript submitted to ACM\\ - \else - \if@ACM@authorversion - This is the author's version of the work. It is posted here for - your personal use. Not for redistribution. The definitive Version - of Record was published in - \if@ACM@journal - \emph{\@journalName}% + \parindent\z@\parskip0.1\baselineskip + \if@ACM@authorversion\else + \if@printpermission\@copyrightpermission\par\fi + \fi + \if@ACM@manuscript\else + \if@ACM@journal\else % Print the conference information + {\itshape \acmConference@shortname, \acmConference@date, \acmConference@venue}\par + \fi + \fi + \if@printcopyright + \copyright\ \@copyrightyear\ \@copyrightowner\\ + \else + \@copyrightyear.\ + \fi + \if@ACM@manuscript + Manuscript submitted to ACM\\ + \else + \if@ACM@authorversion + This is the author's version of the work. It is posted here for + your personal use. Not for redistribution. The definitive Version + of Record was published in + \if@ACM@journal + \emph{\@journalName}% + \else + \emph{Proceedings of \acmConference@name, \acmConference@date}% + \fi + \ifx\@acmDOI\@empty + . + \else + , \@formatdoi{\@acmDOI}. + \fi\\ \else - \emph{Proceedings of \acmConference@name, \acmConference@date}% + \if@ACM@journal + \@permissionCodeOne/\@acmYear/\@acmMonth-ART\@acmArticle + \ifx\@acmPrice\@empty\else\ \$\@acmPrice\fi\\ + \@formatdoi{\@acmDOI}% + \else % Conference + ACM~ISBN~\@acmISBN + \ifx\@acmPrice\@empty.\else\dots\$\@acmPrice\fi\\ + \@formatdoi{\@acmDOI}% + \fi \fi - \ifx\@acmDOI\@empty - . - \else - , \@formatdoi{\@acmDOI}. - \fi\\ - \else - \if@ACM@journal - \@permissionCodeOne/\@acmYear/\@acmMonth-ART\@acmArticle\ - \$\@acmPrice\\ - DOI: \nolinkurl{\@acmDOI}% - \else % Conference - \@acmISBN - \ifx\@acmPrice\@empty.\else\dots\$\@acmPrice\fi\\ - DOI: \nolinkurl{\@acmDOI}% - \fi - \fi - \fi}% + \fi} \endgroup \setcounter{footnote}{0}% \@mkabstract - \if@ACM@printcss + \if@ACM@printccs \ifx\@concepts\@empty\else\bgroup {\@specialsection{CCS Concepts}% \@concepts\par}\egroup \fi \fi - \if\@terms\@empty\else\bgroup - {\@specialsection{General Terms}% - \@terms\par}\egroup - \fi \ifx\@keywords\@empty\else\bgroup {\if@ACM@journal \@specialsection{Additional Key Words and Phrases}% @@ -1485,7 +1648,7 @@ Computing Machinery] \or % sigchi-a \Huge\bfseries \fi} -\def\@subtitlefont{% +\def\@subtitlefont{\normalsize \ifcase\ACM@format@nr \relax % manuscript \mdseries @@ -1573,27 +1736,29 @@ Computing Machinery] \newbox\@ACM@commabox \def\@ACM@addtoaddress#1{% \ifvmode\else + \if@ACM@affiliation@obeypunctuation\else \setbox\@ACM@commabox=\hbox{, }% \unskip\cleaders\copy\@ACM@commabox\hskip\wd\@ACM@commabox - \fi + \fi\fi #1} \if@ACM@journal \let\position\@gobble \def\institution#1{#1\ignorespaces}% - \let\department\@gobble + \newcommand\department[2][0]{}% \let\streetaddress\@gobble \let\city\@gobble \let\state\@gobble \let\postcode\@gobble \let\country\@gobble \else - \def\position#1{#1\par}% - \def\institution#1{#1\par}% - \def\department#1{#1\par}% - \def\streetaddress#1{#1\par}% + \def\position#1{\if@ACM@affiliation@obeypunctuation#1\else#1\par\fi}% + \def\institution#1{\if@ACM@affiliation@obeypunctuation#1\else#1\par\fi}% + \newcommand\department[2][0]{\if@ACM@affiliation@obeypunctuation + #2\else#2\par\fi}% + \def\streetaddress#1{\if@ACM@affiliation@obeypunctuation#1\else#1\par\fi}% \let\city\@ACM@addtoaddress \let\state\@ACM@addtoaddress - \def\postcode#1{\unskip\space#1}% + \def\postcode#1{\if@ACM@affiliation@obeypunctuation#1\else\unskip\space#1\fi}% \let\country\@ACM@addtoaddress \fi \def\@mkauthors{\begingroup @@ -1670,12 +1835,17 @@ Computing Machinery] \def\affiliation##1##2{% \def\@tempa{##2}\ifx\@tempa\@empty\else \ifx\@currentaffiliations\@empty - \gdef\@currentaffiliations{\@affiliationfont##2}% + \gdef\@currentaffiliations{% + \setkeys{@ACM@affiliation@}{obeypunctuation=false}% + \setkeys{@ACM@affiliation@}{##1}% + \@affiliationfont##2}% \else - \g@addto@macro{\@currentaffiliations}{\and##2}% + \g@addto@macro{\@currentaffiliations}{\and + \setkeys{@ACM@affiliation@}{obeypunctuation=false}% + \setkeys{@ACM@affiliation@}{##1}##2}% \fi \fi - \global\let\and\@typeset@author@line} + \global\let\and\@typeset@author@line}% \global\setbox\mktitle@bx=\vbox{\noindent\box\mktitle@bx\par\medskip \noindent\addresses\@typeset@author@line \par\medskip}% @@ -1694,17 +1864,21 @@ Computing Machinery] \def\@mkauthors@iii{% \author@bx@wd=\textwidth\relax \advance\author@bx@wd by -\author@bx@sep\relax - \ifcase\num@authorgroups - \relax % 0? - \or % 1=one author per row - \or % 2=two authors per row - \divide\author@bx@wd by \num@authorgroups\relax - \or % 3=three authors per row - \divide\author@bx@wd by \num@authorgroups\relax - \or % 4=two authors per row (!) - \divide\author@bx@wd by 2\relax - \else % three authors per row - \divide\author@bx@wd by 3\relax + \ifnum\@ACM@authorsperrow>0\relax + \divide\author@bx@wd by \@ACM@authorsperrow\relax + \else + \ifcase\num@authorgroups + \relax % 0? + \or % 1=one author per row + \or % 2=two authors per row + \divide\author@bx@wd by \num@authorgroups\relax + \or % 3=three authors per row + \divide\author@bx@wd by \num@authorgroups\relax + \or % 4=two authors per row (!) + \divide\author@bx@wd by 2\relax + \else % three authors per row + \divide\author@bx@wd by 3\relax + \fi \fi \advance\author@bx@wd by -\author@bx@sep\relax \gdef\@currentauthors{}% @@ -1721,9 +1895,13 @@ Computing Machinery] \g@addto@macro\@currentaffiliation{\par\nolinkurl{##2}}% \fi}% \def\affiliation##1##2{\ifx\@currentaffiliation\@empty - \gdef\@currentaffiliation{##2}% + \gdef\@currentaffiliation{% + \setkeys{@ACM@affiliation@}{obeypunctuation=false}% + \setkeys{@ACM@affiliation@}{##1}##2}% \else - \g@addto@macro\@currentaffiliation{\par##2}% + \g@addto@macro\@currentaffiliation{\par + \setkeys{@ACM@affiliation@}{obeypunctuation=false}% + \setkeys{@ACM@affiliation@}{##1}##2}% \fi \global\let\and\@typeset@author@bx }% @@ -1735,11 +1913,15 @@ Computing Machinery] \def\@mkauthors@iv{% \author@bx@wd=\columnwidth\relax \advance\author@bx@wd by -\author@bx@sep\relax - \ifcase\num@authorgroups - \relax % 0? - \or % 1=one author per row - \else % 2=two authors per row - \divide\author@bx@wd by 2\relax + \ifnum\@ACM@authorsperrow>0\relax + \divide\author@bx@wd by \@ACM@authorsperrow\relax + \else + \ifcase\num@authorgroups + \relax % 0? + \or % 1=one author per row + \else % 2=two authors per row + \divide\author@bx@wd by 2\relax + \fi \fi \advance\author@bx@wd by -\author@bx@sep\relax \gdef\@currentauthors{}% @@ -1756,16 +1938,21 @@ Computing Machinery] \g@addto@macro\@currentaffiliation{\par\nolinkurl{##2}}% \fi}% \def\affiliation##1##2{\ifx\@currentaffiliation\@empty - \gdef\@currentaffiliation{##2}% + \gdef\@currentaffiliation{% + \setkeys{@ACM@affiliation@}{obeypunctuation=false}% + \setkeys{@ACM@affiliation@}{##1}##2}% \else - \g@addto@macro\@currentaffiliation{\par##2}% + \g@addto@macro\@currentaffiliation{\par + \setkeys{@ACM@affiliation@}{obeypunctuation=false}% + \setkeys{@ACM@affiliation@}{##1}##2}% \fi \global\let\and\@typeset@author@bx}% \bgroup\hsize=\columnwidth \par\raggedright\leftskip=\z@ \lineskip=1pc\noindent \addresses\let\and\@typeset@author@bx\and\par\bigskip\egroup} -\def\@authornotemark{\g@addto@macro\@currentauthors{\footnotemark}} +\def\@authornotemark{\g@addto@macro\@currentauthors{\footnotemark\relax}} +\def\@@authornotemark#1{\g@addto@macro\@currentauthors{\footnotemark[#1]}} \def\@mkteasers{% \ifx\@teaserfigures\@empty\else \def\@teaser##1{\par\bigskip\bgroup @@ -1776,16 +1963,20 @@ Computing Machinery] \def\@setaddresses{} \def\@mkabstract{\bgroup \ifx\@abstract\@lempty\else - {\if@ACM@journal + {\phantomsection\addcontentsline{toc}{section}{Abstract}% + \if@ACM@journal \small\noindent \else \section*{Abstract}% \fi - \phantomsection\addcontentsline{toc}{section}{Abstract}% \ignorespaces\@abstract\par}% \fi\egroup} \def\@mkbibcitation{\bgroup \def\footnotemark{}% + \def\\{\unskip{} \ignorespaces}% + \def\footnote{\ClassError{\@classname}{Please do note use footnotes + inside \string\title{} or \string\author{} command! Use + \string\titlenote{} or \string\authornote{} instead!}}% \par\medskip\small\noindent{\bfseries ACM Reference format:}\par\nobreak \noindent\authors. \@acmYear. \@title. \if@ACM@journal @@ -1799,7 +1990,7 @@ Computing Machinery] \ (\acmConference@shortname)\fi ,} \ref{TotPages}~pages. \fi\par - \noindent DOI: \nolinkurl{\@acmDOI} + \noindent\@formatdoi{\@acmDOI} \par\egroup} \def\@printendtopmatter{\par\medskip \ifcase\ACM@format@nr @@ -1826,20 +2017,48 @@ Computing Machinery] \RequirePackage{fancyhdr} \if@ACM@review \newsavebox{\ACM@linecount@bx} - \savebox{\ACM@linecount@bx}[4em][t]{\parbox[t]{4em}{% - \newlength\ACM@linecount@bxht\setlength{\ACM@linecount@bxht}{-\baselineskip} - \@tempcnta\@ne\relax - \loop{\color{ACMRed}\scriptsize\the\@tempcnta}\\ - \advance\@tempcnta by \@ne - \addtolength{\ACM@linecount@bxht}{\baselineskip} - \ifdim\ACM@linecount@bxht<\textheight\repeat}} + \newlength\ACM@linecount@bxht + \newcount\ACM@linecount + \ACM@linecount\@ne\relax + \def\ACM@mk@linecount{% + \savebox{\ACM@linecount@bx}[4em][t]{\parbox[t]{4em}{% + \setlength{\ACM@linecount@bxht}{-\baselineskip}% + \loop{\color{ACMRed}\scriptsize\the\ACM@linecount}\\ + \global\advance\ACM@linecount by \@ne + \addtolength{\ACM@linecount@bxht}{\baselineskip}% + \ifdim\ACM@linecount@bxht<\textheight\repeat}}} \fi -\def\ACM@linecount{% +\def\ACM@linecountL{% \if@ACM@review + \ACM@mk@linecount \begin{picture}(0,0)% \put(-26,-22){\usebox{\ACM@linecount@bx}}% \end{picture}% \fi} +\def\ACM@linecountR{% + \if@ACM@review + \ACM@mk@linecount + \begin{picture}(0,0)% + \put(20,-22){\usebox{\ACM@linecount@bx}}% + \end{picture}% + \fi} +\if@ACM@timestamp + % Subtracting 30 from \time gives us the effect of rounding-down despite + % \numexpr rounding to nearest + \newcounter{ACM@time@hours} + \setcounter{ACM@time@hours}{\numexpr (\time - 30) / 60 \relax} + \newcounter{ACM@time@minutes} + \setcounter{ACM@time@minutes}{\numexpr \time - \theACM@time@hours * 60 \relax} + \newcommand\ACM@timestamp{% + \footnotesize% + \the\year-\two@digits{\the\month}-\two@digits{\the\day}{ }% + \two@digits{\theACM@time@hours}:\two@digits{\theACM@time@minutes}{ }% + page~\thepage\ (pp. \@startPage-\pageref*{TotPages})% + \ifx\@acmSubmissionID\@empty\relax\else + ~Submission~ID: \@acmSubmissionID + \fi + } +\fi \def\@shortauthors{\if@ACM@anonymous Anon.\else\shortauthors\fi} \def\@headfootfont{% \ifcase\ACM@format@nr @@ -1868,46 +2087,50 @@ Computing Machinery] \renewcommand{\footrulewidth}{\z@}% \ifcase\ACM@format@nr \relax % manuscript - \fancyhead[LE]{\ACM@linecount\if@ACM@printfolios\thepage\fi}% + \fancyhead[LE]{\ACM@linecountL\if@ACM@printfolios\thepage\fi}% \fancyhead[RO]{\if@ACM@printfolios\thepage\fi}% \fancyhead[RE]{\@shortauthors}% - \fancyhead[LO]{\ACM@linecount\shorttitle}% + \fancyhead[LO]{\ACM@linecountL\shorttitle}% \fancyfoot[RO,LE]{\footnotesize Manuscript submitted to ACM}% \or % acmsmall - \fancyhead[LE]{\ACM@linecount\@headfootfont\@acmArticle\if@ACM@printfolios:\thepage\fi}% + \fancyhead[LE]{\ACM@linecountL\@headfootfont\@acmArticle\if@ACM@printfolios:\thepage\fi}% \fancyhead[RO]{\@headfootfont\@acmArticle\if@ACM@printfolios:\thepage\fi}% \fancyhead[RE]{\@headfootfont\@shortauthors}% - \fancyhead[LO]{\ACM@linecount\@headfootfont\shorttitle}% + \fancyhead[LO]{\ACM@linecountL\@headfootfont\shorttitle}% \fancyfoot[RO,LE]{\footnotesize \@journalName, Vol. \@acmVolume, No. \@acmNumber, Article \@acmArticle. Publication date: \@acmPubDate.}% \or % acmlarge - \fancyhead[LE]{\ACM@linecount\@headfootfont - \@acmArticle:\if@ACM@printfolios\thepage\quad\textbullet\quad\fi\@shortauthors}% - \fancyhead[LO]{\ACM@linecount}% + \fancyhead[LE]{\ACM@linecountL\@headfootfont + \@acmArticle\if@ACM@printfolios:\thepage\fi\quad\textbullet\quad\@shortauthors}% + \fancyhead[LO]{\ACM@linecountL}% \fancyhead[RO]{\@headfootfont \shorttitle\quad\textbullet\quad\@acmArticle\if@ACM@printfolios:\thepage\fi}% \fancyfoot[RO,LE]{\footnotesize \@journalName, Vol. \@acmVolume, No. \@acmNumber, Article \@acmArticle. Publication date: \@acmPubDate.}% \or % acmtog - \fancyhead[LE]{\ACM@linecount\@headfootfont - \@acmArticle:\if@ACM@printfolios\thepage\quad\textbullet\quad\fi\@shortauthors}% - \fancyhead[LO]{\ACM@linecount}% + \fancyhead[LE]{\ACM@linecountL\@headfootfont + \@acmArticle\if@ACM@printfolios:\thepage\fi\quad\textbullet\quad\@shortauthors}% + \fancyhead[LO]{\ACM@linecountL}% + \fancyhead[RE]{\ACM@linecountR}% \fancyhead[RO]{\@headfootfont - \shorttitle\quad\textbullet\quad\@acmArticle\if@ACM@printfolios:\thepage\fi}% + \shorttitle\quad\textbullet\quad\@acmArticle\if@ACM@printfolios:\thepage\fi\ACM@linecountR}% \fancyfoot[RO,LE]{\footnotesize \@journalName, Vol. \@acmVolume, No. \@acmNumber, Article \@acmArticle. Publication date: \@acmPubDate.}% \else % Proceedings \fancyfoot[C]{\if@ACM@printfolios\footnotesize\thepage\fi}% - \fancyhead[LO]{\ACM@linecount\@headfootfont\shorttitle}% - \fancyhead[RE]{\@headfootfont\@shortauthors}% - \fancyhead[LE]{\ACM@linecount\@headfootfont\acmConference@shortname, + \fancyhead[LO]{\ACM@linecountL\@headfootfont\shorttitle}% + \fancyhead[RE]{\@headfootfont\@shortauthors\ACM@linecountR}% + \fancyhead[LE]{\ACM@linecountL\@headfootfont\acmConference@shortname, \acmConference@date, \acmConference@venue}% \fancyhead[RO]{\@headfootfont\acmConference@shortname, - \acmConference@date, \acmConference@venue}% + \acmConference@date, \acmConference@venue\ACM@linecountR}% \fi \if@ACM@sigchiamode \fancyheadoffset[L]{\dimexpr(\marginparsep+\marginparwidth)}% \fi + \if@ACM@timestamp + \fancyfoot[LO,RE]{\ACM@timestamp} + \fi } \pagestyle{standardpagestyle} \newdimen\@folio@wd @@ -1955,15 +2178,15 @@ Computing Machinery] \renewcommand{\footrulewidth}{\z@}% \ifcase\ACM@format@nr \relax % manuscript - \fancyhead[L]{\ACM@linecount}% + \fancyhead[L]{\ACM@linecountL}% \fancyfoot[RO,LE]{\if@ACM@printfolios\small\thepage\fi}% \fancyfoot[RE,LO]{\footnotesize Manuscript submitted to ACM}% \or % acmsmall \fancyfoot[RO,LE]{\footnotesize \@journalName, Vol. \@acmVolume, No. \@acmNumber, Article \@acmArticle. Publication date: \@acmPubDate.}% - \fancyhead[LE]{\ACM@linecount\@folioblob}% - \fancyhead[LO]{\ACM@linecount}% + \fancyhead[LE]{\ACM@linecountL\@folioblob}% + \fancyhead[LO]{\ACM@linecountL}% \fancyhead[RO]{\@folioblob}% \fancyheadoffset[RO,LE]{0.6\@folio@wd}% \or % acmlarge @@ -1971,18 +2194,28 @@ Computing Machinery] \@acmNumber, Article \@acmArticle. Publication date: \@acmPubDate.}% \fancyhead[RO]{\@folioblob}% - \fancyhead[LE]{\ACM@linecount\@folioblob}% - \fancyhead[LO]{\ACM@linecount}% + \fancyhead[LE]{\ACM@linecountL\@folioblob}% + \fancyhead[LO]{\ACM@linecountL}% \fancyheadoffset[RO,LE]{1.4\@folio@wd}% \or % acmtog \fancyfoot[RO,LE]{\footnotesize \@journalName, Vol. \@acmVolume, No. \@acmNumber, Article \@acmArticle. Publication date: \@acmPubDate.}% - \fancyhead[L]{\ACM@linecount}% + \fancyhead[L]{\ACM@linecountL}% + \fancyhead[R]{\ACM@linecountR}% \else % Conference proceedings - \fancyhead[L]{\ACM@linecount}% + \fancyhead[L]{\ACM@linecountL}% + \fancyhead[R]{\ACM@linecountR}% \fancyfoot[C]{\if@ACM@printfolios\footnotesize\thepage\fi}% \fi + \if@ACM@timestamp + \ifnum\ACM@format@nr=0\relax % Manuscript + \fancyfoot[LO,RE]{\ACM@timestamp\quad + \footnotesize Manuscript submitted to ACM} + \else + \fancyfoot[LO,RE]{\ACM@timestamp} + \fi + \fi } \renewcommand\section{\@startsection{section}{1}{\z@}% {-.75\baselineskip \@plus -2\p@ \@minus -.2\p@}% @@ -2057,6 +2290,7 @@ Computing Machinery] \fi \def\@adddotafter#1{#1\@addpunct{.}} \def\@addspaceafter#1{#1\@addpunct{\enspace}} +\providecommand*\@dotsep{4.5} \def\@acmplainbodyfont{\itshape} \def\@acmplainindent{\parindent} \def\@acmplainheadfont{\scshape} @@ -2181,7 +2415,7 @@ Computing Machinery] \ifx\@tempa\@tempb arXiv:\href{http://arxiv.org/abs/#2}{#2}\else arXiv:#2% \fi} -\normalsize\normalfont +\normalsize\normalfont\frenchspacing \endinput %% %% End of file `acmart.cls'. From ee8f881153440af469c816809f61f7c8adb4334e Mon Sep 17 00:00:00 2001 From: Robby Findler Date: Sun, 2 Jul 2017 23:59:23 -0500 Subject: [PATCH 13/13] add some missing symbols to latex generation --- scribble-lib/scribble/latex-render.rkt | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/scribble-lib/scribble/latex-render.rkt b/scribble-lib/scribble/latex-render.rkt index f7ea738d..794f1b72 100644 --- a/scribble-lib/scribble/latex-render.rkt +++ b/scribble-lib/scribble/latex-render.rkt @@ -1085,6 +1085,9 @@ [(#\↕) "$\\updownarrow$"] [(#\↔) "$\\leftrightarrow$"] [(#\↗) "$\\nearrow$"] + [(#\↝) "$\\leadsto$"] + [(#\↱) "$\\Lsh$"] + [(#\↰) "$\\Rsh$"] [(#\⇕) "$\\Updownarrow$"] [(#\א) "$\\aleph$"] [(#\′) "$\\prime$"] @@ -1159,6 +1162,7 @@ [(#\∨) "$\\vee$"] [(#\∧) "$\\wedge$"] [(#\◃) "$\\triangleright$"] + [(#\◊) "$\\Diamond$"] [(#\⊙) "$\\odot$"] [(#\★) "$\\star$"] [(#\†) "$\\dagger$"]