AutoLink Extension

Automatic Links

The link within traditional markdown links (e.g., [text](link)) may include a markdown filename. The name must be unique, but may be incomplete. The entire page hieerachy is searched and filenames are compared using the python "endswith" method. Thus, the supplied name is considered unique if only one path from all possible paths ends with the supplied text, see Example 1.

[Core](core.md)

The markdown filename link also supports html bookmark style links, as shown in Example 2.

[Core](core.md#shortcut-link)

Automatic Link Shortcuts

Markdown syntax includes syntax for creating shortcuts (see Shortcut links), within MooseDocs these are deemed "shortcut links." The AutoLink extension allows for markdown filenames to be used within a shortcut link. In this case the text from the first heading is used as the link text, as in Example 3.

[core.md]

It is also possible to include html style bookmarks with the filename, depending on the configuration (see Table 1) the link text will include the name of the text within the bookmark and optionally the page heading, see Example 4.

[core.md#shortcut-link]

Automatic Source Content

If a filename is used within a link or shortcut link and the file is contained in the git repository a bottom extending modal window will be created that displays the complete text, as shown in Example 5.

[/Diffusion.C]

[Diffusion Kernel](/Diffusion.C)

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#include "Diffusion.h"

registerMooseObject("MooseApp", Diffusion);

defineLegacyParams(Diffusion);

InputParameters
Diffusion::validParams()
{
  InputParameters params = Kernel::validParams();
  params.addClassDescription("The Laplacian operator ($-\\nabla \\cdot \\nabla u$), with the weak "
                             "form of $(\\nabla \\phi_i, \\nabla u_h)$.");
  return params;
}

Diffusion::Diffusion(const InputParameters & parameters) : Kernel(parameters) {}

Real
Diffusion::computeQpResidual()
{
  return _grad_u[_qp] * _grad_test[_i][_qp];
}

Real
Diffusion::computeQpJacobian()
{
  return _grad_phi[_j][_qp] * _grad_test[_i][_qp];
}

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#include "Diffusion.h"

registerMooseObject("MooseApp", Diffusion);

defineLegacyParams(Diffusion);

InputParameters
Diffusion::validParams()
{
  InputParameters params = Kernel::validParams();
  params.addClassDescription("The Laplacian operator ($-\\nabla \\cdot \\nabla u$), with the weak "
                             "form of $(\\nabla \\phi_i, \\nabla u_h)$.");
  return params;
}

Diffusion::Diffusion(const InputParameters & parameters) : Kernel(parameters) {}

Real
Diffusion::computeQpResidual()
{
  return _grad_u[_qp] * _grad_test[_i][_qp];
}

Real
Diffusion::computeQpJacobian()
{
  return _grad_phi[_j][_qp] * _grad_test[_i][_qp];
}