Differences

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

--- plugin:rtmchecklist [2014-02-08 14:38] – fabienli
+++ plugin:rtmchecklist [2024-02-07 23:13] (current) – screenshots Aleksandr
@@ Line 2: / Line 2: @@
 ---- plugin ----
-description:
+description: This plugin enables to send a predefined list of tasks to Remember The Milk
 author     : fabienli
 email      : fabien.lisiecki+dokuwiki@gmail.com
-type       :
+type       : action syntax
 lastupdate : 2014-02-08
-compatible :
+compatible : Binky
 depends    :
 conflicts  :
-similar    :
+similar    : mailto
-tags       :
+tags       : email
-downloadurl: http://github.com/fabienli/dokuwiki-plugin-rtmchecklist/zipball/master
+downloadurl: https://github.com/fabienli/dokuwiki-plugin-rtmchecklist/zipball/master
-bugtracker : http://github.com/fabienli/dokuwiki-plugin-rtmchecklist/issues
+bugtracker : https://github.com/fabienli/dokuwiki-plugin-rtmchecklist/issues
-sourcerepo : http://github.com/fabienli/dokuwiki-plugin-rtmchecklist/
+sourcerepo : https://github.com/fabienli/dokuwiki-plugin-rtmchecklist
 donationurl:
 screenshot_img :
 ----
 ===== Description =====
-This plugin enables to send a predefined list of items to Remember The Milk, using the import email address.
-You can then manage several checklists (list of items to pack before going on Week End, list of tasks to achieve a procedure) and when any registerd user of the wiki needs it, this is imported into is Remember The Milk inbox.
+This plugin enables to send a predefined list of tasks to Remember The Milk, using the import email address.
+You can then manage several checklists (list of items to pack before going on Week End, list of tasks to achieve a procedure, ...) and when any registerd user of the wiki needs it, clicking on the "Send to RTM" button imports the tasks into her/his Remember The Milk inbox.
 ===== Installation =====
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. 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.
+Each wiki's user that wants to take profit of the plugin needs to setup her/his Remember the Milk import email address in her/his profile page.
 ===== Examples/Usage =====
+Here if the //profit// sample checklist:
+{{https://i.imgur.com/FeuNVXC.jpeg?recache |Sample of rendering of the profit checklist.}}
   <rtmchecklist>
@@ Line 36: / Line 44: @@
     PROFIT!!!
   </rtmchecklist>
 A simple list:
@@ Line 42: / Line 49: @@
   <rtmchecklist> one item to remember </rtmchecklist>
-Some more complex boxes
+Some more complex checklist:
-  <rtmchecklist> one item to remember| a second item </rtmchecklist>
+  <rtmchecklist> one item to remember| a second one separated by pipe</rtmchecklist>
   <rtmchecklist>
    one item to remember
-   per line
+   a second item, one item per line
   </rtmchecklist>
-//[Pictures showing the rendered result will help users to understand]//
+will produce the following checklists:
-//[TODO]//
+{{https://i.imgur.com/TAVuMMS.jpeg?recache |Sample of rendering of the one line checklist}}
+{{https://i.imgur.com/zxkM2Kw.jpeg?recache|Sample of rendering of the several lines checklist}}
 ===== Syntax =====
-Basic syntax:
+Basic syntax: ''%%<rtmchecklist>items list</rtmchecklist>%%''
-<rtmchecklist>items list</rtmchecklist>
+  * **items list** is a list of items separated either by:
-  * **items list** is a list of item separated either by:
     * //return line//
     * //pipe char//
@@ Line 63: / Line 71: @@
 ===== Configuration and Settings =====
-In the //profile// page, you need to setup the Remember the milk import email address. Format should be something like: rmilkuser+xxxxx+import@rmilk.com. You can find this email address at https://www.rememberthemilk.com/#section.settings under the "info" tab.
+In the //profile// page, you need to setup the Remember the milk import email address. Format should be something like: ''%%rmilkuser+xxxxx+import@rmilk.com%%''. You can find this email address at https://www.rememberthemilk.com/#section.settings under the "info" tab.
 ===== Development =====
-//[downloadable blocks, development comments]//
 === Change Log ===
-//[preferable GitHub RSS feed or similar]//
+{{rss>https://github.com/fabienli/dokuwiki-plugin-rtmchecklist/commits/master.atom date}}
   * **2014-01-27**
     * Initial release
 === ToDo/Wish List ===
- * localization
+  * localization
 ===== FAQ =====
-//[discussions should ideally be deleted and turned into FAQ entries along the way]//
+  * Do I need to update the wiki template to add the "Send" button ?
+No, the button is added by the plugin at the bottom of each checklists. The plugin should then be compatible with any template, zithout modification
-===== Discussion =====
-//Could be placed on an external page (e.g. plugin:pluginname:discussion) to have a distinction between user comments and author docs//