From 5f65044b6885f9cdfd76e10c606d88690afbe442 Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc kop@karlpinc.com" Date: Sat, 20 Jan 2024 17:40:49 +0000 Subject: [PATCH] Document BIOGRAPHY_LOG --- doc/src/epilog.inc.m4 | 13 +++++ doc/src/tables.m4 | 3 +- doc/src/tables/biography_log.m4 | 100 ++++++++++++++++++++++++++++++++ include/limits.m4 | 3 + 4 files changed, 118 insertions(+), 1 deletion(-) create mode 100644 doc/src/tables/biography_log.m4 diff --git a/doc/src/epilog.inc.m4 b/doc/src/epilog.inc.m4 index 7fc136c..2f33620 100644 --- a/doc/src/epilog.inc.m4 +++ b/doc/src/epilog.inc.m4 @@ -69,6 +69,19 @@ sdb_generated_rst()dnl .. |BIOGRAPHY.DepartDate| replace:: :ref:`DepartDate ` .. |BIOGRAPHY.DepartType| replace:: :ref:`DepartType ` +.. |BIOGRAPHY_LOG| replace:: :ref:`BIOGRAPHY_LOG ` +.. |BIOGRAPHY_LOG.BLID| + replace:: :ref:`BLID ` +.. |BIOGRAPHY_LOG.DateOfUpdate| + replace:: :ref:`DateOfUpdate ` +.. |BIOGRAPHY_LOG.AnimID| + replace:: :ref:`AnimID ` +.. |BIOGRAPHY_LOG.Description| + replace:: :ref:`Description ` +.. |BIOGRAPHY_LOG.Rationale| + replace:: :ref:`Rationale ` +.. |BIOGRAPHY_LOG.MadeBy| + replace:: :ref:`MadeBy ` .. |COMM_IDS| replace:: :ref:`COMM_IDS ` .. |COMM_IDS.CommID| diff --git a/doc/src/tables.m4 b/doc/src/tables.m4 index 6336746..af3d932 100644 --- a/doc/src/tables.m4 +++ b/doc/src/tables.m4 @@ -1,4 +1,4 @@ -.. Copyright (C) 2023 The Meme Factory, Inc. www.karlpinc.com +.. Copyright (C) 2023, 2024 The Meme Factory, Inc. www.karlpinc.com This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as @@ -29,5 +29,6 @@ Data Tables :maxdepth: 3 tables/biography.rst + tables/biography_log.rst tables/comm_membs.rst tables/comm_memb_log.rst diff --git a/doc/src/tables/biography_log.m4 b/doc/src/tables/biography_log.m4 new file mode 100644 index 0000000..0f231da --- /dev/null +++ b/doc/src/tables/biography_log.m4 @@ -0,0 +1,100 @@ +.. Copyright (C) 2024 The Meme Factory, Inc. www.karlpinc.com + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +.. M4 setup +include(constants.m4)dnl +include(macros.m4)dnl +sdb_rst_quotes(`on')dnl +sdb_generated_rst()dnl + +.. _BIOGRAPHY_LOG: + +BIOGRAPHY_LOG +------------- + +.. |BIOGRAPHY_LOG_summary| replace:: + Each row documents a change made to a |BIOGRAPHY| row. + +|BIOGRAPHY_LOG_summary| +Changes have been logged since sdb_first_biography_log_date. + + +.. _BIOGRAPHY_LOG.BLID: + +BLID (Biography Log IDentifier) +``````````````````````````````` + +.. |BIOGRAPHY_LOG.BLID_summary| replace:: + |idcol| + +|BIOGRAPHY_LOG.BLID_summary| |notnull| + + +.. _BIOGRAPHY_LOG.DateOfUpdate: + +DateOfUpdate +```````````` + +.. |BIOGRAPHY_LOG.DateOfUpdate_summary| replace:: + The date on which the update was made. + +|BIOGRAPHY_LOG.DateOfUpdate_summary| This date must not be before +``sdb_first_biography_log_date``. + + +.. _BIOGRAPHY_LOG.AnimID: + +AnimID (Animal IDentifier) +`````````````````````````` + +.. |BIOGRAPHY.AnimID_summary| replace:: + The short sequence of characters which uniquely identify the chimpanzee + who's demographic information was updated. + +|BIOGRAPHY.AnimID_summary| |keycol| |cannot_change| + + +.. _BIOGRAPHY_LOG.Description: + +Description +``````````` + +.. |BIOGRAPHY_LOG.Description_summary| replace:: + A description of the changes made. + +|BIOGRAPHY_LOG.Description_summary| |notempty| |notnull| + + +.. _BIOGRAPHY_LOG.Rationale: + +Rationale +````````` + +.. |BIOGRAPHY_LOG.Rationale_summary| replace:: + A description of why the change was made. + +|BIOGRAPHY_LOG.Rationale_summary| |notonlyspaces| |notnull| + + +.. _BIOGRAPHY_LOG.MadeBy: + +MadeBy +`````` + +.. |BIOGRAPHY_LOG.MadeBy_summary| replace:: + The |PEOPLE|.\ |PEOPLE.Person| designating the researcher who + made the update. + +|BIOGRAPHY_LOG.MadeBy_summary| |notnull| diff --git a/include/limits.m4 b/include/limits.m4 index c793055..95e212c 100644 --- a/include/limits.m4 +++ b/include/limits.m4 @@ -50,6 +50,9 @@ dnl dnl Administration related dnl +dnl The earliest possible BIOGRAPHY_LOG.DateOfUpdate +define(`sdb_first_biography_log_date', `2013-07-01') + dnl The earliest possible COMM_MEMB_LOG.DateOfUpdate define(`sdb_first_memb_log_date', `2013-12-01') -- 2.34.1