ELOG/elog
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
elog/mkdocs/site/userguide.html
T
ritt 1237f7952a Finde-tuned MkDocs
2026-01-28 09:31:51 +01:00

1173 lines
42 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="index.html">
<link rel="next" href="adminguide.html">
<link rel="icon" href="img/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.21">
<title>User guide - ELOG Electronic Logbook</title>
<link rel="stylesheet" href="assets/stylesheets/main.2a3383ac.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
<script src="https://unpkg.com/iframe-worker/shim"></script>
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#elog-users-guide" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="index.html" title="ELOG Electronic Logbook" class="md-header__button md-logo" aria-label="ELOG Electronic Logbook" data-md-component="logo">
<img src="img/elog.png" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
ELOG Electronic Logbook
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
User guide
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg>
</label>
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg>
</label>
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://bitbucket.org/ritt/elog" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.0.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M22.2 32c-2.1 0-4.2.4-6.1 1.1s-3.7 1.9-5.2 3.4-2.7 3.2-3.5 5.1-1.3 4-1.3 6.1c0 .9.1 1.9.2 2.8l67.8 412.2c.8 5.1 3.4 9.7 7.3 13s8.8 5.2 14 5.2h325.7c3.8.1 7.5-1.3 10.5-3.7s4.9-5.9 5.5-9.7L505 50.7c.7-4.2-.3-8.4-2.8-11.9s-6.2-5.7-10.4-6.4c-.9-.1-1.9-.2-2.8-.2zm285.9 297.8h-104l-28.1-147h157.3z"/></svg>
</div>
<div class="md-source__repository">
Bitbucket
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="index.html" title="ELOG Electronic Logbook" class="md-nav__button md-logo" aria-label="ELOG Electronic Logbook" data-md-component="logo">
<img src="img/elog.png" alt="logo">
</a>
ELOG Electronic Logbook
</label>
<div class="md-nav__source">
<a href="https://bitbucket.org/ritt/elog" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.0.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M22.2 32c-2.1 0-4.2.4-6.1 1.1s-3.7 1.9-5.2 3.4-2.7 3.2-3.5 5.1-1.3 4-1.3 6.1c0 .9.1 1.9.2 2.8l67.8 412.2c.8 5.1 3.4 9.7 7.3 13s8.8 5.2 14 5.2h325.7c3.8.1 7.5-1.3 10.5-3.7s4.9-5.9 5.5-9.7L505 50.7c.7-4.2-.3-8.4-2.8-11.9s-6.2-5.7-10.4-6.4c-.9-.1-1.9-.2-2.8-.2zm285.9 297.8h-104l-28.1-147h157.3z"/></svg>
</div>
<div class="md-source__repository">
Bitbucket
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="index.html" class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
User guide
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="userguide.html" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
User guide
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#a-quick-intro" class="md-nav__link">
<span class="md-ellipsis">
A Quick Intro
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#what-words-mean-here" class="md-nav__link">
<span class="md-ellipsis">
What Words Mean Here
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#accessing-an-elog-server-and-its-logbooks" class="md-nav__link">
<span class="md-ellipsis">
Accessing an ELOG server and its logbook(s)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#viewing-information-in-elog" class="md-nav__link">
<span class="md-ellipsis">
Viewing information in ELOG
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#browsing-around-and-finding-things" class="md-nav__link">
<span class="md-ellipsis">
Browsing around and finding things
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#adding-stuff-to-a-logbook" class="md-nav__link">
<span class="md-ellipsis">
Adding stuff to a logbook
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#misc-tips-tricks-things-to-be-aware-of" class="md-nav__link">
<span class="md-ellipsis">
Misc. tips &amp; tricks, things to be aware of...
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#elog-command-line-client" class="md-nav__link">
<span class="md-ellipsis">
elog command line client
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#rss-feed" class="md-nav__link">
<span class="md-ellipsis">
RSS Feed
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="adminguide.html" class="md-nav__link">
<span class="md-ellipsis">
Admin guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="config.html" class="md-nav__link">
<span class="md-ellipsis">
Config file
</span>
</a>
</li>
<li class="md-nav__item">
<a href="faq.html" class="md-nav__link">
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
<li class="md-nav__item">
<a href="forum.html" class="md-nav__link">
<span class="md-ellipsis">
Forum
</span>
</a>
</li>
<li class="md-nav__item">
<a href="wishlist.html" class="md-nav__link">
<span class="md-ellipsis">
Wishlist
</span>
</a>
</li>
<li class="md-nav__item">
<a href="contrib.html" class="md-nav__link">
<span class="md-ellipsis">
Contributions
</span>
</a>
</li>
<li class="md-nav__item">
<a href="demo.html" class="md-nav__link">
<span class="md-ellipsis">
Demo
</span>
</a>
</li>
<li class="md-nav__item">
<a href="download_info.html" class="md-nav__link">
<span class="md-ellipsis">
Download info
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#a-quick-intro" class="md-nav__link">
<span class="md-ellipsis">
A Quick Intro
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#what-words-mean-here" class="md-nav__link">
<span class="md-ellipsis">
What Words Mean Here
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#accessing-an-elog-server-and-its-logbooks" class="md-nav__link">
<span class="md-ellipsis">
Accessing an ELOG server and its logbook(s)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#viewing-information-in-elog" class="md-nav__link">
<span class="md-ellipsis">
Viewing information in ELOG
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#browsing-around-and-finding-things" class="md-nav__link">
<span class="md-ellipsis">
Browsing around and finding things
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#adding-stuff-to-a-logbook" class="md-nav__link">
<span class="md-ellipsis">
Adding stuff to a logbook
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#misc-tips-tricks-things-to-be-aware-of" class="md-nav__link">
<span class="md-ellipsis">
Misc. tips &amp; tricks, things to be aware of...
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#elog-command-line-client" class="md-nav__link">
<span class="md-ellipsis">
elog command line client
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#rss-feed" class="md-nav__link">
<span class="md-ellipsis">
RSS Feed
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="elog-users-guide">ELOG User's Guide</h1>
<p><em>How to get the most from your ELOG server</em></p>
<hr />
<h2 id="a-quick-intro">A Quick Intro</h2>
<p><strong>ELOG</strong> is part of a family of applications known as <em>weblogs</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 ("<em>entries</em>") 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>
<p>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.</p>
</li>
<li>
<p>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.</p>
</li>
</ul>
<p>This is actually a problem when writing a User's Guide, because
<strong>ELOG</strong> servers, and individual <strong>weblogs</strong> on one server, can vary
wildly in appearance and functionality... This guide only attempts to
cover the main concepts of importance for <strong>ELOG</strong> users, describing
the default "<em>out-of-the-box</em>" setup and how that behaviour may have
been modified by the server administrator.</p>
<h2 id="what-words-mean-here">What Words Mean Here</h2>
<p>Just to be clear, some definitions of terms that will be used throughout
the guide :</p>
<ul>
<li><strong>ELOG server</strong> : the machine on which the <strong>ELOG</strong> server is run. Its
operating system (Windows/Unix/Linux) and status (server/desktop) are
not important, and of course it will probably do many other things
besides.</li>
<li><strong>ELOG administrator</strong> : the person who has the authority to modify
the <strong>ELOG</strong> configuration file on the server. May be an actual system
administrator, a normal user of a server, or just the owner of a
Windows PC.</li>
<li><strong>logbook</strong> : a <em>weblog</em> made available by the <strong>ELOG</strong> server. There
may be many distinct such logbooks on one server.</li>
<li><strong>entry</strong> : the individual piece of information in a logbook. Can be
as basic as a text message with a time-stamp, or carry much more
information : attributes (see below), HTML markup, links, attached
files...</li>
</ul>
<h2 id="accessing-an-elog-server-and-its-logbooks">Accessing an ELOG server and its logbook(s)</h2>
<p>To access a logbook, point your Web browser at the appropriate URL. The
default for a local Elog is <strong><code>http://localhost:8080/logbookname</code></strong>.
Logbook files are stored in directory <strong><code>logbookname</code></strong> which is a
sub-directory of the logbook root directory, defined by the
administrator. See the administrator guide on how to create a new
logbook.</p>
<p>If several logbooks are defined on the server, the entry page may be a
list of all logbooks, with their descriptions, number of entries, and
links to enter the logbook you want to use.</p>
<p>Alternatively, you may be taken directly to a specific logbook. By
default you will see a list of entries, but the administrator may have
defined a different "<em>default view</em>" for the logbook, like the list of
the day\'s entries, or directly display the last entry, etc. (depending
on what is most convenient for that logbook\'s purpose).</p>
<p>Each entry in a logbook is identified by an unique ID, which is last
part of the URL when that message is displayed. This ID might be used to
create a bookmark in a browser pointing directly to a specific entry.</p>
<p>There are four ways through which access to a logbook may be controlled:
it may be open for all to read ; it may require a common "<em>read</em>"
password for all users ; it may require each user to have an individual
user account (login name) and password ; finally, access may be granted
or not depending on the address of the workstation you are using.</p>
<h2 id="viewing-information-in-elog">Viewing information in ELOG</h2>
<p>There are two main viewing modes in a logbook :</p>
<ul>
<li>the "<strong>entry</strong>" view : this is when only one entry is displayed on
screen (like the latest entry when you first enter a logbook, or if
you click on one in a list). Here are the various parts of the display
:</li>
<li>
<p>if there are several logbooks on the <strong>ELOG</strong> server you will see a
row of "<em>tabs</em>" at the top with the names of all the logbooks.
These are link that allow to switch quickly between logbooks (<em>this
may be disabled</em>).</p>
</li>
<li>
<p>below is a title bar with the name of the current logbook at the
left, and the <strong>ELOG</strong> logo at the right. If you are logged in,
there will be a "<code>Logged in as &lt;username&gt;</code>" reminder in between.</p>
</li>
<li>
<p>next is the "<em>menu bar</em>" : on the left is a series of links or
buttons for <strong>ELOG</strong> commands available to you. These are explored
in the sections below (<em>Note: different users may see different
menus</em>). On the right is a "<em>VCR-like</em>" set of buttons for
browsing, also explained later (<em>this may be disabled</em>).</p>
</li>
<li>
<p>after these comes the actual entry information. It always starts
with the entry time-stamp, and may be followed by up to twenty
"<em>attributes</em>". These are like fields in a database and have been
defined specifically for the current logbook. Each attribute has a
checkbox besides it, explained below (<em>this may be disabled</em>).</p>
</li>
<li>
<p>the full-width box below holds the textual content (message) of the
entry. This can be plain-text or HTML code. Note that for some
special applications (say, a photo album or an event log) the
attributes and/or the attached files may be enough information, so
this field may not always be present.</p>
</li>
<li>
<p>last and optionally, one or more attached files (that were uploaded
to the server when the entry was created) are offered as clickable
links for download or viewing, along with the file name and size. If
these are images they may be displayed directly on the page.</p>
<p>At the bottom of every page is a common "<em>footer</em>" for the
logbook. By default this is just a link to the <strong>ELOG</strong> home page in
Switzerland, but may be customized locally (typically to provide a
navigation bar and links for integration with other Web sites).
- the "<strong>search result</strong>" views : these are basically lists of
entries, resulting either from a "<em>Search</em>" command or from
shortcuts such as "<em>Last X days</em>" and "<em>Last X entries</em>" commands
(more on this below). This mode has many options, including :
- a "<em>summary</em>" view : one entry per row in a table. Some attributes
may not be displayed. If the entry text is displayed (or its first
few lines), it goes into the rightmost column. Attachments are not
displayed.</p>
</li>
<li>
<p>a "<em>classical weblog</em>" view : entries appear beneath one another,
with attributes on one line and the text (and attachments, if
present) below. Images may be displayed or just linked to.</p>
</li>
<li>
<p>entries may appear most recent first, or in reverse.</p>
</li>
<li>
<p>menus on list views are different from the entry view menu. By
default they only have two or three commands, but they may have been
customized by the administrator to add more.</p>
<p>All these lists have a number to the left of each listed entry, that
is a link to the corresponding entry view.</p>
</li>
</ul>
<h2 id="browsing-around-and-finding-things">Browsing around and finding things</h2>
<p>There are several interesting ways to peruse the information in a
logbook :</p>
<ul>
<li><strong>weblogs</strong>" are often used for applications where chronology (time) is
relevant, so a very common approach is to see "<em>what happened
last</em>". In <strong>ELOG</strong> there are two commands for this. They are
actually shortcuts for searches, to display the last day\'s (24 hrs)
entries, or the last 10 entries (regardless of age). Note that the
menus on the "<em>search result</em>" views of these commands are a bit
special : they have the same command that created them, but with the
search "<em>interval</em>" doubled. From the "<em>last day</em>" list you can
get the "<em>last 2 days</em>" list, from that one the "<em>last 4 days</em>",
etc., and similarly for "<em>last 10</em>", "<em>last 20</em>", etc., making it
easy to quickly go back in time.</li>
<li>another useful method, very specific to <strong>ELOG</strong>, is "<em>filtered
browsing</em>" - again, shortcuts for specific searches. On the entry
view, the "<em>VCR</em>" buttons normally let you see the previous, next,
first or last entry in the logbook. However, if on the current entry
you check one (or more) of the checkboxes in front of the attributes,
only entries having the same value for the checked attribute(s) will
be displayed by the browse buttons. Thus you can quickly flip through
all the entries you submitted yourself, or of a certain type/category,
depending on what attributes have been defined.</li>
<li>for custom searches there is the query form given by the "<em>Find</em>"
command. This lets you look for entries between two dates, with
particular values for any attribute, or containing specific text. If
you fill in several fields, only entries that meet <strong>ALL</strong> criteria
will be selected. Possible options include sort order and summary view
for results, printer-friendly formatting, displaying attachments or
not, and searching through all logbooks on the <strong>ELOG</strong> server (if
applicable).</li>
</ul>
<h2 id="adding-stuff-to-a-logbook">Adding stuff to a logbook</h2>
<p>If you have "<em>write access</em>" to a logbook (by one of the same four
methods as for read access), then you may use the "<em>New</em>", "<em>Edit</em>",
"<em>Reply</em>" and "<em>Delete</em>" commands.</p>
<p>For the quality of the information committed to the logbook, you need
understand and use these as well as possible. Here are some of the
important features for each commmand :</p>
<ul>
<li><strong>New</strong> :</li>
<li>you will not be able to save your entry if all attributes marked
with a red star (*) are not filled in.</li>
<li>some attributes may be pre-filled from system variables (like your
user name). Pre-filled attributes may be still editable or read-only
(like the entry creation date).</li>
<li>attributes may be text fields (limited to 100 characters),
list-boxes (max. 100 values), or check-boxes. There is also a
special type of attribute where several values are listed on a line
with check-boxes, and you can check as many values as needed.</li>
<li>a nice touch : URLs in attributes (http://..., ftp://...,
mailto:...) are automatically converted to links.</li>
<li>in addition to the above URLs, one can enter a tag <strong>elog:\&lt;id&gt;</strong>
which references another logbook entry. The tag
<strong>elog:\&lt;logbook&gt;/\&lt;id&gt;</strong> references a message in another logbook
on the same server. The tag <strong>elog:\&lt;id&gt;/\&lt;n&gt;</strong> references
attachment number <strong>n</strong> in a logbook entry. To reference an
attachment in the current message, one uses <strong>elog:/\&lt;n&gt;</strong>. An
anchor inside an entry can be referenced with
<strong>elog:\&lt;id&gt;#\&lt;anchor&gt;</strong>.</li>
<li>the Text multi-line field, if present, may be pre-filled with a
template if entries need to have a common, consistent format across
the logbook (especially for HTML). There may also be a comment
inserted before it to explain local rules and conventions, upload
rules, etc.</li>
<li>check the "<em>Submit as HTML</em>" box if the entry contains HTML
markup.</li>
<li>a logbook may be configured to send a notification e-mail to various
recipients each time an entry is submitted. This may be the default
behaviour, and you should check "<em>Suppress notification</em>"" if it is
not wanted. Or it may be checked by default, and you need to
explicitely uncheck it to send the mail. Then again, you may not
have a choice... (note that notifiation recipients may or may not
be disclosed).</li>
<li>if the logbook allows attachments, there will be a number of fields
with "<em>Browse</em>" buttons at the bottom of the form. Use these to
pick one or more files on your local computer, they will be uploaded
to the <strong>ELOG</strong> server as you submit the form. IMPORTANT : there is
an upper limit on the size of individual attached files. By default
it is about 1 MB but can be changed by the administrator.</li>
<li><strong>Edit</strong> :</li>
<li>normally the Edit form will have all the values of the existing
entry in its fields for modification. However, sometimes you may see
fields that have been blanked if this makes sense for a particular
logbook application (e.g. a "<em>Last modified by</em>" field).</li>
<li>the "<em>Submit as new entry</em>" checkbox only appears on Edit forms.
If it is unchecked, the modified entry keeps its original creation
time-stamp. If it is checked, the modified entry becomes the latest
in the logbook, as if it had just been created. Again, it is
possible that this is checked by default, or disabled altogether on
some logbooks.</li>
<li>managing attachments through this form is easy. If all you want to
change is the attributes or text, don\'t touch the fields at the
bottom and the original attachments will be preserved. If you want
to add an additional attachment, use an empty field. If you want to
update an existing file, use the "<em>Browse</em>" button below that
file\'s name to specify the new one. Lastly, if you want to delete
an attachment without upoading a new one in its place, you must type
the magic word "<code>&lt;delete&gt;</code>" in the field below its name.</li>
<li><strong>Reply</strong> :</li>
<li>this command creates a new entry, but with the current entry\'s text
"<em>quoted</em>" (with \'&gt;\') in the compose form, much like when
replying to e-mail.</li>
<li>the new entry has a special "<em>In reply to</em>" attribute with a link
to the original entry ; the latter also acquires a "<em>Reply</em>"
attribute with a link to the new entry. Unfortunately these links
cannot be trusted in the present <strong>ELOG</strong> storage system, and the
whole scheme gets somewhat confusing when there are several replies.</li>
<li><strong>Delete</strong> :</li>
<li>nothing much to say about this one, except that there is no
"<em>Recycle bin</em>" or whatever : once you have confirmed the deletion
of an entry, it\'s gone for good, so be careful ! (same holds for
the replacement or deletion of an attached file).</li>
</ul>
<h2 id="misc-tips-tricks-things-to-be-aware-of">Misc. tips &amp; tricks, things to be aware of...</h2>
<ul>
<li>
<p>you can link directly to a specific entry by its URL, using the
message ID (from another entry or an external Web page). It is also
possible to link to a search result this way: use the "<em>Search</em>"
form to compose a query that will result in exactly what you want
(either a single entry or a list of entries). Copy the URL for that
result page from your browser, and use that as the target for your
link.</p>
</li>
<li>
<p>right now you cannot search entries for attachments by their file
name.</p>
</li>
<li>
<p>right now attributes that consist of just a checkbox ("<em>boolean</em>")
can only be searched by "<em>checked</em>" state in the "<em>Search</em>" form.
However, if you start from an entry where that attribute is unchecked,
you can use "<em>filtered browsing</em>" to flip through all other entries
where it is also unchecked.</p>
</li>
<li>
<p>as mentioned above, the "<em>Reply</em>" command only provides a basic
comment/chat facility - a full-blown discussion board is not
<strong>ELOG</strong>'s purpose. If a logbook has a very specific purpose and
format (picture gallery, event log, file library etc.) it might be a
good idea to disable that command there and move all
chat/comments/discussions to a separate, dedicated logbook to avoid
"<em>visual pollution</em>".</p>
</li>
<li>
<p>it is important to understand that currently the <strong>ELOG</strong> server
application is "<em>single-process</em>" and "<em>non-streaming</em>". In normal
terms this means that :</p>
</li>
<li>
<p>only one request is processed at any one time by the server.</p>
</li>
<li>
<p>uploading or downloading an attachement file is a single request,
and causes the entire file to be loaded in server memory while the
request is being processed.</p>
<p>This is not normally a problem for the sort of short, text-mode
entries <strong>ELOG</strong> is designed to support. However, if a user starts
to upload or download a large attachment file (or image) over a slow
link, all other users on that <strong>ELOG</strong> server will have to wait for
that transfert to finish before they can access any logbook on that
server. This is why there is a low limit on the size of attachments,
and why <strong>ELOG</strong> should not be used to distribute large files under
intensive multi-user conditions.</p>
</li>
<li>
<p>It is possible to use bookmarks to pre-populate various attributes
when submitting an <strong>ELOG</strong> entry. This can be useful if the same
person often creates similar entries from the same PC. For example,
with a bookmark of the form:</p>
<p>http://your.host/your_logbook/?cmd=New&amp;pauthor=joe&amp;ptype=Info</p>
</li>
</ul>
<p>...a new entry is created, with the "<em>author</em>" field pre-populated
with "<em>joe</em>" and the "<em>Info</em>" value preselected for the "<em>type</em>"
field. The same is possible for any attribute defined in the logbook
(note the leading "p"). Thus you can define a set of bookmarks for
various types of logbook entries.</p>
<h2 id="elog-command-line-client">elog command line client</h2>
<p>In addition to submission of logbook entries through the Web interface, the standalone "<em>client</em>" program <strong><code>elog</code></strong> can be used.</p>
<p>The parameters are:</p>
<pre><code class="language-text">elog &lt;parameters&gt;
-h &lt;hostname&gt; Hostname where elogd is running
[-p port] Port where elogd is running
[-d subdir] URL Directoy where elogd is running
-l logbook Name of logbook
-s Use SSL for communication
[-v] For verbose output
[-w password] Write password defined on server
[-u username password] User name and password
[-f &lt;attachment&gt;] Up to 50 attachments
-a &lt;attribute&gt;=&lt;value&gt; Up to 50 attributes
[-r &lt;id&gt;] Reply to existing message
[-q] Quote original text on reply
[-e &lt;id&gt;] Edit existing message
[-x] Suppress email notification
[-n 0|1|2] Encoding: 0:ELcode,1:plain,2:HTML
-m &lt;textfile&gt;] | &lt;text&gt;
</code></pre>
<p>Arguments with blanks must be enclosed in quotes. The elog message can
either be submitted on the command line, piped in like</p>
<p><code>cat text | elog -h ... -l ... -a ...</code></p>
<p>or in a file with the -m flag. Multiple attributes and attachments can
be supplied. If attributes with multiple possible values are defined
in a logbook (via the <em>"MOptions"</em> keyword), they can be separated
with a "|", like <strong><code>-a "&lt;attribute&gt;=&lt;value1&gt; | &lt;value2&gt;"</code></strong>. The
message text can be supplied directly at the command line or submitted
from a file with the <strong><code>-m</code></strong> flag.</p>
<p>The <strong><code>elog</code></strong> program makes it possible to submit logbook entries
automatically by the system or from scripts. In some shift logbooks
this feature is used to enter alarm messages automatically into the
logbook.</p>
<h2 id="rss-feed">RSS Feed</h2>
<p>RSS (RDF Site Summrary or Really Simple Syntication) is a web feed
format to publish frequently new or updated ELOG entries. This is a bit
like the email notifications present in ELOG, but the RSS system does
not go through an email reader, but through a dedicated RSS reader. This
helps to seperate ELOG updates form other email or spam. An RSS
"channel" can be subscribed to, so one gets notified whenever a new or
updated entry exists. One can either use a dedicated RSS reader or
aggregator, or use the RSS functionality of a web browser, such as
Firefox or Google Reader.</p>
<p>To obtain the RSS feed, one simply has to request the file
<strong><code>elog.rdf</code></strong> from a logbook. For the ELOG forum, one can enter the URL</p>
<p><a href="https://elog.psi.ch/elogs/Forum/elog.rdf"><code>https://elog.psi.ch/elogs/Forum/elog.rdf</code></a></p>
<p>The browser then offers the possiblity to subscribe to that logbook:</p>
<p><img alt="" src="img/rss.png" /></p>
<p>In case of "Live Bookmarks" in Firefox, new logbook entries
automatically appear in the bookmark list:</p>
<p><img alt="" src="img/live_bookmarks.png" /></p>
<p>Standalone RSS reader can also notify the user of new entries with
dialog boxes and sounds. For a list of availabel RSS aggregators, see
<a href="http://en.wikipedia.org/wiki/Comparison_of_feed_aggregators">here</a>.</p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": ".", "features": ["search.suggest", "search.highlight", "search.share"], "search": "assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="assets/javascripts/bundle.f55a23d4.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink