From 963b9288456a49936b1ff6ecf94841be58aafce0 Mon Sep 17 00:00:00 2001
From: Roger Leigh <[EMAIL REDACTED]>
Date: Sun, 5 Jun 2022 09:24:20 +0100
Subject: [PATCH] doc: Move TIFF specification and design notes into
subdirectory
---
doc/index.rst | 7 ++-----
.../bigtiff.rst} | 0
.../coverage.rst} | 8 +++----
doc/{document.rst => specification/index.rst} | 21 +++++++++++++------
.../technote2.rst} | 0
5 files changed, 21 insertions(+), 15 deletions(-)
rename doc/{bigtiffdesign.rst => specification/bigtiff.rst} (100%)
rename doc/{support.rst => specification/coverage.rst} (98%)
rename doc/{document.rst => specification/index.rst} (65%)
rename doc/{TIFFTechNote2.rst => specification/technote2.rst} (100%)
diff --git a/doc/index.rst b/doc/index.rst
index 9f5cc2bc..803fa854 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -21,7 +21,7 @@ LibTIFF - TIFF Library and Utilities
This software provides support for the *Tag Image File Format* (TIFF),
a widely used format for storing image data. The latest version of
-the TIFF specification is :doc:`document`
+the TIFF specification is :doc:`specification/index`
available on-line in several different formats.
Included in this software distribution is a library, libtiff, for
@@ -62,14 +62,12 @@ The following sections are included in this documentation:
:titlesonly:
intro
- support
libtiff
internals
addingtags
tools
contrib
- document
- TIFFTechNote2
+ specification/index
build
bugs
images
@@ -77,5 +75,4 @@ The following sections are included in this documentation:
manpages
releases/index
BigTIFFProposal
- bigtiffdesign
bigtiffpr
diff --git a/doc/bigtiffdesign.rst b/doc/specification/bigtiff.rst
similarity index 100%
rename from doc/bigtiffdesign.rst
rename to doc/specification/bigtiff.rst
diff --git a/doc/support.rst b/doc/specification/coverage.rst
similarity index 98%
rename from doc/support.rst
rename to doc/specification/coverage.rst
index 1ddea5ee..bf139505 100644
--- a/doc/support.rst
+++ b/doc/specification/coverage.rst
@@ -1,5 +1,5 @@
-TIFF 6.0 Specification Coverage
-===============================
+LibTIFF Coverage of the TIFF 6.0 Specification
+==============================================
The library is capable of dealing with images that are written to
follow the 5.0 or 6.0 TIFF spec. There is also considerable support
@@ -567,9 +567,9 @@ tag (also non-standard, but registered) can be used to specified a
subvolume "tiling" of a volume of data.
The Colorimetry, and CMYK tags are additions that appear in TIFF 6.0.
-Consult the TIFF 6.0 specification and :ref:`document`.
+Consult the TIFF 6.0 specification and :doc:`index`.
The JPEG-related tag is specified in
-:ref:`TIFFTechNote2`, which defines
+:doc:`technote2`, which defines
a revised JPEG-in-TIFF scheme (revised over the appendix that was
part of the TIFF 6.0 specification).
diff --git a/doc/document.rst b/doc/specification/index.rst
similarity index 65%
rename from doc/document.rst
rename to doc/specification/index.rst
index e1a9c1d0..94bde77d 100644
--- a/doc/document.rst
+++ b/doc/specification/index.rst
@@ -1,7 +1,7 @@
-TIFF Documentation
-==================
+TIFF File Format Specification
+==============================
-.. image:: images/jim.gif
+.. image:: ../images/jim.gif
:width: 139
:alt: jim
@@ -10,7 +10,7 @@ A copy of the 6.0 specification is available from Adobe at
or from the libtiff
ftp site at `<https://download.osgeo.org/libtiff/doc/TIFF6.pdf>`_.
-Draft :doc:`TIFFTechNote2` covers problems
+Draft :doc:`technote2` covers problems
with the TIFF 6.0 design for embedding JPEG-compressed data in TIFF, and
describes an alternative.
@@ -24,5 +24,14 @@ definitions. It is available online at
There is a FAQ, related both to TIFF format and libtiff library:
`<http://www.awaresystems.be/imaging/tiff/faq.html>`_.
-There is a preliminary :ref:`bigtiffdesign` for
-a TIFF variation supporting files larger than 4GB.
+A design for a TIFF variation supporting files larger than 4GB is detailed in :doc:`bigtiff`.
+
+The LibTIFF coverage of the TIFF 6.0 specification is detailed in :doc:`coverage`.
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ technote2
+ bigtiff
+ coverage
diff --git a/doc/TIFFTechNote2.rst b/doc/specification/technote2.rst
similarity index 100%
rename from doc/TIFFTechNote2.rst
rename to doc/specification/technote2.rst