Peter M. Groen / knowledgetree

Commit 4e2ba4a8f9fcfd999feb9ce2615b27ff2ca2cf73

Authored by nbm
1 parent d0e2b327

Documentation update for 3.0.0 


git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@5034 c91229c3-7414-0410-bfa2-8a42b809f60b
Inline Side-by-side
Showing 6 changed files with 87 additions and 48 deletions
docs/CREDITS.txt
  View file @4e2ba4a
1   -KnowledgeTree(tm) depends on the following components:
  1 +KnowledgeTree(tm) makes use of the following components:
  2 +--------------------------------------------------------
2 3  
3 4 Email:
4 5 phpmailer - http://phpmailer.sourceforge.net (LGPL)
5 6  
6   -Mark Round's AuthLDAP class (class.AuthLDAP.php):
7   -http://phpclasses.dknss.com/browse/package/893.html (GPL)
8   -
9   -Javascript
  7 +Javascript:
10 8 MochiKit - http://www.mochikit.com/ (MIT License)
11 9 JS Calendar - http://dynarch.com/mishoo/calendar.epl (LGPL)
12 10 TinyMCE - http://sourceforge.net/projects/tinymce/ (LGPL)
13 11 Option Transfer Widget - http://www.mattkruse.com/ (Custom License)
14 12  
15   -Icons
  13 +Icons:
16 14 "Silk" - http://www.famfamfam.com/lab/icons/silk/ (CC Attribution License)
  15 +
  16 +Alumni:
  17 +-------
  18 +
  19 +KnowlegeTree has previously utilised code from the following sources:
  20 +
  21 +Mark Round's AuthLDAP class (class.AuthLDAP.php):
  22 +http://phpclasses.dknss.com/browse/package/893.html (GPL)
  23 +
... ...
docs/FAQ.txt
  View file @4e2ba4a
1   -KnowledgeTree DMS- Frequently Asked Questions
  1 +KnowledgeTree(tm) DMS - Frequently Asked Questions
2 2  
3 3 Q: I can't seem to search inside my files?
4 4  
5 5 A: There are two things which may cause full-text search not to work:
6 6  
7   - 1. Make sure that the Indexing plugin is enabled (in Admin > Misc > Manage Plugins)
8   - 2. Ensure that the appropriate programs are installed, and (if on Windows)
9   - that the config.ini section "indexer" contains the correct paths to the
10   - files.
  7 + 1. Make sure that the Indexing plugin is enabled
  8 + (in Admin > Misc > Manage Plugins)
  9 + 2. Ensure that the appropriate programs are installed, and
  10 + (especially on Windows) that the config.ini section "indexer"
  11 + contains the correct paths to the files.
11 12  
12 13 Q: Where do I post questions about installing, configuring or using KnowledgeTree?
13 14  
14   -A: Our community forums are a good place to ask questions about installing,
15   - configuring or using KnowledgeTree. Our developers, along with other members of
16   - the open source community and our partner network, will endeavour to answer
17   - your questions.
  15 +A: Our community forums are a good place to ask questions about
  16 + installing, configuring or using KnowledgeTree. Our developers, along
  17 + with other members of the open source community and our partner
  18 + network, will endeavour to answer your questions.
18 19  
19 20 Click on the link below to access the forums:
20 21 http://forum.ktdms.com/
21 22  
22   -Q: Where can I discuss document management best practices, change management and training issues?
  23 +Q: Where can I discuss document management best practices, change
  24 + management and training issues?
23 25  
24   -A: Our community forums are a good place to discuss best practices for document
25   - management, software implementation and training with our developers, other
26   - members of the open source community and our partner network.
  26 +A: Our community forums are a good place to discuss best practices for
  27 + document management, software implementation and training with our
  28 + developers, other members of the open source community and our
  29 + partner network.
27 30  
28 31 Click on the link below to access the forums:
29 32  
30 33 http://forum.ktdms.com/
31 34  
32   -Q: Where can I report bugs in the open source KnowledgeTree server?
  35 +Q: Where can I report bugs in KnowledgeTree?
33 36  
34   -A: You can report bugs in the open source KnowledgeTree server software by
35   - accessing our online ticketing system. The ticketing system will also provide
36   - feedback on the status of the issue. You may view issues reported by other
37   - people and search the system to determine if your issue has already been
  37 +A: You can report bugs in KnowledgeTree by accessing our online
  38 + ticketing system. The ticketing system will also provide feedback on
  39 + the status of the issue. You may view issues reported by other people
  40 + and search the system to determine if your issue has already been
38 41 reported.
39 42  
40 43 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
44 47 Q: I want to modify KnowledgeTree or develop new functionality for it.
45 48 Where do I find more information on how to go about doing this?
46 49  
47   -A: You can find out more information about modifying the KnowledgeTree
48   - server, developing new functionality or translating the software at
49   - the development Wiki. The Wiki is constantly under development and
50   - even you may add content to it!
  50 +A: You can find out more information about modifying KnowledgeTree,
  51 + developing new functionality or translating the software at the
  52 + development Wiki. The Wiki is constantly under development and even
  53 + you may add content to it!
51 54  
52 55 Click on the link below to access the Wiki:
53 56  
... ...
docs/INSTALL.WIN32.txt
  View file @4e2ba4a
... ... @@ -2,10 +2,11 @@ Windows Specific Installation Instructions
2 2 ==========================================
3 3  
4 4 Installation on Windows XP and 2003 requires a slightly different approach to
5   -the *NIX one.
  5 +the generic instructions.
6 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:
  7 +The easiest installation approach for the Windows plaform is to use our
  8 +Windows installer. You can find this for download on SourceForge,
  9 +alongside our usual install bundles:
9 10  
10 11 http://sourceforge.net/projects/kt-dms
11 12  
... ... @@ -111,15 +112,19 @@ General procedure:
111 112 activated from this menu or the full-text search WILL NOT work.
112 113  
113 114  
114   -File Indexing
115   --------------
  115 +External applications
  116 +---------------------
116 117  
117   -The file indexing facilities of KnowledgeTree make use of external
118   -programs to perform their jobs.
  118 +The file indexing and other facilities of KnowledgeTree make use of
  119 +external applications to perform their jobs.
119 120  
120   -At the moment, the "antiword" (http://www.informatik.uni-frankfurt.de/~markus/antiword/)
121   -and "xpdf" packages contains all the external programs you need.
122   -Installing this package is beyond the scope of this document - please
  121 +For the Windows platform, these are:
  122 +
  123 +. antiword - http://www.informatik.uni-frankfurt.de/~markus/antiword/
  124 +. xpdf - http://www.foolabs.com/xpdf/
  125 +. InfoZip unzip and zip - http://www.info-zip.org/
  126 +
  127 +Installing these packages is beyond the scope of this document - please
123 128 consult the KnowledgeTree Wiki at http://support.ktdms.com/confluence/
124 129 to see how others have approached this on your platform.
125 130  
... ...
docs/INSTALL.txt
  View file @4e2ba4a
... ... @@ -109,17 +109,24 @@ KnowledgeTree Installation Notes
109 109 Fulltext indexing of files (e.g. checking their contents) needs to be
110 110 activated from this menu or the full-text search WILL NOT work.
111 111  
112   -File Indexing
113   --------------
  112 +External applications
  113 +---------------------
114 114  
115   -The file indexing facilities of KnowledgeTree make use of external
116   -programs to perform their jobs.
  115 +The file indexing and other facilities of KnowledgeTree make use of
  116 +external applications to perform their jobs.
117 117  
118   -At the moment, the "catdoc" (http://www.45.free.net/~vitus/ice/catdoc/)
119   -and "xpdf" packages contains all the external programs you need.
120   -Installing this package is beyond the scope of this document - please
  118 +For the Windows platform, these are:
  119 +
  120 +. catdoc - http://www.45.free.net/~vitus/ice/catdoc/
  121 +. xpdf - http://www.foolabs.com/xpdf/
  122 +. InfoZip unzip and zip - http://www.info-zip.org/
  123 +
  124 +Installing these packages is beyond the scope of this document - please
121 125 consult the KnowledgeTree Wiki at http://support.ktdms.com/confluence/
122   -to see how others have approached this on your platform.
  126 +to see how others have approached this on your platform. We recommend
  127 +that you use the appropriate package management procedures for
  128 +installing these packages on your system to ensure ease of maintenance
  129 +and upgrade.
123 130  
124 131 NOTE: if you install the packages outside of the path normally searched
125 132 by your operating system (e.g. in c:\antiword or /usr/local/bin) you will
... ...
docs/TODO.txt
  View file @4e2ba4a
... ... @@ -13,6 +13,5 @@ KnowledgeTree DMS Development TODO List
13 13 - Make logging robust
14 14 - Revisit application logging and tidy up logging levels.
15 15 - Allow thumbnails for image types (API for any other filetype)
16   -- Multi-document select in a folder (for delete, move etc.)
17 16  
18 17 $Id$
... ...
docs/UPGRADE.txt
  View file @4e2ba4a
... ... @@ -11,6 +11,13 @@ and a backup will allow you to return to the original version of
11 11 KnowledgeTree. Please report failed upgrades to the KnowledgeTree
12 12 developers.
13 13  
  14 +Ensure that the web user may write to all the folders within the 'var'
  15 +folder, so that logging and other changes are possible.
  16 +
  17 +Make sure to read the "Additional steps" section towards the end of the
  18 +document to ensure that any specific steps for your upgrade are
  19 +performed before you continue.
  20 +
14 21 Automated upgrade
15 22 -----------------
16 23  
... ... @@ -23,7 +30,7 @@ forced to do so. Using the automated upgrade will create an upgrade
23 30 history that can be reviewed via the KnowledgeTree administrators
24 31 interface.
25 32  
26   -If you are upgrading KnowledgeTree from versions prior to 2.0.6, see the
  33 +If you are upgrading KnowledgeTree from versions prior to 3.0.0, see the
27 34 section at the bottom of this document to set up automated upgrades.
28 35  
29 36 Web page:
... ... @@ -67,6 +74,17 @@ $default->dbAdminPass = "js9281djw";
67 74  
68 75 You should now be able to use the automated upgrade.
69 76  
  77 +KnowledgeTree 3.0.0
  78 +-------------------
  79 +
  80 +KnowledgeTree 3.0 includes the move of the default document storage
  81 +location from "Documents" in the root of the KnowledgeTree install to
  82 +"var/Documents". The "log" directory has also moved to "var/log".
  83 +
  84 +If you are using the default document storage location (ie, you have not
  85 +specifically set another document location), move the Documents
  86 +directory to "var/Documents before upgrading.
  87 +
70 88  
71 89 ---------------------------------------------------------------------------
72 90  
... ...