From ca38510bcbf93b527bbd6e9a26def732872b68c2 Mon Sep 17 00:00:00 2001
From: "Karl O. Pinc kop@karlpinc.com" <kop@karlpinc.com>
Date: Sat, 1 Nov 2025 22:22:15 +0000
Subject: [PATCH] Put a TOC in each table's docs above the column docs

---
 doc/src/tables/arrivals.m4         | 4 ++++
 doc/src/tables/biography_data.m4   | 4 ++++
 doc/src/tables/biography_log.m4    | 3 +++
 doc/src/tables/comm_memb_log.m4    | 3 +++
 doc/src/tables/comm_membs.m4       | 3 +++
 doc/src/tables/events.m4           | 4 ++++
 doc/src/tables/follow_observers.m4 | 4 ++++
 doc/src/tables/follow_studies.m4   | 3 +++
 doc/src/tables/follows.m4          | 3 +++
 doc/src/tables/humans.m4           | 4 ++++
 doc/src/tables/roles.m4            | 4 ++++
 doc/src/tables/species_present.m4  | 4 ++++
 12 files changed, 43 insertions(+)

diff --git a/doc/src/tables/arrivals.m4 b/doc/src/tables/arrivals.m4
index 0cbef1b..1e0fb9f 100644
--- a/doc/src/tables/arrivals.m4
+++ b/doc/src/tables/arrivals.m4
@@ -53,6 +53,10 @@ For further information, including additional data integrity rules,
 see the documentation of the :ref:`EVENTS <EVENTS_arrival_code>`
 table.
 
+.. contents::
+   :depth: 2
+
+
 .. _ARRIVALS.ArID:
 
 ArID (Arrival ID)
diff --git a/doc/src/tables/biography_data.m4 b/doc/src/tables/biography_data.m4
index e5b6509..0e419ba 100644
--- a/doc/src/tables/biography_data.m4
+++ b/doc/src/tables/biography_data.m4
@@ -95,6 +95,10 @@ unknown individual |BIOGRAPHY_DATA.Animid| codes:
 ``sdb_stranger_male``, ``sdb_stranger_female``,
 ``sdb_stranger_female2``, and ``sdb_stranger_female3``.
 
+.. contents::
+   :depth: 2
+
+
 .. _BIOGRAPHY_DATA.AnimID:
 
 AnimID (Animal IDentifier)
diff --git a/doc/src/tables/biography_log.m4 b/doc/src/tables/biography_log.m4
index 0b642e9..2d58505 100644
--- a/doc/src/tables/biography_log.m4
+++ b/doc/src/tables/biography_log.m4
@@ -30,6 +30,9 @@ BIOGRAPHY_LOG
 |BIOGRAPHY_LOG_summary|
 Changes have been logged since sdb_first_biography_log_date.
 
+.. contents::
+   :depth: 2
+
 
 .. _BIOGRAPHY_LOG.BLID:
 
diff --git a/doc/src/tables/comm_memb_log.m4 b/doc/src/tables/comm_memb_log.m4
index e0755f8..a33bce2 100644
--- a/doc/src/tables/comm_memb_log.m4
+++ b/doc/src/tables/comm_memb_log.m4
@@ -35,6 +35,9 @@ COMM_MEMB_LOG
 This is meta-information which records history concerning the state of
 the database.
 
+.. contents::
+   :depth: 2
+
 
 .. _COMM_MEMB_LOG.CommMLID:
 
diff --git a/doc/src/tables/comm_membs.m4 b/doc/src/tables/comm_membs.m4
index b49ea17..97a1f07 100644
--- a/doc/src/tables/comm_membs.m4
+++ b/doc/src/tables/comm_membs.m4
@@ -72,6 +72,9 @@ This means, the |COMM_MEMBS.EndDate| may not be after the individual's
 
 The |COMM_MEMBS.StartDate| must not be after the |COMM_MEMBS.EndDate|.
 
+.. contents::
+   :depth: 2
+
 
 .. _COMM_MEMBS.CommMID:
 
diff --git a/doc/src/tables/events.m4 b/doc/src/tables/events.m4
index 02a34e1..78787a6 100644
--- a/doc/src/tables/events.m4
+++ b/doc/src/tables/events.m4
@@ -92,6 +92,10 @@ The following table lists these rules and implications:
 ``sdb_pantgrunt`` (Pantgrunt)
    A row must exist on PANTGRUNTS.
 
+.. contents::
+   :depth: 2
+
+
 .. _EVENTS.EID:
 
 EID (Event ID)
diff --git a/doc/src/tables/follow_observers.m4 b/doc/src/tables/follow_observers.m4
index 85db67e..3b8dfe8 100644
--- a/doc/src/tables/follow_observers.m4
+++ b/doc/src/tables/follow_observers.m4
@@ -43,6 +43,10 @@ The system will generate a warning if there are multiple
 FOLLOW_OBSERVERS rows having the same |FOLLOW_OBSERVERS.Period|,
 related to a single row in |FOLLOWS|.
 
+.. contents::
+   :depth: 2
+
+
 .. _FOLLOW_OBSERVERS.FOID:
 
 FOID (Follow Observers ID)
diff --git a/doc/src/tables/follow_studies.m4 b/doc/src/tables/follow_studies.m4
index a697d96..2d36b92 100644
--- a/doc/src/tables/follow_studies.m4
+++ b/doc/src/tables/follow_studies.m4
@@ -29,6 +29,9 @@ FOLLOW_STUDIES
 
 |FOLLOW_STUDIES_summary|
 
+.. contents::
+   :depth: 2
+
 
 .. _FOLLOW_STUDIES.FSID:
 
diff --git a/doc/src/tables/follows.m4 b/doc/src/tables/follows.m4
index ddc5d8f..b501c7e 100644
--- a/doc/src/tables/follows.m4
+++ b/doc/src/tables/follows.m4
@@ -48,6 +48,9 @@ was under study, on or after the focal's |BIOGRAPHY_DATA|.\
 |BIOGRAPHY_DATA.EntryDate| and on or before the focal's
 |BIOGRAPHY_DATA|.\ |BIOGRAPHY_DATA.DepartDate|.
 
+.. contents::
+   :depth: 2
+
 
 .. _FOLLOWS.FID:
 
diff --git a/doc/src/tables/humans.m4 b/doc/src/tables/humans.m4
index a4cbbf8..ae576df 100644
--- a/doc/src/tables/humans.m4
+++ b/doc/src/tables/humans.m4
@@ -35,6 +35,10 @@ other species; the |EVENTS| row with an |EVENTS.EID| value that
 matches the HUMANS row's |HUMANS.EID| value must have an |EVENTS|\
 .|EVENTS.Behavior| value of ``sdb_other_species``.
 
+.. contents::
+   :depth: 2
+
+
 .. _HUMANS.HID:
 
 HID (Humans ID)
diff --git a/doc/src/tables/roles.m4 b/doc/src/tables/roles.m4
index 5f41a20..47c22bb 100644
--- a/doc/src/tables/roles.m4
+++ b/doc/src/tables/roles.m4
@@ -46,6 +46,10 @@ For further information on the required, and expected, relationship
 between ROLES, |EVENTS|, and other tables see the documentation of the
 |EVENTS| table.
 
+.. contents::
+   :depth: 2
+
+
 .. _ROLES.PID:
 
 PID (Participant ID)
diff --git a/doc/src/tables/species_present.m4 b/doc/src/tables/species_present.m4
index 89a9162..db94093 100644
--- a/doc/src/tables/species_present.m4
+++ b/doc/src/tables/species_present.m4
@@ -34,6 +34,10 @@ other species; the |EVENTS| row with an |EVENTS.EID| value that
 matches the SPECIES_PRESENT row's |SPECIES_PRESENT.EID| value must have an |EVENTS|\
 .|EVENTS.Behavior| value of ``sdb_other_species``.
 
+.. contents::
+   :depth: 2
+
+
 .. _SPECIES_PRESENT.OSID:
 
 OSID (Other Species ID)
-- 
2.34.1