Differences

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

--- plugin:agenda [2011-10-10 19:17] – 178.16.41.83
+++ plugin:agenda [2023-10-30 23:50] (current) – Klap-in
@@ Line 2: / Line 2: @@
 ---- plugin ----
-description: personal organizer and day planner, that lets you group tasks by projects
+description: Personal organizer and day planner, that lets you group tasks by projects
 author     : javy_tahu
 email      : vytautas@jakut.is
 type       : syntax
 lastupdate : 2011-10-10
-compatible : 2009-12-25c "Lemming"
+compatible : Lemming
 depends    :
 conflicts  :
 similar    : Gtd, Task, Do
-tags       : agenda, todo, pm, projects, task, tasks
+tags       : !discontinued, agenda, todo, pm, projects, task
-downloadurl: http://github.com/tahu/dokuwiki-agenda/zipball/master
+downloadurl: # https://github.com/tahu/dokuwiki-agenda/zipball/master
-bugtracker : http://github.com/tahu/dokuwiki-agenda/issues
+bugtracker : # https://github.com/tahu/dokuwiki-agenda/issues
-sourcerepo : http://github.com/tahu/dokuwiki-agenda/
+sourcerepo : # https://github.com/tahu/dokuwiki-agenda/
-donationurl: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=Z33AVZY6K42RQ
+donationurl: # https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=Z33AVZY6K42RQ FIXME
 ----
-<file>
+[[https://jakut.is/dokuwiki/dokuwiki-agenda|Demo page]] FIXME
 ==== About ====
-dokuwiki-agenda: personal organizer and day planner, that lets you group tasks by projects
+  * dokuwiki-agenda: personal organizer and day planner, that lets you group tasks by projects
-platform: a plugin for DokuWiki (http://dokuwiki.org)
+  * platform: a plugin for [[:DokuWiki]]
-author: Vytautas Jakutis <vytautas@jakut.is>
+  * author: [[vytautas@jakut.is|Vytautas Jakutis]]
-dokuwiki plugin page: http://www.dokuwiki.org/plugin:agenda
+  * demo page: https://jakut.is/dokuwiki/dokuwiki-agenda FIXME
-issue tracker: https://github.com/tahu/dokuwiki-agenda/issues
+  * dokuwiki plugin page: http://www.dokuwiki.org/plugin:agenda
-source code repository: git://github.com/tahu/dokuwiki-agenda.git
+  * issue tracker: https://github.com/tahu/dokuwiki-agenda/issues FIXME
+  * source code repository: %%git://github.com/tahu/dokuwiki-agenda.git%% FIXME
 ==== Installation ====
 If you install this plugin manually, make sure it is installed in
 lib/plugins/agenda/ - if the folder is called different it
 will not work!
-Please refer to http://www.dokuwiki.org/plugins for additional info
+Please refer to [[:plugins]] for additional info
 on how to install plugins in DokuWiki.
 ==== Usage ====
+Notice: this syntax plugin requires %%~~NOCACHE~~%% in the page the tags are used in.
 === Prerequisite terms ===
-Cycle is a unit of interval of time.
-Scheduled cycle is a cycle with a date and a number that represents the time when the cycle is scheduled in that date.
+**Cycle** is a unit of interval of time.
-Project has a title and a list of tasks.
+**Scheduled cycle** is a cycle with a date and a number that represents the time when the cycle is scheduled in that date.
-Task has a description and a list of scheduled cycles.
+**Project** has a title and a list of tasks.
-Wakeup log is a sorted list of dates and times that represents the time of getting out of bed for the particular date.
+**Task** has a description and a list of scheduled cycles.
+**Wakeup log** is a sorted list of dates and times that represents the time of getting out of bed for the particular date.
 === DokuWiki syntax tags ===
-The parameters for tags are formatted using Yet Another Markup Language (http://yaml.org/), see the example on the bottom of this README.
+The parameters for tags are formatted using [[http://yaml.org/|Yet Another Markup Language]], see the example on the bottom of this README.
-<agenda_browser> renders a widget to browse the dates forwards and backwards, one day at a time. It takes no parameters
+''<agenda_browser>'' renders a widget to browse the dates forwards and backwards, one day at a time. It takes no parameters
-<agenda_timetable> renders a table with times and tasks in a current day. It takes these parameters: baseID, cycleLength, wakeupFile, wakeupTime, exclude, statics, incycles, cycleNames, cycles.
+''<agenda_timetable>'' renders a table with times and tasks in a current day. It takes these parameters: baseID, cycleLength, wakeupFile, wakeupTime, exclude, statics, incycles, cycleNames, cycles.
-<agenda_nextfree> renders a small table of weekdays and the first date that has at least one unscheduled cycle in them. It takes these parameters: cycles, exclude, incycles, baseID.
+''<agenda_nextfree>'' renders a small table of weekdays and the first date that has at least one unscheduled cycle in them. It takes these parameters: cycles, exclude, incycles, baseID.
-<agenda_unassigned> renders a list of every projects tasks that have an empty list of scheduled cycles. It takes these parameters: exclude, incycles, baseID.
+''<agenda_unassigned>'' renders a list of every projects tasks that have an empty list of scheduled cycles. It takes these parameters: exclude, incycles, baseID.
 === Project pages ===
@@ Line 65: / Line 72: @@
 An example of a single scheduled cycle representation: 2011-09-05 4.
 An example of a project page:
+<code>
 | meet with Alice to discuss user requirements | 2011-10-18 4 |
 | write a weekly report | 2011-10-10 3, 2011-10-17 3 |
+</code>
 === Tag parameters ===
-baseID is an ID of namespace where the pages of projects are in.
+''baseID'' is an ID of namespace where the pages of projects are in.
-cycleLength is a number of minutes that defines the length of one cycle.
+''cycleLength'' is a number of minutes that defines the length of one cycle.
-wakeupTime is a time of day when you regularly wake up, e.g. 06:00. If it is null, then the wakeupFile is used to set the wakeup time for all the dates. The dates in future will have the wakeupTime of the last logged date.
+''wakeupTime'' is a time of day when you regularly wake up, e.g. 06:00. If it is null, then the wakeupFile is used to set the wakeup time for all the dates. The dates in future will have the wakeupTime of the last logged date.
-wakeupFile is an ID of the wakeup log page, example contents of that page:
+''wakeupFile'' is an ID of the wakeup log page, example contents of that page:
+<code>
 | 2011-09-04 | 07:00 |
 | 2011-09-05 | 06:00 |
 | 2011-09-06 | 06:05 |
+</code>
-exclude is a list of titles of projects that must not be listed anywhere, they must be just ignored.
+''exclude'' is a list of titles of projects that must not be listed anywhere, they must be just ignored.
-statics is a list of labels used to replace "static" in cycles parameter.
+''statics'' is a list of labels used to replace "static" in cycles parameter.
-incycles is a map of project titles to lists of labels that will be used in cycles parameter.
+''incycles'' is a map of project titles to lists of labels that will be used in cycles parameter.
-cycles is a list of project titles from incycles, and types "action" and "static". This is the template for your day. The project titles will be replaced with labels from incycles parameter and a list of tasks from the project page by finding the matching scheduled cycle. The "action" items will be replaced with just a list of tasks gathered the same way. The "static" items will be replaced with labels from the statics parameter.
+''cycles'' is a list of project titles from incycles, and types "action" and "static". This is the template for your day. The project titles will be replaced with labels from incycles parameter and a list of tasks from the project page by finding the matching scheduled cycle. The "action" items will be replaced with just a list of tasks gathered the same way. The "static" items will be replaced with labels from the statics parameter.
@@ Line 94: / Line 105: @@
 === Example ===
+<code>
+~~NOCACHE~~
 <agenda_browser>
@@ Line 122: / Line 135: @@
   MEAL: [breakfast, lunch, dinner, supper]
 </agenda_unassigned>
+</code>
 === License ===
@@ Line 136: / Line 150: @@
 See the COPYING file in your DokuWiki folder for details
-</file>