# References

## SSH Monitor references

```{toctree}
:glob:
:maxdepth: 1

template/index
substitutions/index
source-code/index
```

```{warning}
Before reading the the above references
(generated with [Doxygen](https://www.doxygen.nl/) + [Sphinx](https://www.sphinx-doc.org) + [Breathe](https://breathe.readthedocs.io)),
be aware that:

* in {{template}} files:
  an {{EPICS}} {{record}} is interpreted as a class,
  and an {{EPICS}} field is interpreted as a class attribute.
* in `.substitutions` files:
  a scope is interpreted as a class, and an {{EPICS}} {{macro}} is interpreted either as a global variable or as a class attribute.

So don't be confused is you cross an {{EPICS}} {{record}} labeled as a "class",
or an {{EPICS}} {{macro}} labeled as an "attribute".
```

## EPICS references

{{EPICS}} documentation:

* <https://docs.epics-controls.org/en/latest/>
* <https://epics.anl.gov/base/R3-15/9.php>
* <https://epics.anl.gov/base/R3-15/6-docs/AppDevGuide/AppDevGuide.html>
* <https://epics.anl.gov/base/R7-0/7.php>

{{EPICS}} {{Top}} and {{App}}s architecture:

* <https://docs.epics-controls.org/en/latest/appdevguide/EPICSBuildFacility.html?highlight=Top#top-directory-structure>
* <https://docs.epics-controls.org/en/latest/appdevguide/gettingStarted.html?highlight=App#description>

{{EPICS}} {{cmd}} file:

* <https://docs.epics-controls.org/en/latest/appdevguide/gettingStarted.html?highlight=cmd#run-the-ioc-example>
* <https://epics.anl.gov/base/R3-15/6-docs/AppDevGuide/IOCShell.html#x19-73300018>

{{EPICS}} {{substitutions}} file:

* <https://docs.epics-controls.org/en/latest/appdevguide/databaseDefinition.html?highlight=template#dbloadtemplate>

{{EPICS}} {{template}} file:

* <https://docs.epics-controls.org/en/latest/appdevguide/databaseDefinition.html?highlight=database%20file#dbloadrecords>
* <https://docs.epics-controls.org/en/latest/guides/EPICS_Process_Database_Concepts.html>
* <https://docs.epics-controls.org/en/latest/process-database/common-database-patterns.html>
* <https://docs.epics-controls.org/en/latest/getting-started/creating-ioc.html>
* <https://epics.anl.gov/base/R3-15/6-docs/AppDevGuide/DatabaseLockingScanningAndProcessing.html#x6-1730005>
* <https://epics.anl.gov/base/R3-15/6-docs/AppDevGuide/DatabaseDefinition.html#x7-2010006>