From a87f5a628182641d78fe41b83605364a81132480 Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Thu, 14 Sep 2023 10:09:13 -0500 Subject: [PATCH] Fix footnote numbering --- doc/src/architecture/databases.m4 | 4 ++-- doc/src/architecture/special_values.m4 | 12 ++++++------ doc/src/code_tables.m4 | 26 +++++++++++++------------- doc/src/er_diagrams.m4 | 4 ++-- doc/src/intro/about_db.m4 | 4 ++-- doc/src/intro/about_doc.m4 | 16 ++++++++-------- 6 files changed, 33 insertions(+), 33 deletions(-) diff --git a/doc/src/architecture/databases.m4 b/doc/src/architecture/databases.m4 index 10c14ff..d35cc05 100644 --- a/doc/src/architecture/databases.m4 +++ b/doc/src/architecture/databases.m4 @@ -25,7 +25,7 @@ Databases --------- SokweDB utilizes at least 3 databases, each for a different purpose. -There may also be other databases available.\ [#f8]_ +There may also be other databases available.\ [#f1]_ sokwedb ``````` @@ -54,5 +54,5 @@ tested in the ``sokwedb_test`` database. .. rubric:: Footnotes -.. [#f8] Particularly during periods of heavy software development, +.. [#f1] Particularly during periods of heavy software development, there may be a separate database dedicated to each developer. diff --git a/doc/src/architecture/special_values.m4 b/doc/src/architecture/special_values.m4 index d739385..342b10b 100644 --- a/doc/src/architecture/special_values.m4 +++ b/doc/src/architecture/special_values.m4 @@ -26,7 +26,7 @@ Special Data Values ------------------- As much as possible SokweDB utilizes a controlled vocabulary within -the system's data store. To provide the system's users\ [#f10]_ with +the system's data store. To provide the system's users\ [#f1]_ with control over the codes used, this vocabulary may be tailored by adding or deleting codes to or from the tables which define the system's vocabulary. @@ -42,7 +42,7 @@ defined in support or other tables. Because these codes have intrinsic meaning, they cannot be removed from the SokweDB system nor should their presence in the data be used to code a different meaning from that which the code presently has. For example, the meaning of -|DEPARTTYPES| code value ``sdb_end_of_obs`` (alive\ [#f11]_) should +|DEPARTTYPES| code value ``sdb_end_of_obs`` (alive\ [#f2]_) should not be changed to mean “death due to meteorite impact” because the system's programs would then allow individuals to have sexual cycles after death. Each of the "special" values that the system requires @@ -56,7 +56,7 @@ adjusted to reflect the change. SokweDB prevents ordinary users from altering rows that give meaning to special values in an attempt to prevent mis-configuration of the system. Only users with permissions to modify a table's triggers may -alter the table's special values.\ [#f12]_ This is not a panacea. To +alter the table's special values.\ [#f3]_ This is not a panacea. To return to the example above, not only does the system expect a |DEPARTTYPES| code of ``sdb_end_of_obs`` to mean alive, it also expects ``sdb_end_of_obs`` to be the only code in |DEPARTTYPES| that @@ -68,10 +68,10 @@ modifying the content of tables that instantiate special values. .. rubric:: Footnotes -.. [#f10] As opposed to the system's programmers. -.. [#f11] Specifically, "still alive and present as of the last census date". +.. [#f1] As opposed to the system's programmers. +.. [#f2] Specifically, "still alive and present as of the last census date". -.. [#f12] +.. [#f3] Rather than create another role just to control the alteration of special values the choice was made to use PostgreSQL's ``TRIGGER`` privilege. This allows superusers (or the somewhat less diff --git a/doc/src/code_tables.m4 b/doc/src/code_tables.m4 index 4fa23e3..2bd8015 100644 --- a/doc/src/code_tables.m4 +++ b/doc/src/code_tables.m4 @@ -198,7 +198,7 @@ PEOPLE must have a row representing them in this table. Note that, for reasons of simplicity and performance, SokweDB accepts -only the ASCII character set.\ [#f14]_ (Those characters found on a +only the ASCII character set.\ [#f1]_ (Those characters found on a standard U.S. keyboard.) @@ -267,15 +267,15 @@ appearing in new data. .. rubric:: Footnotes -.. [#f14] The database could accept the full-set of Unicode characters, - providing glyphs for all languages and cultures as well as a - full set of emoji. And if collation (sorting) was - configured so as *not* to support language and cultural - conventions then there would be no performance impact. - - But this would allow, say, chimpanzees to be named with - Chinese ideographic glyphs, allowing arbitrary glyphs to be - used anywhere text might appear. Because this is not - desired we would need to institute additional controls to - keep the data clean. It is simpler to live with the ASCII - character set when it comes to recording people's names. +.. [#f1] The database could accept the full-set of Unicode characters, + providing glyphs for all languages and cultures as well as a + full set of emoji. And if collation (sorting) was configured + so as *not* to support language and cultural conventions then + there would be no performance impact. + + But this would allow, say, chimpanzees to be named with + Chinese ideographic glyphs, allowing arbitrary glyphs to be used + anywhere text might appear. Because this is not desired we + would need to institute additional controls to keep the data + clean. It is simpler to live with the ASCII character set + when it comes to recording people's names. diff --git a/doc/src/er_diagrams.m4 b/doc/src/er_diagrams.m4 index df8ce29..b55351a 100644 --- a/doc/src/er_diagrams.m4 +++ b/doc/src/er_diagrams.m4 @@ -48,7 +48,7 @@ understanding immediately. When an id value of a row in one table appears as data in a second table, the data in the second table can be used to retrieve the -identified row from the first table.\ [#f9]_ When an id value of a row +identified row from the first table.\ [#f1]_ When an id value of a row in the first table appears as data only once in the second table, the two tables are said to have a one-to-one relationship. One row in the first table relates to one (or possibly zero) row(s) in the second @@ -82,5 +82,5 @@ individual transferring also exists. .. rubric:: Footnotes -.. [#f9] And the reverse is true. The id of a row in the first table +.. [#f1] And the reverse is true. The id of a row in the first table can be used to find the row in the second table that holds it. diff --git a/doc/src/intro/about_db.m4 b/doc/src/intro/about_db.m4 index 1beb472..1523128 100644 --- a/doc/src/intro/about_db.m4 +++ b/doc/src/intro/about_db.m4 @@ -138,7 +138,7 @@ data upload to do analysis. About Schemas ````````````` -Schemas partition databases.\ [#f7]_ \ [#f2]_ They work like +Schemas partition databases.\ [#f1]_ \ [#f2]_ They work like directories or folders do in filesystems, but can be only one level deep. A schema cannot contain another schema. @@ -148,7 +148,7 @@ schemas. .. rubric:: Footnotes -.. [#f7] The term "schema" is overloaded. A separate meaning defines +.. [#f1] The term "schema" is overloaded. A separate meaning defines a schema as the tables, columns and relationships between tables that exist within a database. So a schema can denote the design of a particular database. diff --git a/doc/src/intro/about_doc.m4 b/doc/src/intro/about_doc.m4 index 9508ab6..5621fd0 100644 --- a/doc/src/intro/about_doc.m4 +++ b/doc/src/intro/about_doc.m4 @@ -45,7 +45,7 @@ which also speaks to the conventions of the overall database design. There are a number of conventions regarding character case. The database is case insensitive when it comes to the names used to -identify content -- table names and column names and so forth.\ [#f6]_ +identify content -- table names and column names and so forth.\ [#f2]_ Within this document schema names are written with an initial capital letter, table and view names are written in all upper case, and column names are written with initial capital letters. @@ -54,14 +54,14 @@ Unless otherwise noted all columns must contain a value. Note that an empty string, the series of characters consisting of zero characters, is a value. -The empty string\ [#f4]_ is a string and so it is +The empty string\ [#f3]_ is a string and so it is reasonable to compare it with other non-empty strings. The empty -string is distinct from |null|\ [#f5]_, which means "no +string is distinct from |null|\ [#f4]_, which means "no information", and is used when there is no value/no data at all. Data consistency is guaranteed only when the guarantee is explicitly -mentioned.\ [#f15]_ Care must be taken when updating data unless there +mentioned.\ [#f5]_ Care must be taken when updating data unless there is an explicit guarantee of data consistently. This document uses a particular vocabulary, which informs the table @@ -88,14 +88,14 @@ query relates multiple tables. .. [#f1] The wiki, found at https://sokwe.janegoodall.org/, is a good place to document day-to-day procedures and practices. -.. [#f6] To be precise, *unless special steps are taken* the database, +.. [#f2] To be precise, *unless special steps are taken* the database, and SQL, is case-insensitive when it comes to names. -.. [#f4] Written ``''`` in SQL. +.. [#f3] Written ``''`` in SQL. -.. [#f5] Written |null| in SQL. +.. [#f4] Written |null| in SQL. -.. [#f15] The notations in the :ref:`erdiagrams` are dense in +.. [#f5] The notations in the :ref:`erdiagrams` are dense in constraints, constraints built into the database, which ensure data integrity. -- 2.34.1