From 4e2ba4a8f9fcfd999feb9ce2615b27ff2ca2cf73 Mon Sep 17 00:00:00 2001 From: nbm Date: Thu, 2 Mar 2006 07:07:54 +0000 Subject: [PATCH] Documentation update for 3.0.0 --- docs/CREDITS.txt | 19 +++++++++++++------ docs/FAQ.txt | 47 +++++++++++++++++++++++++---------------------- docs/INSTALL.WIN32.txt | 25 +++++++++++++++---------- docs/INSTALL.txt | 23 +++++++++++++++-------- docs/TODO.txt | 1 - docs/UPGRADE.txt | 20 +++++++++++++++++++- 6 files changed, 87 insertions(+), 48 deletions(-) diff --git a/docs/CREDITS.txt b/docs/CREDITS.txt index b6d01b4..c53c4e4 100644 --- a/docs/CREDITS.txt +++ b/docs/CREDITS.txt @@ -1,16 +1,23 @@ -KnowledgeTree(tm) depends on the following components: +KnowledgeTree(tm) makes use of the following components: +-------------------------------------------------------- Email: phpmailer - http://phpmailer.sourceforge.net (LGPL) -Mark Round's AuthLDAP class (class.AuthLDAP.php): -http://phpclasses.dknss.com/browse/package/893.html (GPL) - -Javascript +Javascript: MochiKit - http://www.mochikit.com/ (MIT License) JS Calendar - http://dynarch.com/mishoo/calendar.epl (LGPL) TinyMCE - http://sourceforge.net/projects/tinymce/ (LGPL) Option Transfer Widget - http://www.mattkruse.com/ (Custom License) -Icons +Icons: "Silk" - http://www.famfamfam.com/lab/icons/silk/ (CC Attribution License) + +Alumni: +------- + +KnowlegeTree has previously utilised code from the following sources: + +Mark Round's AuthLDAP class (class.AuthLDAP.php): +http://phpclasses.dknss.com/browse/package/893.html (GPL) + diff --git a/docs/FAQ.txt b/docs/FAQ.txt index 37a308a..306c019 100644 --- a/docs/FAQ.txt +++ b/docs/FAQ.txt @@ -1,40 +1,43 @@ -KnowledgeTree DMS- Frequently Asked Questions +KnowledgeTree(tm) DMS - Frequently Asked Questions Q: I can't seem to search inside my files? A: There are two things which may cause full-text search not to work: - 1. Make sure that the Indexing plugin is enabled (in Admin > Misc > Manage Plugins) - 2. Ensure that the appropriate programs are installed, and (if on Windows) - that the config.ini section "indexer" contains the correct paths to the - files. + 1. Make sure that the Indexing plugin is enabled + (in Admin > Misc > Manage Plugins) + 2. Ensure that the appropriate programs are installed, and + (especially on Windows) that the config.ini section "indexer" + contains the correct paths to the files. Q: Where do I post questions about installing, configuring or using KnowledgeTree? -A: Our community forums are a good place to ask questions about installing, - configuring or using KnowledgeTree. Our developers, along with other members of - the open source community and our partner network, will endeavour to answer - your questions. +A: Our community forums are a good place to ask questions about + installing, configuring or using KnowledgeTree. Our developers, along + with other members of the open source community and our partner + network, will endeavour to answer your questions. Click on the link below to access the forums: http://forum.ktdms.com/ -Q: Where can I discuss document management best practices, change management and training issues? +Q: Where can I discuss document management best practices, change + management and training issues? -A: Our community forums are a good place to discuss best practices for document - management, software implementation and training with our developers, other - members of the open source community and our partner network. +A: Our community forums are a good place to discuss best practices for + document management, software implementation and training with our + developers, other members of the open source community and our + partner network. Click on the link below to access the forums: http://forum.ktdms.com/ -Q: Where can I report bugs in the open source KnowledgeTree server? +Q: Where can I report bugs in KnowledgeTree? -A: You can report bugs in the open source KnowledgeTree server software by - accessing our online ticketing system. The ticketing system will also provide - feedback on the status of the issue. You may view issues reported by other - people and search the system to determine if your issue has already been +A: You can report bugs in KnowledgeTree by accessing our online + ticketing system. The ticketing system will also provide feedback on + the status of the issue. You may view issues reported by other people + and search the system to determine if your issue has already been reported. Click on the link below to access the ticketing system: @@ -44,10 +47,10 @@ A: You can report bugs in the open source KnowledgeTree server software by Q: I want to modify KnowledgeTree or develop new functionality for it. Where do I find more information on how to go about doing this? -A: You can find out more information about modifying the KnowledgeTree - server, developing new functionality or translating the software at - the development Wiki. The Wiki is constantly under development and - even you may add content to it! +A: You can find out more information about modifying KnowledgeTree, + developing new functionality or translating the software at the + development Wiki. The Wiki is constantly under development and even + you may add content to it! Click on the link below to access the Wiki: diff --git a/docs/INSTALL.WIN32.txt b/docs/INSTALL.WIN32.txt index 3e99af7..5467b78 100644 --- a/docs/INSTALL.WIN32.txt +++ b/docs/INSTALL.WIN32.txt @@ -2,10 +2,11 @@ Windows Specific Installation Instructions ========================================== Installation on Windows XP and 2003 requires a slightly different approach to -the *NIX one. +the generic instructions. -The easiest installation approach is to use our Windows installer. You can -find this for download on SourceForge, alongside our usual install bundles: +The easiest installation approach for the Windows plaform is to use our +Windows installer. You can find this for download on SourceForge, +alongside our usual install bundles: http://sourceforge.net/projects/kt-dms @@ -111,15 +112,19 @@ General procedure: activated from this menu or the full-text search WILL NOT work. -File Indexing -------------- +External applications +--------------------- -The file indexing facilities of KnowledgeTree make use of external -programs to perform their jobs. +The file indexing and other facilities of KnowledgeTree make use of +external applications to perform their jobs. -At the moment, the "antiword" (http://www.informatik.uni-frankfurt.de/~markus/antiword/) -and "xpdf" packages contains all the external programs you need. -Installing this package is beyond the scope of this document - please +For the Windows platform, these are: + +. antiword - http://www.informatik.uni-frankfurt.de/~markus/antiword/ +. xpdf - http://www.foolabs.com/xpdf/ +. InfoZip unzip and zip - http://www.info-zip.org/ + +Installing these packages is beyond the scope of this document - please consult the KnowledgeTree Wiki at http://support.ktdms.com/confluence/ to see how others have approached this on your platform. diff --git a/docs/INSTALL.txt b/docs/INSTALL.txt index 0c9edf8..d24ba7c 100644 --- a/docs/INSTALL.txt +++ b/docs/INSTALL.txt @@ -109,17 +109,24 @@ KnowledgeTree Installation Notes Fulltext indexing of files (e.g. checking their contents) needs to be activated from this menu or the full-text search WILL NOT work. -File Indexing -------------- +External applications +--------------------- -The file indexing facilities of KnowledgeTree make use of external -programs to perform their jobs. +The file indexing and other facilities of KnowledgeTree make use of +external applications to perform their jobs. -At the moment, the "catdoc" (http://www.45.free.net/~vitus/ice/catdoc/) -and "xpdf" packages contains all the external programs you need. -Installing this package is beyond the scope of this document - please +For the Windows platform, these are: + +. catdoc - http://www.45.free.net/~vitus/ice/catdoc/ +. xpdf - http://www.foolabs.com/xpdf/ +. InfoZip unzip and zip - http://www.info-zip.org/ + +Installing these packages is beyond the scope of this document - please consult the KnowledgeTree Wiki at http://support.ktdms.com/confluence/ -to see how others have approached this on your platform. +to see how others have approached this on your platform. We recommend +that you use the appropriate package management procedures for +installing these packages on your system to ensure ease of maintenance +and upgrade. NOTE: if you install the packages outside of the path normally searched by your operating system (e.g. in c:\antiword or /usr/local/bin) you will diff --git a/docs/TODO.txt b/docs/TODO.txt index 386d548..edca825 100644 --- a/docs/TODO.txt +++ b/docs/TODO.txt @@ -13,6 +13,5 @@ KnowledgeTree DMS Development TODO List - Make logging robust - Revisit application logging and tidy up logging levels. - Allow thumbnails for image types (API for any other filetype) -- Multi-document select in a folder (for delete, move etc.) $Id$ diff --git a/docs/UPGRADE.txt b/docs/UPGRADE.txt index 5d8c481..51beaf3 100644 --- a/docs/UPGRADE.txt +++ b/docs/UPGRADE.txt @@ -11,6 +11,13 @@ and a backup will allow you to return to the original version of KnowledgeTree. Please report failed upgrades to the KnowledgeTree developers. +Ensure that the web user may write to all the folders within the 'var' +folder, so that logging and other changes are possible. + +Make sure to read the "Additional steps" section towards the end of the +document to ensure that any specific steps for your upgrade are +performed before you continue. + Automated upgrade ----------------- @@ -23,7 +30,7 @@ forced to do so. Using the automated upgrade will create an upgrade history that can be reviewed via the KnowledgeTree administrators interface. -If you are upgrading KnowledgeTree from versions prior to 2.0.6, see the +If you are upgrading KnowledgeTree from versions prior to 3.0.0, see the section at the bottom of this document to set up automated upgrades. Web page: @@ -67,6 +74,17 @@ $default->dbAdminPass = "js9281djw"; You should now be able to use the automated upgrade. +KnowledgeTree 3.0.0 +------------------- + +KnowledgeTree 3.0 includes the move of the default document storage +location from "Documents" in the root of the KnowledgeTree install to +"var/Documents". The "log" directory has also moved to "var/log". + +If you are using the default document storage location (ie, you have not +specifically set another document location), move the Documents +directory to "var/Documents before upgrading. + --------------------------------------------------------------------------- -- libgit2 0.21.4