From 0737d0dbf74d7107ebb3dd2358f68cd3f2944094 Mon Sep 17 00:00:00 2001 From: Allen Byrne <50328838+byrnHDF@users.noreply.github.com> Date: Thu, 12 Sep 2024 22:46:58 -0500 Subject: [PATCH] Correct URLs in documentation (#4823) --- CITATION.cff | 2 +- HDF5Examples/README.md | 30 +++++++++---------- config/cmake/README.md.cmake.in | 2 +- doc/parallel-compression.md | 6 ++-- doxygen/aliases | 10 +++---- doxygen/dox/IntroHDF5.dox | 1 - doxygen/dox/LearnBasics3.dox | 28 ++++++----------- doxygen/dox/LearnHDFView.dox | 2 +- doxygen/dox/VOLConnGuide.dox | 4 +-- doxygen/hdf5doxy_layout.xml | 6 ++-- hl/src/H5DOpublic.h | 2 +- hl/src/H5DSpublic.h | 4 +-- hl/src/H5LTpublic.h | 2 +- java/src/hdf/overview.html | 2 +- release_docs/INSTALL | 2 +- release_docs/INSTALL_Autotools.txt | 4 +-- release_docs/INSTALL_parallel | 2 +- release_docs/RELEASE.txt | 6 ++-- release_docs/RELEASE_PROCESS.md | 4 +-- src/H5Ppublic.h | 14 ++++----- src/H5VLmodule.h | 2 +- src/H5module.h | 2 +- tools/src/h5dump/h5dump.c | 7 ++--- tools/src/h5dump/h5dump.h | 6 ++-- tools/test/h5dump/expected/h5dump-help.txt | 2 +- .../pbits/tnofilename-with-packed-bits.ddl | 2 +- .../expected/pbits/tpbitsIncomplete.ddl | 2 +- .../expected/pbits/tpbitsLengthExceeded.ddl | 2 +- .../expected/pbits/tpbitsLengthPositive.ddl | 2 +- .../expected/pbits/tpbitsMaxExceeded.ddl | 2 +- .../expected/pbits/tpbitsOffsetExceeded.ddl | 2 +- .../expected/pbits/tpbitsOffsetNegative.ddl | 2 +- 32 files changed, 76 insertions(+), 90 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index f7eaf133318..c96341f138c 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -9,4 +9,4 @@ authors: website: 'https://www.hdfgroup.org' repository-code: 'https://github.com/HDFGroup/hdf5' url: 'https://www.hdfgroup.org/HDF5/' -repository-artifact: 'https://support.hdfgroup.org/downloads/HDF5' +repository-artifact: 'https://support.hdfgroup.org/downloads/index.html' diff --git a/HDF5Examples/README.md b/HDF5Examples/README.md index c1a27d5fb12..82b3cfec46d 100644 --- a/HDF5Examples/README.md +++ b/HDF5Examples/README.md @@ -9,9 +9,7 @@ in science, engineering, and research communities worldwide. The HDF Group is the developer, maintainer, and steward of HDF5 software. Find more information about The HDF Group, the HDF5 Community, and other HDF5 software projects, -tools, and services at The HDF Group's website. - - https://www.hdfgroup.org/ +tools, and services at [The HDF Group's website](https://www.hdfgroup.org/). @@ -19,44 +17,44 @@ HELP AND SUPPORT ---------------- Information regarding Help Desk and Support services is available at - https://hdfgroup.atlassian.net/servicedesk/customer/portals + https://help.hdfgroup.org FORUM and NEWS -------------- -The following public forums are provided for public announcements and discussions +The [HDF Forum](https://forum.hdfgroup.org) is provided for public announcements and discussions of interest to the general HDF5 Community. - - Homepage of the Forum - https://forum.hdfgroup.org - - - News and Announcement + - News and Announcements https://forum.hdfgroup.org/c/news-and-announcements-from-the-hdf-group - - HDF5 and HDF4 Topics + - HDF5 Topics https://forum.hdfgroup.org/c/hdf5 These forums are provided as an open and public service for searching and reading. Posting requires completing a simple registration and allows one to join in the -conversation. Please read the following instructions pertaining to the Forum's -use and configuration - https://forum.hdfgroup.org/t/quickstart-guide-welcome-to-the-new-hdf-forum +conversation. Please read the [instructions](https://forum.hdfgroup.org/t/quickstart-guide-welcome-to-the-new-hdf-forum +) pertaining to the Forum's use and configuration. HDF5 SNAPSHOTS, PREVIOUS RELEASES AND SOURCE CODE -------------------------------------------- Full Documentation and Programming Resources for this HDF5 can be found at - https://support.hdfgroup.org/documentation/hdf5/index.html + https://support.hdfgroup.org/documentation/index.html Periodically development code snapshots are provided at the following URL: - https://github.com/HDFGroup/hdf5/releases + https://github.com/HDFGroup/hdf5/releases/tag/snapshot Source packages for current and previous releases are located at: - https://support.hdfgroup.org/releases/hdf5/downloads/ + hdf5 1.14 releases: + https://support.hdfgroup.org/releases/hdf5/v1_14/index.html + + Archived releases: + https://support.hdfgroup.org/archive/support/ftp/HDF5/releases/index.html Development code is available at our Github location: diff --git a/config/cmake/README.md.cmake.in b/config/cmake/README.md.cmake.in index 3f541e4e8a3..40294c15255 100644 --- a/config/cmake/README.md.cmake.in +++ b/config/cmake/README.md.cmake.in @@ -75,6 +75,6 @@ For more information see USING_CMake_Examples.txt in the install folder. =========================================================================== Documentation for this release can be found at the following URL: - https://support.hdfgroup.org/hdf5/@HDF5_PACKAGE_NAME@-@HDF5_PACKAGE_VERSION@/documentation/doxygen/index.html + https://support.hdfgroup.org/releases/hdf5/@${H5_VERS_MAJOR}@_@${H5_VERS_MINOR}@/@${H5_VERS_MAJOR}@_@${H5_VERS_MINOR}@_@${H5_VERS_RELEASE}@/documentation/doxygen/index.html Bugs should be reported to help@hdfgroup.org. diff --git a/doc/parallel-compression.md b/doc/parallel-compression.md index 0d16c448e65..9879f6efc91 100644 --- a/doc/parallel-compression.md +++ b/doc/parallel-compression.md @@ -340,9 +340,9 @@ hid_t file_id = H5Fcreate("file.h5", H5F_ACC_TRUNC, H5P_DEFAULT, fapl_id); [u5]: https://hdfgroup.github.io/hdf5/develop/group___d_c_p_l.html#ga85faefca58387bba409b65c470d7d851 [u6]: https://hdfgroup.github.io/hdf5/develop/group___d_c_p_l.html#ga4335bb45b35386daa837b4ff1b9cd4a4 [u7]: https://hdfgroup.github.io/hdf5/develop/group___d_c_p_l.html#ga6bd822266b31f86551a9a1d79601b6a2 -[u8]: https://support.hdfgroup.org/documentation/hdf5/parallel-compression-improvements-in-hdf5-1-13-1 -[u9]: https://support.hdfgroup.org/documentation/hdf5/chunking_in_hdf5.html -[u10]: https://support.hdfgroup.org/documentation/hdf5/technotes/TechNote-HDF5-ImprovingIOPerformanceCompressedDatasets.pdf +[u8]: https://www.hdfgroup.org/2022/03/04/parallel-compression-improvements-in-hdf5-1-13-1/ +[u9]: https://support.hdfgroup.org/releases/hdf5/documentation/advanced_topics/chunking_in_hdf5.md +[u10]: https://support.hdfgroup.org/releases/hdf5/documentation/hdf5_topics/HDF5ImprovingIOPerformanceCompressedDatasets.pdf [u11]: https://hdfgroup.github.io/hdf5/develop/group___f_a_p_l.html#gab99d5af749aeb3896fd9e3ceb273677a [u12]: https://hdfgroup.github.io/hdf5/develop/group___f_c_p_l.html#ga167ff65f392ca3b7f1933b1cee1b9f70 [u13]: https://hdfgroup.github.io/hdf5/develop/group___f_c_p_l.html#gad012d7f3c2f1e1999eb1770aae3a4963 diff --git a/doxygen/aliases b/doxygen/aliases index 831ec7786b1..3c79b179df0 100644 --- a/doxygen/aliases +++ b/doxygen/aliases @@ -258,13 +258,13 @@ ALIASES += sa_metadata_ops="\sa \li H5Pget_all_coll_metadata_ops() \li H5Pget_co ALIASES += ref_cons_semantics="Enabling a Strict Consistency Semantics Model in Parallel HDF5" ALIASES += ref_file_image_ops="HDF5 File Image Operations" -ALIASES += ref_filter_pipe="Data Flow Pipeline for H5Dread()" +ALIASES += ref_filter_pipe="Data Flow Pipeline for H5Dread()" ALIASES += ref_group_impls="Group implementations in HDF5" ALIASES += ref_h5lib_relver="HDF5 Library Release Version Numbers" -ALIASES += ref_mdc_in_hdf5="Metadata Caching in HDF5" -ALIASES += ref_mdc_logging="Metadata Cache Logging" -ALIASES += ref_news_112="New Features in HDF5 Release 1.12" -ALIASES += ref_h5ocopy="Copying Committed Datatypes with H5Ocopy()" +ALIASES += ref_mdc_in_hdf5="Metadata Caching in HDF5" +ALIASES += ref_mdc_logging="Metadata Cache Logging" +ALIASES += ref_news_112="New Features in HDF5 Release 1.12" +ALIASES += ref_h5ocopy="Copying Committed Datatypes with H5Ocopy()" ALIASES += ref_sencode_fmt_change="RFC H5Sencode() / H5Sdecode() Format Change" ALIASES += ref_vlen_strings="\Emph{Creating variable-length string datatypes}" ALIASES += ref_vol_doc="VOL documentation" diff --git a/doxygen/dox/IntroHDF5.dox b/doxygen/dox/IntroHDF5.dox index 6f3938ed8b2..acb497120da 100644 --- a/doxygen/dox/IntroHDF5.dox +++ b/doxygen/dox/IntroHDF5.dox @@ -617,7 +617,6 @@ on the HDF-EOS Tools and Information Center pag \li \ref LBExamples \li \ref ExAPI \li Examples in the Source Code -\li Other Examples \section secHDF5ExamplesCompile How To Compile For information on compiling in C, C++ and Fortran, see: \ref LBCompiling diff --git a/doxygen/dox/LearnBasics3.dox b/doxygen/dox/LearnBasics3.dox index d853c83d742..13cb4f43abd 100644 --- a/doxygen/dox/LearnBasics3.dox +++ b/doxygen/dox/LearnBasics3.dox @@ -181,9 +181,9 @@ created the dataset layout cannot be changed. The h5repack utility can be used t to a new with a new layout. \section secLBDsetLayoutSource Sources of Information -Chunking in HDF5 -(See the documentation on Advanced Topics in HDF5) -see \ref sec_plist in the HDF5 \ref UG. +Chunking in HDF5 +(See the documentation on Advanced Topics in HDF5) +\see \ref sec_plist in the HDF5 \ref UG.
Previous Chapter \ref LBPropsList - Next Chapter \ref LBExtDset @@ -201,7 +201,7 @@ certain initial dimensions, then to later increase the size of any of the initia HDF5 requires you to use chunking to define extendible datasets. This makes it possible to extend datasets efficiently without having to excessively reorganize storage. (To use chunking efficiently, -be sure to see the advanced topic, Chunking in HDF5.) +be sure to see the advanced topic, Chunking in HDF5.) The following operations are required in order to extend a dataset: \li Declare the dataspace of the dataset to have unlimited dimensions for all dimensions that might eventually be extended. @@ -243,7 +243,7 @@ Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics \section secLBComDsetCreate Creating a Compressed Dataset HDF5 requires you to use chunking to create a compressed dataset. (To use chunking efficiently, -be sure to see the advanced topic, Chunking in HDF5.) +be sure to see the advanced topic, Chunking in HDF5.) The following operations are required in order to create a compressed dataset: \li Create a dataset creation property list. @@ -251,7 +251,7 @@ The following operations are required in order to create a compressed dataset: \li Create the dataset. \li Close the dataset creation property list and dataset. -For more information on compression, see the FAQ question on Using Compression in HDF5. +For more information on compression, see the FAQ question on Using Compression in HDF5. \section secLBComDsetProg Programming Example @@ -968,8 +968,7 @@ or on WINDOWS you may need to add the path to the bin folder to PATH. \section secLBCompilingCMake Compiling an Application with CMake \subsection subsecLBCompilingCMakeScripts CMake Scripts for Building Applications -Simple scripts are provided for building applications with different languages and options. -See CMake Scripts for Building Applications. +See Using CMake to Build Applications to build applications with different languages and options. For a more complete script (and to help resolve issues) see the script provided with the HDF5 Examples project. @@ -977,7 +976,7 @@ For a more complete script (and to help resolve issues) see the script provided The installed HDF5 can be verified by compiling the HDF5 Examples project, included with the CMake built HDF5 binaries in the share folder or you can go to the HDF5 Examples in the HDF5 github repository. -Go into the share directory and follow the instructions in USING_CMake_examples.txt to build the examples. +Go into the share directory and follow the instructions in Using CMake to Build Examples to build the examples. In general, users must first set the HDF5_ROOT environment variable to the installed location of the CMake configuration files for HDF5. For example, on Windows the following path might be set: @@ -1031,17 +1030,8 @@ For example, on Unix the log files will be in: There are log files for the configure, test, and build.
-Previous Chapter \ref LBQuizAnswers - Next Chapter \ref LBTraining +Previous Chapter \ref LBQuizAnswers Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics -@page LBTraining Training Videos - -Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics - -Training Videos - -
-Navigate back: \ref index "Main" / \ref GettingStarted / \ref LearnBasics - */ diff --git a/doxygen/dox/LearnHDFView.dox b/doxygen/dox/LearnHDFView.dox index cfe11e19137..2a1ed610ef2 100644 --- a/doxygen/dox/LearnHDFView.dox +++ b/doxygen/dox/LearnHDFView.dox @@ -246,7 +246,7 @@ in the file). Please note that the chunk sizes used in this topic are for demonstration purposes only. For information on chunking and specifying an appropriate chunk size, see the -Chunking in HDF5 documentation. +Chunking in HDF5 documentation. Also see the HDF5 Tutorial topic on \ref secLBComDsetCreate.