DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:davcal

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:davcal [2018-09-10 11:22] andyboehplugin:davcal [2024-02-08 09:03] (current) – [davcal Plugin] LMS23
Line 3: Line 3:
 ---- plugin ---- ---- plugin ----
 description: Add a synchronisable Calendar to DokuWiki description: Add a synchronisable Calendar to DokuWiki
-author     : Andreas Böhler +author     : DokuFreaks (previous: Andreas Böhler) 
-email      : dev@aboehler.at +email      : dev@aboehler.at
 type       : Syntax Plugin type       : Syntax Plugin
-lastupdate : 2017-11-24 +lastupdate : 2022-08-04 
-compatible : Elenor Of Tsort, Detritus, Hrun, Frusterick Manners+compatible : Elenor Of Tsort, Detritus, Hrun, Frusterick Manners, Greebo, Hogfather, Igor, "Jack Jackrum", Kaos
 depends    : sqlite depends    : sqlite
 conflicts  conflicts 
 similar    : calendoku, icalevents, icalendar, google_cal, calendoku similar    : calendoku, icalevents, icalendar, google_cal, calendoku
-tags       : calendar, ical, caldav+tags       : calendar, ical, caldav, !discontinued
  
-downloadurl: http://www.aboehler.at/hg/davcal/archive/tip.tar.gz +downloadurl: https://github.com/dokufreaks/dokuwiki-plugin-davcal/archive/refs/heads/master.zip 
-bugtracker : https://code.rnb-consulting.at/tag/davcal_plugin+bugtracker : https://github.com/dokufreaks/dokuwiki-plugin-davcal/issues 
-sourcerepo : http://www.aboehler.at/hg/davcal/+sourcerepo : https://github.com/dokufreaks/dokuwiki-plugin-davcal
 donationurl:  donationurl: 
  
 screenshot_img :  screenshot_img : 
 ---- ----
 +
 +FIXME **Look for new maintainer - Would be nice if someone could take on this plugin and develop it further! \\ 
 +However, any help with a javascript update is welcome!** FIXME
 +
 +
 +===== New repository =====
 +The original authors repository https://gitlab.aboehler.at/dokuwiki/davcal/ is cloned to 
 +https://github.com/dokufreaks/dokuwiki-plugin-davcal
 +
 +Pull requests are welcome.
  
 ==== DAVCal provides ==== ==== DAVCal provides ====
Line 31: Line 41:
 ===== Requirements ===== ===== Requirements =====
  
-  * You need the sqlite PlugIn+  * You need the [[plugin:sqlite]] PlugIn
   * You need at least PHP 5.4 (required by the underlying DAV library), including the PHP XML module (php-xml((openSUSE users add the packages php5-dom, php5-xmlwriter, php5-xmlreader and php5-mbstring)))   * You need at least PHP 5.4 (required by the underlying DAV library), including the PHP XML module (php-xml((openSUSE users add the packages php5-dom, php5-xmlwriter, php5-xmlreader and php5-mbstring)))
   * CalDAV synchronisation requires   * CalDAV synchronisation requires
Line 42: Line 52:
  
 Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually. Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
- 
-==== Nginx usage ==== 
- 
-Since //.ics// url are a bit weird, the following hack is required to make them work: 
- 
-<code> 
-location ~ ^/lib/plugins/davcal/ics.php/(.*)$ { 
-    include fastcgi_params; 
-    fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; 
-    fastcgi_param REDIRECT_STATUS 200; 
-    fastcgi_pass unix:/var/run/php/php7.0-fpm.sock; 
- 
-    fastcgi_split_path_info ^(.+\.php)(.*)$; 
-    fastcgi_param PATH_INFO $fastcgi_path_info; 
-    fastcgi_param PATH_TRANSLATED $document_root$fastcgi_path_info; 
-} 
-</code> 
- 
  
 ===== Examples/Usage ===== ===== Examples/Usage =====
Line 91: Line 83:
 In order to display a table with events, the syntax is slightly different: In order to display a table with events, the syntax is slightly different:
  
-<code>{{davcaltable>id=calendars:mycalendar:start,id=calendars:othercalendar,startdate=2015-10-20,numdays=30,dateformat=Y-m-d,onlystart=true,sort=asc,timezone=Europe/Vienna}}+<code>{{davcaltable>id=calendars:mycalendar:start,id=calendars:othercalendar,startdate=2015-10-20,numdays=30,dateformat=Y-m-d,calname=true,onlystart=true,sort=asc,timezone=Europe/Vienna,nolocation}}
 </code> </code>
  
-This creates tabular output and starts from 2015/10/20 (''%%startdate=2015-10-20%%'', this date format is required!), displays up to 30 days (''%%numdays=30%%''), formats the events as Y-m-d (''%%dateformat=Y-m-d%%'') and displays only the column 'At' instead of 'From' and 'To' (''%%onlystart=true%%''). Events are sorted in ascending order (''%%sort=asc%%'') and their time is converted to the timezone 'Europe/Vienna' (''%%timezone=Europe/Vienna%%''). It is also possible to define the date relative to the current date: ''%%startdate=today-30%%'' means 30 days ago, ''%%startdate=today+1%%'' means tomorrow. If you omit the timezone, 'UTC' is assumed.+This creates tabular output and starts from 2015/10/20 (''%%startdate=2015-10-20%%'', this date format is required!), displays up to 30 days (''%%numdays=30%%''), formats the events as Y-m-d (''%%dateformat=Y-m-d%%'') and displays only the column 'At' instead of 'From' and 'To' (''%%onlystart=true%%''). Events are sorted in ascending order (''%%sort=asc%%'') and their time is converted to the timezone 'Europe/Vienna' (''%%timezone=Europe/Vienna%%''). It is also possible to define the date relative to the current date: ''%%startdate=today-30%%'' means 30 days ago, ''%%startdate=today+1%%'' means tomorrow. If you omit the timezone, 'UTC' is assumed. The field 'Location' is hidden (''%% nolocation%%''), but the calendar name is displayed (''%%calname=true%%'').
  
 If you want to get all events up to and including today, you can do the following:  If you want to get all events up to and including today, you can do the following: 
Line 126: Line 118:
 | sort | ''%%asc%%'' or ''%%desc%%'' | Sort the events in ascending or descending order (by start date). Defaults to ''desc'' | | sort | ''%%asc%%'' or ''%%desc%%'' | Sort the events in ascending or descending order (by start date). Defaults to ''desc'' |
 | timezone | Any timezone supported by PHP | Specify the timezone the events should be displayed in. Defaults probably to UTC, depending on your server configuration. | | timezone | Any timezone supported by PHP | Specify the timezone the events should be displayed in. Defaults probably to UTC, depending on your server configuration. |
 +| nolocation | not specified | If specified, the field 'Location' is hidden. |
 +| calname | ''true'', ''on'' | Set this to ''true'' or ''on'' to add a column with the calendar name the event is saved in. The default is ''false''. |
  
 ===== Settings ===== ===== Settings =====
  
 The admin can specify default settings for all calendars (timezone, week numbers, ...) in the settings panel. Users can override the settings on a per-user basis by clicking on the link 'Settings/Sync'. The admin can also disable this button in the admin settings. The admin can specify default settings for all calendars (timezone, week numbers, ...) in the settings panel. Users can override the settings on a per-user basis by clicking on the link 'Settings/Sync'. The admin can also disable this button in the admin settings.
 +
 +==== Nginx usage ====
 +
 +Since //.ics// url are a bit weird, the following hack is required to make them work:
 +
 +<code>
 +location ~ ^/lib/plugins/davcal/ics.php/(.*)$ {
 +    include fastcgi_params;
 +    fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
 +    fastcgi_param REDIRECT_STATUS 200;
 +    fastcgi_pass unix:/var/run/php/php7.0-fpm.sock;
 +
 +    fastcgi_split_path_info ^(.+\.php)(.*)$;
 +    fastcgi_param PATH_INFO $fastcgi_path_info;
 +    fastcgi_param PATH_TRANSLATED $document_root$fastcgi_path_info;
 +}
 +</code>
 +
 +Also, CalDAV requires a similar code block for nginx.
 +<code>
 +location ~ ^/lib/plugins/davcal/calenderserver.php/(.*)$ {
 +    include fastcgi_params;
 +    fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
 +    fastcgi_param REDIRECT_STATUS 200;
 +    fastcgi_pass unix:/var/run/php/php7.0-fpm.sock;
 +
 +    fastcgi_split_path_info ^(.+\.php)(.*)$;
 +    fastcgi_param PATH_INFO $fastcgi_path_info;
 +    fastcgi_param PATH_TRANSLATED $document_root$fastcgi_path_info;
 +}
 +</code>
 +
 +Also, the caret (^) might need to be removed from the location line to get either block to work in some nginx configurations.  Also, the path to the PHP FPM sock might need adjusted.
  
 ===== Synchronization (Client Mode) ===== ===== Synchronization (Client Mode) =====
Line 200: Line 227:
 DavCAL currently supports the languages DavCAL currently supports the languages
  
-  * English (en) 
   * Dutch (nl)   * Dutch (nl)
 +  * English (en)
   * French (fr)   * French (fr)
   * German (de and de-informal)   * German (de and de-informal)
 +  * Russian (ru)
  
-If you would like to provide translations, don't hesitate to contact me or open a task at [[https://code.rnb-consulting.at/tag/davcal_plugin/|code.rnb-consulting.at/tag/davcal_plugin]].+If you would like to provide translations, don't hesitate to contact me or open a task at [[https://github.com/dokufreaks/dokuwiki-plugin-davcal]].
  
 ===== Limitations ===== ===== Limitations =====
Line 229: Line 257:
 === Change Log === === Change Log ===
  
-{{rss>http://feeds.feedburner.com/dokuwiki-plugin-davcal date}}+{{rss>https://github.com/dokufreaks/dokuwiki-plugin-davcal/commits/master.atom date}}
  
 === Known Bugs and Issues === === Known Bugs and Issues ===
  
-Please use the bug tracker ("Create Task...", click on the drop-down icon of the backlog) at [[https://code.rnb-consulting.at/tag/davcal_plugin/|code.rnb-consulting.at/tag/davcal_plugin]]. This page is unmonitored. +[[https://github.com/dokufreaks/dokuwiki-plugin-davcal/issues|Use GitHub]]
- +
-  * Timezone support is not fully tested +
-  * Recurring events should be displayed correctly, but there is no user-interface to add/edit them +
-  * Due to the underlying DAV library, you need at least PHP 5.4. Otherwise, you'll get PHP parse errors.+
  
 === ToDo/Wish List === === ToDo/Wish List ===
  
-Please use the bug tracker ("Create Task...", click on the drop-down icon of the backlog) at [[https://code.rnb-consulting.at/tag/davcal_plugin/|code.rnb-consulting.at/tag/davcal_plugin]]. This page is unmonitored.+[[https://github.com/dokufreaks/dokuwiki-plugin-davcal/issues|Use GitHub]]
  
-  * Add editor support for recurring events. Please! nth.DayPerMonth, EveryNDaysByStart, nth.DatePerMonth (+4): https://code.rnb-consulting.at/T19 
-  * Translations (please contact me via E-Mail if you would like to contribute translations) 
  
plugin/davcal.1536571341.txt.gz · Last modified: 2018-09-10 11:22 by andyboeh

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki