moregroupware Manual

Last modified 2003-04-25

Thomas Bley

Karsten Dambekalns

Marc Logemann

Patrick Malaison

Bjørn Roger Rasmussen

Copyright © 2003 Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

Abstract

This is the beginning of a moregroupware manual. It will contain an end user section, developer chapters, FAQ and more.

Table of Contents

I. Getting started

1. Introduction to moregroupware

What is moregroupware?

Why moregroupware?

How can I try moregroupware?

Who is developing moregroupware?

Who is using moregroupware?

Somewhere in Australia
Local government, south - west part of Norway:

2. Setting up moregroupware

Requirements

Upgrade

Getting more.groupware

Downloading more.groupware releases
Downloading more.groupware snapshots
Downloading more.groupware from CVS

Preparing the more.groupware setup

Troubleshooting

Known bugs

Webmail 2
General strange behavior of moregroupware

3. Setting up moregroupware on Linux

Short installation instructions

Detailed installation instructions

Very detailed installation instructions

Moregroupware together with Red Hat Linux 7.x and 8.x
Making your computer ready for running Moregroupware
Configuring MySQL
Unpacking the more.groupware files
Configuring Moregroupware
Security

4. Setting up moregroupware on Windows

Introduction

Download

Installing Apache

Installing PHP

Setting up PHP as Apache module

Installing MySQL

Installing Moregroupware

More support and help

5. The setup process

6. Securing your moregroupware setup

7. Additional moregroupware components

Appointment reminder
Address queries with Mutt
Moving data from TWIG to moregroupware

II. Using moregroupware

8. A Guided Tour of moregroupware

9. The admin module

10. The calendar module

The views

Today
This Week
This Month

Creating an Appointment

Date and Time
Location and Subject
Participants
Repetition
Create Appointment

Configuring your Calendar

11. The contact module

Importing vCards

12. The notes module

Notes in the Overview module

Managing notes

The notes overview screen
Viewing notes details
Creating notes
Editing notes
Deleting notes

Managing note categories

The notes categories overview screen
Creating categories
Editing categories
Deleting notes

Configuring the notes module

User settings
General settings

13. The projects module

Creating and editing projects

GANTT diagrams

Tracking time spent on projects

Creating and editing occupations
Creating and editing timesheets
Listing and evaluating timesheets

14. The webmail module

Search for users and contacts
Sending a message internally
Attachments

Folders

Select a folder
Public Folders

General settings

Email accounts

Display a list of all accounts
Create a new account

Backup Webmail (for Admins only)

Backup your database
Backup you hard-disk

III. Administration of moregroupware

15. User administration

Create new users from a file

16. Common user complaints

Session timeout

17. Backing up your more.groupware data

Backup of your MySQL database
Restore of your MySQL database

IV. Developer's corner

18. CVS and more.groupware development

Accessing CVS as a developer

CVS/SSH for unix/linux users
CVS/SSH for windows users (using wincvs)

Branching in CVS

more.groupware structure in CVS

19. How to translate Moregroupware

Structure of Moregroupware

Moregroupware lang-file

Using newslines for long text
Variables inside lang files

Test new language

Common Errors

When adding a completely new language...

20. Adding a module to moregroupware

Directory-Structure of a Module

Module Application Structure

Never use include($var/myinclude.php)!
Don't use your own database connections

What is the config.inc.php file?

What does container.inc do exactly?

require_once(SMARTY_DIR . "Smarty.class.php");
include(INCLUDEPATH .'mgw.class.inc');
include(INCLUDEPATH .'lang.inc');
include(INCLUDEPATH .'userfunc.inc');
include(INCLUDEPATH .'version.inc');
include(INCLUDEPATH .'appconfig.inc');
include(INCLUDE .'module_exec.inc');

Whats special about module_exec.inc

21. Handling common coding tasks

The definition.xml file

Logging functions

Using the core logging in more.groupware

Notification functions

Using notification in more.groupware

Database handling

SQL portability

Date and time handling

Templates with Smarty

Session usage

Using session standards in more.groupware
Passing sessions around in more.groupware
Storing per-module information in the session

Using the settings module

22. moregroupware coding conventions

Indenting
Naming conventions
Constants
Global variables
Control structures
Function calls
Comments
Including code
PHP code tags
Using CVS
General script structure

V. Appendices

A. The moregroupware FAQ

General
Installation
Administration
Common mistakes
Additional

B. Manually upgrading moregroupware

Upgrading from 0.6.2 to 0.6.3
Upgrading from 0.6.3 to 0.6.4(pl1)
Upgrading from 0.6.4pl1 to 0.6.5
Upgrading from 0.6.5 to 0.6.6
Upgrading from 0.6.6 to 0.6.7

C. Using DocBook XML for documentation

Introduction
Compiling XML to HTML, PDF, ...

D. Credits

Software and libraries

PHP
Smarty
JPGraph
FPDF
ADOdb
MySQL

E. The Licenses

X11 License
GNU General Public License
GNU Free Documentation License

List of Figures

5.1. Error message after unpacking
5.2. Choose language
5.3. System check
5.4. Settings screen
5.5. Authentication settings SQL/NTLM
5.6. Authentication settings LDAP
5.7. Module selection
5.8. Installation results
10.1. Calendar day view
10.2. Appointment details
10.3. Appointment editing
10.4. Appointment deletion
10.5. Calendar week view
10.6. Calendar month view
10.7. New appointment form
10.8. Participant overview
10.9. Appointment conflict detected
10.10. Calendar configuration settings
12.1. Notes overview
12.2. Notes details
12.3. Creating a note
12.4. Editing a note
12.5. Category overview
12.6. Creating a category
12.7. Editing a category
13.1. The list of defined projects
13.2. Creating a project
13.3. A GANTT diagram showing two projects
13.4. The list of available occupations
13.5. Creating an occupation
13.6. Editing an occupation's hourly rate
13.7. Creating a timesheet
13.8. Listing projects and timesheets
13.9. Listing timesheets for a project
14.1. The mail list
14.2. The submenu bar
14.3. The views bar
14.4. The intial tree view
14.5. Unread mails in the tree view
14.6. Folder actions in the tree view
14.7. Mail actions in the tree view
18.1. part of the CVS structure
19.1. Moregroupware Tree
20.1. Module directory tree
20.2. Minimal module directory tree

List of Tables

10.1.

List of Examples

21.1. The defintion.xml of the notes module.
21.2. Firing a log message.
21.3. Firing an extended log message.
21.4. Displaying a success message.
21.5. Checking for the ID and rights of the current user.
21.6. Checking for user settings.
21.7. Creating a hidden form field for session passing.
21.8. Creating a regular link for session passing.
21.9. Creating a regular link for session passing in PHP.

		Next
		Part I. Getting started