Files
elog/doc/faq.html
T
ritt c59db781c7 *** empty log message ***
SVN revision: 373
2003-01-31 20:43:34 +00:00

184 lines
8.6 KiB
HTML
Executable File

<HTML>
<HEAD>
<TITLE>ELOG FAQ</TITLE>
<LINK REV="made" HREF="mailto:fredp@mygale.org">
<META NAME="generator" CONTENT="NoteTab Light 4.86c">
<META NAME="author" CONTENT="Fred Pacquier">
<META NAME="description" CONTENT="Home of the Electronic Logbook (ELOG) package">
<META NAME="keywords" CONTENT="ELOG MIDAS PSI RITT">
<LINK REL="stylesheet" TYPE="text/css" HREF="elog.css">
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#800080" ALINK="#FF0000">
<div class=title>&nbsp; ELOG FAQ &nbsp;</div>
<p>
<div class=menu>&nbsp;Site map :&nbsp;
&nbsp;[<a class=nav href="index.html">Home</a>]&nbsp;
&nbsp;[<a class=nav href="userguide.html">User's Guide</a>]&nbsp;
&nbsp;[<a class=nav href="adminguide.html">Administrator's Guide</a>]&nbsp;
&nbsp;[FAQ]&nbsp;
&nbsp;[<a class=nav href="wishlist.html">Wishlist</a>]&nbsp;
&nbsp;[<a class=nav href="http://midas.psi.ch/elogdemo/">DEMO</a>]&nbsp;
&nbsp;[<a class=nav href="download.html">Download</a>]&nbsp;
</div>
<p>
<div class=Sub><i>Frequently Asked Questions about usage and configuration</i></div>
<hr>
<OL>
<LI><b>How does one configure elog to display a listing of all messages by default instead the last message</b>
<p>
Starting from version 2.2.0 on, a page with the last messages is displayed by default. To display
something else, one can use the <b><code>Start page</code></b> option in elogd. The entry:<p>
<code>
Start page = 0?cmd=last
</code><p>
shows the last entry by default (pre-2.2.0 behaviour). To show all messages, one can use:
<code><p>
Start page = ?cmd=Search&mode=summary&all=1<p>
</code><p>
This shows all messages from all logbooks (<i>all=1</i>). To have the described behaviour for
all logbooks, the above statements can be placed in the <b><code>[global]</code></b> section.
<p>
<LI><b>Are there any plans to implement a MySQL back end?</b>
<p>
No. The idea behind <b>ELOG</b> is that it is a <I>simple to use, simple to install</I> application. Many people use <b>ELOG</b> under Windows, and they even don't know what MySQL means. Other people like the flat file database format, because it's simple, easily accessible from other programs, and it's easy to backup certain days or months of the database (since the filenames contain the date). Since <b>ELOG</b> should be independent of any other package, some "switchable" backend between native <b>ELOG</b> format and MySQL would be needed, which is lots of work and not planned right now.
<p>
<LI><b>Can I run the ELOG daemon from inside Apache or any other Web server?</b>
<p>
No. The <b>ELOG</b> daemon was designed as a standalone server and it will stay like that in the future.
The reason for that is that <code><b>elogd</b></code> should not rely on any other software. This is for
example important for many people running <code><b>elogd</b></code> under Windows, and they have no clue
how to install Apache for Windows. The installation and maintenance for <code><b>elogd</b></code>
therefore becomes much simpler. To run <code><b>elogd</b></code> in parallel to an Apache server on
port 80, use Apache as a proxy, following the instruction on the installation page
("Running elogd under Apache").<p>
<LI><b>I can access my logbook without any password, isn't that a security problem?</b>
<p> By default, no password is used in <b>ELOG</b>. This can be useful for public directories etc. that
anybody should be able to read. To add password security, read the documentation under <a href=
"config.html#access">Access control</a>. The recommended setup is password file security with
guest access.
<p> Note that passwords are transferred over the network in plain text and therefore not secure. If this
is a problem, a <a href="adminguide.html#secure">secure</a> network connection should be used. <p>
<LI><b>I want a bookmark pointing to the last page where an attribute has a certain value</b>
<p>
Use the URL:
<p>
<code>http://&lt;your.host&gt;/&lt;logbook&gt;/?cmd=Last&&lt;attribute&gt;=&lt;value&gt;</code>
<p>
This executes the "<I>Last</I>" command using a filter with &lt;attribute&gt;=&lt;value&gt;. The following command displays the same page, but also locks the attribute (checks the box next to &lt;attribute&gt;) so that browsing (next, previous, first, last) only shows pages with that attribute value.
<p>
<code>http://&lt;your.host&gt;/&lt;logbook&gt;/?cmd=Last&&lt;attribute&gt;=&lt;value&gt;&l&lt;attribute&gt;=1</code>
<p>
Note the "l" before the second attribute, as in "<I>lAuthor=1</I>".
<p>
<LI><b>I want a logbook with public read access (no password), but restricted write access</b>
<p>
In an old version of the FAQ it has been stated here that one has to use two logbooks pointing to
the same data directory. From Version 2.0.6 on, this can be accomplished much easier by the usage
of the <b>"Guest menu command"</b>. Use a logbook with user level access (password file), and add
menu lists like in the following example to the configuration file:<p>
<code>
Menu commands = New, Edit, Reply, Find, Last 10, Change password, Logout, Help<br>
Guest menu commands = Find, Last 10, Login, Help<br>
</code><p>
If users access the logbook without supplying a user name, they are treated like "guests" and see
the "Guest menu commands", with which one cannot submit or edit logbook entries. If one hits the
"login" button, a user can login with a user name/password and sees the normal menu commands, with
which one can submit new logbook entries.<p>
An optional self registration is possible by specifying<p>
<code>
Self register = 1
</code><p>
in the configuration file. New users can then create their own accounts.<p>
<LI><b>I have many loogbooks with password files, so if I add a user or want to change
a password I have to do this for all logbooks which is painful.</b>
<p>
You can have several logbooks point to the same password file. So if you change a user or
password in that file, it becomes automatically available in all logbooks which use that file.
<p>
<LI><b>By default, ELOG displays the last entry from a logbook. How can I configure it to
display the last 10 messages instead?</b>
<p>
There is a simple trick. You use the <b>"<I>Welcome page</I>"</b> option in the <code><b>elogd</b></code> file
to redirect the start page to the <b>last 10</b> command. Put the statement:
<p>
<pre>
Welcome page = redir.html
</pre>
into <code><b>elogd</b></code> and create that file with following contents:
<p>
<pre>
&lt;head&gt;
&lt;meta http-equiv="refresh" content="0; URL=/logbook/last10"&gt;
&lt;/head&gt;
</pre>
This causes the welcome page being redirected to <b>/logbook/last10</b>, where <b>logbook</b> must be replaced by the current logbook name. Following other redirections are possible:
<p>
<pre>
/logbook/last20 for the last 20 messages and so on
/logbook/past1 for the last day
/logbook/past2 for the last two days and so on
/logbook?cmd=New for the new message entry form
/logbook?cmd=Find for the "find" page
/logbook?cmd=Search&amp;&lt;attrib&gt;=&lt;value&gt; for a search with &lt;attrib&gt;=&lt;value&gt;
</pre>
<LI><b>I want to have additional command specific to my lookbook</b>
<p>
New commands can be added for example with the <b><code>"Bottom text = bottom.html"</b></code> option.
To display all messages from last week and month of with "category = info", one can put
following HTML code in bottom.html:
<pre>
&lt;center&gt;
&lt;a href="?last=7&Category=Info"&gt;Info from last week&lt;/a&gt; |
&lt;a href="?last=31&Category=Info"&gt;Info from last month&lt;/a&gt; |
&lt;/center>
</pre>
<p>
Note that the parameters <b><code>"last=7&Category=Info"</b></code> apply a filter on the display. You can learn
how to make these filters by looking at the URL in your browser when you submit a find
command with certain options.<p>
<LI><b>How does one configure elog to disable editing of existing messages? I want a logbook where one
can enter messages but not change them afterwards.</b>
<p>
This works with the option <b><code>Menu commands</code></b>. By default, the menu commands <b><code>
Back, New, Edit, Delete, Reply, Find, Config, Help</code></b> are dispalyed and allowed. To avoid
editing (and deleting) of existing messages, one removes the two commands and puts following
statement into <b><code>elogd.cfg</b></code>:
<p>
<code>Menu commands = Back, New, Reply, Find, Config, Help</code>
<p>
This prohibits the execution of the commands "Edit" and "Delete".
<p>
</OL>
<HR>
<div class=footer>&nbsp;
Content by <a class=nav href="mailto:Stefan.Ritt@psi.ch">Stefan Ritt</a>,
Web pages by <a class=nav href="mailto:fredp@mygale.org">Fred Pacquier</a>
- last modified on 19/12/2001
&nbsp;</div>
</BODY>
</HTML>