# HG changeset patch # User Paul Boddie # Date 1446743820 -3600 # Node ID ead8eeb668ff8cc6d77d3aab994fcb643f221d99 # Parent 819a0a8a3ae5c363daef4ea06c31ac2c7d0682d4 Added more explanatory material, changed graph font names and sizes, added gettext prerequisite. diff -r 819a0a8a3ae5 -r ead8eeb668ff docs/wiki/AgentPrograms --- a/docs/wiki/AgentPrograms Thu Nov 05 00:58:02 2015 +0100 +++ b/docs/wiki/AgentPrograms Thu Nov 05 18:17:00 2015 +0100 @@ -39,6 +39,8 @@ One exception is the `imip_person.py` program that needs to be told whether it will deliver messages using [[../MailIntegration/LMTP|LMTP]] with the `-l` option or using [[../MailIntegration/LocalSMTP|SMTP]] with the `-L` option. +See the [[../MailIntegration/Transports|transports documentation]] for more +information. == Program Responsibilities == diff -r 819a0a8a3ae5 -r ead8eeb668ff docs/wiki/Downloads --- a/docs/wiki/Downloads Thu Nov 05 00:58:02 2015 +0100 +++ b/docs/wiki/Downloads Thu Nov 05 18:17:00 2015 +0100 @@ -9,6 +9,9 @@ See the [[../GettingStarted|getting started guide]] once you have obtained the software. +Remember that certain [[../Prerequisites|prerequisites]] are needed for the +software to work. + == Copyright and Licence == The imip-agent distribution is made available according to the terms of the diff -r 819a0a8a3ae5 -r ead8eeb668ff docs/wiki/FrontPage --- a/docs/wiki/FrontPage Thu Nov 05 00:58:02 2015 +0100 +++ b/docs/wiki/FrontPage Thu Nov 05 18:17:00 2015 +0100 @@ -37,7 +37,7 @@ //format=svg //transform=notugly digraph architecture { - node [shape=box,fontsize="16.0",fontname="sans-serif",tooltip="The imip-agent architecture"]; + node [shape=box,fontsize="13.0",fontname="Helvetica",tooltip="The imip-agent architecture"]; edge [tooltip="The imip-agent architecture"]; rankdir=LR; diff -r 819a0a8a3ae5 -r ead8eeb668ff docs/wiki/GettingStarted --- a/docs/wiki/GettingStarted Thu Nov 05 00:58:02 2015 +0100 +++ b/docs/wiki/GettingStarted Thu Nov 05 18:17:00 2015 +0100 @@ -9,6 +9,15 @@ abilities, but any difficulties in getting the software to work will be compounded by any problem or deficiency in either of these areas. +<> + +== Obtaining the Software == + +To get started, the imip-agent software must be [[../Downloads|downloaded]] +and any [[../Prerequisites|prerequisites]] installed, the latter being +software that imip-agent needs to work with. The choice of prerequisites +will influence some of the activities described below. + == Configuring System Users == The [[../SystemUsers|system users guide]] indicates the requirements for @@ -55,13 +64,14 @@ tools/init.sh --help }}} -Fixing ownership can be done using the `tools/fix.sh` script, in case some form -of modification has altered the ownership or membership of the created files -and directories. +Fixing ownership can be done using the `tools/fix.sh` script, as described in +the [[../Administration|administration guide]] in case some form of modification +has altered the ownership or membership of the created files and directories. -== Configuring Other Software == +== Integrating with Other Software == -The `conf` directory contains subdirectories for different systems: +The `conf` directory in the imip-agent source code distribution contains +subdirectories for different systems: {{{#!table '''Directory''' || '''Description''' || '''Guide''' @@ -94,7 +104,14 @@ The behaviour of the imip-agent software itself can be configured using mechanisms described in the [[../Configuration|configuration guide]]. +== Administering the Software == + +With the basic configuration performed, all that remains is to perform +any necessary [[../Administration|administration tasks]] to set the +software up for certain kinds of users or participants. + == Using the Software == -With everything configured, it should be possible to get started using -the software. See the [[../Usage|usage guide]] for details. +With configuration and administration performed, it should be possible +to get started using the software. See the [[../Usage|usage guide]] +for details. diff -r 819a0a8a3ae5 -r ead8eeb668ff docs/wiki/MailIntegration --- a/docs/wiki/MailIntegration Thu Nov 05 00:58:02 2015 +0100 +++ b/docs/wiki/MailIntegration Thu Nov 05 18:17:00 2015 +0100 @@ -16,7 +16,7 @@ //format=svg //transform=notugly digraph mail_integration { - node [shape=box,fontsize="16.0",fontname="sans-serif",tooltip="Mail integration"]; + node [shape=box,fontsize="13.0",fontname="Helvetica",tooltip="Mail integration"]; edge [tooltip="Mail integration"]; rankdir=LR; diff -r 819a0a8a3ae5 -r ead8eeb668ff docs/wiki/MailIntegration--LMTP --- a/docs/wiki/MailIntegration--LMTP Thu Nov 05 00:58:02 2015 +0100 +++ b/docs/wiki/MailIntegration--LMTP Thu Nov 05 18:17:00 2015 +0100 @@ -10,7 +10,7 @@ //format=svg //transform=notugly digraph lmtp { - node [shape=box,fontsize="16.0",fontname="sans-serif",tooltip="LMTP delivery"]; + node [shape=box,fontsize="13.0",fontname="Helvetica",tooltip="LMTP delivery"]; edge [tooltip="LMTP delivery"]; rankdir=LR; diff -r 819a0a8a3ae5 -r ead8eeb668ff docs/wiki/MailIntegration--LocalSMTP --- a/docs/wiki/MailIntegration--LocalSMTP Thu Nov 05 00:58:02 2015 +0100 +++ b/docs/wiki/MailIntegration--LocalSMTP Thu Nov 05 18:17:00 2015 +0100 @@ -7,7 +7,7 @@ //format=svg //transform=notugly digraph local_smtp { - node [shape=box,fontsize="16.0",fontname="sans-serif",tooltip="Local SMTP delivery"]; + node [shape=box,fontsize="13.0",fontname="Helvetica",tooltip="Local SMTP delivery"]; edge [tooltip="Local SMTP delivery"]; rankdir=LR; diff -r 819a0a8a3ae5 -r ead8eeb668ff docs/wiki/OutgoingMessages --- a/docs/wiki/OutgoingMessages Thu Nov 05 00:58:02 2015 +0100 +++ b/docs/wiki/OutgoingMessages Thu Nov 05 18:17:00 2015 +0100 @@ -8,7 +8,7 @@ //format=svg //transform=notugly digraph outgoing { - node [shape=box,fontsize="16.0",fontname="sans-serif",tooltip="Outgoing messages"]; + node [shape=box,fontsize="13.0",fontname="Helvetica",tooltip="Outgoing messages"]; edge [tooltip="Outgoing messages"]; rankdir=LR; @@ -46,7 +46,7 @@ //format=svg //transform=notugly digraph manager_outgoing { - node [shape=box,fontsize="16.0",fontname="sans-serif",tooltip="Outgoing messages from the manager"]; + node [shape=box,fontsize="13.0",fontname="Helvetica",tooltip="Outgoing messages from the manager"]; edge [tooltip="Outgoing messages from the manager"]; rankdir=LR; diff -r 819a0a8a3ae5 -r ead8eeb668ff docs/wiki/Prerequisites --- a/docs/wiki/Prerequisites Thu Nov 05 00:58:02 2015 +0100 +++ b/docs/wiki/Prerequisites Thu Nov 05 18:17:00 2015 +0100 @@ -11,6 +11,10 @@ Python:: python pytz:: python-tz +To provide localised messages: + + gettext:: gettext + To update free/busy details periodically, the following software is recommended: