moregroupware Manual
   Next

moregroupware Manual

Last modified 2003-11-04

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 more.groupware
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 more.groupware
3. The setup process
4. Securing your moregroupware setup
5. Additional moregroupware components
Appointment reminder
Address queries with Mutt
Moving data from TWIG to moregroupware
II. Using moregroupware
6. A Guided Tour of moregroupware
7. The admin module
8. 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
9. The contact module
Importing vCards
10. 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 a category
Configuring the notes module
User settings
General settings
11. 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
12. The webmail module
The mail list
The toolbar
The sidebar
The tree
Compose an email
Search for users and contacts
Sending a message internally
Attachments
Add Signature
Return receipt
Send as draft
Search for
Folders
Select a folder
Public Folders
General settings
Admin 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
13. User administration
Create new users from a file
14. Common user complaints
Session timeout
15. Backing up your more.groupware data
Backup of your MySQL database
Restore of your MySQL database
IV. Developer's corner
16. 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
17. 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...
18. 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
19. 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
20. 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 more.groupware FAQ
General
Installation
Administration
Common errors and problems
Miscellaneous
B. Manually upgrading moregroupware
Upgrading from 0.6.6 to 0.6.7
Upgrading from 0.6.7 to 0.6.8
Upgrading from 0.6.8 to 0.6.9
Upgrading from 0.6.8/0.6.9 to 0.7.0
Upgrading from 0.7.0 to 0.7.1
Upgrading from 0.7.1 to 0.7.2
Upgrading from 0.7.2 to 0.7.3
21. Setting up LAMP and more.groupware
Short installation instructions
Detailed installation instructions
Very detailed installation instructions
more.groupware together with Red Hat Linux 7.x and 8.x
Making your computer ready for running more.groupware
Configuring MySQL
Unpacking the more.groupware files
Configuring more.groupware
Security
22. Setting up WAMP and more.groupware
Introduction
Download
Installing Apache
Installing PHP
Setting up PHP as Apache module
Installing MySQL
Installing more.groupware
More support and help
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

3.1. Error message after unpacking
3.2. Choose language
3.3. System check
3.4. Settings screen
3.5. Authentication settings SQL/NTLM
3.6. Authentication settings LDAP
3.7. Module installation
3.8. Installation results
8.1. Calendar day view
8.2. Appointment details
8.3. Appointment editing
8.4. Appointment deletion
8.5. Calendar week view
8.6. Calendar month view
8.7. New appointment form
8.8. Participant overview
8.9. Appointment conflict detected
8.10. Calendar configuration settings
10.1. Notes overview
10.2. Notes details
10.3. Creating a note
10.4. Editing a note
10.5. Category overview
10.6. Creating a category
10.7. Editing a category
11.1. The list of defined projects
11.2. Creating a project
11.3. A GANTT diagram showing two projects
11.4. The list of available occupations
11.5. Creating an occupation
11.6. Editing an occupation's hourly rate
11.7. Creating a timesheet
11.8. Listing projects and timesheets
11.9. Listing timesheets for a project
12.1. The mail list
12.2. The submenu bar
12.3. View customization
12.4. The intial tree view
12.5. Unread mails in the tree view
12.6. Folder actions in the tree view
12.7. Mail actions in the tree view
16.1. part of the CVS structure
17.1. Moregroupware Tree
18.1. Module directory tree
18.2. Minimal module directory tree

List of Tables

8.1.

List of Examples

19.1. The defintion.xml of the notes module.
19.2. Firing a log message.
19.3. Firing an extended log message.
19.4. Displaying a success message.
19.5. Checking for the ID and rights of the current user.
19.6. Checking for user settings.
19.7. Creating a hidden form field for session passing.
19.8. Creating a regular link for session passing.
19.9. Creating a regular link for session passing in PHP.
   Next
   Part I. Getting started