Commit 70173af31924c52fbfb6bd41124ae70891a94cb9

Authored by bshuttle
1 parent 9aa9199e

- re-arrange the docs folder

- add a INSTALL.WIN32.txt file
- bump the version to 2.99.7


git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@4667 c91229c3-7414-0410-bfa2-8a42b809f60b
docs/CREDITS.txt
... ... @@ -5,3 +5,9 @@ phpmailer - http://phpmailer.sourceforge.net (LGPL)
5 5  
6 6 Mark Round's AuthLDAP class (class.AuthLDAP.php):
7 7 http://phpclasses.dknss.com/browse/package/893.html (GPL)
  8 +
  9 +Javascript
  10 +MochiKit - http://www.mochikit.com/ (MIT License)
  11 +JS Calendar - http://dynarch.com/mishoo/calendar.epl (LGPL)
  12 +TinyMCE - http://sourceforge.net/projects/tinymce/ (LGPL)
  13 +Option Transfer Widget - http://www.mattkruse.com/ (Custom License)
8 14 \ No newline at end of file
... ...
docs/INSTALL.WIN32.txt 0 → 100644
  1 +Windows Specific Installation Instructions
  2 +==========================================
  3 +
  4 +Installation on Windows XP and 2003 requires a slightly different approach to
  5 +the *NIX one.
  6 +
  7 +The easiest installation approach is to use our Windows installer. You can
  8 +find this for download on SourceForge, alongside our usual install bundles:
  9 +
  10 + http://sourceforge.net/projects/kt-dms
  11 +
  12 +Manual Install (XAMPP)
  13 +----------------------
  14 +
  15 +If you need to do a manual installation of KnowledgeTree for some reason,
  16 +we recommend using a bundled version of Apache, MySQL and PHP. For testing
  17 +purposes, we use XAMPP (version 1.5.1):
  18 +
  19 + http://www.apachefriends.org/en/xampp.html
  20 +
  21 +General procedure:
  22 +
  23 + * Install XAMPP
  24 +
  25 + * Extract the KnowledgeTree zipfile inside the XAMPP htdocs directory. If
  26 + you installed XAMPP in
  27 +
  28 + c:\Program Files\xampp
  29 +
  30 + then you need to extract KnowledgeTree so that its files are in
  31 +
  32 + c:\Program Files\xampp\htdocs\knowledgeTree
  33 +
  34 + This will be referred to as "<knowledgeTree>" in paths from here on.
  35 +
  36 + * Conduct the Pre-installation checkup. Assuming you are running XAMPP on
  37 + "localhost", visit
  38 +
  39 + http://localhost/knowledgeTree/setup/
  40 +
  41 + * Configure the Database. The most effective way to do this with XAMPP is
  42 + to use phpmyadmin:
  43 +
  44 + http://localhost/phpmyadmin/
  45 +
  46 + 1. Create a new database (call it "dms")
  47 + 2. Create the tables:
  48 +
  49 + - open the "dms" database from the left-menu/.
  50 + - go to "SQL" at the top of the screen.
  51 + - Where it says "Location of the text file" click browse and then run:
  52 +
  53 + * <knowledgeTree>\sql\mysql\install\structure.sql
  54 + * <knowledgeTree>\sql\mysql\install\data.sql
  55 + * <knowledgeTree>\sql\mysql\install\user.sql
  56 +
  57 + * Configure your installation in <knowledgeTree>config\config.ini:
  58 +
  59 + - The default configuration will determine many settings on your
  60 + installation automatically, and this is the preferred method of
  61 + running KnowledgeTree. Please do not manually set these settings
  62 + unless you know what you are doing.
  63 +
  64 + - The default configuration uses the database username and password
  65 + in the user.sql file mentioned above, use the local host for the
  66 + database, and use the database named 'dms'. If you follow the
  67 + examples above in setting up the database, this means KnowledgeTree
  68 + should be fully configured to start working.
  69 +
  70 + - However, you should change this once you've performed your initial
  71 + evalution of KnowledgeTree for the security of your documents.
  72 +
  73 + - The following settings in config/environment.php control the
  74 + database connectivity, and can be set as shown:
  75 +
  76 + [db]
  77 + dbHost = localhost
  78 + dbName = dms
  79 + dbUser = myuser
  80 + dbPass = mypassword
  81 +
  82 + * Check the post-installation checklist:
  83 +
  84 + If your knowledgeTree installation is at http://localhost/, go to:
  85 +
  86 + http://localhost/setup/
  87 +
  88 + And click on "Post-installation checkup".
  89 +
  90 + * Login:
  91 + - in a web browser go to your KnowledgeTree installation via the web
  92 + - default user is "admin" with password "admin"
  93 +
  94 + * Register the standard plugins.
  95 +
  96 + - in a web browser go to "DMS Administration" , then "Miscellaneous",
  97 + then "Manage Plugins"
  98 + - click "Reread plugins" to load the list of available plugins.
  99 + - enable the plugins as required.
  100 +
  101 + * Please note: *
  102 + Fulltext indexing of files (e.g. checking their contents) needs to be
  103 + activated from this menu or the full-text search WILL NOT work.
  104 +
  105 +
  106 +File Indexing
  107 +-------------
  108 +
  109 +The file indexing facilities of KnowledgeTree make use of external
  110 +programs to perform their jobs.
  111 +
  112 +At the moment, the "catdoc" (http://www.45.free.net/~vitus/ice/catdoc/)
  113 +and "xpdf" packages contains all the external programs you need.
  114 +Installing this package is beyond the scope of this document - please
  115 +consult the KnowledgeTree Wiki at http://support.ktdms.com/confluence/
  116 +to see how others have approached this on your platform.
  117 +
  118 +You can find Windows specific installation instructions here:
  119 +
  120 + http://support.ktdms.com/confluence/display/KTWiki/Windows+XP+installation+instructions
  121 +
  122 +
  123 +Troubleshooting
  124 +---------------
  125 +
  126 +Please make sure that your KnowledgeTree installation passes all the
  127 +pre- and post-installation checkups first.
  128 +
  129 +Refer to the Frequently Asked Questions list on the KnowledgeTree Wiki
  130 +at http://support.ktdms.com/confluence/
  131 +
  132 +Ask on the KnowledgeTree forums on http://forum.ktdms.com/.
  133 +
  134 +If you have found a bug, please report it to the KnowledgeTree bug
  135 +reporting system at http://support.ktdms.com/.
  136 +
  137 +Upgrading
  138 +---------
  139 +
  140 +Refer to docs/UPGRADE.txt
... ...
docs/INSTALL.txt
... ... @@ -99,6 +99,15 @@ KnowledgeTree Installation Notes
99 99 - in a web browser go to your KnowledgeTree installation via the web
100 100 - default user is "admin" with password "admin"
101 101  
  102 +* Register the standard plugins.
  103 + - in a web browser go to "DMS Administration" , then "Miscellaneous",
  104 + then "Manage Plugins"
  105 + - click "Reread plugins" to load the list of available plugins.
  106 + - enable the plugins as required.
  107 +
  108 + * Please note: *
  109 + Fulltext indexing of files (e.g. checking their contents) needs to be
  110 + activated from this menu or the full-text search WILL NOT work.
102 111  
103 112 File Indexing
104 113 -------------
... ...
docs/README.txt
1 1 KnowledgeTree Document Management System
2 2 ----------------------------------------
3 3  
4   -Welcome to the first KnowledgeTree 3 beta. While it represents a
  4 +Welcome to the fourth KnowledgeTree 3 beta. While it represents a
5 5 significant improvement to the visible and background components of
6 6 KnowledgeTree, it is not yet ready for production use. It is
7 7 recommended that you ensure you have backups of anything you put into
... ...
docs/UPGRADE.txt
1 1 KnowledgeTree Upgrade instructions
2 2 ==================================
3 3  
  4 +* Please Note that KT3 Beta 4 is the first post-2.0.x version to support
  5 + a sane upgrade path. WE STRONGLY RECOMMEND YOU MAKE A BACKUP BEFORE
  6 + YOU START. Please help us by submitting any bugs you find in the migration
  7 + process at
  8 +
  9 + http://support.ktdms.com
  10 +
4 11 Before you upgrade
5 12 ------------------
6 13  
... ...
docs/VERSION.txt
1   -2.99.6-20050120-8
  1 +2.99.7
... ...
docs/Browse.txt renamed to docs/developer/Browse.txt
docs/Permissions.txt renamed to docs/developer/Permissions.txt
docs/RELEASE.txt renamed to docs/developer/RELEASE.txt
docs/codingStandards.txt renamed to docs/developer/codingStandards.txt
docs/i18n.txt renamed to docs/developer/i18n.txt
docs/metadata-versions.txt renamed to docs/developer/metadata-versions.txt