plugin:countdown
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
plugin:countdown [2010-09-07 16:30] – [Discussion] 217.228.197.32 | plugin:countdown [2019-01-15 20:52] – corrected download URL ryan.chappelle | ||
---|---|---|---|
Line 2: | Line 2: | ||
---- plugin ---- | ---- plugin ---- | ||
- | description: | + | description: |
- | author | + | author |
email : luis.machuca [at] gulix.cl | email : luis.machuca [at] gulix.cl | ||
type : syntax | type : syntax | ||
- | lastupdate : 2009-12-19 | + | lastupdate : 2019-01-13 |
- | compatible : | + | compatible : Lemming, Anteater, Weatherwax, Binky, Frusterick Manners, Greebo |
depends | depends | ||
conflicts | conflicts | ||
Line 13: | Line 13: | ||
tags : counter, date | tags : counter, date | ||
- | downloadurl: | + | downloadurl: |
+ | sourceurl | ||
+ | bugtracker : https:// | ||
+ | donationurl: | ||
---- | ---- | ||
Line 19: | Line 22: | ||
The **Countdown Plugin** shows a countdown to a specific (target) date. | The **Countdown Plugin** shows a countdown to a specific (target) date. | ||
- | **Under new management since June 11, 2009**. | + | **Under new management since June 11, 2009**.\\ |
+ | -Previously maintained by [[ekkart@ekkart.de|Ekkart Kleinod]] (since version 2.x).\\ | ||
+ | -Based on even earlier work by [[rbpeters@peterro.com|Ron Peters]] (version 1.0).\\ | ||
+ | -Which was itself a modified version of the [[http:// | ||
- | Previously maintained by [[ekkart@ekkart.de|Ekkart Kleinod]] (since | + | **Important: |
- | Based on even earlier work by [[rbpeters@peterro.com|Ron Peters]] (version 1.0). | + | ===== Download and Installation ===== |
+ | Search and install the plugin using the [[plugin: | ||
- | Which was itself a modified version | + | As of the date of January 2019, the latest version is the version '' |
- | **Important:** version 2.x is not compatible with version 1.0 (syntax change of date) | + | :!: It is recommended you upgrade the plugin if you are using PHP>=7.0 to avoid some warnings in the code, thanks to Stefan Huehner for the corrections. |
- | ===== Attention: new maintainer needed -> found ===== | + | ==== Previous Versions |
- | Due to changes in my homepage backend I no longer develop this plugin. I will host the plugin | + | **Download links for previous version**: |
+ | * [[https:// | ||
+ | * [[http:// | ||
+ | * [[http:// | ||
- | Regards, Ekkart. | + | ==== Demo ==== |
- | >Hi, Ekkart. I've already mailed you asking to take over the development. But of course you might want to wait JIC someone else applies too. Kind regards. | + | :!: [[http://ryan.gulix.cl/dw/desarrollo/dokuwiki/plugin-countdown|(Neo) Demo Site]]. The site is in Spanish, but usage should be pretty obvious and language is neutral enough that even Google Translator shall do fine. An English demo page will be made available for the next release |
- | >>Hi Luis, sorry for not answering, I'm afraid, your mail was put into the spam folder. It's okay for me if you develop the plugin | + | |
- | >>> | + | Examples of use and more information |
+ | |||
+ | ^ {{http://ryan.gulix.cl/ | ||
+ | | The output of the '' | ||
- | ===== Description | + | ===== Usage ===== |
- | With this [[: | + | With this [[: |
The format is: | The format is: | ||
Line 47: | Line 60: | ||
< | < | ||
- | This will be replaced with either | + | This will be replaced with either: |
XX days [HH:MM] until description | XX days [HH:MM] until description | ||
Line 54: | Line 67: | ||
(where the '' | (where the '' | ||
- | Possible formats of //date// are all [[http:// | + | Possible formats of //date// are all [[http:// |
Examples: | Examples: | ||
< | < | ||
< | < | ||
+ | | ||
+ | Disable Page Caching so the plugin text can remain dynamic, insert this into any page using this plugin: | ||
- | ===== Download/ | + | |
- | + | ||
- | Download and install the plugin using the [[plugin: | + | |
- | + | ||
- | :!: If you are using a previous version of the plugin, it is recommended that you **uninstall** the previous version before installing the RC. | + | |
- | + | ||
- | **Download links for previous version**: | + | |
- | * [[http:// | + | |
- | * [[http:// | + | |
- | + | ||
- | Refer to [[: | + | |
- | + | ||
- | :!: [[http:// | + | |
- | + | ||
- | Examples of use and more information can be found on [[http:// | + | |
- | + | ||
- | ^ {{http:// | + | |
- | | | + | |
Line 84: | Line 82: | ||
The plugin is configurable in some ways since version 2.0. | The plugin is configurable in some ways since version 2.0. | ||
- | There are three parameters that are configurable, | + | There are six parameters that are configurable, |
**Visibility of Countdown Date**: | **Visibility of Countdown Date**: | ||
Line 91: | Line 89: | ||
Example: | Example: | ||
- | | + | |
- | results in | + | |
XX days until description | XX days until description | ||
- | + | (with option enabled) | |
- | $conf[' | + | |
- | results in | + | |
XX days until description (mm/ | XX days until description (mm/ | ||
- | **Short | + | **Short |
- | The parameter '' | + | The parameter '' |
Example: | Example: | ||
- | | + | |
- | results in | + | |
Today is description | Today is description | ||
Line 112: | Line 106: | ||
The parameter '' | The parameter '' | ||
- | Example: | + | Examples: |
- | | + | |
- | results in | + | |
XX days HH:MM until description (mm/ | XX days HH:MM until description (mm/ | ||
+ | |||
+ | ==== Parameters in the Latest Release ==== | ||
+ | |||
+ | **Display business days** | ||
+ | |||
+ | The parameter '' | ||
+ | |||
+ | Examples: | ||
+ | (with option enabled) | ||
+ | XX (BB) days until description | ||
+ | |||
+ | **Server Time Message** | ||
+ | |||
+ | This parameter is a Boolean that determines whether this plugin will add a notice to DokuWiki' | ||
+ | |||
+ | Examples: | ||
+ | (with option enabled) | ||
+ | (the following sample message will show on DokuWiki' | ||
+ | Server time for Countdown plugin is: 2011-03-08 12:45 | ||
+ | |||
===== Internationalisation ===== | ===== Internationalisation ===== | ||
Line 126: | Line 139: | ||
The following languages are included: | The following languages are included: | ||
+ | |||
* German (de), English (en) by Ekkart Kleinod | * German (de), English (en) by Ekkart Kleinod | ||
* Estonian (et) by Mikk Leini | * Estonian (et) by Mikk Leini | ||
Line 137: | Line 151: | ||
===== Versions ===== | ===== Versions ===== | ||
+ | * :!: version 2.6 (2019-01-13): | ||
+ | * version 2.5rc2 (2011-03-11) maintained by Luis Machuca Bezzaza: correction of a one-day-time bug and addition of the option to display business days and server time; minor overall improvements; | ||
* version 2.5rc (2009-12-19) maintained by Luis Machuca Bezzaza: Czech, Spanish and Br-Portuguese language files, ability to display hours, general code rewrite to use getLang(), [[xref> | * version 2.5rc (2009-12-19) maintained by Luis Machuca Bezzaza: Czech, Spanish and Br-Portuguese language files, ability to display hours, general code rewrite to use getLang(), [[xref> | ||
* version 2.1.3 (2009-01-24) maintained by Ekkart Kleinod: French language file | * version 2.1.3 (2009-01-24) maintained by Ekkart Kleinod: French language file | ||
Line 145: | Line 161: | ||
* version 2.0 (2008-02-18) maintained by Ekkart Kleinod: language and configuration options, code rewrite | * version 2.0 (2008-02-18) maintained by Ekkart Kleinod: language and configuration options, code rewrite | ||
* version 1.0 maintained by Ron Peters: basic functionality | * version 1.0 maintained by Ron Peters: basic functionality | ||
+ | |||
===== Discussion ===== | ===== Discussion ===== | ||
Line 173: | Line 190: | ||
The ability to display " | The ability to display " | ||
+ | >This feature has been added, albeit in a simple way, in version 2.5.rc2. | ||
---- | ---- | ||
Line 200: | Line 218: | ||
</ | </ | ||
</ | </ | ||
+ | >This was apparently a bug caused y leftover code, and seems to be fixed in the newest release. | ||
+ | |||
+ | ==== de-informal ==== | ||
+ | We set the global wiki language " | ||
+ | |||
+ | |||
+ | ==== Bug line 127 syntax.php : ==== | ||
+ | |||
+ | |||
+ | // check parsed date | ||
+ | if ($parsedDate <= 0) { | ||
+ | $renderer-> | ||
+ | } else { | ||
+ | | ||
+ | you have to change it to : (getLand --> getlang) | ||
+ | | ||
+ | // check parsed date | ||
+ | if ($parsedDate <= 0) { | ||
+ | $renderer-> | ||
+ | } else { | ||
+ | |||
+ | >Will get to fix it. Thanks for letting me know! --- [[user> | ||
+ | |||
+ | ==== Attention: new maintainer needed -> found ==== | ||
+ | |||
+ | Due to changes in my homepage backend I no longer develop this plugin. I will host the plugin until a new maintainer is found. Please contact me if a new maintainer takes over the development. | ||
+ | |||
+ | Regards, Ekkart. | ||
+ | |||
+ | >Hi, Ekkart. I've already mailed you asking to take over the development. But of course you might want to wait JIC someone else applies too. Kind regards. | ||
+ | >>Hi Luis, sorry for not answering, I'm afraid, your mail was put into the spam folder. It's okay for me if you develop the plugin further. All files are in the zip archive. Regards, Ekkart. | ||
+ | >>> | ||
+ | |||
+ | ==== do not show the Description ==== | ||
+ | |||
+ | I installed the plugin an try it, but the description will not displayed. | ||
+ | have a look to: http:// | ||
+ | |||
+ | Regards, Mark W. | ||
+ | |||
+ | >Fixed in the latest update. Can't believe I just missed one or two lines of code. -- --- [[user> | ||
+ | >> updated and it works, thx --- [[user> | ||
+ | |||
+ | |||
+ | ==== ADDON select language ==== | ||
+ | |||
+ | created by --- [[user> | ||
+ | |||
+ | if your language for the countdown plugin is different from the prefered language | ||
+ | you need to modify the .../ | ||
+ | |||
+ | to select the language during the admin configuration | ||
+ | replace the original .../ | ||
+ | |||
+ | so we have now two ways to change the language | ||
+ | - per default in the config manager | ||
+ | - with the extented syntax: < | ||
+ | |||
+ | i have an example on http:// | ||
+ | |||
+ | === new .../ | ||
+ | |||
+ | |||
+ | <code php> | ||
+ | <?php | ||
+ | /** | ||
+ | * Metadata configuration for countdown plugin. | ||
+ | * | ||
+ | * @license GPL 2 (http:// | ||
+ | * @author | ||
+ | */ | ||
+ | |||
+ | $meta[' | ||
+ | $meta[' | ||
+ | $meta[' | ||
+ | |||
+ | /// The two following configurations are in a beta state | ||
+ | $meta[' | ||
+ | $meta[' | ||
+ | |||
+ | // | ||
+ | /** | ||
+ | * Addon for Metadata configuration for countdown plugin. | ||
+ | * | ||
+ | * @author Mark Wolfgruber | ||
+ | | ||
+ | */ | ||
+ | |||
+ | if(!defined(' | ||
+ | |||
+ | // Source: http:// | ||
+ | // if not exist PHP 5 a function named scandir | ||
+ | if (!function_exists(' | ||
+ | function scandir($directory, | ||
+ | if(!is_dir($directory)) { | ||
+ | return false; | ||
+ | } | ||
+ | $files = array(); | ||
+ | $handle = opendir($directory); | ||
+ | while (false !== ($filename = readdir($handle))) { | ||
+ | $files[] = $filename; | ||
+ | } | ||
+ | closedir($handle); | ||
+ | |||
+ | if($sorting_order == 1) { | ||
+ | rsort($files); | ||
+ | } else { | ||
+ | sort($files); | ||
+ | } | ||
+ | return $files; | ||
+ | } | ||
+ | } | ||
+ | |||
+ | // define countdown language directory | ||
+ | $countdown_lang_folder = DOKU_INC.' | ||
+ | |||
+ | // read countdown language directory | ||
+ | foreach(scandir($countdown_lang_folder) as $file) { | ||
+ | if($file[0] != ' | ||
+ | if(is_dir($countdown_lang_folder.'/' | ||
+ | $countdown_lang_folderArray[] = $file; | ||
+ | } else { // read files (not needed at the moment) | ||
+ | $countdown_lang_fileArray[] = $file; | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | $meta[' | ||
+ | </ | ||
+ | |||
+ | === modification 1 of the .../ | ||
+ | |||
+ | |||
+ | <code php> | ||
+ | /** | ||
+ | * | ||
+ | * this function is a copy of .../ | ||
+ | * | ||
+ | * only two lines are added | ||
+ | * | ||
+ | */ | ||
+ | function setupLocale() { | ||
+ | if ($this-> | ||
+ | |||
+ | global $conf; | ||
+ | $path = DOKU_PLUGIN.$this-> | ||
+ | |||
+ | // don't include once, in case several plugin components require the same language file | ||
+ | @include($path.' | ||
+ | | ||
+ | if ($conf[' | ||
+ | // add following 2 lines | ||
+ | if ($this-> | ||
+ | if ($this-> | ||
+ | |||
+ | $this-> | ||
+ | $this-> | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | |||
+ | === modification 2 of the .../ | ||
+ | |||
+ | |||
+ | add in function render($mode, | ||
+ | '' | ||
+ | |||
+ | <code php> | ||
+ | // check for new language data | ||
+ | if ($data[2]) { | ||
+ | if ($this-> | ||
+ | $this-> | ||
+ | } else { | ||
+ | if ($this-> | ||
+ | $this-> | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ==== Feature: Annual Timer ==== | ||
+ | Is it possible to have it so the countdown automatically rolls over once it has reached its target so it has a new target of next year. | ||
+ | |||
+ | The idea I have in mind is to have a countdown to someones birthday, and once it has reached the end of the birthday day, it increments the target year by 1 and starts the countdown all over again. | ||
+ | |||
+ | Cheers | ||
+ | |||
+ | --- [[user> | ||
+ | |||
+ | |||
+ | ==== 1250 days? ==== | ||
+ | >Is it a way to show up how many **Years, Month, Days, Hours** - till to the target in 2045? There are too many days to be able to figure out when will take actually place the event... | ||
+ | |||
+ | --- [[user> | ||
+ | |||
+ | ==== 1 day miscount ==== | ||
+ | In the latest version there is still a problem with day count. | ||
+ | To fix that problem next code: | ||
+ | <code php> | ||
+ | $difference = $diffseconds / 86400; | ||
+ | </ | ||
+ | has to be replaced by the following: | ||
+ | <code php> | ||
+ | $difference = ceil($diffseconds / 86400); | ||
+ | </ | ||
+ | in plugin' | ||
+ | --- [[user> |
plugin/countdown.txt · Last modified: 2022-05-31 17:08 by kkue