Location: PHPKode > projects > Outreach Project Tool > OPT_1-2-7_MAX/docs/FAQ.txt
=======
OPT FAQ
=======

Bogdan Stancescu <hide@address.com>, December 2001
Guy Davis        <hide@address.com>
Martin Vernooij	 <hide@address.com>
Last updated: January 2005


CONTENTS
********

 0. Definitions (MUST READ!)
 1. What is the difference between OPT and OPT Max?
 2. Why is the menu frame higher than it needs to be?
 3. I want to customize my main menu. How do I do that?
 4. I want to contribute. Who do I talk to?
 5. I have some problems setting up the e-mail features in OPT. What do I do?
 6. I need [this feature] in OPT for one of our customers. What do I do?
 7. Why is the permission system so poor?
 8. Where is this project headed to?
 9. I have a problem with an OPT plugin. Who do I talk to?
10. I want to translate OPT to some other language. What do I do?
11. I really like how OPT looks
12. I really like how OPT looks but I'd like to have my logo on the main menu
13. I really like how OPT looks but I'd like to be able to change the colors
14. I don't like how OPT looks and I want to design my own templates
15. Are the upgrades incremental or do I just get the latest regardless of my current version?
16. I want to be able to upload large documents (>10 MB) - what should I do?
17. I hate the "Blocked" message OPT issues occasionaly - how do I get rid of it?
18. My Outlook removes the "personal" field from the e-mail address and OPT can't parse the destination.
19. I forgot my OPT admin password - what do I do?

0. DEFINITIONS
This section defines a couple of things we refer to throughout the document:
- the OPT SF page: SF stands for SourceForge (http://sourceforge.net).
  The OPT page on SF is http://sourceforge.net/projects/outreach
- the OPT mailing list: you can subscribe to the list at
  https://lists.sourceforge.net/lists/listinfo/outreach-general
  You can check out the message archive at
  http://www.geocrawler.com/lists/3/SourceForge/19543/0/
- my e-mail: is the one at the top of this document.
- the time of this writing: check the "Last updated" date at the beginning
  of this file.

1. What is the difference between OPT and OPT Max?
OPT is the original version developed by Lanifex. OPT Max is generally a version that includes the
original version and the available plugins. It also has a number of other enhancements, so generally
you're better of using the MAX version. The MAX version has been created by Guy Davis.

2. Why is the menu frame higher than it needs to be?
Because of Netscape Communicator 4.x which doesn't render frame sizes
accurately. Even with the current frame size Netscape
sometimes trims it - but at least the text is readable... :-(
(http://builder.cnet.com/webbuilding/pages/Authoring/Tagmania/120699/index.html)

3. I want to customize my main menu. How do I do that?
Check out the "Plugins" help page (last paragraph). You get to the
Plugins help page by clicking on "Plugins" and then on the help icon
(the question mark icon in the top right corner).

4. I want to contribute. Who do I talk to?
You can contribute with anything to this project - and you're welcome to.
We accept the following contributions:
- YOUR TIME. You can contribute with your time to this project
  by either developing features or by documenting, providing QA or
  even submitting bugs.
  - If you want to contribute time to this project you should first check the
    OPT page on sourceforge and see if your contribution fits anywhere there
    (BUG REPORTS and FEATURE REQUESTS fit there).
  - If you want to WRITE SOME CODE, you should consider joining the OPT mailing
    list and post whatever you're planning to do on the mailing list - this way
    other developers get the chance to have a say about it and you can get some
    useful suggestions.
    We suggest choosing a topic you're very familiar with or, better yet, a
    feature you'd enjoy for development.
  - If you ALREADY WROTE A PATCH and want to contribute it, just drop me an
    e-mail (see e-mail at the top).
  - If you WANT TO WRITE A PLUGIN you should first join the mailing list (see
    above) and then check out the example plugins provided for this purpose.
  - If you ALREADY WROTE A PLUGIN and want to release it to the world, drop
    me an e-mail.
- A POSTCARD. Yes, we also would like it if you sent us a postcard. Please
  mail it to
      CSO Lanifex GmbH,
      Praterstrasse 60/1/2
      A-1020 Vienna, AUSTRIA

5. I have some problems setting up the e-mail features in OPT. What do I do?
First you read the INSTALL.email in this distribution. Read it thoroughly, most
of the problems users encountered so far are listed there. If that doesn't help,
check the OPT sourceforge page and the mailing list archive - many people bumped
into many problems so you should be able to find some help there. If none of
those help, either post it to the OPT SF page or join the mailing list and post
the message there. This way other users who bump into the same problem you did
can get a chance to solve it by looking at the archive.

6. I need [this feature] in OPT for one of our customers. What do I do?
You send me an e-mail and we discuss about it. If it's not urgent and OPT would
benefit from it, we'll add it to the development plan and do it. If it's urgent
or very specific, we can discuss a very reasonable budget and a deadline and
we're going to do it that way. Please be aware that, unless explicitly specified,
all developments to OPT will be made public and available to all.

7. Why is the permission system so poor?
OPT was originally developed by CSO Lanifex as part of our intranet. We didn't
need a very fancy permissions system - just administrators and regular users.
Our company is not a very large one, therefore we considered it would be enough
for the users who work in Lanifex to be considered admins and for the rest to
be considered regular users. We didn't start thinking about improving it until
the project was rather mature and changing the permission system implied a lot
of work. However, changing it is in the development plan, just not very soon.

8. Where is this project headed to?
The simple answer is: being as useful as possible.
The complex answer is: we're trying to develop OPT in a dynamic way, guided
mostly by our user's feedback and common sense. We try to keep it generic but
that implies a lot of specifics. Yes, it sounds silly, but if we developed a
tool targeted at some specific kind of projects - say, programming - then we'd
just go for a few programming specifics - such as strong versioning support.
Keeping it generic means that we have to also take into consideration the
specific needs for other fields - that's why we implemented the meeting module,
for instance. For very specific needs we recommend plugins (which are generally
not developed by CSO Lanifex).
Why all the discussion about specifics? So you can understand why we can't
predict any milestones, let alone deadlines. For a generic roadmap, you can check
the roadmap document under Docs on the OPT SF page. But that's not strict at all
because new features are suggested every day by our users and some of them are
so exciting that we can't resist the urge to implement them right away.

9. I have a problem with an OPT plugin. Who do I talk to?
You should use the Plugins tracker on the OPT SF page. Alternatively, you can post
the issue on the mailing list - at the time of this writing, all of the OPT plugin
developers are subscribed to the mailing list, and we expect that to happen in the
future as well.
Update: The GANTT charts plugin developer has apparently dropped it due to unknown
reasons, so that's not true anymore. However, I'll try to maintain his plugin so
the mailing list seems like the best bet anyway.
Update2: Currently there are no plugins available. All that has been a plugin in the 
past are now an integral part of OPT.

10. I want to translate OPT to some other language. What do I do?
We're currently in the process of implementing localization features to OPT.
The current version of OPT has limited translation support, meaning that on one hand
you need PHP compiled with --with-gettext (see question 17 below if you have problems
with that) -- and on the other hand, not all of OPT has translations implemented.
If you do have gettext enabled, please use the interface, go to admin/translations
and use the help there in order to find out what to do.

11. I really like how OPT looks.
Cool.

12. I really like how OPT looks but I'd like to have my logo on the main menu
If you want your logo on the main menu, you should check out the file named
TopNoBrand.png in the dev directory in the original archive - that should help.

13. I really like how OPT looks but I'd like to be able to change the colors
You should take a look at opt/include/gui.php. That file contains most of the GUI
(graphical user interface) stuff - including colors. If you want to change the
graphics, take a look at the opt/images directory - most of the images used
throughout OPT are in there. You should also take a look at opt/include/opt_css.php
for that matter. The printer-friendly settings in gui.php are applied when you click
on the printer icon in the main menu.

14. I don't like how OPT looks and I want to design my own templates
Arghh, formerly question no. 13 - no luck. OPT doesn't support templating at the time of this
writing. We are planning to support color schemes and maybe skins, but templating is
not a priority at this time.

15. Are the upgrades incremental or do I just get the latest regardless of my current version?
The upgrades are incremental. You can't skip any - you must get all of the upgrades
following your current version of OPT and apply them in order.  This is easy using UpgradeManager.

16. I want to be able to upload large documents (>2 MB) - what should I do?
If your maximum document upload expectancy is MAX_DOC, you should set the following
values in your php.ini:
post_max_size = MAX_DOC
upload_max_filesize = MAX_DOC
memory_limit = MAX_DOC*LAMBDA
LAMBDA is a coefficient depending on the nature of the files you upload. For plain text
files, LAMBDA should be about 1.5, and for binary files you may go as high 2-2.5. That's
because the data you upload has to be slashed for database insertion, and it also has
to be split in chunks due to a problem with large data transfer to MySQL.

17. I hate the "Blocked" message OPT issues occasionaly - how do I get rid of it?
Please read the online documentation under Admin/Settings/Global Settings, specifically
login_interval and login_attempts.
If you're the administrator and don't remember your password and want to keep trying,
log in MySQL, open the OPT database and issue the following:
update settings set value=0 where name='login_interval';
You can set the default back from MySQL with
update settings set value=5 where name='login_interval';
or from the interface by clicking on "[Default]" next to login_interval.
Alternatively, take a look at question 19 below.

18. My Outlook removes the "personal" field from the e-mail address and OPT can't parse the destination.
You should enclose the whole OPT mail address (including the personal field) in double quotes.
For example, send mail to "OPT archive #2 <hide@address.com>" (quotes included).

19. I forgot my OPT admin password - what do I do?
First try using the forgot password link on the main page. If that doesn't work, here's
the hardcore way to do it:

Copy the piece of code below in a file, save it as php somewhere under your document root and
access it via http. Press "Submit" and copy the resulting MD5 to the clipboard. Then manually log
in MySQL (using the following command: "mysql -u<username> -p" - type the password when requested)
and type the following:

use <your opt database>;
select id, fname, lname from people;

You're going to get a list of numbers (id) and names (fname - lname pairs). Choose the
number corresponding to the person you want the password changed and issue the following:

update people set pwd="<paste from clipboard>" where id=<chosen number>;

Now for the PHP code:
--- code start ---
<?
  if ($pwd) {
    echo("MD5 to copy: <b>".md5($pwd)."</b><br>");
  }
?>
<form action="<? echo $PHP_SELF; ?>" method="POST">
New password: <input type="text" name="pwd"><br>
<input type="submit">
</form>
--- code end ---

Do not enter either quotes or double quotes in the password - depending on your PHP settings
you might end up with them slashed which may confuse you when logging in.
Return current item: Outreach Project Tool