imip-agent

Changeset

1006:ead8eeb668ff
2015-11-05 Paul Boddie raw files shortlog changelog graph Added more explanatory material, changed graph font names and sizes, added gettext prerequisite.
docs/wiki/AgentPrograms (file) docs/wiki/Downloads (file) docs/wiki/FrontPage (file) docs/wiki/GettingStarted (file) docs/wiki/MailIntegration (file) docs/wiki/MailIntegration--LMTP (file) docs/wiki/MailIntegration--LocalSMTP (file) docs/wiki/OutgoingMessages (file) docs/wiki/Prerequisites (file)
     1.1 --- a/docs/wiki/AgentPrograms	Thu Nov 05 00:58:02 2015 +0100
     1.2 +++ b/docs/wiki/AgentPrograms	Thu Nov 05 18:17:00 2015 +0100
     1.3 @@ -39,6 +39,8 @@
     1.4  One exception is the `imip_person.py` program that needs to be told whether
     1.5  it will deliver messages using [[../MailIntegration/LMTP|LMTP]] with the `-l`
     1.6  option or using [[../MailIntegration/LocalSMTP|SMTP]] with the `-L` option.
     1.7 +See the [[../MailIntegration/Transports|transports documentation]] for more
     1.8 +information.
     1.9  
    1.10  == Program Responsibilities ==
    1.11  
     2.1 --- a/docs/wiki/Downloads	Thu Nov 05 00:58:02 2015 +0100
     2.2 +++ b/docs/wiki/Downloads	Thu Nov 05 18:17:00 2015 +0100
     2.3 @@ -9,6 +9,9 @@
     2.4  See the [[../GettingStarted|getting started guide]] once you have obtained
     2.5  the software.
     2.6  
     2.7 +Remember that certain [[../Prerequisites|prerequisites]] are needed for the
     2.8 +software to work.
     2.9 +
    2.10  == Copyright and Licence ==
    2.11  
    2.12  The imip-agent distribution is made available according to the terms of the
     3.1 --- a/docs/wiki/FrontPage	Thu Nov 05 00:58:02 2015 +0100
     3.2 +++ b/docs/wiki/FrontPage	Thu Nov 05 18:17:00 2015 +0100
     3.3 @@ -37,7 +37,7 @@
     3.4  //format=svg
     3.5  //transform=notugly
     3.6  digraph architecture {
     3.7 -  node [shape=box,fontsize="16.0",fontname="sans-serif",tooltip="The imip-agent architecture"];
     3.8 +  node [shape=box,fontsize="13.0",fontname="Helvetica",tooltip="The imip-agent architecture"];
     3.9    edge [tooltip="The imip-agent architecture"];
    3.10    rankdir=LR;
    3.11  
     4.1 --- a/docs/wiki/GettingStarted	Thu Nov 05 00:58:02 2015 +0100
     4.2 +++ b/docs/wiki/GettingStarted	Thu Nov 05 18:17:00 2015 +0100
     4.3 @@ -9,6 +9,15 @@
     4.4  abilities, but any difficulties in getting the software to work will be
     4.5  compounded by any problem or deficiency in either of these areas.
     4.6  
     4.7 +<<TableOfContents(2,2)>>
     4.8 +
     4.9 +== Obtaining the Software ==
    4.10 +
    4.11 +To get started, the imip-agent software must be [[../Downloads|downloaded]]
    4.12 +and any [[../Prerequisites|prerequisites]] installed, the latter being
    4.13 +software that imip-agent needs to work with. The choice of prerequisites
    4.14 +will influence some of the activities described below.
    4.15 +
    4.16  == Configuring System Users ==
    4.17  
    4.18  The [[../SystemUsers|system users guide]] indicates the requirements for
    4.19 @@ -55,13 +64,14 @@
    4.20  tools/init.sh --help
    4.21  }}}
    4.22  
    4.23 -Fixing ownership can be done using the `tools/fix.sh` script, in case some form
    4.24 -of modification has altered the ownership or membership of the created files
    4.25 -and directories.
    4.26 +Fixing ownership can be done using the `tools/fix.sh` script, as described in
    4.27 +the [[../Administration|administration guide]] in case some form of modification
    4.28 +has altered the ownership or membership of the created files and directories.
    4.29  
    4.30 -== Configuring Other Software ==
    4.31 +== Integrating with Other Software ==
    4.32  
    4.33 -The `conf` directory contains subdirectories for different systems:
    4.34 +The `conf` directory in the imip-agent source code distribution contains
    4.35 +subdirectories for different systems:
    4.36  
    4.37  {{{#!table
    4.38  '''Directory''' || '''Description''' || '''Guide'''
    4.39 @@ -94,7 +104,14 @@
    4.40  The behaviour of the imip-agent software itself can be configured using
    4.41  mechanisms described in the [[../Configuration|configuration guide]].
    4.42  
    4.43 +== Administering the Software ==
    4.44 +
    4.45 +With the basic configuration performed, all that remains is to perform
    4.46 +any necessary [[../Administration|administration tasks]] to set the
    4.47 +software up for certain kinds of users or participants.
    4.48 +
    4.49  == Using the Software ==
    4.50  
    4.51 -With everything configured, it should be possible to get started using
    4.52 -the software. See the [[../Usage|usage guide]] for details.
    4.53 +With configuration and administration performed, it should be possible
    4.54 +to get started using the software. See the [[../Usage|usage guide]]
    4.55 +for details.
     5.1 --- a/docs/wiki/MailIntegration	Thu Nov 05 00:58:02 2015 +0100
     5.2 +++ b/docs/wiki/MailIntegration	Thu Nov 05 18:17:00 2015 +0100
     5.3 @@ -16,7 +16,7 @@
     5.4  //format=svg
     5.5  //transform=notugly
     5.6  digraph mail_integration {
     5.7 -  node [shape=box,fontsize="16.0",fontname="sans-serif",tooltip="Mail integration"];
     5.8 +  node [shape=box,fontsize="13.0",fontname="Helvetica",tooltip="Mail integration"];
     5.9    edge [tooltip="Mail integration"];
    5.10    rankdir=LR;
    5.11  
     6.1 --- a/docs/wiki/MailIntegration--LMTP	Thu Nov 05 00:58:02 2015 +0100
     6.2 +++ b/docs/wiki/MailIntegration--LMTP	Thu Nov 05 18:17:00 2015 +0100
     6.3 @@ -10,7 +10,7 @@
     6.4  //format=svg
     6.5  //transform=notugly
     6.6  digraph lmtp {
     6.7 -  node [shape=box,fontsize="16.0",fontname="sans-serif",tooltip="LMTP delivery"];
     6.8 +  node [shape=box,fontsize="13.0",fontname="Helvetica",tooltip="LMTP delivery"];
     6.9    edge [tooltip="LMTP delivery"];
    6.10    rankdir=LR;
    6.11  
     7.1 --- a/docs/wiki/MailIntegration--LocalSMTP	Thu Nov 05 00:58:02 2015 +0100
     7.2 +++ b/docs/wiki/MailIntegration--LocalSMTP	Thu Nov 05 18:17:00 2015 +0100
     7.3 @@ -7,7 +7,7 @@
     7.4  //format=svg
     7.5  //transform=notugly
     7.6  digraph local_smtp {
     7.7 -  node [shape=box,fontsize="16.0",fontname="sans-serif",tooltip="Local SMTP delivery"];
     7.8 +  node [shape=box,fontsize="13.0",fontname="Helvetica",tooltip="Local SMTP delivery"];
     7.9    edge [tooltip="Local SMTP delivery"];
    7.10    rankdir=LR;
    7.11  
     8.1 --- a/docs/wiki/OutgoingMessages	Thu Nov 05 00:58:02 2015 +0100
     8.2 +++ b/docs/wiki/OutgoingMessages	Thu Nov 05 18:17:00 2015 +0100
     8.3 @@ -8,7 +8,7 @@
     8.4  //format=svg
     8.5  //transform=notugly
     8.6  digraph outgoing {
     8.7 -  node [shape=box,fontsize="16.0",fontname="sans-serif",tooltip="Outgoing messages"];
     8.8 +  node [shape=box,fontsize="13.0",fontname="Helvetica",tooltip="Outgoing messages"];
     8.9    edge [tooltip="Outgoing messages"];
    8.10    rankdir=LR;
    8.11  
    8.12 @@ -46,7 +46,7 @@
    8.13  //format=svg
    8.14  //transform=notugly
    8.15  digraph manager_outgoing {
    8.16 -  node [shape=box,fontsize="16.0",fontname="sans-serif",tooltip="Outgoing messages from the manager"];
    8.17 +  node [shape=box,fontsize="13.0",fontname="Helvetica",tooltip="Outgoing messages from the manager"];
    8.18    edge [tooltip="Outgoing messages from the manager"];
    8.19    rankdir=LR;
    8.20  
     9.1 --- a/docs/wiki/Prerequisites	Thu Nov 05 00:58:02 2015 +0100
     9.2 +++ b/docs/wiki/Prerequisites	Thu Nov 05 18:17:00 2015 +0100
     9.3 @@ -11,6 +11,10 @@
     9.4   Python::  python
     9.5   pytz::    python-tz
     9.6  
     9.7 +To provide localised messages:
     9.8 +
     9.9 + gettext:: gettext
    9.10 +
    9.11  To update free/busy details periodically, the following software is
    9.12  recommended:
    9.13