Convert RecordReference.md to ComponentReference.pod
That .pod file will now be converted to .html using the same style as the individual local documents that it links to. The dbdToHtml output files now include a header and footer that link to the ComponentReference.html file (they started pointing to the original RecordReference.html but that was broken on most people's builds because we weren't converting that from the original Markdown version). This commit also adjusts documentation/Makefile to use the build system properly, and reorders the Doxygen main page index.
This commit is contained in:
Andrew Johnson
170
documentation/ComponentReference.pod
Normal file
170
documentation/ComponentReference.pod
Normal file
@ -0,0 +1,170 @@
|
||||
=head1 EPICS Component Reference Manual
|
||||
|
||||
This document provides reference information about the record types,
|
||||
menus, link types and channel filters included with EPICS Base.
|
||||
|
||||
Many details about the record and menu definitions are derived automatically
|
||||
from the source code at build time.
|
||||
|
||||
|
||||
=head2 Introduction and IOC Concepts
|
||||
|
||||
These links point to an external website where introductory and overview
|
||||
documentation is now being published.
|
||||
|
||||
=over
|
||||
|
||||
=item * L<Introduction to EPICS|https://docs.epics-controls.org/en/latest/guides/EPICS_Intro.html>
|
||||
|
||||
=item * L<Process Database Concepts|https://docs.epics-controls.org/en/latest/guides/EPICS_Process_Database_Concepts.html>
|
||||
|
||||
=back
|
||||
|
||||
|
||||
=head2 Record Type Definitions
|
||||
|
||||
These sections describe common aspects of the record types:
|
||||
|
||||
=over
|
||||
|
||||
=item * L<Fields Common to All Record Types|dbCommonRecord>
|
||||
|
||||
=item * L<Fields Common to Input Record Types|dbCommonInput>
|
||||
|
||||
=item * L<Fields Common to Output Record Types|dbCommonOutput>
|
||||
|
||||
=back
|
||||
|
||||
|
||||
These are the record types supplied with EPICS Base:
|
||||
|
||||
=over
|
||||
|
||||
=item * L<Analog Array Input Record (aai)|aaiRecord>
|
||||
|
||||
=item * L<Analog Array Output Record (aao)|aaoRecord>
|
||||
|
||||
=item * L<Analog Input Record (ai)|aiRecord>
|
||||
|
||||
=item * L<Analog Output Record (ao)|aoRecord>
|
||||
|
||||
=item * L<Array Subroutine Record (aSub)|aSubRecord>
|
||||
|
||||
=item * L<Binary Input Record (bi)|biRecord>
|
||||
|
||||
=item * L<Binary Output Record (bo)|boRecord>
|
||||
|
||||
=item * L<Calculation Output Record (calcout)|calcoutRecord>
|
||||
|
||||
=item * L<Calculation Record (calc)|calcRecord>
|
||||
|
||||
=item * L<Compression Record (compress)|compressRecord>
|
||||
|
||||
=item * L<Data Fanout Record (dfanout)|dfanoutRecord>
|
||||
|
||||
=item * L<Event Record (event)|eventRecord>
|
||||
|
||||
=item * L<Fanout Record (fanout)|fanoutRecord>
|
||||
|
||||
=item * L<Histogram Record (histogram)|histogramRecord>
|
||||
|
||||
=item * L<64-bit Integer Input Record (int64in)|int64inRecord>
|
||||
|
||||
=item * L<64-bit Integer Output Record (int64out)|int64outRecord>
|
||||
|
||||
=item * L<Long Input Record (longin)|longinRecord>
|
||||
|
||||
=item * L<Long Output Record (longout)|longoutRecord>
|
||||
|
||||
=item * L<Long String Input Record (lsi)|lsiRecord>
|
||||
|
||||
=item * L<Long String Output Record (lso)|lsoRecord>
|
||||
|
||||
=item * L<Multi-Bit Binary Input Direct Record (mbbiDirect)|mbbiDirectRecord>
|
||||
|
||||
=item * L<Multi-Bit Binary Input Record (mbbi)|mbbiRecord>
|
||||
|
||||
=item * L<Multi-Bit Binary Output Direct Record (mbboDirect)|mbboDirectRecord>
|
||||
|
||||
=item * L<Multi-Bit Binary Output Record (mbbo)|mbboRecord>
|
||||
|
||||
=item * L<Permissive Record (permissive)|permissiveRecord>
|
||||
|
||||
=item * L<Printf Record (printf)|printfRecord>
|
||||
|
||||
=item * L<Select Record (sel)|selRecord>
|
||||
|
||||
=item * L<Sequence Record (seq)|seqRecord>
|
||||
|
||||
=item * L<State Record (state)|stateRecord>
|
||||
|
||||
=item * L<String Input Record (stringin)|stringinRecord>
|
||||
|
||||
=item * L<String Output Record (stringout)|stringoutRecord>
|
||||
|
||||
=item * L<Sub-Array Record (subArray)|subArrayRecord>
|
||||
|
||||
=item * L<Subroutine Record (sub)|subRecord>
|
||||
|
||||
=item * L<Waveform Record (waveform)|waveformRecord>
|
||||
|
||||
=back
|
||||
|
||||
|
||||
=head2 Menu Definitions
|
||||
|
||||
Menu field choices are documented with the record type that defines them, or
|
||||
here for the global menus that are used by multiple record types:
|
||||
|
||||
=over
|
||||
|
||||
=item * L<Alarm Severity Menu|menuAlarmSevr>
|
||||
|
||||
=item * L<Alarm Status Menu|menuAlarmStat>
|
||||
|
||||
=item * L<Analog Conversions Menu|menuConvert>
|
||||
|
||||
=item * L<Field Type Menu|menuFtype>
|
||||
|
||||
=item * L<Invalid Value Output Action Menu|menuIvoa>
|
||||
|
||||
=item * L<Output Mode Select Menu|menuOmsl>
|
||||
|
||||
=item * L<Process at iocInit Menu|menuPini>
|
||||
|
||||
=item * L<Post Monitors Menu|menuPost>
|
||||
|
||||
=item * L<Priority Menu|menuPriority>
|
||||
|
||||
=item * L<Scan Menu|menuScan>
|
||||
|
||||
=item * L<Simulation Mode Menu|menuSimm>
|
||||
|
||||
=item * L<YesE<sol>No Menu|menuYesNo>
|
||||
|
||||
=back
|
||||
|
||||
|
||||
=head2 Other Components
|
||||
|
||||
EPICS Base also comes with extensible sets of server Channel Filters and IOC
|
||||
Database Link types, which are documented here:
|
||||
|
||||
=over
|
||||
|
||||
=item * L<Channel Filters|filters>
|
||||
|
||||
=item * L<IOC Database Link Types|links>
|
||||
|
||||
=back
|
||||
|
||||
|
||||
=head2 Corrections and Updates
|
||||
|
||||
Corrections to these documents can be submitted as patch files to the EPICS
|
||||
core developers, or as GitHub pull requests to the 7.0 branch of Base.
|
||||
These document sources can be found under `modules/database/src` tree, mostly
|
||||
in the `std/rec` and `ioc/db` directories in files with extension `.dbd.pod`.
|
||||
The documentation source format is a combination of the EPICS DBD file format
|
||||
with an extended version of Perl's POD (plain old documentation); run `perldoc
|
||||
pod` for details of POD.
|
||||
@ -762,7 +762,6 @@ WARN_LOGFILE =
|
||||
INPUT = ../mainpage.dox \
|
||||
../RELEASE_NOTES.md \
|
||||
../README.md \
|
||||
../RecordReference.md \
|
||||
@TOP@/include
|
||||
|
||||
# This tag can be used to specify the character encoding of the source files
|
||||
|
||||
@ -1,24 +1,24 @@
|
||||
TOP = ..
|
||||
include $(TOP)/configure/CONFIG
|
||||
|
||||
ifeq ($(T_A),$(EPICS_HOST_ARCH))
|
||||
|
||||
DOXYGEN=doxygen
|
||||
|
||||
EXPAND = Doxyfile@
|
||||
|
||||
EXPAND_ME += EPICS_VERSION
|
||||
EXPAND_ME += EPICS_REVISION
|
||||
EXPAND_ME += EPICS_MODIFICATION
|
||||
EXPAND_ME += EPICS_PATCH_LEVEL
|
||||
EXPAND_ME += OS_CLASS CMPLR_CLASS
|
||||
|
||||
HTMLS += ComponentReference.html
|
||||
|
||||
TARGETS += doxygen
|
||||
|
||||
DOXYGEN = doxygen
|
||||
ME = documentation/O.$(T_A)/html
|
||||
GH_FILES = $(ME)/ $(ME)/.nojekyll $(ME)/*.* $(ME)/*/*.*
|
||||
|
||||
install: doxygen
|
||||
include $(TOP)/configure/RULES
|
||||
|
||||
doxygen: Doxyfile ../mainpage.dox
|
||||
doxygen: Doxyfile ../mainpage.dox $(INSTALL_HTMLS)
|
||||
$(DOXYGEN)
|
||||
rsync -av $(TOP)/html/ html/
|
||||
|
||||
@ -29,7 +29,3 @@ commit: doxygen
|
||||
(cd $(TOP) && $(CURDIR)/../commit-gh.sh $(GH_FILES))
|
||||
|
||||
.PHONY: commit
|
||||
|
||||
endif # EPICS_HOST_ARCH
|
||||
|
||||
include $(TOP)/configure/RULES
|
||||
|
||||
@ -1,96 +0,0 @@
|
||||
# EPICS Reference Manual {#recordrefmanual}
|
||||
|
||||
This document provides reference information about the record types,
|
||||
menus, link types and channel filters included with Base.
|
||||
|
||||
Many details about the record and menu definitions are derived automatically
|
||||
from the source code at build time.
|
||||
|
||||
## Introduction and IOC Concepts
|
||||
|
||||
These links point to an external website where introductory and overview
|
||||
documentation is now being published.
|
||||
|
||||
* [Introduction to EPICS](https://docs.epics-controls.org/en/latest/guides/EPICS_Intro.html)
|
||||
* [Process Database Concepts](https://docs.epics-controls.org/en/latest/guides/EPICS_Process_Database_Concepts.html)
|
||||
|
||||
## Record Type Definitions
|
||||
|
||||
These sections describe common aspects of the record types:
|
||||
|
||||
* [Fields Common to All Record Types](dbCommonRecord.html)
|
||||
* [Fields Common to Input Record Types](dbCommonInput.html)
|
||||
* [Fields Common to Output Record Types](dbCommonOutput.html)
|
||||
|
||||
These are the record types supplied with EPICS Base:
|
||||
|
||||
* [Analog Array Input Record (aai)](aaiRecord.html)
|
||||
* [Analog Array Output Record (aao)](aaoRecord.html)
|
||||
* [Analog Input Record (ai)](aiRecord.html)
|
||||
* [Analog Output Record (ao)](aoRecord.html)
|
||||
* [Array Subroutine Record (aSub)](aSubRecord.html)
|
||||
* [Binary Input Record (bi)](biRecord.html)
|
||||
* [Binary Output Record (bo)](boRecord.html)
|
||||
* [Calculation Output Record (calcout)](calcoutRecord.html)
|
||||
* [Calculation Record (calc)](calcRecord.html)
|
||||
* [Compression Record (compress)](compressRecord.html)
|
||||
* [Data Fanout Record (dfanout)](dfanoutRecord.html)
|
||||
* [Event Record (event)](eventRecord.html)
|
||||
* [Fanout Record (fanout)](fanoutRecord.html)
|
||||
* [Histogram Record (histogram)](histogramRecord.html)
|
||||
* [64-bit Integer Input Record (int64in)](int64inRecord.html)
|
||||
* [64-bit Integer Output Record (int64out)](int64outRecord.html)
|
||||
* [Long Input Record (longin)](longinRecord.html)
|
||||
* [Long Output Record (longout)](longoutRecord.html)
|
||||
* [Long String Input Record (lsi)](lsiRecord.html)
|
||||
* [Long String Output Record (lso)](lsoRecord.html)
|
||||
* [Multi-Bit Binary Input Direct Record (mbbiDirect)](mbbiDirectRecord.html)
|
||||
* [Multi-Bit Binary Input Record (mbbi)](mbbiRecord.html)
|
||||
* [Multi-Bit Binary Output Direct Record (mbboDirect)](mbboDirectRecord.html)
|
||||
* [Multi-Bit Binary Output Record (mbbo)](mbboRecord.html)
|
||||
* [Permissive Record (permissive)](permissiveRecord.html)
|
||||
* [Printf Record (printf)](printfRecord.html)
|
||||
* [Select Record (sel)](selRecord.html)
|
||||
* [Sequence Record (seq)](seqRecord.html)
|
||||
* [State Record (state)](stateRecord.html)
|
||||
* [String Input Record (stringin)](stringinRecord.html)
|
||||
* [String Output Record (stringout)](stringoutRecord.html)
|
||||
* [Sub-Array Record (subArray)](subArrayRecord.html)
|
||||
* [Subroutine Record (sub)](subRecord.html)
|
||||
* [Waveform Record (waveform)](waveformRecord.html)
|
||||
|
||||
## Menu Definitions
|
||||
|
||||
Menu field choices are documented with the record type that defines them, or
|
||||
here for the global menus that are used by multiple record types:
|
||||
|
||||
* [Alarm Severity Menu](menuAlarmSevr.html)
|
||||
* [Alarm Status Menu](menuAlarmStat.html)
|
||||
* [Analog Conversions Menu](menuConvert.html)
|
||||
* [Field Type Menu](menuFtype.html)
|
||||
* [Invalid Value Output Action Menu](menuIvoa.html)
|
||||
* [Output Mode Select Menu](menuOmsl.html)
|
||||
* [Process at iocInit Menu](menuPini.html)
|
||||
* [Post Monitors Menu](menuPost.html)
|
||||
* [Priority Menu](menuPriority.html)
|
||||
* [Scan Menu](menuScan.html)
|
||||
* [Simulation Mode Menu](menuSimm.html)
|
||||
* [Yes/No Menu](menuYesNo.html)
|
||||
|
||||
## Other Definitions
|
||||
|
||||
EPICS Base also comes with extensible sets of link types and channel filters
|
||||
which are described here:
|
||||
|
||||
* [Link Types](links.html)
|
||||
* [Channel Filters](filters.html)
|
||||
|
||||
## Corrections and Updates
|
||||
|
||||
Corrections to these documents can be submitted as patch files to the EPICS core
|
||||
developers, or as merge requests or pull requests to the 7.0 branch of Base.
|
||||
The document sources can be found in the `modules/database/src/std/rec` and
|
||||
`modules/database/src/ioc/db` directories in files with extension `.dbd.pod`.
|
||||
The documentation source format is a combination of the EPICS DBD file format
|
||||
with an extended version of Perl's POD (plain old documentation); run `perldoc
|
||||
pod` for details of POD.
|
||||
@ -5,11 +5,11 @@ Documentation index
|
||||
|
||||
@li @ref releasenotes
|
||||
@li @ref install
|
||||
@li @ref recordrefmanual
|
||||
@li <a href="ComponentReference.html">EPICS Component Reference Manual</a>
|
||||
@li <a href="filters.html">Field Modifiers and Channel Filters</a>
|
||||
@li <a href="links.html">Extensible IOC Database Links</a>
|
||||
@li <a href="CAref.html">Channel Access Reference Manual</a>
|
||||
@li <a href="filters.html">Server Side Filters Reference</a>
|
||||
@li <a href="msi.html">msi: Macro Substitution and Include Tool</a>
|
||||
@li <a href="links.html">JSON Link Types</a>
|
||||
@li <a href="CA.html">Perl 5 Interface to Channel Access</a>
|
||||
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user