496 lines
30 KiB
HTML
496 lines
30 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<link rel="shortcut icon" href="../img/favicon.ico" />
|
|
<title>FAQ - ELOG Electronic Logbook</title>
|
|
<link rel="stylesheet" href="../css/theme.css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "FAQ";
|
|
var mkdocs_page_input_path = "faq.md";
|
|
var mkdocs_page_url = null;
|
|
</script>
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
|
<script>hljs.highlightAll();</script>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> ELOG Electronic Logbook
|
|
</a><div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../userguide/">User guide</a>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../adminguide/">Admin guide</a>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../config/">Config file</a>
|
|
</li>
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="#">FAQ</a>
|
|
<ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="#how-does-one-configure-elog-to-display-the-last-message-by-default">How does one configure elog to display the last message by default</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#are-there-any-plans-to-implement-a-mysql-back-end">Are there any plans to implement a MySQL back end?</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#can-i-run-the-elog-daemon-from-inside-apache-or-any-other-web-server">Can I run the ELOG daemon from inside Apache or any other Web server?</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#i-can-access-my-logbook-without-any-password-isnt-that-a-security-problem">I can access my logbook without any password, isn't that a security problem?</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#i-want-a-bookmark-pointing-to-the-last-page-where-an-attribute-has-a-certain-value">I want a bookmark pointing to the last page where an attribute has a certain value</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#i-want-a-logbook-with-public-read-access-no-password-but-restricted-write-access">I want a logbook with public read access (no password), but restricted write access</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#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">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.</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#how-can-i-configure-elog-such-that-it-displays-something-else-than-the-message-list-by-default">How can I configure ELOG such that it displays something else than the message list by default?</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#i-want-to-have-additional-commands-specific-to-my-lookbook">I want to have additional commands specific to my lookbook</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#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">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.</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#how-can-i-track-various-revisions-of-a-message-using-the-edit-command">How can I track various revisions of a message using the "edit" command?</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#how-can-i-enter-a-date-which-is-different-from-current-one">How can I enter a date which is different from current one?</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#i-cannot-pass-the-login-page-its-always-redisplayed-even-if-i-put-in-the-right-password">I cannot pass the login page, it's always redisplayed even if I put in the right password?</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#how-can-i-change-an-attribute-for-an-entire-thread-we-have-an-attribute-open-problemfixed-which-should-be-changed-for-the-whole-thread-if-that-problem-has-been-fixed">How can I change an attribute for an entire thread? We have an attribute "open problem/fixed" which should be changed for the whole thread if that problem has been fixed.</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#can-i-use-rss-feeds-with-password-protected-logbooks">Can I use RSS feeds with password protected logbooks?</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#how-can-i-make-a-whole-thread-open-or-closed">How can I make a whole thread open or closed?</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#does-elog-have-a-spell-checker">Does elog have a spell checker?</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#why-are-entries-with-large-attachments-submitted-so-slowly">Why are entries with large attachments submitted so slowly?</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#the-elgod-daemon-crashes-from-time-to-time-what-can-i-do">The elgod daemon crashes from time to time, what can I do?</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#how-can-i-create-an-elog-entry-automatically-from-a-script">How can I create an ELOG entry automatically from a script?</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#i-want-to-notify-different-people-for-different-things-how-do-i-set-up-this">I want to notify different people for different things, how do I set up this?</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../forum/">Forum</a>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../wishlist/">Wishlist</a>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../contrib/">Contributions</a>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../demo/">Demo</a>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../download/">Download</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">ELOG Electronic Logbook</a>
|
|
|
|
</nav>
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
|
|
<li class="breadcrumb-item active">FAQ</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div class="section" itemprop="articleBody">
|
|
|
|
<h1 id="elog-faq">ELOG FAQ</h1>
|
|
<p><strong>Frequently Asked Questions about usage and configuration</strong></p>
|
|
<p>Please check also the <a href="http://elog.psi.ch/elogs/Forum">ELOG Forum</a>.</p>
|
|
<hr />
|
|
<h2 id="how-does-one-configure-elog-to-display-the-last-message-by-default">How does one configure elog to display the last message by default</h2>
|
|
<p>One can use the <strong><code>Start page</code></strong> option for that. The entry:</p>
|
|
<p><code>Start page = 0?cmd=last</code></p>
|
|
<p>shows the last message entry by default. To have the described behaviour
|
|
for all logbooks, the above statements can be placed in the
|
|
<strong><code>[global]</code></strong> section.</p>
|
|
<h2 id="are-there-any-plans-to-implement-a-mysql-back-end">Are there any plans to implement a MySQL back end?</h2>
|
|
<p>No. The idea behind <strong>ELOG</strong> is that it is a <em>simple to use, simple to
|
|
install</em> application. Many people use <strong>ELOG</strong> 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 <strong>ELOG</strong> should
|
|
be independent of any other package, some "switchable" backend between
|
|
native <strong>ELOG</strong> format and MySQL would be needed, which is lots of work
|
|
and not planned right now.</p>
|
|
<p>However, there are several contributions from other people who wrote
|
|
scripts to put ELOG entries into a MySQL database. One is available at
|
|
<a href="http://elog.psi.ch/elogs/Forum/387">http://elog.psi.ch/elogs/Forum/387</a>.</p>
|
|
<h2 id="can-i-run-the-elog-daemon-from-inside-apache-or-any-other-web-server">Can I run the ELOG daemon from inside Apache or any other Web server?</h2>
|
|
<p>No. The <strong>ELOG</strong> daemon was designed as a standalone server and it will
|
|
stay like that in the future. The reason for that is that <strong><code>elogd</code></strong>
|
|
should not rely on any other software. This is for example important for
|
|
many people running <strong><code>elogd</code></strong> under Windows, and they have no clue how
|
|
to install Apache for Windows. The installation and maintenance for
|
|
<strong><code>elogd</code></strong> therefore becomes much simpler. To run <strong><code>elogd</code></strong> 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>
|
|
<h2 id="i-can-access-my-logbook-without-any-password-isnt-that-a-security-problem">I can access my logbook without any password, isn't that a security problem?</h2>
|
|
<p>By default, no password is used in <strong>ELOG</strong>. 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/#access-control">Access
|
|
control</a>. The recommended setup is password file
|
|
security with guest access.</p>
|
|
<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/#secure-connections-howto">secure</a> network connection should be used.</p>
|
|
<h2 id="i-want-a-bookmark-pointing-to-the-last-page-where-an-attribute-has-a-certain-value">I want a bookmark pointing to the last page where an attribute has a certain value</h2>
|
|
<p>Use the URL:</p>
|
|
<p><code>http://<your.host>/<logbook>/?cmd=Last&<attribute>=<value></code></p>
|
|
<p>This executes the "<em>Last</em>" command using a filter with
|
|
<strong><code><attribute>=<value></code></strong>. The following command displays the same page,
|
|
but also locks the attribute (checks the box next to <code><attribute></code>) so
|
|
that browsing (next, previous, first, last) only shows pages with that
|
|
attribute value.</p>
|
|
<p><code>http://<your.host>/<logbook>/?cmd=Last&<attribute>=<value>&l<attribute>=1</code></p>
|
|
<p>Note the <code>"l"</code> before the second attribute, as in <code>"*lAuthor=1*"</code>.</p>
|
|
<h2 id="i-want-a-logbook-with-public-read-access-no-password-but-restricted-write-access">I want a logbook with public read access (no password), but restricted write access</h2>
|
|
<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 <strong>"Guest menu
|
|
command"</strong>. Use a logbook with user level access (password file), and
|
|
add menu lists like in the following example to the configuration file:</p>
|
|
<pre><code class="language-text">Menu commands = New, Edit, Reply, Find, Last 10, Change password, Logout, Help
|
|
Guest menu commands = Find, Last 10, Login, Help
|
|
</code></pre>
|
|
<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>
|
|
<p>An optional self registration is possible by specifying</p>
|
|
<p><code>Self register = 1</code></p>
|
|
<p>in the configuration file. New users can then create their own accounts.</p>
|
|
<h2 id="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">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.</h2>
|
|
<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>
|
|
<h2 id="how-can-i-configure-elog-such-that-it-displays-something-else-than-the-message-list-by-default">How can I configure ELOG such that it displays something else than the message list by default?</h2>
|
|
<p>There is a simple trick. You use the <strong>"<em>Start page</em>"</strong> option in the
|
|
<strong><code>elogd</code></strong> file to redirect the start page to something else. Here are
|
|
some examples:</p>
|
|
<pre><code class="language-text">?npp=5 for the last 5 messages
|
|
?last=7 show last 7 days (week)
|
|
?cmd=New show the new message entry form
|
|
?cmd=Find Show the "find" page
|
|
?cmd=Search&<attrib>=<value> for a search with <attrib>=<value>
|
|
</code></pre>
|
|
<p>The various URLs can be copied from the browser's address bar when
|
|
doint various things there.</p>
|
|
<h2 id="i-want-to-have-additional-commands-specific-to-my-lookbook">I want to have additional commands specific to my lookbook</h2>
|
|
<p>New commands can be added for example with the
|
|
<strong><code>"Bottom text = bottom.html"</code></strong> option. To display all messages from
|
|
last week and month of with "category = info", one can put following
|
|
HTML code in bottom.html:</p>
|
|
<pre><code><center>
|
|
<a href="?last=7&Category=Info">Info from last week</a> |
|
|
<a href="?last=31&Category=Info">Info from last month</a> |
|
|
</center>
|
|
</code></pre>
|
|
<p>Note that the parameters <strong><code>"last=7&Category=Info"</code></strong> applies 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>
|
|
<h2 id="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">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.</h2>
|
|
<p>This works with the option <strong><code>Menu commands</code></strong>. By default, the menu
|
|
commands <strong><code>Back, New, Edit, Delete, Reply, Find, Config, Help</code></strong> are
|
|
dispalyed and allowed. To avoid editing (and deleting) of existing
|
|
messages, one removes the two commands and puts following statement into
|
|
<strong><code>elogd.cfg</code>:</strong></p>
|
|
<p><code>Menu commands = Back, New, Reply, Find, Config, Help</code></p>
|
|
<p>This prohibits the execution of the commands "Edit" and "Delete".</p>
|
|
<h2 id="how-can-i-track-various-revisions-of-a-message-using-the-edit-command">How can I track various revisions of a message using the "edit" command?</h2>
|
|
<p>There are two ways:</p>
|
|
<ul>
|
|
<li>Add an attribute which keeps the revision dates and names as follows:</li>
|
|
</ul>
|
|
<pre><code class="language-text">Attributes = Author, ..., Revisions
|
|
Locked attributes = Revisions
|
|
Subst on Edit Revisions = $Revisions<br>$date by $long_name
|
|
</code></pre>
|
|
<p>The "Revisions" attribute cannot be modified manually (since it's
|
|
locked). On each edit, the date and the current author is appedned to
|
|
the previous revisions. The "\<br>" puts a line break between the
|
|
entries.</p>
|
|
<ul>
|
|
<li>
|
|
<p>Create a thread for each entry. In addition of having the date and
|
|
author of different revisions, the message content is kept. To revise
|
|
and entry, one hits "Reply" instead of "Edit" (one can disable the
|
|
"Edit" command for example). If one puts following option into the
|
|
configuration file:</p>
|
|
<p><code>Reply string = ""</code></p>
|
|
</li>
|
|
</ul>
|
|
<p>then the reply contains the original message without the usual "> "
|
|
at the beginning of each line. One can then edit the message and
|
|
submit it. In the threaded message list display, one sees then the
|
|
different revisions as a message thread.</p>
|
|
<h2 id="how-can-i-enter-a-date-which-is-different-from-current-one">How can I enter a date which is different from current one?</h2>
|
|
<p>Usually, the current date/time is recorded when you add a new entry. It
|
|
might be, however, that one wants to enter "old" entries, or some
|
|
entries with a date in the future (like a to-do list with a due date).
|
|
To do that, on can add a new attribute (let's call it <em>Record date</em>, to
|
|
be different from the pre-defined <em>Date</em>:</p>
|
|
<pre><code class="language-text">Attributes = Author, ..., Record date
|
|
Type Record date = date
|
|
Preset Record date = $date
|
|
Date format = %Y %m %d
|
|
List Display = Record date, Author, ...
|
|
Start page = ?rsort=Record date
|
|
</code></pre>
|
|
<p>The <em>Preset Record date</em> statement sets the record date to the current
|
|
date, but this can then of course edited during the message entry. The
|
|
<em>List Display</em> and <em>Start page</em> statements show the record date as the
|
|
first column in the summary display and also sort by that. Note the
|
|
<em>Date format</em> showing first year, then month and day. This is necessary
|
|
since sorting is done only lexically. Please note that the <em>List
|
|
Display</em> was renamed recently. Prior to version 2.3.10, it was called
|
|
<em>Display Search</em>.</p>
|
|
<h2 id="i-cannot-pass-the-login-page-its-always-redisplayed-even-if-i-put-in-the-right-password">I cannot pass the login page, it's always redisplayed even if I put in the right password?</h2>
|
|
<p>This can happen if you change the login policy, for example move the
|
|
<strong><code>Password file =</code></strong> entry in the configuration file from a logbook
|
|
section to the [global] section or back. In that case some old cookies
|
|
could be stored in your browser, which confuse the system. Please delete
|
|
your cookies in the browser to resolve this problem. Read your browser
|
|
documentation on how to do that.</p>
|
|
<h2 id="how-can-i-change-an-attribute-for-an-entire-thread-we-have-an-attribute-open-problemfixed-which-should-be-changed-for-the-whole-thread-if-that-problem-has-been-fixed">How can I change an attribute for an entire thread? We have an attribute "open problem/fixed" which should be changed for the whole thread if that problem has been fixed.</h2>
|
|
<p>This is a typical request of a bug-tracking set-up. Someone enters a
|
|
request, opening a new thread. The expert(s) reply to the the request,
|
|
and after a while, the request gets satisfied or the problem gets fixed.
|
|
If an attribute like "status", having the options "open" and
|
|
"fixed" could get changed for the whole thread, on could very easily
|
|
search for all "open" problems.</p>
|
|
<p>Since this functionality is not implemented, an alternative strategy is
|
|
recommended: Implement two (or more) logbooks. The first logbook has
|
|
open issues, the second one has fixed ones. When an entry changes state,
|
|
it simply has to be copied to the second logbook. This can be done by
|
|
defining the menu command "move" in the config file, like:</p>
|
|
<p><code>Menu commands = Back, New, Edit, Delete, Reply, Find, Move to, Config, Help</code></p>
|
|
<p>Note the additional <strong><em>Move to</em></strong>. This solution is even more elegant
|
|
than having attributes changed in whole threads, since one has two
|
|
separate logbooks, and can treat the second one more like an archive,
|
|
make separate back-ups, or deleting some entries after some time, while
|
|
keeping the open issues untouched.</p>
|
|
<h2 id="can-i-use-rss-feeds-with-password-protected-logbooks">Can I use RSS feeds with password protected logbooks?</h2>
|
|
<p>RSS feeds normally only work for logbooks which have at least public
|
|
read access (via the guest menu commands). There is however a way to
|
|
allow only restricted read access and still use RSS feeds. This is done
|
|
by adding an additional read password via the
|
|
<strong><code>elogd -r <pwd> -l <logbook></code></strong> command. This password (username may
|
|
be any) can then be used in an RSS reader for restricted access. One
|
|
reader which has been successfully used with this kind of authentication
|
|
is <a href="http://www.rssreader.com">RSSReader</a>.</p>
|
|
<h2 id="how-can-i-make-a-whole-thread-open-or-closed">How can I make a whole thread open or closed?</h2>
|
|
<p>Sometime people want to mark a whole thread in a way. An example is a
|
|
to-do list, where they want a special icon on high priority things, and
|
|
have this icon disappear one the task is finished. This can be easily
|
|
done with icons. The configuration could look like this:</p>
|
|
<pre><code class="language-text">Attributes = Author, Status, Subject
|
|
IOptions Status = icon1.gif, icon2.gif, icon4.gif
|
|
Preset Status = icon4.gif
|
|
Preset on reply status = icon2.gif
|
|
Icon comment icon1.gif = Closed entry
|
|
Icon comment icon4.gif = Open entry
|
|
Thread display = $Author $Subject
|
|
Thread icon = Status
|
|
</code></pre>
|
|
<p>New entries get an exclamation mark icon for example ("Preset status =
|
|
..."). Replies to this entry get a reply icon. Once the thread should
|
|
be closed, one simple edits the top entry in that thread and changes the
|
|
icon. The icon1.gif from the distribution is maybe not ideally suited
|
|
for that, but one could make a green check mark icon for example for
|
|
that. The "Thread display" and "Thread icon" make this icon appear
|
|
at the left side of the threaded display.</p>
|
|
<p>An alternative approach would be to use two logbooks. The first one
|
|
receive all new entries ("open items"). Once an entry (with its
|
|
replies) gets closed, it must be moved manually to the second logbook
|
|
("closed items"). This can be done with the "Move To" command (see
|
|
"menu commands" in config file). This way one nicely separates open
|
|
and closed items in two separate logbooks. One can still search both
|
|
logbooks at the same time if one checks "Search all logbooks" in the
|
|
find page.</p>
|
|
<p>Starting from elog version 2.7.7, there now even a third way to do this.
|
|
With an additional line in the configuration file: Collapse tn last = 1
|
|
(in fact the default, but to be explicit), then when the thread is ready
|
|
to be marked as closed, select the "closed entry" icon when writing
|
|
the last entry. When the entries are viewed in "threaded" mode, then
|
|
the closed entry icon appears on the last entry; and when in "threaded,
|
|
collapsed" mode, then the closed entry icon appears in the one line
|
|
that represents that whole thread.</p>
|
|
<h2 id="does-elog-have-a-spell-checker">Does elog have a spell checker?</h2>
|
|
<p>No, but you can use any spell checker which works with your browser.
|
|
Examples are <a href="http://www.iespellc.com">IESpell</a> for Internet Explorer
|
|
and <a href="http://spellbound.sourceforge.net">SpellBound</a> for Mozilla-based
|
|
browsers.</p>
|
|
<h2 id="why-are-entries-with-large-attachments-submitted-so-slowly">Why are entries with large attachments submitted so slowly?</h2>
|
|
<p>If email notifications are used, the ELOG program has to pass these
|
|
attachments to the email server, which might take quite some time. Some
|
|
email servers even don't allow to forward attachments if they are
|
|
larger than a few mega bytes. In that one can simply turn off the
|
|
forwarding of email attachments with</p>
|
|
<p><code>Email format = 111</code></p>
|
|
<p>this causes only the attachment names being forwarded, not the
|
|
attachments themselves.</p>
|
|
<h2 id="the-elgod-daemon-crashes-from-time-to-time-what-can-i-do">The elgod daemon crashes from time to time, what can I do?</h2>
|
|
<p>Bugs are constantly fixed inside elogd so a upgrade to the current
|
|
version is recommended as a first measrue. If that does not help, the
|
|
key will be the reproducibility of the crash. I only can fix problems if
|
|
I can reproduce them. Sometimes it's related to strange logbook entries
|
|
which cause elogd to crash when they are edited. So if there is a way to
|
|
reproducible trigger the problem, I need the files and confiration
|
|
related with it. If I can reproduce it in my local installation, I can
|
|
fix it pretty soon.</p>
|
|
<p>If that is not possible, an alternative is to run elgod under a
|
|
debugger, and do a stack trace if the program dies. Under linux, this
|
|
can be done using the gdb debugger, which might look like this:</p>
|
|
<pre><code class="language-text">[~/elog]$ gdb ./elogd
|
|
GNU gdb Red Hat Linux (6.5-25.el5rh)
|
|
...
|
|
|
|
(gdb) run
|
|
Starting program: /afs/psi.ch/user/r/ritt/elog/elogd
|
|
elogd 2.7.5 built Dec 2 2008, 10:47:09 revision 2147
|
|
ImageMagick detected
|
|
Indexing logbooks ... test
|
|
|
|
Program received signal SIGSEGV, Segmentation fault.
|
|
0x08054beb in el_index_logbooks () at src/elogd.c:3892
|
|
3892 *p = (char)1;
|
|
(gdb) where
|
|
#0 0x08054beb in el_index_logbooks () at src/elogd.c:3892
|
|
#1 0x080b8774 in server_loop () at src/elogd.c:27565
|
|
#2 0x080bbdd5 in main (argc=1, argv=0xbfee5b54) at src/elogd.c:28923
|
|
(gdb)
|
|
</code></pre>
|
|
<p>So the basic command is to make a stack trace with "where" after a
|
|
segmentation fault. This tells me where in the code something wrong
|
|
happened (in this case it was inside the function el_index_logbooks() at
|
|
line 3892. Please send me this information and I will try then to figure
|
|
out what was wrong.</p>
|
|
<h2 id="how-can-i-create-an-elog-entry-automatically-from-a-script">How can I create an ELOG entry automatically from a script?</h2>
|
|
<p>The <a href="../userguide/#elog-command-line-client">User's
|
|
Guide</a> describes the standalone "elog"
|
|
utility, which can be used from a script or from another program to
|
|
submit an automatic email entry. This works locally or remotely, with
|
|
optional attachments. Enter "elog -h" for a full list of options. The
|
|
elog utility is part of the distribution and resides in the same
|
|
directory as the elogd daemon.</p>
|
|
<h2 id="i-want-to-notify-different-people-for-different-things-how-do-i-set-up-this">I want to notify different people for different things, how do I set up this?</h2>
|
|
<p>Assume you want to send an email notification to person A for a problem
|
|
report, to person B for problem fix and so on. The simplest way is to
|
|
use the <code>Email <attribute> <value> = <email address></code> syntax. So you
|
|
could set-up following configuration:</p>
|
|
<pre><code class="language-text">Attributes = Author, Type
|
|
Options Type = Problem Report, Problem Fix
|
|
Email Type Problem Report = person.a@elog.com
|
|
Email Type Problem Fix = person.b@elog.com
|
|
</code></pre>
|
|
<p>If you want to select email addresses directly from a list, you can do
|
|
the set-up as following: Attributes = Author, Notify MOptions Notify =
|
|
Person A, Person B Email Notify Person A = person.a@elog.com Email
|
|
Notify Person B = person.b@elog.com This way you can for each entry
|
|
select one or more people to be notified from the pre-defined list.</p>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="../config/" class="btn btn-neutral float-left" title="Config file"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
<a href="../forum/" class="btn btn-neutral float-right" title="Forum">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
</div>
|
|
|
|
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" aria-label="Versions">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
|
|
<span><a href="../config/" style="color: #fcfcfc">« Previous</a></span>
|
|
|
|
|
|
<span><a href="../forum/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script src="../js/jquery-3.6.0.min.js"></script>
|
|
<script>var base_url = "..";</script>
|
|
<script src="../js/theme_extra.js"></script>
|
|
<script src="../js/theme.js"></script>
|
|
<script src="../search/main.js"></script>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|