Next: , Previous: Creating Your Planner, Up: Installation


3.3 Components

Now that you have the archive, let's look at what's in it.

There should be three directories, named planner, muse and remember.

In the planner/ directory, you'll see many files with names like planner-gnus.el. These are extra modules and extensions for Planner, which you can use to tailor Planner to fit your desired planning and information management habits.

In the muse/lisp directory, you'll see many files with names like muse-blosxom.el. As in planner/, these are optional modules and extensions.

A minimal working installation includes just planner/planner.el.

You need planner.el because it provides the core functions for handling tasks, notes, and page navigation. You need Emacs Muse because it provides the functions used to display your pages (both in an emacs buffer and as HTML), and for connecting them to each other. More specifically, it enables you to have hyperlinks and formatting in your emacs buffers even though the actual files you are working with are saved in plain text. These abilities are used in Planner to format your planner pages the way you like, to create links from your tasks and notes to the materials and projects they refer to, and to optionally “publish” your pages in different formats, including HTML.

In the remember/ directory are files related to RememberMode. RememberMode does not depend on Planner or Muse, but works best with Planner installed. It is not required in order to use Planner, but it is used by many Planner users to record notes and information to their planner pages.

If you are curious, you can open each file in these directories and read the comments at the top, to get an idea of what each extension is used for. They are also all detailed later in this manual.