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 acronyms, the full name will appear when the mouse is placed over the acronym.

Example 1: Example use of acronyms.

Markdown
HTML

The [!ac](INL) was founded in 1949 and has changed names many times, but [!ac](INL) has
been used since 2005.

The 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	None	The style settings that are passed to rendered HTML tag.
class	None	The class settings to be passed to rendered HTML tag.
id	None	The class settings to be passed to the rendered tag.
complete	False	Show the complete list of acronyms regardless of use on current page.
location	None	The markdown content directory to build the list from.
heading	True	Display the headings row of the acronym table.
prefix	Table	Prefix to use when a caption and id are provided.
caption	None	The caption to use for the acronym table.

Example 2: Example of the !acronym list command.

Markdown
HTML

!acronym list complete=True

Acronym	Description
AD	automatic differentiation
AMP	Asset Management Plan
API	Application Programming Interface
ASME	American Society of Mechanical Engineers
BC	boundary condition
BCs	boundary conditions
BVP	boundary value problem
CCB	Change Control Board
CCI	Communication and Contact Information
CD	continuous deployment
CI	continuous integration
CIVET	Continuous Integration for Verification, Enhancement, and Testing
CMP	Configuration Management Plan
CSV	comma-separated values
DOE	Department of Energy
DOE-NE	Department of Energy, Nuclear Energy
DOF	degree-of-freedom
DOFs	degrees-of-freedom
EA	Enterprise Architecture
FAR	Failure Analysis Report
FE	finite element
FEM	Finite Element Method
FVM	Finite Volume Method
GMRES	Generalized Minimum Residual Method
GUI	graphical user interface
HIT	Hierarchical Input Text
HPC	High Performance Computing
I/O	Input/Output
IGA	Isogeometric Analysis
INL	Idaho National Laboratory
IT	Information Technology
JFNK	Jacobian-Free Newton-Krylov
JSON	JavaScript Object Notation
LGPL	GNU Lesser General Public License
LWP	Laboratory Wide Procedure
MMS	Method of Manufactured Solutions
MOOSE	Multiphysics Object Oriented Simulation Environment
MPI	Message Passing Interface
MWR	Method of Mean Weighted Residuals
NCRC	Nuclear Computational Resource Center
NE	Nuclear Energy
NEAMS	Nuclear Energy Advanced Modeling and Simulation
NQA-1	Nuclear Quality Assurance Level 1
PBS	Portable Batch System
PDE	partial differential equation
PDEs	partial differential equations
PETSc	Portable, Extensible Toolkit for Scientific Computation
PJFNK	Preconditioned Jacobian Free Newton Krylov
PMP	Project Management Plan
POSIX	Portable Operating System Interface
QLD	Quality Level Determination
QP	quadrature point
QPs	quadrature points
RTM	Requirement Traceability Matrix
SCS	Software Coding Standards
SDD	Software Design Description
SLL	Software Library List
SQA	Software Quality Assurance
SQAP	Software Quality Assurance Plan
SQP	Software Quality Plan
SRS	Software Requirement Specification
SSD	Safety Software Determination
STP	Software Test Plan
VVP	Verification and Validation Plan
VVR	Verification and Validation Report

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
active	True	Toggle for disabling the extension. This only changes the initial active state, use setActive to control at runtime.
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