Add navigate chapters and use release_docs in Learn Basics (HDFGroup#…

…4441)
bmribler · Apr 29, 2024 · 667b607 · 667b607
1 parent 1d3b224
commit 667b607
Show file tree

Hide file tree

Showing 8 changed files with 1,013 additions and 8 deletions.
diff --git a/configure.ac b/configure.ac
@@ -1543,7 +1543,7 @@ if test "X$HDF5_DOXYGEN" = "Xyes"; then
   DOXYGEN_OPTIMIZE_OUTPUT_FOR_C=YES
   DOXYGEN_MACRO_EXPANSION=YES
   DOXYGEN_OUTPUT_DIRECTORY=hdf5lib_docs
-  DOXYGEN_EXAMPLES_DIRECTORY='$(SRCDIR)/doxygen/dox/cookbook $(SRCDIR)/doxygen/examples $(SRCDIR)/src $(SRCDIR)/examples $(SRCDIR)/test'
+  DOXYGEN_EXAMPLES_DIRECTORY='$(SRCDIR)/doxygen/dox/cookbook $(SRCDIR)/doxygen/examples $(SRCDIR)/src $(SRCDIR)/release_docs $(SRCDIR)/test'
   DOXYGEN_LAYOUT_FILE='$(SRCDIR)/doxygen/hdf5doxy_layout.xml'
   DOXYGEN_HTML_HEADER='$(SRCDIR)/doxygen/hdf5_header.html'
   DOXYGEN_HTML_FOOTER='$(SRCDIR)/doxygen/hdf5_footer.html'

diff --git a/doxygen/CMakeLists.txt b/doxygen/CMakeLists.txt
@@ -17,7 +17,7 @@ if (DOXYGEN_FOUND)
   set (DOXYGEN_OPTIMIZE_OUTPUT_FOR_C YES)
   set (DOXYGEN_MACRO_EXPANSION YES)
   set (DOXYGEN_OUTPUT_DIRECTORY ${HDF5_BINARY_DIR}/hdf5lib_docs)
-  set (DOXYGEN_EXAMPLES_DIRECTORY "${HDF5_DOXYGEN_DIR}/dox/cookbook ${HDF5_DOXYGEN_DIR}/examples ${HDF5_SRC_DIR} ${HDF5_SOURCE_DIR}/examples ${HDF5_TEST_SRC_DIR}")
+  set (DOXYGEN_EXAMPLES_DIRECTORY "${HDF5_DOXYGEN_DIR}/dox/cookbook ${HDF5_DOXYGEN_DIR}/examples ${HDF5_SRC_DIR} ${HDF5_SOURCE_DIR}/release_docs ${HDF5_TEST_SRC_DIR}")
   set (DOXYGEN_LAYOUT_FILE ${HDF5_DOXYGEN_DIR}/hdf5doxy_layout.xml)
   set (DOXYGEN_HTML_HEADER ${HDF5_DOXYGEN_DIR}/hdf5_header.html)
   set (DOXYGEN_HTML_FOOTER ${HDF5_DOXYGEN_DIR}/hdf5_footer.html)

diff --git a/doxygen/dox/LearnBasics1.dox b/doxygen/dox/LearnBasics1.dox
@@ -21,6 +21,9 @@ directories and files, an HDF5 object in an HDF5 file is often referred to by it
 
 \li <code style="background-color:whitesmoke;">/foo/zoo</code>  signifies a member of the group foo, which in turn is a member of the root group.
 
+<hr>
+Next Chapter \ref LBAPI
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 @page LBAPI The HDF5 API
@@ -135,6 +138,9 @@ The APIs are listed below:
 </tr>
 </table>
 
+<hr>
+Previous Chapter \ref LBFileOrg - Next Chapter \ref LBProg
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 @page LBProg Programming Issues
@@ -203,6 +209,9 @@ Java:     Add <code>"import hdf.hdf5lib.H5;
 </li>
 </ul>
 
+<hr>
+Previous Chapter \ref LBAPI - Next Chapter \ref LBFileCreate
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 @page LBFileCreate Creating an HDF5 File
@@ -395,6 +404,9 @@ The simplified DDL for file definition is as follows:
         <group_member> ::= <group> | <dataset>
 \endcode
 
+<hr>
+Previous Chapter \ref LBProg - Next Chapter \ref LBDsetCreate
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 @page LBDsetCreate Creating a Dataset
@@ -712,6 +724,9 @@ The following is the simplified DDL dataset definition:
 \endcode
 
 <hr>
+
+Previous Chapter \ref LBFileCreate - Next Chapter \ref LBDsetRW
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 @page LBDsetRW Reading From and Writing To a Dataset
@@ -852,6 +867,8 @@ Shown below is the contents of dsetf.h5 (created by the FORTRAN program).
 \endcode
 
 <hr>
+Previous Chapter \ref LBDsetCreate - Next Chapter \ref LBAttrCreate
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 @page LBAttrCreate Creating an Attribute
@@ -1018,6 +1035,8 @@ ATTRIBUTE "attr" {
 \endcode
 
 <hr>
+Previous Chapter \ref LBDsetRW - Next Chapter \ref LBGrpCreate
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 */
diff --git a/doxygen/dox/LearnBasics2.dox b/doxygen/dox/LearnBasics2.dox
@@ -63,6 +63,8 @@ GROUP "/" {
 \endcode
 
 <hr>
+Previous Chapter \ref LBAttrCreate - Next Chapter \ref LBGrpCreateNames
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 @page LBGrpCreateNames Creating Groups using Absolute and Relative Names
@@ -189,6 +191,8 @@ GROUP "/" {
 \endcode
 
 <hr>
+Previous Chapter \ref LBGrpCreate - Next Chapter \ref LBGrpDset
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 @page LBGrpDset Creating Datasets in Groups
@@ -298,6 +302,8 @@ DATASET "dset1" {
 \endcode
 
 <hr>
+Previous Chapter \ref LBGrpCreateNames - Next Chapter \ref LBDsetSubRW
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 @page LBDsetSubRW Reading From or Writing To a Subset of a Dataset
@@ -477,6 +483,8 @@ example code. The memory dataspace was defined as one-dimensional.
 for these parameters, rather than passing in an array for each, and for Fortran 90 you can omit these parameters.
 
 <hr>
+Previous Chapter \ref LBGrpDset - Next Chapter \ref LBDatatypes
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 @page LBDatatypes Datatype Basics
@@ -1159,6 +1167,8 @@ If nested VL datatypes were used to create the buffer, this routine frees them f
 releasing all the memory without creating memory leaks.
 
 <hr>
+Previous Chapter \ref LBDsetSubRW - Next Chapter \ref LBPropsList
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 */
diff --git a/doxygen/dox/LearnBasics3.dox b/doxygen/dox/LearnBasics3.dox
@@ -39,6 +39,8 @@ list of the property types.
 \li Close the property list when done, using #H5Pclose.
 
 <hr>
+Previous Chapter \ref LBDatatypes - Next Chapter \ref LBDsetLayout
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 @page LBDsetLayout Dataset Storage Layout
@@ -171,6 +173,8 @@ to a new with a new layout.
 \see \ref sec_plist in the HDF5 \ref UG.
 
 <hr>
+Previous Chapter \ref LBPropsList - Next Chapter \ref LBExtDset
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 
@@ -216,6 +220,8 @@ after this call, the dataset's dataspace must be refreshed with #H5Dget_space be
 \li Once there is no longer a need for a Property List instance, it should be closed with the #H5Pclose call.
 
 <hr>
+Previous Chapter \ref LBDsetLayout - Next Chapter \ref LBComDset
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 @page LBComDset Compressed Datasets
@@ -258,6 +264,8 @@ to #H5Dcreate will fail if attempting to create an SZIP compressed dataset with
 The conflict can only be detected when the property list is used.
 
 <hr>
+Previous Chapter \ref LBExtDset - Next Chapter \ref LBContents
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 @page LBContents Discovering the Contents of an HDF5 File
@@ -302,6 +310,8 @@ The h5ex_g_visit example traverses a file using H5Ovisit and H5Lvisit:
 \li F90:  <a href="https://\SRCURL/HDF5Examples/FORTRAN/H5G/h5ex_g_visit.F90">h5ex_g_visit_F03.f90</a>
 
 <hr>
+Previous Chapter \ref LBComDset - Next Chapter \ref LBQuiz
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 @page LBQuiz Learning the basics QUIZ
@@ -398,6 +408,8 @@ is in the <code style="background-color:whitesmoke;">root</code> group. How woul
 </ol>
 
 <hr>
+Previous Chapter \ref LBContents - Next Chapter \ref LBQuizAnswers
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 @page LBQuizAnswers Learning the basics QUIZ with Answers
@@ -691,6 +703,8 @@ did = H5Dopen (file_id, "/foo/boo/moo"); /* absolute path */
 </ol>
 
 <hr>
+Previous Chapter \ref LBQuiz - Next Chapter \ref LBCompiling
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 /** @page LBCompiling Compiling HDF5 Applications
@@ -747,6 +761,9 @@ The h5cc, h5c++, and h5fc compile scripts come with the HDF5 binary distribution
 libraries, and utilities) for the platforms we support. The h5c++ and h5fc utilities are ONLY present
 if the library was built with C++ and Fortran.
 
+<h4>USING_HDF5_CMake.txt:</h4>
+\verbinclude USING_HDF5_CMake.txt
+
 \section secLBCompilingVS Using Visual Studio
 
    1. If you are building on 64-bit Windows, find the "Platform" dropdown
@@ -811,7 +828,7 @@ HDF5 C Library
 \code
 libhdf5_hl_cpp.a
 libhdf5_cpp.a
-libhdf5hl_fortran.a
+libhdf5_hl_fortran.a
 libhdf5_fortran.a
 libhdf5_hl.a
 libhdf5.a
@@ -821,7 +838,7 @@ libhdf5.a
 \code
 libhdf5_hl_cpp.a
 libhdf5_cpp.a
-libhdf5hl_fortran.a
+libhdf5_hl_fortran.a
 libhdf5_fortran.a
 libhdf5_hl.a
 libhdf5.a
@@ -832,7 +849,7 @@ libhdf5.a
 \code
 libhdf5_hl_cpp.lib
 libhdf5_cpp.lib
-libhdf5hl_fortran.lib
+libhdf5_hl_fortran.lib
 libhdf5_fortran.lib
 libhdf5_hl.lib
 libhdf5.lib
@@ -863,7 +880,7 @@ HDF5 C Library
 \code
 libhdf5_hl_cpp.so
 libhdf5_cpp.so
-libhdf5hl_fortran.so
+libhdf5_hl_fortran.so
 libhdf5_fortran.so
 libhdf5_hl.so
 libhdf5.so
@@ -873,7 +890,7 @@ libhdf5.so
 \code
 libhdf5_hl_cpp.dylib
 libhdf5_cpp.dylib
-libhdf5hl_fortran.dylib
+libhdf5_hl_fortran.dylib
 libhdf5_fortran.dylib
 libhdf5_hl.dylib
 libhdf5.dylib
@@ -883,7 +900,7 @@ libhdf5.dylib
 \code
 hdf5_hl_cpp.lib
 hdf5_cpp.lib
-hdf5hl_fortran.lib
+hdf5_hl_fortran.lib
 hdf5_fortran.lib
 hdf5_hl.lib
 hdf5.lib
@@ -1001,6 +1018,8 @@ For example, on Unix the log files will be in:
 There are log files for the configure, test, and build. 
 
 <hr>
+Previous Chapter \ref LBQuizAnswers - Next Chapter \ref LBTraining
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 */

diff --git a/doxygen/dox/TrainingVideos.dox b/doxygen/dox/TrainingVideos.dox
@@ -40,6 +40,8 @@ Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 </table>
 
 <hr>
+Previous Chapter \ref LBCompiling
+
 Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics
 
 */