Changes between Version 51 and Version 52 of TracCronPlugin

Timestamp:

Sep 2, 2017, 8:48:59 AM (7 years ago)

Author:

figaro

Comment:

Rearranged paragraphs to maintain consistency

TracCronPlugin

@@ -1 +1 @@
 [[PageOutline(2-5,Contents,pullout)]]
 
-= Trac Cron task scheduler
+= Trac task scheduler, recurring tasks
 
 == Description
@@ -8 +8 @@
 
 Key features:
- * Task are plugin
- * Bundled out-of-the-box task
- * Scheduler are plugin
+ * Tasks are implemented as Python plugins
+ * Comes bundled with out-of-the-box tasks
+ * Scheduler is implemented as a plugin
  * Bundled out-of-the-box scheduler; '''new''': cron syntax is supported
- * Listener mechanism to be notified of task execution 
+ * Listener mechanism allows the user to be notified of task execution 
  * Bundled out-of-the-box listener; '''new''': admin panel for listener
- * Task execution history; '''new''': rss feed is available
+ * Task execution history can be viewed through an rss feed
 
 The plugin provides an administration panel to help with scheduling:
@@ -20 +20 @@
 [[Image(tcp_admin_panel.png, 80%, border=2)]]
 
-== Bugs/Feature Requests
-
-Existing bugs and feature requests for TracCronPlugin are 
-[report:9?COMPONENT=TracCronPlugin here].
-
-If you have any issues, create a 
-[/newticket?component=TracCronPlugin new ticket].
-
-[[TicketQuery(component=TracCronPlugin,group=type,format=progress)]]
-
-== Download
-
-Current stable release is '''0.3.1'''.
-
-You can use `easy_install` or `pip` to download and install the latest package into your Python environment:
-{{{#!sh
-easy_install TracCronPlugin
-}}}
-
-or: 
-{{{#!sh
-pip install TracCronPlugin
-}}}
-
-Alternatively, download the [pypi:TracCronPlugin distribution files] from PyPI for installation from source only.
-
-== Source
-
-You can browse the source or clone TracCronPlugin from [https://bitbucket.org/t2y/trac.plugins.traccron BitBucket] using Mercurial.
-Originally, TracCronPlugin source is hosted in [/svn/traccronplugin trac-hacks.org svn], but is no longer maintained there.
-
-== Example
-
-Simply create in a module (.py) a class that implements the ICronTask and put it in the plugins directory. Then you can either modify the trac.ini file or use the Trac cron admin panel.
+To add a task to the scheduler simply create in a module (.py) a class that implements the ICronTask and put it in the `plugins` directory. Then you can either modify your `trac.ini` file or use the Trac cron admin panel.
 
 === Writing a task
@@ -112 +79 @@
 === Installing a task
 
-Since tasks are components you just have to put the class definition of your task in a Python module in the plugins directory.
-You can either create a .py file and put it in the plugins directory or you can package the .py file into an egg and leave it in the plugins directory.
+Since tasks are components, you just have to put the class definition of your task in a Python module in the `plugins` directory.
+You can either create a .py file and put it in the `plugins` directory or you can package the .py file into an egg and leave it in the `plugins` directory.
 
 TracCronPlugin will show the task in the administration panel.
 
+Other examples of how to implement recurring tasks are given below.
+
+== Bugs/Feature Requests
+
+Existing bugs and feature requests for TracCronPlugin are 
+[report:9?COMPONENT=TracCronPlugin here].
+
+If you have any issues, create a 
+[/newticket?component=TracCronPlugin new ticket].
+
+[[TicketQuery(component=TracCronPlugin,group=type,format=progress)]]
+
+== Download
+
+Download the zipped source from [export:traccronplugin here], however the latest stable version is maintained at [https://bitbucket.org/t2y/trac.plugins.traccron BitBucket].
+Current stable release is '''0.3.1'''.
+
+== Source
+
+You can browse the source or clone TracCronPlugin from [https://bitbucket.org/t2y/trac.plugins.traccron BitBucket] using Mercurial.
+Originally, TracCronPlugin source is hosted in [/svn/traccronplugin trac-hacks.org svn], but is no longer maintained there.
+
+== Installation
+
+You can use `easy_install` or `pip` to download and install the latest package into your Python environment:
+{{{#!sh
+$ easy_install TracCronPlugin
+}}}
+
+or: 
+{{{#!sh
+$ pip install TracCronPlugin
+}}}
+
+Alternatively, download the [pypi:TracCronPlugin distribution files] from PyPI for installation from source only.
+
 == Configuration
 
-The plugin can be entirely configured from either within the trac.ini file or from the administration panel.
+The plugin can be entirely configured from either within the `trac.ini` file or from the administration panel.
 The section name of TracCronPlugin is `traccron`, here is a full sample: