-
-
Notifications
You must be signed in to change notification settings - Fork 95
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[WIP] Improve acmart support #415
Open
fare
wants to merge
1
commit into
racket:master
Choose a base branch
from
fare-patches:acmart
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,14 +15,23 @@ Machinery.} | |
@margin-note{@tt{acmart} documentation: @link["https://portalparts.acm.org/hippo/latex_templates/acmart.pdf"]{[link]}} | ||
|
||
@bold{Note:} a @racketmodname[scribble/acmart] document must include a | ||
@racket[title] and @racket[author]. | ||
@racket[title] and at least one @racket[author], | ||
with an affilitation that includes at least institution and country. | ||
|
||
Example: | ||
|
||
@verbatim[#:indent 2]|{ | ||
#lang scribble/acmart | ||
#lang scribble/acmart @sigplan @authorversion @10pt | ||
@title{Surreal Numbers} | ||
@author{Ursula N. Owens} | ||
@author["Ursula N. Owens" | ||
#:affiliation | ||
(affiliation #:institution "Subreal Numerologists" | ||
#:city "R'lyeh" #:country "THEM") | ||
#:email "[email protected]"] | ||
@author["Djorge U. Oruel" | ||
#:affiliation | ||
(affiliation #:institution "" #:country "") | ||
#:email "[email protected]"] | ||
}| | ||
|
||
@deftogether[( | ||
|
@@ -35,9 +44,8 @@ Example: | |
@defidform[sigplan] | ||
@defidform[sigchi] | ||
@defidform[sigchi-a] | ||
@defidform[dtrap] | ||
@defidform[tiot] | ||
@defidform[tdsci] | ||
@defidform[acmengage] | ||
@defidform[acmcp] | ||
)]{ | ||
|
||
Enables the given document format. Use the format only on the same | ||
|
@@ -168,14 +176,21 @@ Specifies a subtitle.} | |
(listof affiliation?) | ||
#f) | ||
#f] | ||
[#:additional-affiliation additional-affiliation | ||
(or/c pre-content? | ||
affiliation? | ||
(listof pre-content?) | ||
(listof affiliation?) | ||
#f) | ||
#f] | ||
[#:email email | ||
(or/c pre-content? email? (listof email?)) | ||
'()] | ||
[name pre-content?] ...) | ||
block?]{ | ||
|
||
Specifies an author with an optional email address, affiliation, and/or orcid. | ||
|
||
@codeblock|{ | ||
#lang scribble/acmart | ||
@title{Title} | ||
|
@@ -194,6 +209,7 @@ Specifies a subtitle.} | |
@deftogether[( | ||
@defproc[(acmJournal [journal pre-content?] ...) block?] | ||
@defproc[(acmConference [name pre-content?] [date pre-content?] [venue pre-content?]) block?] | ||
@defproc[(acmBooktitle [title pre-content?]) block?] | ||
@defproc[(acmVolume [content pre-content?] ...) block?] | ||
@defproc[(acmNumber [content pre-content?] ...) block?] | ||
@defproc[(acmArticle [content pre-content?] ...) block?] | ||
|
@@ -203,9 +219,13 @@ Specifies a subtitle.} | |
@defproc[(acmPrice [content pre-content?] ...) block?] | ||
@defproc[(acmISBN [content pre-content?] ...) block?] | ||
@defproc[(acmDOI [content pre-content?] ...) block?] | ||
@defproc[(editor [name pre-content?] ...) block?] | ||
)]{ | ||
|
||
Declares information that is collected into the front-matter region of the paper.} | ||
Declares information that is collected into the front-matter region of the paper. | ||
|
||
Some of these procedures accept an empty string as argument to disable the corresponding message. | ||
} | ||
|
||
@deftogether[( | ||
@defproc[(acmBadgeL [#:url url string? #f] [graphics string?]) block?] | ||
|
@@ -233,11 +253,11 @@ screen version of the image links to the badge authority. | |
} | ||
|
||
@defproc[(email? [email any/c]) boolean?]{ | ||
|
||
Returns @racket[#t] if @racket[email] is an @racket[email], | ||
@racket[#f] otherwise. | ||
} | ||
|
||
|
||
@defproc[(affiliation | ||
[#:position position (or/c pre-content? #f) #f] | ||
|
@@ -248,24 +268,31 @@ screen version of the image links to the badge authority. | |
[#:postcode postcode (or/c pre-content? #f) #f] | ||
[#:country country (or/c pre-content? #f) #f]) | ||
affiliation?]{ | ||
|
||
Creates an @racket[affiliation?] object for use with @racket[author]. | ||
|
||
As of acmart v2.05, the ACM insists that you should include | ||
a city (or it issues a LaTeX warning) | ||
and especially a country (or it issues a LaTeX error). | ||
You may explicitly provide an empty string to eschew this error | ||
without declaring a country when this might not make sense in your situation: | ||
@racket[(affiliation #:institution "Apatrides United" #:country "")] | ||
} | ||
|
||
@defproc[(affiliation? [aff any/c]) boolean?]{ | ||
|
||
Returns @racket[#t] if @racket[aff] is an | ||
@racket[affiliation], @racket[#f] otherwise. | ||
} | ||
|
||
@defproc[(institution [#:departments departments (or/c pre-content? institution? (listof institution)) '()] | ||
[inst institution?] ...) | ||
@defproc[(institution [#:departments departments (listof (or/c pre-content? institution?)) '()] | ||
[pre-content?] ...) | ||
institution?]{ | ||
|
||
Creates an @racket[institution?] object for use in @racket[author].} | ||
|
||
@defproc[(institution? [inst any/c]) boolean]{ | ||
|
||
Returns @racket[#t] if @racket[inst] is an | ||
@racket[institution], @racket[#f] otherwise. | ||
} | ||
|
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be possible to preserve these so that old programs that use them can still be run?