From 718da5c9be96b7eccd7ce3a95f3b2d232c11ca32 Mon Sep 17 00:00:00 2001 From: Andrew Johnson Date: Sat, 4 Feb 2023 22:56:19 -0600 Subject: [PATCH] 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. --- configure/RULES.Db | 2 +- documentation/ComponentReference.pod | 170 ++++++++++++++++++++++++ documentation/Doxyfile@ | 1 - documentation/Makefile | 18 +-- documentation/RecordReference.md | 96 ------------- documentation/mainpage.dox | 6 +- modules/database/src/tools/dbdToHtml.pl | 4 +- 7 files changed, 183 insertions(+), 114 deletions(-) create mode 100644 documentation/ComponentReference.pod delete mode 100644 documentation/RecordReference.md diff --git a/configure/RULES.Db b/configure/RULES.Db index 18b546cc2..f08af423d 100644 --- a/configure/RULES.Db +++ b/configure/RULES.Db @@ -17,7 +17,7 @@ TEMPL_SUFFIX ?= .template # vpath vpath %.pm $(USR_VPATH) $(SRC_DIRS) $(dir $(DBD)) -vpath %.pod $(USR_VPATH) $(SRC_DIRS) $(dir $(DBD)) +vpath %.pod $(USR_VPATH) $(SRC_DIRS) .. $(dir $(DBD)) vpath %.dbd $(USR_VPATH) $(SRC_DIRS) $(dir $(DBD)) vpath %.db $(USR_VPATH) $(SRC_DIRS) $(dir $(DB)) vpath %.vdb $(USR_VPATH) $(SRC_DIRS) $(dir $(DB)) diff --git a/documentation/ComponentReference.pod b/documentation/ComponentReference.pod new file mode 100644 index 000000000..95169598b --- /dev/null +++ b/documentation/ComponentReference.pod @@ -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 + +=item * L + +=back + + +=head2 Record Type Definitions + +These sections describe common aspects of the record types: + +=over + +=item * L + +=item * L + +=item * L + +=back + + +These are the record types supplied with EPICS Base: + +=over + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L<64-bit Integer Input Record (int64in)|int64inRecord> + +=item * L<64-bit Integer Output Record (int64out)|int64outRecord> + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L + +=item * L