Skip to content

Commit

Permalink
FEAT: Site documentation tool versions
Browse files Browse the repository at this point in the history
- 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.
  • Loading branch information
carlwilson committed May 29, 2024
1 parent 702a64e commit b130dba
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 12 deletions.
12 changes: 12 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -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
14 changes: 14 additions & 0 deletions docs/_data/vars.yml
Original file line number Diff line number Diff line change
@@ -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"
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: Home
---
![ViPER logo](../assets/img/viper-logo.png "ViPER logo")

<div class="buttons"><a href="https://ddhn.openpreservation.org/viper-v1.1.ova" class="btn btn-success btn-lg" data-wow-duration="2s" data-wow-delay="0.2s" style="visibility: visible; animation-duration: 2s; animation-delay: 0.2s; animation-name: fadeInLeft;"><i class="fa fa-download"></i> Download<br> <small>ViPER 1.1</small></a></div>
<div class="buttons"><a href="https://ddhn.openpreservation.org/viper-v{{ site.data.vars.version }}.ova" class="btn btn-success btn-lg" data-wow-duration="2s" data-wow-delay="0.2s" style="visibility: visible; animation-duration: 2s; animation-delay: 0.2s; animation-name: fadeInLeft;"><i class="fa fa-download"></i> Download<br> <small>ViPER {{ site.data.vars.version }}</small></a></div>

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.

Expand Down
20 changes: 10 additions & 10 deletions docs/tools/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -17,25 +17,25 @@ to identify and report the specific format versions of digital files. These sign
- GitHub: <https://github.com/digital-preservation/droid>
- PRONOM Homepage: <http://www.nationalarchives.gov.uk/PRONOM/Default.aspx>

## ![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.

- Homepage: <https://jhove.openpreservation.org>
- GitHub: <https://github.com/openpreserve/jhove>

## ![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.

- Homepage: <https://tika.apache.org/>
- GitHub: <https://github.com/apache/tika>
- Wiki: <https://cwiki.apache.org/confluence/display/tika>
- Supported Formats: <https://tika.apache.org/1.25/formats.html>
- Supported Formats: <https://tika.apache.org/2.9.2/formats.html>

## ![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.

Expand All @@ -44,7 +44,7 @@ A validation and characterisation tool for the PDF/A format, developed by The PD
- GUI User Guide: <https://github.com/veraPDF/veraPDF-apps/raw/master/veraPDFPDFAConformanceCheckerGUI.pdf>
- GitHub: <https://github.com/veraPDF/veraPDF-library/>

## ![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.

Expand All @@ -53,26 +53,26 @@ A tool for converting video from nearly any format to a selection of modern, wid
- The Forum: <https://forum.handbrake.fr/>
- GitHub: <https://github.com/HandBrake/HandBrake>

## ![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: <https://mediaarea.net/en/MediaInfo>
- Supported Formats: <https://mediaarea.net/en/MediaInfo/Support/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: <https://mediaarea.net/MediaConch>

## ![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: <https://inkscape.org/>

## ![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.

Expand Down

0 comments on commit b130dba

Please sign in to comment.