From 115fbfd7283e1010fa1527d771f44d138f2d478e Mon Sep 17 00:00:00 2001 From: Stefan Ritt Date: Mon, 17 Feb 2003 12:58:26 +0000 Subject: [PATCH] Added #11 SVN revision: 397 --- doc/faq.html | 115 +++++++++++++++++++++++++++++++++------------------ 1 file changed, 74 insertions(+), 41 deletions(-) diff --git a/doc/faq.html b/doc/faq.html index 1f307dff..4e48dd0e 100755 --- a/doc/faq.html +++ b/doc/faq.html @@ -24,32 +24,44 @@

Frequently Asked Questions about usage and configuration
-
+
+
    +
  1. How does one configure elog to display the last message by default +
  2. Are there any plans to implement a MySQL back end? +
  3. Can I run the ELOG daemon from inside Apache or any other Web server? +
  4. I can access my logbook without any password, isn't that a security problem? +
  5. I want a bookmark pointing to the last page where an attribute has a certain value +
  6. I want a logbook with public read access (no password), but restricted write access +
  7. 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. +
  8. How can I configure ELOG such that it displays something else than the message list by default? +
  9. I want to have additional commands specific to my lookbook +
  10. 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. +
  11. How can I track various revisions of a message using the "edit" command? +
+ +
    -
  1. How does one configure elog to display a listing of all messages by default instead the last message +
  2. How does one configure elog to display the last message by default

    -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 Start page option in elogd. The entry:

    +One can use the Start page option for that. The entry:

    Start page = 0?cmd=last

    -shows the last entry by default (pre-2.2.0 behaviour). To show all messages, one can use: -

    -Start page = ?cmd=Search&mode=summary&all=1

    -

    -This shows all messages from all logbooks (all=1). To have the described behaviour for +shows the last message entry by default. To have the described behaviour for all logbooks, the above statements can be placed in the [global] section.

    -

  3. Are there any plans to implement a MySQL back end? +
  4. Are there any plans to implement a MySQL back end?

    No. The idea behind ELOG is that it is a simple to use, simple to install application. Many people use ELOG 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 ELOG should be independent of any other package, some "switchable" backend between native ELOG format and MySQL would be needed, which is lots of work and not planned right now.

    -

  5. Can I run the ELOG daemon from inside Apache or any other Web server? +
  6. Can I run the ELOG daemon from inside Apache or any other Web server?

    No. The ELOG daemon was designed as a standalone server and it will stay like that in the future. The reason for that is that elogd should not rely on any other software. This is for @@ -59,7 +71,7 @@ therefore becomes much simpler. To run elogd in parallel to port 80, use Apache as a proxy, following the instruction on the installation page ("Running elogd under Apache").

    -

  7. I can access my logbook without any password, isn't that a security problem? +
  8. I can access my logbook without any password, isn't that a security problem?

    By default, no password is used in ELOG. This can be useful for public directories etc. that anybody should be able to read. To add password security, read the documentation under Note that passwords are transferred over the network in plain text and therefore not secure. If this is a problem, a secure network connection should be used.

    -

  9. I want a bookmark pointing to the last page where an attribute has a certain value +
  10. I want a bookmark pointing to the last page where an attribute has a certain value

    Use the URL:

    @@ -82,7 +94,7 @@ This executes the "Last" command using a filter with <attribute>=&l Note the "l" before the second attribute, as in "lAuthor=1".

    -

  11. I want a logbook with public read access (no password), but restricted write access +
  12. I want a logbook with public read access (no password), but restricted write access

    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 @@ -107,41 +119,30 @@ Self register = 1 in the configuration file. New users can then create their own accounts.

    -

  13. I have many loogbooks with password files, so if I add a user or want to change +
  14. 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.

    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.

    -

  15. By default, ELOG displays the last entry from a logbook. How can I configure it to -display the last 10 messages instead? +
  16. How can I configure ELOG such that it displays something else than the message list by default?

    -There is a simple trick. You use the "Welcome page" option in the elogd file -to redirect the start page to the last 10 command. Put the statement: +There is a simple trick. You use the "Start page" option in the elogd file +to redirect the start page to something else. Here are some examples: 

    -Welcome page = redir.html
-
    -into elogd and create that file with following contents: -

    -

    -<head>
-<meta http-equiv="refresh" content="0; URL=/logbook/last10">
-</head>
-
    -This causes the welcome page being redirected to /logbook/last10, where logbook must be replaced by the current logbook name. Following other redirections are possible: -

    -

    -/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&<attrib>=<value>    for a search with <attrib>=<value>
+?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>
    -
  17. I want to have additional command specific to my lookbook +The various URLs can be copied from the browser's address bar when doint various things there. +

    + +

  18. I want to have additional commands specific to my lookbook

    New commands can be added for example with the "Bottom text = bottom.html" option. To display all messages from last week and month of with "category = info", one can put @@ -154,11 +155,11 @@ following HTML code in bottom.html: </center>

    -Note that the parameters "last=7&Category=Info" apply a filter on the display. You can learn +Note that the parameters "last=7&Category=Info" 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.

    -

  19. How does one configure elog to disable editing of existing messages? I want a logbook where one +
  20. 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.

    This works with the option Menu commands. By default, the menu commands @@ -171,13 +172,45 @@ statement into elogd.cfg: This prohibits the execution of the commands "Edit" and "Delete".

    +

  21. How can I track various revisions of a message using the "edit" command? +

    +There are two ways: +

    + +

      +
    • Add an attribute which keeps the revision dates and names as follows: +
      +Attributes = Author, ..., Revisions
+Locked attributes = Revisions
+Subst on Edit Revisions = $Revisions<br>$date by $long_name
+
      + +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.

      + +

    • 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:

      + +

      +Reply string = ""
+
      + +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.

      + +

    +
  Content by Stefan Ritt, Web pages by Fred Pacquier - - last modified on 19/12/2001 + - last modified on 17/02/2003