From 4252a61d3fd66c4f2d1106d0bc223737e4a8acae Mon Sep 17 00:00:00 2001
From: Roger Leigh <[EMAIL REDACTED]>
Date: Sun, 5 Jun 2022 11:19:38 +0100
Subject: [PATCH] doc: Additional top-level tidying
---
doc/addingtags.rst | 15 ++++++---------
doc/index.rst | 14 +++++++-------
doc/{intro.rst => terms.rst} | 4 ++--
3 files changed, 15 insertions(+), 18 deletions(-)
rename doc/{intro.rst => terms.rst} (96%)
diff --git a/doc/addingtags.rst b/doc/addingtags.rst
index 0c49847b..8d190cc2 100644
--- a/doc/addingtags.rst
+++ b/doc/addingtags.rst
@@ -1,8 +1,5 @@
-Modifying The TIFF Library
-==========================
-
Defining New TIFF Tags
-----------------------
+======================
Libtiff has built-in knowledge of all the standard TIFF tags, as
well as extensions. The following describes how to add knowledge of
@@ -10,7 +7,7 @@ new tags as builtins to libtiff, or how to application specific tags can
be used by applications without modifying libtiff.
TIFFFieldInfo
-^^^^^^^^^^^^^
+-------------
How libtiff manages specific tags is primarily controlled by the
definition for that tag value stored internally as a TIFFFieldInfo structure.
@@ -107,7 +104,7 @@ definitions, including :c:func:`_TIFFFindFieldInfo`, and
list, though I don't see it off hand.
Default Tag Auto-registration
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-----------------------------
In libtiff 3.6.0 a new mechanism was introduced allowing libtiff to
read unrecognised tags automatically. When an unknown tags is encountered,
@@ -132,7 +129,7 @@ Thus, to read anonymous auto-registered tags use the following:
TIFFGetField(tif, TIFFTAG_UNKNOWN_TO_LIBTIFF, &count, &value);
Defining Application Tags
-^^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------------
For various reasons, it is common for applications to want to define
their own tags to store information outside the core TIFF specification.
@@ -225,7 +222,7 @@ call :c:func:`TIFFMergeFieldInfo` before setting new tags. The whole extender
architecture can then be avoided.
Adding New Builtin Tags
-^^^^^^^^^^^^^^^^^^^^^^^
+-----------------------
A similar approach is taken to the above. However, the :c:struct:`TIFFFieldInfo`
should be added to the :c:var:`tiffFieldInfo[]` list in :file:`tif_dirinfo.c`.
@@ -265,7 +262,7 @@ data on disk and :c:type:`t*_t` when stuff is in memory) and be careful about
passing items through printf or similar vararg interfaces.
Adding New Codec-private Tags
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-----------------------------
To add tags that are meaningful *only when a particular compression
algorithm is used* follow these steps:
diff --git a/doc/index.rst b/doc/index.rst
index a9496e13..b278f59a 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -25,11 +25,11 @@ the TIFF specification is :doc:`specification/index`.
Included in this software distribution are:
-* a library, libtiff, for reading and writing TIFF images
+* a library, :file:`libtiff`, for reading and writing TIFF images
* a small collection of tools for performing simple manipulations of TIFF images
* documentation for the library and tools.
-The libtiff library, along with associated tool programs, should handle most of
+The :file:`libtiff` library, along with associated tool programs, should handle most of
your needs for reading and writing TIFF images.
LibTIFF is portable software, supported on various operating systems including
@@ -41,15 +41,15 @@ The following sections are included in this documentation:
:maxdepth: 2
:titlesonly:
- intro
+ specification/index
+ images
+ build
+ terms
libtiff
internals
addingtags
tools
contrib
- specification/index
- build
- images
- project/index
manpages
+ project/index
releases/index
diff --git a/doc/intro.rst b/doc/terms.rst
similarity index 96%
rename from doc/intro.rst
rename to doc/terms.rst
index bdf5fd92..d20d80ed 100644
--- a/doc/intro.rst
+++ b/doc/terms.rst
@@ -1,5 +1,5 @@
-Introduction to the TIFF Documentation
-======================================
+Terminology
+===========
.. image:: images/strike.gif
:width: 128