294 lines
14 KiB
HTML
294 lines
14 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" /><meta name="description" content="None" />
|
|
<link rel="shortcut icon" href="img/favicon.ico" />
|
|
<title>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 = "Home";
|
|
var mkdocs_page_input_path = "index.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 class="current">
|
|
<li class="toctree-l1 current"><a class="reference internal current" href="#">Home</a>
|
|
<ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="#what-is-elog">What is ELOG ?</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#screen-shots">Screen shots</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#use-cases">Use cases</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#license">License</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#credits">Credits</a>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#talks-and-presentations">Talks and presentations</a>
|
|
</li>
|
|
</ul>
|
|
</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>
|
|
<li class="toctree-l1"><a class="reference internal" href="faq/">FAQ</a>
|
|
</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">Home</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="the-elog-home-page">The ELOG Home Page</h1>
|
|
<p>Home of the <em>Electronic Logbook</em> package by <a href="mailto:Stefan.Ritt@psi.ch">Stefan
|
|
Ritt</a></p>
|
|
<p><em>Current version: 3.1.4</em></p>
|
|
<hr />
|
|
<h2 id="what-is-elog">What is ELOG ?</h2>
|
|
<p><strong>ELOG</strong> is part of a family of applications known as <em><em>weblog</em>s</em> .
|
|
Their general purpose is :</p>
|
|
<ol>
|
|
<li>to make it easy for people to put information online in a
|
|
chronological fashion, in the form of short, time-stamped text
|
|
messages ("entries") with optional HTML markup for presentation,
|
|
and optional file attachments (images, archives, etc.)</li>
|
|
<li>to make it easy for other people to access this information through
|
|
a Web interface, browse entries, search, download files, and
|
|
optionally add, update, delete or comment on entries.</li>
|
|
</ol>
|
|
<p><strong>ELOG</strong> is a remarkable implementation of a <em>weblog</em> in at least two
|
|
respects :</p>
|
|
<ul>
|
|
<li>its simplicity of use : you don't need to be a seasoned server
|
|
operator and/or an experimented database administrator to run <strong>ELOG</strong>
|
|
; one executable file (under Unix or Windows), a simple configuration
|
|
text file, and it works. No Web server or relational database
|
|
required. It is also easy to translate the interface to the
|
|
appropriate language for your users.</li>
|
|
<li>its versatility : through its single configuration file, <strong>ELOG</strong> can
|
|
be made to display an infinity of variants of the <em>weblog</em> concept.
|
|
There are options for what to display, how to display it, what
|
|
commands are available and to whom, access control, etc. Moreover, a
|
|
single server can host several <em><em>weblog</em>s</em>, and each <em>weblog</em> can be
|
|
totally different from the rest.</li>
|
|
</ul>
|
|
<h2 id="screen-shots">Screen shots</h2>
|
|
<p><a href="elog/elog.gif" target="_blank">
|
|
<img src="img/elog_thumb.gif" alt="thumb" style="float:left; margin:0 1em 1em 0; width:200px;">
|
|
</a></p>
|
|
<p>On the left upper panel is a typical logbook page displayed by Netscape Navigator. Each
|
|
logbook page can contain attachments in a similar way to emails. This makes it possible
|
|
to store images or text files and retrieve them easily. You could for example attach a sample
|
|
configuration file which can later be copied to the local machine with the "<em>Save As...</em>"
|
|
function of the Web browser.</p>
|
|
<p>Several logbooks can be served though a single <strong>ELOG</strong> server. Each logbook can use different
|
|
attributes for its entries. The logbook can then be searched using these attributes. The
|
|
right pane on the left image shows a search for all entries with attribute "<em>Type</em>" equal to<br />
|
|
"<em>Configuration</em>", and the lower pane shows the search result. It is also possible to use <br />
|
|
full-text search in attributes and the entry body. </p>
|
|
<p>While logbook entries are usually displayed one entry per page, they can also be listed <br />
|
|
consecutively which makes it easy to produce a paper printout of a logbook. </p>
|
|
<p>Logbook pages can be edited or deleted. This feature can be turned off in the configuration
|
|
file so that a logbook entries cannot be changed after being submitted. </p>
|
|
<p>An additional feature is the automatic generation of a notification email messages <br />
|
|
based on a certain type or category of a logbook entry. </p>
|
|
<p>Also try out the <strong><a href="http://elog.psi.ch/elogs/Linux%20Demo/">online demo</a></strong></p>
|
|
<h2 id="use-cases">Use cases</h2>
|
|
<p>The features of <strong>ELOG</strong> make it useful for several applications:</p>
|
|
<ul>
|
|
<li><strong>Personal Logbooks</strong>. Personal notes can be written into <strong>ELOG</strong> and
|
|
can then be retrieved from anywhere with a Web browser. This makes it
|
|
handy for PC supporters who have to go around in companies or
|
|
laboratories and don\'t want to carry their paper logbook with them.
|
|
The same holds true for people traveling around a lot. The logbook
|
|
database consists of plain ASCII files which can copied easily between
|
|
different computers to have local access, for example on a notebook
|
|
with no network connection.</li>
|
|
<li><strong>Shared Logbooks</strong>. Logbooks can be shared by several people, for
|
|
reading and optionally for writing. This way workgroups can share and
|
|
exchange information like in a (simplified) news group. This is
|
|
supported by the <em>Reply</em> command in <strong>ELOG</strong> which creates
|
|
"<em>threads</em>" of entries. Users can be notified by email when new
|
|
entries are added to the logbook. Compared to that of a news server,
|
|
the installation of <strong>ELOG</strong> is much simpler.</li>
|
|
<li><strong>Small Databases</strong>. Since arbitrary attributes can be defined for a
|
|
logbook, it can be used as a small database with search facilities.</li>
|
|
<li><strong>Problem collections</strong>. A system can consist of two logbooks, in one
|
|
of which users enter bugs or problems. If someone adds a problem, an
|
|
email is automatically sent to the administrator, who can then copy
|
|
the entry to the second logbook and add the solution to the problem.
|
|
Users can then look up all fixed problems.</li>
|
|
<li><strong>Shift Logbooks</strong>. If the <em>Allow delete</em> and <em>Allow edit</em> flags are
|
|
off, an entry cannot be modified once it\'s been entered. This can be
|
|
useful for shift logbooks for example in accelerator control rooms
|
|
where each entry becomes a "<em>document</em>" with a time and author
|
|
stamp. <strong>ELOG</strong> was originally developed as a shift logbook for the
|
|
<a href="http://pibeta.psi.ch">PiBeta</a> and <a href="http://meg.psi.ch">Muegamma</a>
|
|
particle experiments at <a href="http://www.psi.ch">PSI</a>.</li>
|
|
<li><strong>File collections</strong>. Since files can be attached to <strong>ELOG</strong> entries,
|
|
the system can be used to store and retrieve files. This can be used
|
|
to store configuration files, which need to be accessible by several
|
|
people over the web, or to store images. Since <strong>ELOG</strong> features an
|
|
elaborate query facility, entries can be searched for by specifying
|
|
several categories.</li>
|
|
</ul>
|
|
<h2 id="license">License</h2>
|
|
<p><strong>ELOG</strong> is released under the <a href="http://www.gnu.org/copyleft/gpl.html">GNU Public
|
|
License</a> .</p>
|
|
<h2 id="credits">Credits</h2>
|
|
<p>The author would like to give credits to following people:</p>
|
|
<ul>
|
|
<li><a href="mailto:fredp@dial.oleane.com">Fred Pacquier</a> for this Web site and
|
|
the French translation</li>
|
|
<li><a href="mailto:roktas@omu.edu.tr">Recai Oktas</a> and <a href="mailto:roger.kalt@psi.ch">Roger
|
|
Kalt</a> for the Debian package</li>
|
|
<li><a href="mailto:djek@xs4all.nl">djek</a> for the Dutch translation</li>
|
|
<li><a href="mailto:Heiko.Scheit@mpi-hd.mpg.de">Heiko Scheit</a> for many bug fixes
|
|
and fruitful discussions</li>
|
|
<li><a href="mailto:jhcalvo@arnet.com.ar">Julio Calvo</a> for the Spanish translation</li>
|
|
<li><a href="mailto:AlberT@SuperAlberT.it">Emiliano 'AlberT' Gabrielli</a>
|
|
for his idea of scaling attached images</li>
|
|
<li><a href="mailto:andreas.luedeke@psi.ch">Andreas Luedeke</a>
|
|
for continuing user support and deployment of ELOG at PSI</li>
|
|
</ul>
|
|
<h2 id="talks-and-presentations">Talks and presentations</h2>
|
|
<p>Here are some talks and presentations given at various occasions:</p>
|
|
<ul>
|
|
<li>Seminar at KIT, Karlsruhe, Jan. 2015. <a href="https://elog.psi.ch/elog/talks/2015_1_intro.pptx">Introduction
|
|
talk</a> by Stefan
|
|
Ritt.</li>
|
|
<li>Seminar at KIT, Karlsruhe, Jan. 2015. <a href="http://elog.psi.ch/elog/talks/2015_1_accel.pptx">Application of
|
|
ELOG</a> for accelerator
|
|
operation at PSI by <a href="mailto:andreas.luedeke@psi.ch">Andreas Luedeke</a>.</li>
|
|
</ul>
|
|
<hr />
|
|
<p><em>Content by <a href="https://www.psi.ch/en/ltp-muon-physics/people/stefan-ritt">Stefan Ritt</a>, Web pages
|
|
by <a href="mailto:fredp@mygale.org">Fred Pacquier</a></em></p>
|
|
|
|
</div>
|
|
</div><footer>
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
|
|
<a href="userguide/" class="btn btn-neutral float-right" title="User guide">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="userguide/" 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>
|
|
|
|
<!--
|
|
MkDocs version : 1.6.1
|
|
Build Date UTC : 2025-10-02 09:51:22.343965+00:00
|
|
-->
|