show/

index.php (the display engine)

I'll want to display entries:
- One at a time (like a Wiki).
- Many at a time, most recent first (like a blog).
- Many at a time, in summary form, on a calendar.
- Many at a time, in summary form (as in search results).
- One at a time (as a flashcard in a series).
The main file just grabs one or more entries from storage. The main file loads a "plugin" that decides how to display these entries (and may tell the main file whether to pull entries by name or by date, and whether to pull only the first few lines or the entire text of each entry). This allows me to, in the future, write a plugin that retrieves any sort of custom information from each entry, such as pictures (displayed in thumbnails on a page).

It is the URL that tells show.php which plugin to use to build and display the content. Thus "karig.net/week/2007-06-23" is translated to "karig.net/show?p=week&a=2007-06-23" which in turn includes "week.php".

Show.php uses only one plugin to display the main content, but it may load other plugins as "extras" specified by the template.

template.html (the display template)

The layout of the pieces of the page are stored separately from the programming logic (in show.php). The template contains no PHP -- only special "tags" such as "{CONTENT}" and "{SEARCH}" that tells show.php where to put things, and what things to put in. (Maybe extras: {EXTRA:911TRIBUTE} to run "911tribute.php" if it exists and add that script's output in place of that tag.)

plugins for "show"

edit/

index.php (the standalone editor)

The editor has a "list mode" that displays entry names as links; click on one to edit the entry.

The editor can edit plain text files. This is one advantage of having you enter straight HTML instead of markup. This also opens up the possibility of editing configuration files, e.g., "journal" files that list entry names in a hierarchy (which can be displayed by a "journal" plugin).

plugins for "edit"

.htaccess (the URL fixer)

The URL looks like this: karig.net/plugin_name/criteria, e.g., karig.net/page/Entry_name, or karig.net/week/2007-07-30, or karig.net/month/2007-06, etc.

entries/

Files are stored by name. An entry "Mnopqrs" would be stored at "store/mno/mnopqrs".

index.php

Contains code to store and retrieve entries by name. Also prevents direct exploration of this folder.

indexes/

Indexes by creation date and modification date are stored here. Custom fields can be indexed here also. An index is just a folder with a field name, containing a file for each field value; each file contains a list of names of entries associated with that field and value.

index.php

Contains code to create and update indexes. Also prevents direct exploration of this folder.

log/

Contains a record of each change made to the database (including a complete copy of each entry after it has been changed and resaved). This allows old versions of entries to be restored, and it shows what changes were made and when.

index.php

Contains code to append and retrieve log entries. Also prevents direct exploration of this folder.