Display message on old (not edited in X years) pages

demiankatz

Hello, everyone! I have a wiki that has been under development for more than a decade. As a result, it contains some pages that haven't been updated in years and may be out of date. I'd like to display an age-related warning; if a page hasn't been edited in X years, there should be a message at the top indicating that some content may be out of date, and an edit might be needed. Is there an existing feature or plugin that would enable this functionality?

thanks,
Demian

sascha-leib

Maybe just use some JavaScript in ''conf/userscript.js'' that scrapes the "Last modified" data from the page, compares the year with the current date and injects a message if they are more than a certain number apart...

dustojnikhummer

sascha-leib That is a good idea. Still, having a simple, one click install extensions would be easier for people who don't know what they are doing, me included.

Chris75

sascha-leib

Hi, I liked the idea! I also wanted it for my wiki, so I programmed this. It is basically a Javascript Plugin.
Put the following code into your /dokuwiki/conf/userscript.js:

// ********************************* Old Page Warning Plugin *********************************** 

var $lastmod_warning = 'This page has not been updated for 2 years! Information on this page may not be valid anymore!';
var $regex_date_forward = /[0-9]{2}[\/\-\.|\\][0-9]{2}[\/\-\.|\\][0-9]{4}/m;
var $regex_date_backward = /[0-9]{4}[\/\-\.|\\][0-9]{2}[\/\-\.|\\][0-9]{2}/m;
var $lastmod_date = '';

// *********** check out the HTML footer element in your wiki *********** 
if ( jQuery("div.docInfo").length > 0 ) {
   var $lastmod_message = jQuery("div.docInfo").text();
} else if ( jQuery("div.page-footer").length > 0 ) {
   var $lastmod_message = jQuery("div.page-footer").text();
} else {
   // DEBUGGING MESSAGE
   console.log('The HTML element "page footer" with the "Last modified ..." message cannot be found!');
}

// *********** scrape the last modified date from your footer *********** 
if ( $lastmod_message != '' && $regex_date_forward.test($lastmod_message) ) {
   $lastmod_date = jQuery.trim($lastmod_message.match($regex_date_forward));
   var $lastmod_date_day = $lastmod_date.substring(0,2);
   var $lastmod_date_month = $lastmod_date.substring(3,5);
   var $lastmod_date_year = $lastmod_date.substring(6);
} else if ( $lastmod_message != '' && $regex_date_backward.test($lastmod_message) ) {
   $lastmod_date = jQuery.trim($lastmod_message.match($regex_date_backward));
   var $lastmod_date_year = $lastmod_date.substring(0,4);
   var $lastmod_date_month = $lastmod_date.substring(5,7);
   var $lastmod_date_day = $lastmod_date.substring(8);
} else {
   // DEBUGGING MESSAGE
   console.log('The "last modified date" cannot be found inside the HTML element "page footer"!');
}

// *********** compare dates and put the warning message into the page header *********** 
   var $lastmod_date_clean = $lastmod_date_year + '-' + $lastmod_date_month + '-' + $lastmod_date_day;   // required format
   var $lastmod_date_stamp = Date.parse($lastmod_date_clean);
   var $lastmod_date_current = Date.now();
   if ( $lastmod_date != '' && $lastmod_date_stamp < ($lastmod_date_current - 1000*60*60*24*365*2) ) {   // UNIX timestamp in milliseconds: 2 years
      jQuery("#dokuwiki__content").before('<div class="message-box" style="background-color:orange;z-index:10000;padding:2px 5px;"><span>' + $lastmod_warning + '</span></div>');
   }

// *********************************************************************************************

All settings can be edited directly in the code, like the time, the message and the HTML footer element.
Limitation: This should work for the Standard Template and the Sprintdoc Template out of the box. For other templates the appropriate HTML footer element, e.g.: jQuery("div.docInfo") with the "last modified message", needs to be substituted in the code.

Cheers!

Chris75

You can also transfer the "last modified date" directly from PHP $INFO['lastmod'] to Javascript JSINFO['lastmod']. Go to /dokuwiki/inc/common.php and look for the comment * Initialize and/or fill global $JSINFO with some basic info to be given to javascript, then add the following as a new line to the set:

$JSINFO['lastmod']               = isset($INFO) ? (int) $INFO['lastmod']*1000 : '';    // ****** ADDED ******

Note, that the value is multiplied by 1000, because the date (as a Unix timestamp) is needed in Javascript in the unit Milliseconds, but, is provided in PHP in the unit Seconds.

Now, the javascript code in /dokuwiki/conf/userscript.js boils down to this:

// *********** Old Page Warning Plugin - compare dates and put the warning message into the page header *********** 

var $lastmod_warning = 'This page has not been updated for 2 years! Information on this page may not be valid anymore!';
var $lastmod_date_current = Date.now();
var $lastmod_date = JSINFO['lastmod'];
if ( $lastmod_date != '' && $lastmod_date < ($lastmod_date_current - 1000*60*60*24*365*2) ) {   // UNIX timestamp in the unit Milliseconds: 2 years
   jQuery("#dokuwiki__content").before('<div class="message-box" style="background-color:orange;z-index:10000;padding:2px 5px;"><span>' + $lastmod_warning + '</span></div>');
}

And that's all that's left from the above plugin code, and that's all that's needed!

Cheers!

Global DokuWiki Links