- Project tools
- How do I...
|Over 500 more tools...
Newsbruiser Entry CGIs
Leonard Richardson <email@example.com>
There are several CGIs whose purpose is to view and manipulate
notebook entries in various ways.
- add.cgi provides an interface to adding a new entry to
that notebook. If the notebook has categories enabled, you can also
file the new entry under zero or more categories. You need to enter
the notebook's password to use add.cgi.
will give you an interface to add an entry to the mynotebook
- view.cgi takes a notebook name and an entry ID (complete
or partial), and displays the corresponding entry or entries.
will show you the current month of entries in mynotebook. It
also shows an appropriate navigation bar and search box on the top and
the bottom of the entry list.
directory]/view.cgi/mynotebook/lastmonth will show you the
previous month of entries in mynotebook. This is so you can
make an archives link which will always work.
directory]/view.cgi/mynotebook/2001/ will show you all the entries
made in mynotebook in 2001.
directory]/view.cgi/mynotebook/2001/7 will show you all the entries
made in mynotebook in July 2001.
directory]/view.cgi/mynotebook/2001/7/9 will show you all the
entries made in mynotebook on the 9th of July,
directory]/view.cgi/mynotebook/2001/7/9/1 will show you the second
entry made in mynotebook on the 9th of July,
You can also specify a value for the argument order to
force view.cgi to display its entries in chronological or reverse
chronological order (instead of whatever is set as the default).
show the entries from July 2001 in chronological order, and
show entries from the current month in reverse chronological order.
- edit.cgi takes a notebook name and an entry ID. If the
entry ID specifies one particular entry, edit.cgi provides an
interface to changing the text, title and/or author. If the notebook
has categories enabled, you can also change the categories with which
the entry is associated. You must specify the notebook's password to
change an entry.
If the entry ID specifies multiple entries, then all of them are
displayed, in the same format as view.cgi displays them, except that
with edit.cgi each entry will have a button that you can click on to
edit that entry.
directory]/edit.cgi/mynotebook/2001/7/9/1 will give you an
interface to edit the second entry made in mynotebook on the
9th of July, 2001.
will show you the current month of mynotebook entries along
with edit buttons. All the other view.cgi examples also apply,
- delete.cgi takes one and only one entry (ie. an entry ID
that designates a particular entry). When you confirm, it deletes the
entry and reshuffles the entries for that date to fill any gap left by
the entry. This CGI will only work if the notebook has entry deletion
enabled. You need to enter the notebook's password to use delete.cgi.
- calendar.cgi takes a notebook name and either the year
portion or the year and month portions of an entry ID. It displays a
calendar of that year or that month, with the days linked to the
entries for that day. Beside each entry is a graphical indication of
how much was posted that day.
- search.cgi takes a query string "q", which contains the
string to be searched for. You can search for any combination of
alphanumerics, space, dash, underscore, period, and the at
sign. Everything else will be filtered out and the filtered string
used to search. If you don't specify q, you'll get a spartan form with
a search box. If you do specify q, you'll get the search box and all
the entries matching your search string, using the same format used by
- random.cgi prints out a random entry from a notebook. It
takes no arguments.
- rss.cgi prints out an RSS feed for a notebook. It takes
two arguments: "version", which can be "0.92", "1.0", "2.0", or "3.0",
corresponding to the RSS version you want, and "entries", which
controls the number of recent entries you want to get (the default is
- configure.cgi lets you configure various aspects of a
notebook. From here you can set or change the contact information,
enable various features, customize the UI, etc. If your notebook is
set up to enable cookie authentication, you must be logged in to use
theme-generate.cgi Otherwise, you must enter the notebook's password
to change any of the configuration options.
- util.cgi is used to perform various administrative
actions on the notebook. Currently the only thing you can do from
util.cgi is rebuild the notebook's search index. You should
only need to do this if your index gets corrupted due to a bug in
You must enter the notebook's administrative password to use
- theme-generate.cgi is used to turn your UI configuration
into a NewsBruiser theme file. If your notebook is set up to enable
cookie authentication, you must be logged in to use
Back to the main documentation