summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBogomil Shopov <bogomil@efb.bg>2011-06-08 15:21:45 (GMT)
committerBogomil Shopov <bogomil@efb.bg>2011-06-08 15:21:45 (GMT)
commitec0aa25b4658cdfaa46e72f68b77d2d35fac9213 (patch)
treef8dc82925969f9cf7deed1d76af87f2f987c54a5 /docs
downloadkasync-ec0aa25b4658cdfaa46e72f68b77d2d35fac9213.tar.gz
First commit of Kasync module.
Diffstat (limited to 'docs')
-rwxr-xr-xdocs/CHANGES5
-rwxr-xr-xdocs/CREDITS24
-rwxr-xr-xdocs/INSTALL243
-rwxr-xr-xdocs/RELEASE_NOTES50
-rwxr-xr-xdocs/TODO8
5 files changed, 330 insertions, 0 deletions
diff --git a/docs/CHANGES b/docs/CHANGES
new file mode 100755
index 0000000..141c0cc
--- /dev/null
+++ b/docs/CHANGES
@@ -0,0 +1,5 @@
+---
+0.1
+---
+
+[xyz] Initial Release
diff --git a/docs/CREDITS b/docs/CREDITS
new file mode 100755
index 0000000..e184cff
--- /dev/null
+++ b/docs/CREDITS
@@ -0,0 +1,24 @@
+===========================
+ Kasync Development Team
+===========================
+
+
+Core Developers
+===============
+
+
+
+Drivers
+=======
+
+
+
+Localization
+============
+
+===================== ======================================================
+===================== ======================================================
+
+
+Contributions
+=============
diff --git a/docs/INSTALL b/docs/INSTALL
new file mode 100755
index 0000000..4263247
--- /dev/null
+++ b/docs/INSTALL
@@ -0,0 +1,243 @@
+=========================
+ Installing Kasync 1.0
+=========================
+
+:Last update: $Date: 2007-12-14 17:44:26 $
+:Revision: $Revision: 1.16 $
+
+.. contents:: Contents
+.. section-numbering::
+
+This document contains instructions for installing the Kasync ...
+
+For information on the capabilities and features of Kasync, see the file
+README_ in the top-level directory of the Kasync distribution.
+
+
+Obtaining Kasync
+==================
+
+Kasync can be obtained from the Horde website and FTP server, at
+
+ http://www.horde.org/kasync/
+
+ ftp://ftp.horde.org/pub/kasync/
+
+Or use the mirror closest to you:
+
+ http://www.horde.org/mirrors.php
+
+Bleeding-edge development versions of Kasync are available via CVS; see the
+file `horde/docs/HACKING`_ in the Horde distribution, or the website
+http://www.horde.org/source/, for information on accessing the Horde CVS
+repository.
+
+
+Prerequisites
+=============
+
+To function properly, Kasync **requires** the following:
+
+1. A working Horde installation.
+
+ Kasync runs within the `Horde Application Framework`_, a set of common
+ tools for Web applications written in PHP. You must install Horde before
+ installing Kasync.
+
+ .. Important:: Kasync 1.0 requires version 3.0+ of the Horde Framework -
+ earlier versions of Horde will **not** work.
+
+ .. _`Horde Application Framework`: http://www.horde.org/horde/
+
+ The Horde Framework can be obtained from the Horde website and FTP server,
+ at
+
+ http://www.horde.org/horde/
+
+ ftp://ftp.horde.org/pub/horde/
+
+ Many of Kasync's prerequisites are also Horde prerequisites.
+
+ .. Important:: Be sure to have completed all of the steps in the
+ `horde/docs/INSTALL`_ file for the Horde Framework before
+ installing Kasync.
+
+2. The following PHP capabilities:
+
+ a. FOO support ``--with-foo`` [OPTIONAL]
+
+ Description of Foo and what it is used for.
+
+3. The following PEAR packages:
+ (See `horde/docs/INSTALL`_ for instructions on installing PEAR packages)
+
+ a. PEAR_Package x.x.x [OPTIONAL]
+
+ Kasync uses the Foo_Bar class for...
+
+4. The following PECL modules:
+ (See `horde/docs/INSTALL`_ for instructions on installing PECL modules)
+
+ a. pecl_package x.x.x [OPTIONAL]
+
+ pecl_package is required to...
+
+5. Something else.
+
+The following items are not required, but are strongly **recommended**:
+
+1. Yet something else.
+
+
+Installing Kasync
+===================
+
+Kasync is written in PHP, and must be installed in a web-accessible
+directory. The precise location of this directory will differ from system to
+system. Conventionally, Kasync is installed directly underneath Horde in the
+web server's document tree.
+
+Since Kasync is written in PHP, there is no compilation necessary; simply
+expand the distribution where you want it to reside and rename the root
+directory of the distribution to whatever you wish to appear in the URL. For
+example, with the Apache web server's default document root of
+``/usr/local/apache/htdocs``, you would type::
+
+ cd /usr/local/apache/htdocs/horde
+ tar zxvf /path/to/kasync-h3-x.y.z.tar.gz
+ mv kasync-h3-x.y.z kasync
+
+and would then find Kasync at the URL::
+
+ http://your-server/horde/kasync/
+
+
+Configuring Kasync
+====================
+
+1. Configuring Horde for Kasync
+
+ a. Register the application
+
+ In ``horde/config/registry.php``, find the ``applications['kasync']``
+ stanza. The default settings here should be okay, but you can change
+ them if desired. If you have changed the location of Kasync relative
+ to Horde, either in the URL, in the filesystem or both, you must update
+ the ``fileroot`` and ``webroot`` settings to their correct values.
+
+2. Creating the database tables
+
+ The specific steps to create Kasync's database tables depend on which
+ database you've chosen to use.
+
+ First, look in ``scripts/sql/`` to see if a script already exists for your
+ database type. If so, you should be able to simply execute that script as
+ superuser in your database. (Note that executing the script as the "horde"
+ user will probably fail when granting privileges.)
+
+ If such a script does not exist, you'll need to build your own, using the
+ file ``kasync.sql`` as a starting point. If you need assistance in
+ creating database tables, you may wish to let us know on the Kasync
+ mailing list.
+
+ You will also need to make sure that the "horde" user in your database has
+ table-creation privileges, so that the tables that `PEAR DB`_ uses to
+ provide portable sequences can be created.
+
+ .. _`PEAR DB`: http://pear.php.net/DB
+
+3. Configuring Kasync
+
+ To configure Kasync, change to the ``config/`` directory of the installed
+ distribution, and make copies of all of the configuration ``dist`` files
+ without the ``dist`` suffix::
+
+ cd config/
+ for foo in *.dist; do cp $foo `basename $foo .dist`; done
+
+ Or on Windows::
+
+ copy *.dist *.
+
+ Documentation on the format and purpose of those files can be found in each
+ file. You may edit these files if you wish to customize Kasync's
+ appearance and behavior. With one exception (``foo.php``) the defaults will
+ be correct for most sites.
+
+ You must login to Horde as a Horde Administrator to finish the
+ configuration of Kasync. Use the Horde ``Administration`` menu item to
+ get to the administration page, and then click on the ``Configuration``
+ icon to get the configuration page. Select ``Kasync Name`` from the
+ selection list of applications. Fill in or change any configuration values
+ as needed. When done click on ``Generate Kasync Name Configuration`` to
+ generate the ``conf.php`` file. If your web server doesn't have write
+ permissions to the Kasync configuration directory or file, it will not be
+ able to write the file. In this case, go back to ``Configuration`` and
+ choose one of the other methods to create the configuration file
+ ``kasync/config/conf.php``.
+
+ Note for international users: Kasync uses GNU gettext to provide local
+ translations of text displayed by applications; the translations are found
+ in the ``po/`` directory. If a translation is not yet available for your
+ locale (and you wish to create one), see the ``horde/po/README`` file, or
+ if you're having trouble using a provided translation, please see the
+ `horde/docs/TRANSLATIONS`_ file for instructions.
+
+4. More instructions, upgrading, securing, etc.
+
+5. Testing Kasync
+
+ Once you have configured Kasync, bring up the included test page in your
+ Web browser to ensure that all necessary prerequisites have been met. See
+ the `horde/docs/INSTALL`_ document for further details on Horde test
+ scripts. If you installed Kasync as described above, the URL to the test
+ page would be::
+
+ http://your-server/horde/kasync/test.php
+
+ The test script will also allow you to test...
+
+ Next, use Kasync to.... Test at least the following:
+
+ - Foo
+ - Bar
+
+
+Known Problems
+==============
+
+...
+
+
+Obtaining Support
+=================
+
+If you encounter problems with Kasync, help is available!
+
+The Horde Frequently Asked Questions List (FAQ), available on the Web at
+
+ http://www.horde.org/faq/
+
+The Horde Project runs a number of mailing lists, for individual applications
+and for issues relating to the project as a whole. Information, archives, and
+subscription information can be found at
+
+ http://www.horde.org/mail/
+
+Lastly, Horde developers, contributors and users may also be found on IRC,
+on the channel #horde on the Freenode Network (irc.freenode.net).
+
+Please keep in mind that Kasync is free software written by volunteers.
+For information on reasonable support expectations, please read
+
+ http://www.horde.org/support.php
+
+Thanks for using Kasync!
+
+The Kasync team
+
+
+.. _README: ?f=README.html
+.. _`horde/docs/HACKING`: ../../horde/docs/?f=HACKING.html
+.. _`horde/docs/INSTALL`: ../../horde/docs/?f=INSTALL.html
+.. _`horde/docs/TRANSLATIONS`: ../../horde/docs/?f=TRANSLATIONS.html
diff --git a/docs/RELEASE_NOTES b/docs/RELEASE_NOTES
new file mode 100755
index 0000000..1b67f40
--- /dev/null
+++ b/docs/RELEASE_NOTES
@@ -0,0 +1,50 @@
+<?php
+/**
+ * Release focus. Possible values:
+ * 0 - N/A
+ * 1 - Initial freshmeat announcement
+ * 2 - Documentation
+ * 3 - Code cleanup
+ * 4 - Minor feature enhancements
+ * 5 - Major feature enhancements
+ * 6 - Minor bugfixes
+ * 7 - Major bugfixes
+ * 8 - Minor security fixes
+ * 9 - Major security fixes
+ */
+$this->notes['fm']['focus'] = 4;
+
+/* Mailing list release notes. */
+$this->notes['ml']['changes'] = <<<ML
+The Horde Team is pleased to announce the [first release candidate|final
+release] of the Kasync Foo Bar Application version H3 (x.x).
+
+The Kasync Foo Bar Application is a...
+
+[For alpha/beta releases:
+This is a preview version that should not be used on production systems. This
+version is considered feature complete but there might still be a few bugs.
+You should not use this preview version over existing production data.
+
+We encourage widespread testing and feedback via the mailing lists or our bug
+tracking system. Updated translations are very welcome, though some strings
+might still change before the final release.]
+
+[For release candidates:
+Barring any problems, this code will be released as Kasync H3 (x.x).
+Testing is requested and comments are encouraged.
+Updated translations would also be great.]
+
+The major changes compared to the Kasync version H3 (x.x) are:
+[or: Kasync version H3 (x.y) is a major upgrade in the x.x release series,
+including these enhancements:]
+ * ...
+ML;
+
+/* Freshmeat release notes, not more than 600 characters. */
+$this->notes['fm']['changes'] = <<<FM
+FM;
+
+$this->notes['name'] = 'Kasync';
+$this->notes['fm']['project'] = 'kasync';
+$this->notes['fm']['branch'] = 'Default';
diff --git a/docs/TODO b/docs/TODO
new file mode 100755
index 0000000..c9a601c
--- /dev/null
+++ b/docs/TODO
@@ -0,0 +1,8 @@
+================================
+ Kasync Development TODO List
+================================
+
+:Last update: $Date: 2007-04-22 04:51:54 $
+:Revision: $Revision: 1.2 $
+
+- Example todo