Previous: <past-notes>, Up: More about Notes

6.5.4 Note Indices

Make sure that planner-notes-index.el is in your load path and add this to your .emacs (or _emacs): 

     (require 'planner-notes-index)

Then you can use tags of the form: 

     <planner-notes-index page="2004.03.02">
     <planner-notes-index from="2004.03.01" to="2004.03.31">
     <planner-notes-index limit="10">
     <planner-notes-index page="PlanPage">
     <planner-notes-index-month-table month="2004.03" limit="5">
     <planner-notes-index-month-table month="2004.03">

You can also use the following interactive functions:

planner-notes-index planner-notes-index-days planner-notes-index-weeks planner-notes-index-months planner-notes-index-years (wow!)

These work based on the current date (date of current buffer, or today).

If a single page is specified, this page is scanned for headlines of the form: 

      .#1 Headline

The results are presented as a bulleted list.

If from and to are specified, all date pages between them (inclusive) are scanned. If from is omitted, it is assumed to be the earliest entry. If to is omitted, it is assumed to be the latest entry.

If recent is specified, the list includes only that many recent headlines. and the results are presented as a bulleted list.

To customize presentation, you can write a function that generates the appropriate <planner-notes-index> tags. You can also use planner-extract-note-headlines in your own functions.

Functions

The following interactive functions are defined in planner-notes-index.el:

— Function: planner-notes-index &optional from to limit

Display a clickable notes index. If called from a Lisp program, display only dates between from and to. With a prefix arg limit, display only that number of entries.

— Function: planner-notes-index-days days

Display an index of notes posted over the past few days. The list ends with the day of the current buffer or planner-today.

— Function: planner-notes-index-weeks weeks

Display an index of notes posted over the past few weeks. The list ends with the week of the current buffer or planner-today. Weeks start from Sunday.

— Function: planner-notes-index-months months

Display an index of notes posted over the past few months. The list ends with the month of the current buffer or planner-today.

— Function: planner-notes-index-years years

Display an index of notes posted over the past few years. The current year is included.

planner-notes-index.el does not define any keybindings.