To Do
This is my To Do list for RESTLog. Warning: incoherent ramblings on half-baked ideas ahead. Enhancements to add to the RESTLog client and server implementations, in roughly their order of priority:
Template Editing- Add the ability to edit the HTML and RSS template files.
Should be able to GET them up in the edit box in RESTLogClient
and then PUT them back. Requires adding to the RESTLog interface, probably
add the URL
RESTLog.cgi/template
and then use content negotiation to refer to either the HTML or RSS template file. This will also require adding two more buttons to the client UI; "Edit HTML Template" and "Edit RSS Template" which when pressed all the other buttons need to disappear and replace the "Edit XXXX Template" to "Update XXXX Template". Have to also remember to disable the "Title" control.Update: Completed.
Template Editing II- Add handling to the client and server for the structured
'templates' format as it is outlined in Template
And Archive Revisions.
Update: Completed.
Python Cleanup- Make all the code in RESTLog.cgi into a library
make RESTLog.cgi a simple called of the libraries. This will make it
easier to upgrade when running RESTLog on multiple directories, for example
here with one running the root and also in stories.
Add the following line to the .htaccess file:
SetEnv PYTHONPATH /my/home/dir/lib/python
. In the process of cleaning up also ensure that all customization is done in RESTLog.cgi and confirm that installs in different directories can use a common set of template files if they want to.Update: Completed.
C# Cleanup- The RESTLog interface code needs to be cleaned up. Create a single
HTTP class that has the following members: PUT(), GET(), POST() and DELETE().
For example:
HTTP.PUT(string URL, string ContentType)
.Update: Completed, just need to release the code.
Archives- Content will soon start rolling off the main page. Need
to setup an archiving mechanism. The first brush idea is to
provide a URI driven mechanism, such as:
RESTLog.cgi/1-20
which returns a page with items one through twenty displayed. Then I could provide an archive pageRESTLog.cgi/archives
that was dynamically generated with links to groups of postings in groups of twenty. This may tie into the searching.Update: Completed.
Archives II- Add handling to the client and server for the structured
'archives' format as it is outlined in Template
And Archive Revisions.
Update: Completed.
- _type=xml
- Using the simple extension ?xml is convenient but will cause grief for implementing search, need to add a second method of ?_type=xml. Support both styles.
- Excerpts
- Possibly add support for excerpts. Put the excerpts in the 'description' element and the full content in 'content:encoded'. Maybe.
- Search
- Need the ability to search the site using the
URL
RESTLog.cgi?q=search+terms
. One thing to remember is that the search may have to operate on multiple data directories if you want to search across a site with multiple installs of RESTLog, like is done here with the news and a separate directory for stories. Cool URIs Don't Change- Tweak the Python scripts and .htaccess files so that we conform as
closely as possible to the suggestions in Cool URIs Don't Change.
Update: Completed.
- Tidy
- Incorporate HTML validation into the client, possibly by shelling out to Tidy.