[]
= optionalTable of Contents
yearbox Plugin
Compatible with DokuWiki
- 2024-02-06 "Kaos" unknown
- 2023-04-04 "Jack Jackrum" unknown
- 2022-07-31 "Igor" unknown
- 2020-07-29 "Hogfather" yes
Similar to monthcal, wikicalendar
This Plugin needs at least PHP 7.2!
(If you absolutely have to run a PHP version that is End of Life since long ago, you can install the last PHP 7.0 compatible version.)
Installation
Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.
As per development version on GitHub:
- Merge pull request #22 from dokuwiki-translate/lang_update_640_168475… (2023-06-18 20:46)
- translation update (2023-05-22 14:40)
- translation update (2022-02-04 18:20)
- translation update (2022-02-04 18:20)
- chore(release): 1.0.1 (2021-03-19 22:28)
- fix: resolve PHP 8 errors (2021-03-19 22:21)
- fix: restore compatibility with DokuWiki stable (2021-03-19 22:08)
- docs: update plugin-link in plugin.info.txt (#15) (2021-03-19 21:44)
Examples/Usage
This plugin builds a HTML calendar for the given year, with a link to create a new page for each day of the year. Existing pages will have a tool-tip showing a preview of the page content. You can also use the recent= option to show only recent months, which is useful on the bottom of diary pages.
The purpose of the plugin is to easily create and manage diary, journal, and event pages. If you want to include a recent months calendar at the bottom of each of your diary pages then the include plugin is very helpful.
For example the following markup on your wiki page:
====== Yearbox test page ====== {{yearbox>recent=10;align=left}} {{yearbox>recent=200;align=left}} {{yearbox>year=2011,2013;months=5,6;weekdays=1,2,3,4,5}} {{yearbox>recent=1;ns=diary;name=day;size=15}} {{yearbox>recent=15;ns=journal;size=11}} {{yearbox>recent=45;size=10}} {{yearbox>year=2011;size=10;ns=events;name=jour}} ~~NOCACHE~~
…will result in these calendars.
The namespace/page-name is automatically created as follows:
- <ns>
- <year-month>
- <name>-<year>-<month>-<day>
Tip: The pagequery plugin can be quite useful if you want to display a list of recent entries, perhaps for use in a simple blog.
Syntax
Parameters:
Syntax1) | Explanation | Default |
---|---|---|
ns=<namespace> | root namespace in which to create the linked calendar pages | current ns |
recent=<num> | build calendar based on recent days, i.e. how many days should be visible before today (rounded up to whole months)—take precedence over other options! | 21 days |
year=yyyy[,yyyy] | build calendar for the given year, or range of years (inclusive) year must be ≥ 1902 | current year |
months=<csv> 2) | which months should be visible, 1=Jan, 2=Feb,…, e.g. months=6,7 (Jun,Jul) | all |
weekdays=<csv> | which weekdays should have links, 1=Mon, 2=Tue,… e.g. weekdays=1,2,3,4,5 (Mon to Fri)3) | all |
name=<name> | prefix for new page name, e.g diary, journal, day | day |
size=<num> | font size to use; this controls the width/height of the calendar table4) | 12px |
align=<direction> | align the year table left or right | centre |
E.g.:
{{yearbox>year=2010,2012;name=journal;size=12;ns=diary}}
Configuration and Settings
The month and day abbreviations can be changed in the language files. A few languages are already available. Feel free to add your language on yearbox translation page.
Development
Releases:
- 1.0.0 (2021-03-14) by micgro42⚠ BREAKING CHANGES PHP 7.1 and older is no longer supported Features PHP 8 is now supported
- Version 2021-01-02 by micgro42show abbreviated December again
- Version 2020-07-07 by micgro42Portuguese translations added.
- 2019-05-29: UI improvement on mobile by micgro42The table is now horizontally scrollable on small devices
Change Log
See CHANGELOG.md.
FAQ
MAKE SURE YOU USE ~~NOCACHE~~ ON THE PAGE!
Discussion
Please use the discussion page.