From b130dbabf545fd5913356f87725344b609694ffe Mon Sep 17 00:00:00 2001 From: Carl Wilson Date: Wed, 29 May 2024 14:16:00 +0100 Subject: [PATCH] FEAT: Site documentation tool versions - added `docs/_data/vars.yml` with template details, e.g.: - ViPER release details; - tool versions; and - guest OS details. - used template vars to add dynamic variables to the index page and the tools page. --- docs/_config.yml | 12 ++++++++++++ docs/_data/vars.yml | 14 ++++++++++++++ docs/index.md | 4 ++-- docs/tools/index.md | 20 ++++++++++---------- 4 files changed, 38 insertions(+), 12 deletions(-) create mode 100644 docs/_config.yml create mode 100644 docs/_data/vars.yml diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..b3c8075 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,12 @@ +github: [metadata] +encoding: UTF-8 +kramdown: + input: GFM + hard_wrap: false +future: true +jailed: false +repository: openpreserve/ViPER +plugins: +- jekyll-github-metadata +- jekyll-sitemap +- jemoji diff --git a/docs/_data/vars.yml b/docs/_data/vars.yml new file mode 100644 index 0000000..c7f4597 --- /dev/null +++ b/docs/_data/vars.yml @@ -0,0 +1,14 @@ +version: "1.2-RC1" +release_date: "31.05.2024" +guest_os: "Debian" +guest_os_version: "12" +guest_os_nickname: "Bookworm" +droid_version: "6.7.0" +jhove_version: "1.28.0" +verapdf_version: "1.26.2" +tika_version: "2.9.2" +handbrake_version: "1.6.1" +mediainfo_version: "24.04" +mediaconch_version: "23.10" +inkscape_version: "1.2.2" +gimp_version: "2.10.34" \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 8bdc17c..f8c5d62 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,9 +4,9 @@ title: Home --- ![ViPER logo](../assets/img/viper-logo.png "ViPER logo") -
Download
ViPER 1.1
+
Download
ViPER {{ site.data.vars.version }}
-Developed in collaboration with the Dutch Digital Heritage Network, ViPER is an easy-to-install virtual machine running popular open source preservation tools with graphical user interfaces: DROID, HandBrake, JHOVE, MediaConch, Mediainfo, Tika and veraPDF. With this VRE we aim to reduce barriers to using and testing digital preservation software. +Developed in collaboration with the Dutch Digital Heritage Network, ViPER is an easy-to-install virtual machine running popular open source preservation tools with graphical user interfaces: DROID, HandBrake, JHOVE, MediaConch, Mediainfo, Tika and veraPDF. With this virtual machine, we aim to reduce barriers to using and testing digital preservation software. With a selection of open source digital preservation tools pre-installed, it enables users to try out tools typically used in the pre-ingest and ingest stages of a digital preservation workflow, without having to install or configure the software. You can research them before making decisions about which to use in your production environment. diff --git a/docs/tools/index.md b/docs/tools/index.md index 39bfda4..d3abd05 100644 --- a/docs/tools/index.md +++ b/docs/tools/index.md @@ -6,7 +6,7 @@ title: ViPER Tools Here you can find a full list of the bundled tools and some references to online resources. -## ![DROID icon](../assets/img/icons/droid.png "DROID icon") DROID (Digital Record Object Identification) +## ![DROID icon](../assets/img/icons/droid.png "DROID icon") DROID (Digital Record Object Identification) v{{ site.data.vars.droid_version }} A file format identification tool developed and maintained by The National Archives of the UK. DROID performs automated batch identification of file format. DROID uses internal signatures @@ -17,7 +17,7 @@ to identify and report the specific format versions of digital files. These sign - GitHub: - PRONOM Homepage: -## ![JHOVE icon](../assets/img/icons/jhove.png "JHOVE icon") JHOVE +## ![JHOVE icon](../assets/img/icons/jhove.png "JHOVE icon") JHOVE v{{ site.data.vars.jhove_version }} A tool developed by Harvard University Library and the Open Preservation Foundation. JHOVE provides functions to perform format-specific identification, validation, and characterization of digital objects. @@ -25,7 +25,7 @@ JHOVE provides functions to perform format-specific identification, validation, - Homepage: - GitHub: -## ![Tika icon](../assets/img/icons/tika.jpg "Tika icon") Apache Tika +## ![Tika icon](../assets/img/icons/tika.jpg "Tika icon") Apache Tika v{{ site.data.vars.tika_version }} A characterisation and text extraction tool developed and maintained by the Apache Software Foundation. detects and extracts metadata and text from over a thousand different file types (such as PPT, XLS, and PDF). All of these file types can be parsed through a single interface, making Tika useful for search engine indexing, content analysis, translation, and much more. @@ -33,9 +33,9 @@ detects and extracts metadata and text from over a thousand different file types - Homepage: - GitHub: - Wiki: -- Supported Formats: +- Supported Formats: -## ![veraPDF icon](../assets/img/icons/verapdf.png "veraPDF icon") veraPDF +## ![veraPDF icon](../assets/img/icons/verapdf.png "veraPDF icon") veraPDF v{{ site.data.vars.verapdf_version }} A validation and characterisation tool for the PDF/A format, developed by The PDF Association and The Open Preservation Foundation. @@ -44,7 +44,7 @@ A validation and characterisation tool for the PDF/A format, developed by The PD - GUI User Guide: - GitHub: -## ![HandBrake icon](../assets/img/icons/handbrake.png "HandBrake icon") HandBrake +## ![HandBrake icon](../assets/img/icons/handbrake.png "HandBrake icon") HandBrake v{{ site.data.vars.handbrake_version }} A tool for converting video from nearly any format to a selection of modern, widely supported codecs. @@ -53,26 +53,26 @@ A tool for converting video from nearly any format to a selection of modern, wid - The Forum: - GitHub: -## ![Mediainfo icon](../assets/img/icons/mediainfo.png "Mediainfo icon") Mediainfo +## ![Mediainfo icon](../assets/img/icons/mediainfo.png "Mediainfo icon") Mediainfo v{{ site.data.vars.mediainfo_version }} A convenient unified display of the most relevant technical and tag data for video and audio files. - Homepage: - Supported Formats: -## ![MediaConch icon](../assets/img/icons/mediainfo.png "Mediaconch icon") MediaConch +## ![MediaConch icon](../assets/img/icons/mediainfo.png "Mediaconch icon") MediaConch v{{ site.data.vars.mediaconch_version }} An extensible, open source software project consisting of an implementation checker, policy checker, reporter, and fixer that targets preservation-level audiovisual files. - Homepage:  -## ![Inkscape icon](../assets/img/icons/inkscape.png "Inkscape icon") Inkscape +## ![Inkscape icon](../assets/img/icons/inkscape.png "Inkscape icon") Inkscape v{{ site.data.vars.inkscape_version }} Open source image manipulation software bundled with Debian. - Homepage: -## ![GIMP icon](../assets/img/icons/gimp.png "Inkscape icon") GIMP (GNU Image Manipulation Program) +## ![GIMP icon](../assets/img/icons/gimp.png "Inkscape icon") GIMP (GNU Image Manipulation Program) v{{ site.data.vars.gimp_version }} Open source image manipulation software bundled with Debian.