From 6eb2fa427fac8e19388a2eedeea55944b9dc9a22 Mon Sep 17 00:00:00 2001 From: Fredrik Ekre Date: Thu, 5 Nov 2020 22:22:00 +0100 Subject: [PATCH] Experiment with a old-version note. --- v2.6.0/assets/documenter.js | 21 +++++++++++++++++++++ versions.js | 2 ++ 2 files changed, 23 insertions(+) diff --git a/v2.6.0/assets/documenter.js b/v2.6.0/assets/documenter.js index 22f0f9a..34112e3 100644 --- a/v2.6.0/assets/documenter.js +++ b/v2.6.0/assets/documenter.js @@ -251,6 +251,27 @@ $(document).ready(function() { }); } + // if the current version is not latest version, show a warning + if (typeof DOCUMENTER_CURRENT_VERSION !== 'undefined' && typeof DOCUMENTER_LATEST_VERSION !== 'undefined') { + var releaseRegex = /^v\d+\.\d+.\d+$/; + var isReleaseCurrent = releaseRegex.test(DOCUMENTER_CURRENT_VERSION); + var isReleaseLatest = releaseRegex.test(DOCUMENTER_LATEST_VERSION); + if ( isReleaseLatest && isReleaseCurrent && DOCUMENTER_CURRENT_VERSION != DOCUMENTER_LATEST_VERSION ) { + // Create a div + var oldNoteDiv = document.createElement('div'); + oldNoteDiv.setAttribute('class', 'old-doc-warn'); + oldNoteDiv.setAttribute('style', 'background:#cb3c33'); + // Create the note + var oldNoteP = document.createElement('p'); + oldNoteP.setAttribute('style', 'margin:1rem;'); + var latestURL = documenterBaseURL + "/../" + DOCUMENTER_LATEST_VERSION; + oldNoteP.innerHTML = 'Warning! This documents and old version of Literate. Click here to see the latest release, or select the appropriate version in the drop-down menu below.'; + oldNoteDiv.appendChild(oldNoteP); + // Insert it in the DOM before the version selector + version_selector.before(oldNoteDiv); + } + } + // only show the version selector if the selector has been populated if (version_selector_select.children("option").length > 0) { version_selector.toggleClass("visible"); diff --git a/versions.js b/versions.js index 0d251b9..39d2200 100644 --- a/versions.js +++ b/versions.js @@ -15,3 +15,5 @@ var DOC_VERSIONS = [ "v0.1", "dev", ]; + +var DOCUMENTER_LATEST_VERSION = "v2.7.0";