Text.LaTeX.Packages.Acronym

Add acronyms to your documents using this module.

Define and render acronyms in a document, where the first occurrance is the long variant, and the next ones are the shorter variant.

Acronym package

pacronym :: PackageName

The pacronym package.

usepackage [] pacronym

Package options

footnote :: LaTeXC l => l

Redefines the `\acf` and `\acfp` commands making the full name appear as a footnote

nohyperlinks :: LaTeXC l => l

If hyperref is loaded, all acronyms will link to their glossary entry. With the nohyperlinks option, these links are suppressed.

printonlyused :: LaTeXC l => l

We need a marker which is set if the option printonlyused was used.

withpage :: LaTeXC l => l

A marker which tells us to print page numbers.

smaller :: LaTeXC l => l

The option smaller leads to a redefinition of `\acsfont`. We want to make the acronym appear smaller. Since this should be done in a context-sensitive way, we rely on the macro textsmaller provided by the relsize package. As `\RequiredPackage` cannot be used inside `\DeclareOption`, we need a boolean variable.

dua :: LaTeXC l => l

The option dua stands for "don't use acronyms". It leads to a redefinition of `\ac` and `\acp` making the full name appear all the time and suppressing all acronyms but the explicitly requested by `\acf` and `\acfp`.

nolist :: LaTeXC l => l

The option nolist stands for "don't write the list of acronyms".

Types

newtype Acronym

An acronym type with a label, this is used to generate commands linked to this acronym.

Constructors

Acronym

Fields

• acronymLabel :: String

ac :: LaTeXC l => Acronym -> l

Enter an acronym inside the text. The first time the acronym is used, it will specify the full name, and between parenthesis, the short name. If you specified the footnote option, it will print the short name, and add a footnote with the long name. The next time, only the short time is printed.

acf :: LaTeXC l => Acronym -> l

You can use this command to later in the text again print the full name of the acronym, this stands for "full acronym", it always prints the full name, and the acronym between parenthesis.

acs :: LaTeXC l => Acronym -> l

This will enter the short version of the acronym inside the text.

acl :: LaTeXC l => Acronym -> l

This will enter the expanded version of the acronym in the text, without mentioning the acronym between parenthesis.

acp :: LaTeXC l => Acronym -> l

This works the same way as ac, except that it will make the short and the long forms into plurals.

acfp :: LaTeXC l => Acronym -> l

This works the same way as acf, except tah it will make the short and long forms into plurals.

acsp :: LaTeXC l => Acronym -> l

Works the same way as acs, but makes the short form into a plural.

aclp :: LaTeXC l => Acronym -> l

Works the same way as acl, but makes the long form into a plural.

acfi :: LaTeXC l => Acronym -> l

Prints the full name acronym in italics and the abbreviated form in an upshaped form.

acsu :: LaTeXC l => Acronym -> l

Prints the short form of the acronym, and marks it as used.

aclu :: LaTeXC l => Acronym -> l

Prints the long form of the acronym and marks it as used.

iac :: LaTeXC l => Acronym -> l

Works the same way as the ac command, but prefixes it with an appropriate indefinite article.

iac2 :: LaTeXC l => Acronym -> l

Works the same way as the ac command, but prefixes it with an appropriate upper case indefinite article.

ac' :: LaTeXC l => Acronym -> l

Enter an acronym inside the text. It will specify the full name, and between parenthesis, the short name. If you specified the footnote option, it will print the short name, and add a footnote with the long name. This does not mark the acronym as used.

acf' :: LaTeXC l => Acronym -> l

You can use this command to later in the text again print the full name of the acronym, this stands for "full acronym", it always prints the full name, and the acronym between parenthesis. This does not mark the acronym as used.

acs' :: LaTeXC l => Acronym -> l

This will enter the short version of the acronym inside the text. This does not mark the acronym as used.

acl' :: LaTeXC l => Acronym -> l

This will enter the expanded version of the acronym in the text, without mentioning the acronym between parenthesis. This does not mark the acronym as used.

acp' :: LaTeXC l => Acronym -> l

This works the same way as ac, except that it will make the short and the long forms into plurals. This does not mark the acronym as used.

acfp' :: LaTeXC l => Acronym -> l

This works the same way as acf, except tah it will make the short and long forms into plurals. This does not mark the acronym as used.

acsp' :: LaTeXC l => Acronym -> l

Works the same way as acs, but makes the short form into a plural. This does not mark the acronym as used.

aclp' :: LaTeXC l => Acronym -> l

Works the same way as acl, but makes the long form into a plural. This does not mark the acronym as used.

acfi' :: LaTeXC l => Acronym -> l

Prints the full name acronym in italics and the abbreviated form in an upshaped form. This does not mark the acronym as used.

acsu' :: LaTeXC l => Acronym -> l

Prints the short form of the acronym, and marks it as used. This does not mark the acronym as used.

aclu' :: LaTeXC l => Acronym -> l

Prints the long form of the acronym and marks it as used. This does not mark the acronym as used.

iac' :: LaTeXC l => Acronym -> l

Works the same way as the ac command, but prefixes it with an appropriate indefinite article. This does not mark the acronym as used.

iac2' :: LaTeXC l => Acronym -> l

Works the same way as the ac command, but prefixes it with an appropriate upper case indefinite article. This does not mark the acronym as used.

acresetall :: LaTeXC l => l

The memory of the marco ac is flushed, afterwards, ac will print the full name of any acronym, and the acronym within parenthesis.

acused :: LaTeXC l => Acronym -> l

Marks an acronym as useed, as if it has been called with ac, but without printing anything. In the future, only the short form of the acronym will be printed. acresetall undoes this.

acroextra :: LaTeXC l => l -> l

This can be used inside the acro part to add extra data to the list of acrynyms, this will *not* be included when rendering the acronym in the document itself.

acronym :: LaTeXC l => l -> l

Define an acronym environment to write the acronym definitions to.

acro :: LaTeXC l => String -> l -> l -> (l, Acronym)

Define an acronym with a label and both a short, and a long name. This returns the LaTeX code to define the acronym, and the Acronym object to use in the rest of the code.

acro' :: LaTeXC l => String -> l -> (l, Acronym)

Define an acronym with a label, and only a long name. This returns the LaTeX code to define the acronym, and the Acronym object to use in the rest of the code.

acroM :: Monad m => String -> LaTeXT m () -> LaTeXT m () -> LaTeXT m Acronym

The monadic variant of the acro function where the Acronym is returned as a result of the definition.

acroM' :: Monad m => String -> LaTeXT m () -> LaTeXT m Acronym

The monadic variant of the acro' function, where the Acronym is returned as result of the definition.