Next: , Previous: Accomplishments, Up: Task Reports and Overviews


6.2.3.2 Status Reports

planner-report.el creates a status report for a given timespan. The report itself is just another Planner page in your planner directory. Once generated, it contains tasks and notes culled from active project pages. Tasks are only shown if they are incomplete or were completed within the timespan. Notes are shown if they were created during the timespan. Tasks and notes are grouped together under a heading for their corresponding project.

The idea is you have one of these status reports generated periodically (say, every couple of weeks). Perhaps you use cron to run them automatically and then mail you a reminder that they've been done. Then you can edit the page, adding verbiage where it is needed and removing irrelevant items. This editing process is as easy as editing any other Planner page. Finally, you can publish the page along with the rest of your planner using M-x muse-project-publish.

If you use planner-authz.el, you can tell planner-report.el only to consult project pages that a given list of users (planner-report-authz) can access when generating the report. For example, if you're preparing a status report for your boss, add yourself and him to planner-report-authz. The resulting status report will only contain information the two of you are supposed to have access to, and the report itself will be similarly restricted.

Getting started

Add the following to your .emacs file:

     (require 'planner-report)

Then you can use the following command to generate a status report:

     M-x planner-report-generate

You will be prompted for a beginning and ending date, and then the status report will be generated. You can then edit it to your liking and publish it just like you would the rest of your planner.

Options

— User Option: planner-report-authz

List of users a status report should be restricted to. When status reports are generated, only planner pages accessible by these users will be consulted, and the resulting status report will be similarly restricted.

— User Option: planner-report-pretty-print-plan-pages

If non-nil, pretty print plan pages. If nil, leave page names as-is. This requires that muse-wiki.el be loaded to work properly.

— User Option: planner-report-remove-task-numbers

Remove task numbers when generating status reports.

— User Option: planner-report-replace-note-numbers

If non-nil, a string with which to replace note numbers when generating status reports.

— User Option: planner-report-unfinished-offset

If non-nil, the offset in days from the current date of unfinished tasks to include in the status report. If nil, include all unfinished tasks.

Functions

— Function: planner-report-generate begin end

Generate a status report spanning a period from begin to end. begin and end are in the format YYYY.MM.DD.