Acronym Extension

The acronym extension provides a convenient way to defined acronyms that may be used throughout all documentation pages. On each page the full text and acronym definition will be displayed the first time is used, as shown in Example 1.

note

When viewing on the website a tooltip is created for the the acronyms, the full name will appear when the mouse is placed over the acronym.

Example 1: Example use of acronyms.

The !!acro INL!! was founded in 1949 and has changed names many times, but !!acro INL!! has
been used since 2005.

The Idaho National Laboratory (INL) was founded in 1949 and has changed names many times, but INL has been used since 2005.

Acronym List

A list of acronyms can be created by using the !acronym list command. Table 1 show the available options for this command.

Table 1: Available configuration options for the !acronym list command.

Key	Default	Description
style		The style settings that are passed to rendered HTML tag.
complete	False	Show the complete list of acronyms regardless of use on current page.
class		The class settings to be passed to rendered HTML tag.
caption	None	The caption to use for the acronym table.
prefix	Table	Prefix to use when a caption and id are provided.
id		The class settings to be passed to the rendered tag.
heading	True	Display the headings row of the acronym table.

Example 2: Example of the !acronym list command.

!acronym list complete=True

Acronym	Description
MOOSE	Multiphysics Object Oriented Simulation Environment
LGPL	GNU Library General Public License
FEM	Finite Element Method
INL	Idaho National Laboratory
POSIX	Portable Operating System Interface
PDE	partial differential equation
PDEs	partial differential equations
JFNK	Jacobian-Free Newton-Krylov

Configuration

The available configuration options for the acronym extension are provided in Table 2.

Table 2: Available configuration options for the AcronymExtension object.

Key	Default	Description
acronyms	{}	Complete dict (or dict of dict) of acronyms.

The acronyms are defined in the configuration (e.g., config.yml) as a dictionary of items under the "acronyms" configuration item.


Extensions:
    acronym:
        type: MooseDocs.extensions.acronym
        acronyms:
            INL: Idaho National Laboratory
            INEL: Idaho National Engineering Laboratory
            INEEL: Idaho National Engineering and Environmental Laboratory

Additionally, multiple dictionaries may be used to allow items to be pulled from multiple sources. For example, to use the acronyms defined within the framework as well as define additional items, the following may be done.


Extensions:
    acronym:
        type: MooseDocs.extensions.acronym
        acronyms:
            framework: !include ${MOOSE_DIR}/framework/doc/acronyms.yml
            my_app:
                INEL: Idaho National Engineering Laboratory
                INEEL: Idaho National Engineering and Environmental Laboratory

Acronym List
Configuration