Commit c65ff32f10f33427b94a6895c5e599af975ee849

Authored by kevin_fourie
1 parent f3586163

Merged om from DEV trunk...

KTS-1966
"Replace docs folder contents with link to online documentation"
Removed docs and updated COPYING.

Committed By: Kevin
Reviewed By: Conrad

KTS-1966
"Replace docs folder contents with link to online documentation"
Added new README.txt file.

Committed By: Kevin
Reviewed By: Conrad

git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/STABLE/trunk@6763 c91229c3-7414-0410-bfa2-8a42b809f60b
docs/COPYING
1 -KnowledgeTree Public License  
2 -  
3 -The KnowledgeTree Public License ("KPL") consists of the Mozilla Public License Version 1.1, modified to be specific to KnowledgeTree, with the Additional Terms in Exhibit B. The original Mozilla Public License 1.1 can be found at: http://www.mozilla.org/MPL/MPL-1.1.html  
4 -  
5 -Changelog:  
6 -  
7 - * KnowledgeTree Public License 1.1.1  
8 - o Modified to reflect www.knowledgetree.com  
9 - o Modified to reflect new branding  
10 -  
11 -KNOWLEDGETREE PUBLIC LICENSE  
12 -Version 1.1.1  
13 -  
14 -1. Definitions.  
15 -  
16 -1.0.1. "Commercial Use" means distribution or otherwise making the Covered Code available to a third party.  
17 -  
18 -1.1. ''Contributor'' means each entity that creates or contributes to the creation of Modifications.  
19 -  
20 -1.2. ''Contributor Version'' means the combination of the Original Code, prior Modifications used by a Contributor, and the Modifications made by that particular Contributor.  
21 -  
22 -1.3. ''Covered Code'' means the Original Code or Modifications or the combination of the Original Code and Modifications, in each case including portions thereof.  
23 -  
24 -1.4. ''Electronic Distribution Mechanism'' means a mechanism generally accepted in the software development community for the electronic transfer of data.  
25 -  
26 -1.5. ''Executable'' means Covered Code in any form other than Source Code.  
27 -  
28 -1.6. ''Initial Developer'' means the individual or entity identified as the Initial Developer in the Source Code notice required by Exhibit A.  
29 -  
30 -1.7. ''Larger Work'' means a work which combines Covered Code or portions thereof with code not governed by the terms of this License.  
31 -  
32 -1.8. ''License'' means this document.  
33 -  
34 -1.8.1. "Licensable" means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently acquired, any and all of the rights conveyed herein.  
35 -  
36 -1.9. ''Modifications'' means any addition to or deletion from the substance or structure of either the Original Code or any previous Modifications. When Covered Code is released as a series of files, a Modification is:  
37 -  
38 -A. Any addition to or deletion from the contents of a file containing Original Code or previous Modifications.  
39 -  
40 -B. Any new file that contains any part of the Original Code or previous Modifications.  
41 -  
42 -1.10. ''Original Code'' means Source Code of computer software code which is described in the Source Code notice required by Exhibit A as Original Code, and which, at the time of its release under this License is not already Covered Code governed by this License.  
43 -  
44 -1.10.1. "Patent Claims" means any patent claim(s), now owned or hereafter acquired, including without limitation, method, process, and apparatus claims, in any patent Licensable by grantor.  
45 -  
46 -1.11. ''Source Code'' means the preferred form of the Covered Code for making modifications to it, including all modules it contains, plus any associated interface definition files, scripts used to control compilation and installation of an Executable, or source code differential comparisons against either the Original Code or another well known, available Covered Code of the Contributor's choice. The Source Code can be in a compressed or archival form, provided the appropriate decompression or de-archiving software is widely available for no charge.  
47 -  
48 -1.12. "You'' (or "Your") means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License or a future version of this License issued under Section 6.1. For legal entities, "You'' includes any entity which controls, is controlled by, or is under common control with You. For purposes of this definition, "control'' means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity.  
49 -  
50 -2. Source Code License.  
51 -  
52 -2.1. The Initial Developer Grant.  
53 -The Initial Developer hereby grants You a world-wide, royalty-free, non-exclusive license, subject to third party intellectual property claims:  
54 -  
55 -(a) under intellectual property rights (other than patent or trademark) Licensable by Initial Developer to use, reproduce, modify, display, perform, sublicense and distribute the Original Code (or portions thereof) with or without Modifications, and/or as part of a Larger Work; and  
56 -  
57 -(b) under Patents Claims infringed by the making, using or selling of Original Code, to make, have made, use, practice, sell, and offer for sale, and/or otherwise dispose of the Original Code (or portions thereof).  
58 -  
59 -(c) the licenses granted in this Section 2.1(a) and (b) are effective on the date Initial Developer first distributes Original Code under the terms of this License.  
60 -  
61 -(d) Notwithstanding Section 2.1(b) above, no patent license is granted: 1) for code that You delete from the Original Code; 2) separate from the Original Code; or 3) for infringements caused by: i) the modification of the Original Code or ii) the combination of the Original Code with other software or devices.  
62 -  
63 -2.2. Contributor Grant.  
64 -Subject to third party intellectual property claims, each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license  
65 -  
66 -  
67 -(a) under intellectual property rights (other than patent or trademark) Licensable by Contributor, to use, reproduce, modify, display, perform, sublicense and distribute the Modifications created by such Contributor (or portions thereof) either on an unmodified basis, with other Modifications, as Covered Code and/or as part of a Larger Work; and  
68 -  
69 -(b) under Patent Claims infringed by the making, using, or selling of Modifications made by that Contributor either alone and/or in combination with its Contributor Version (or portions of such combination), to make, use, sell, offer for sale, have made, and/or otherwise dispose of: 1) Modifications made by that Contributor (or portions thereof); and 2) the combination of Modifications made by that Contributor with its Contributor Version (or portions of such combination).  
70 -  
71 -(c) the licenses granted in Sections 2.2(a) and 2.2(b) are effective on the date Contributor first makes Commercial Use of the Covered Code.  
72 -  
73 -(d) Notwithstanding Section 2.2(b) above, no patent license is granted: 1) for any code that Contributor has deleted from the Contributor Version; 2) separate from the Contributor Version; 3) for infringements caused by: i) third party modifications of Contributor Version or ii) the combination of Modifications made by that Contributor with other software (except as part of the Contributor Version) or other devices; or 4) under Patent Claims infringed by Covered Code in the absence of Modifications made by that Contributor.  
74 -  
75 -  
76 -3. Distribution Obligations.  
77 -  
78 -3.1. Application of License.  
79 -The Modifications which You create or to which You contribute are governed by the terms of this License, including without limitation Section 2.2. The Source Code version of Covered Code may be distributed only under the terms of this License or a future version of this License released under Section 6.1, and You must include a copy of this License with every copy of the Source Code You distribute. You may not offer or impose any terms on any Source Code version that alters or restricts the applicable version of this License or the recipients' rights hereunder. However, You may include an additional document offering the additional rights described in Section 3.5.  
80 -  
81 -3.2. Availability of Source Code.  
82 -Any Modification which You create or to which You contribute must be made available in Source Code form under the terms of this License either on the same media as an Executable version or via an accepted Electronic Distribution Mechanism to anyone to whom you made an Executable version available; and if made available via Electronic Distribution Mechanism, must remain available for at least twelve (12) months after the date it initially became available, or at least six (6) months after a subsequent version of that particular Modification has been made available to such recipients. You are responsible for ensuring that the Source Code version remains available even if the Electronic Distribution Mechanism is maintained by a third party.  
83 -  
84 -3.3. Description of Modifications.  
85 -You must cause all Covered Code to which You contribute to contain a file documenting the changes You made to create that Covered Code and the date of any change. You must include a prominent statement that the Modification is derived, directly or indirectly, from Original Code provided by the Initial Developer and including the name of the Initial Developer in (a) the Source Code, and (b) in any notice in an Executable version or related documentation in which You describe the origin or ownership of the Covered Code.  
86 -  
87 -3.4. Intellectual Property Matters  
88 -  
89 -(a) Third Party Claims.  
90 -If Contributor has knowledge that a license under a third party's intellectual property rights is required to exercise the rights granted by such Contributor under Sections 2.1 or 2.2, Contributor must include a text file with the Source Code distribution titled "LEGAL'' which describes the claim and the party making the claim in sufficient detail that a recipient will know whom to contact. If Contributor obtains such knowledge after the Modification is made available as described in Section 3.2, Contributor shall promptly modify the LEGAL file in all copies Contributor makes available thereafter and shall take other steps (such as notifying appropriate mailing lists or newsgroups) reasonably calculated to inform those who received the Covered Code that new knowledge has been obtained.  
91 -  
92 -(b) Contributor APIs.  
93 -If Contributor's Modifications include an application programming interface and Contributor has knowledge of patent licenses which are reasonably necessary to implement that API, Contributor must also include this information in the LEGAL file.  
94 -  
95 -(c) Representations.  
96 -  
97 -Contributor represents that, except as disclosed pursuant to Section 3.4(a) above, Contributor believes that Contributor's Modifications are Contributor's original creation(s) and/or Contributor has sufficient rights to grant the rights conveyed by this License.  
98 -  
99 -  
100 -3.5. Required Notices.  
101 -You must duplicate the notice in Exhibit A in each file of the Source Code. If it is not possible to put such notice in a particular Source Code file due to its structure, then You must include such notice in a location (such as a relevant directory) where a user would be likely to look for such a notice. If You created one or more Modification(s) You may add your name as a Contributor to the notice described in Exhibit A. You must also duplicate this License in any documentation for the Source Code where You describe recipients' rights or ownership rights relating to Covered Code. You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Code. However, You may do so only on Your own behalf, and not on behalf of the Initial Developer or any Contributor. You must make it absolutely clear than any such warranty, support, indemnity or liability obligation is offered by You alone, and You hereby agree to indemnify the Initial Developer and every Contributor for any liability incurred by the Initial Developer or such Contributor as a result of warranty, support, indemnity or liability terms You offer.  
102 -  
103 -3.6. Distribution of Executable Versions.  
104 -You may distribute Covered Code in Executable form only if the requirements of Section 3.1-3.5 have been met for that Covered Code, and if You include a notice stating that the Source Code version of the Covered Code is available under the terms of this License, including a description of how and where You have fulfilled the obligations of Section 3.2. The notice must be conspicuously included in any notice in an Executable version, related documentation or collateral in which You describe recipients' rights relating to the Covered Code. You may distribute the Executable version of Covered Code or ownership rights under a license of Your choice, which may contain terms different from this License, provided that You are in compliance with the terms of this License and that the license for the Executable version does not attempt to limit or alter the recipient's rights in the Source Code version from the rights set forth in this License. If You distribute the Executable version under a different license You must make it absolutely clear that any terms which differ from this License are offered by You alone, not by the Initial Developer or any Contributor. You hereby agree to indemnify the Initial Developer and every Contributor for any liability incurred by the Initial Developer or such Contributor as a result of any such terms You offer.  
105 -  
106 -3.7. Larger Works.  
107 -You may create a Larger Work by combining Covered Code with other code not governed by the terms of this License and distribute the Larger Work as a single product. In such a case, You must make sure the requirements of this License are fulfilled for the Covered Code.  
108 -  
109 -4. Inability to Comply Due to Statute or Regulation.  
110 -  
111 -If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Code due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be included in the LEGAL file described in Section 3.4 and must be included with all distributions of the Source Code. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it.  
112 -  
113 -5. Application of this License.  
114 -  
115 -This License applies to code to which the Initial Developer has attached the notice in Exhibit A and to related Covered Code.  
116 -  
117 -6. Versions of the License.  
118 -  
119 -6.1. New Versions.  
120 -The Jam Warehouse Software (Pty) Ltd may publish revised and/or new versions of the License from time to time. Each version will be given a distinguishing version number.  
121 -  
122 -6.2. Effect of New Versions.  
123 -Once Covered Code has been published under a particular version of the License, You may always continue to use it under the terms of that version. You may also choose to use such Covered Code under the terms of any subsequent version of the License published by The Jam Warehouse Software (Pty) Ltd, trading as KnowledgeTree. No one other than The Jam Warehouse Software (Pty) Ltd has the right to modify the terms applicable to Covered Code created under this License.  
124 -  
125 -6.3. Derivative Works.  
126 -If You create or use a modified version of this License (which you may only do in order to apply it to code which is not already Covered Code governed by this License), You must (a) rename Your license so that the phrases ''KnowledgeTree'', ''KPL'' or any confusingly similar phrase do not appear in your license (except to note that your license differs from this License) and (b) otherwise make it clear that Your version of the license contains terms which differ from the KnowledgeTree Public License. (Filling in the name of the Initial Developer, Original Code or Contributor in the notice described in Exhibit A shall not of themselves be deemed to be modifications of this License.)  
127 -  
128 -7. DISCLAIMER OF WARRANTY.  
129 -  
130 -COVERED CODE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS'' BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE COVERED CODE IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE COVERED CODE IS WITH YOU. SHOULD ANY COVERED CODE PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL DEVELOPER OR ANY OTHER CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY COVERED CODE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER.  
131 -  
132 -8. TERMINATION.  
133 -  
134 -8.1. This License and the rights granted hereunder will terminate automatically if You fail to comply with terms herein and fail to cure such breach within 30 days of becoming aware of the breach. All sublicenses to the Covered Code which are properly granted shall survive any termination of this License. Provisions which, by their nature, must remain in effect beyond the termination of this License shall survive.  
135 -  
136 -8.2. If You initiate litigation by asserting a patent infringement claim (excluding declatory judgment actions) against Initial Developer or a Contributor (the Initial Developer or Contributor against whom You file such action is referred to as "Participant") alleging that:  
137 -  
138 -(a) such Participant's Contributor Version directly or indirectly infringes any patent, then any and all rights granted by such Participant to You under Sections 2.1 and/or 2.2 of this License shall, upon 60 days notice from Participant terminate prospectively, unless if within 60 days after receipt of notice You either: (i) agree in writing to pay Participant a mutually agreeable reasonable royalty for Your past and future use of Modifications made by such Participant, or (ii) withdraw Your litigation claim with respect to the Contributor Version against such Participant. If within 60 days of notice, a reasonable royalty and payment arrangement are not mutually agreed upon in writing by the parties or the litigation claim is not withdrawn, the rights granted by Participant to You under Sections 2.1 and/or 2.2 automatically terminate at the expiration of the 60 day notice period specified above.  
139 -  
140 -(b) any software, hardware, or device, other than such Participant's Contributor Version, directly or indirectly infringes any patent, then any rights granted to You by such Participant under Sections 2.1(b) and 2.2(b) are revoked effective as of the date You first made, used, sold, distributed, or had made, Modifications made by that Participant.  
141 -  
142 -8.3. If You assert a patent infringement claim against Participant alleging that such Participant's Contributor Version directly or indirectly infringes any patent where such claim is resolved (such as by license or settlement) prior to the initiation of patent infringement litigation, then the reasonable value of the licenses granted by such Participant under Sections 2.1 or 2.2 shall be taken into account in determining the amount or value of any payment or license.  
143 -  
144 -8.4. In the event of termination under Sections 8.1 or 8.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or any distributor hereunder prior to termination shall survive termination.  
145 -  
146 -9. LIMITATION OF LIABILITY.  
147 -  
148 -UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL YOU, THE INITIAL DEVELOPER, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF COVERED CODE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER COMMERCIAL DAMAGES OR LOSSES, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION OF LIABILITY SHALL NOT APPLY TO LIABILITY FOR DEATH OR PERSONAL INJURY RESULTING FROM SUCH PARTY'S NEGLIGENCE TO THE EXTENT APPLICABLE LAW PROHIBITS SUCH LIMITATION. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS EXCLUSION AND LIMITATION MAY NOT APPLY TO YOU.  
149 -  
150 -10. U.S. GOVERNMENT END USERS.  
151 -  
152 -The Covered Code is a ''commercial item,'' as that term is defined in 48 C.F.R. 2.101 (Oct. 1995), consisting of ''commercial computer software'' and ''commercial computer software documentation,'' as such terms are used in 48 C.F.R. 12.212 (Sept. 1995). Consistent with 48 C.F.R. 12.212 and 48 C.F.R. 227.7202-1 through 227.7202-4 (June 1995), all U.S. Government End Users acquire Covered Code with only those rights set forth herein.  
153 -  
154 -11. MISCELLANEOUS.  
155 -  
156 -This License represents the complete agreement concerning subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. This License shall be governed by California law provisions (except to the extent applicable law, if any, provides otherwise), excluding its conflict-of-law provisions. With respect to disputes in which at least one party is a citizen of, or an entity chartered or registered to do business in the United States of America, any litigation relating to this License shall be subject to the jurisdiction of the Federal Courts of the Northern District of California, with venue lying in Santa Clara County, California, with the losing party responsible for costs, including without limitation, court costs and reasonable attorneys' fees and expenses. The application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not apply to this License.  
157 -  
158 -12. RESPONSIBILITY FOR CLAIMS.  
159 -  
160 -As between Initial Developer and the Contributors, each party is responsible for claims and damages arising, directly or indirectly, out of its utilization of rights under this License and You agree to work with Initial Developer and Contributors to distribute such responsibility on an equitable basis. Nothing herein is intended or shall be deemed to constitute any admission of liability.  
161 -  
162 -13. MULTIPLE-LICENSED CODE.  
163 -  
164 -Initial Developer may designate portions of the Covered Code as "Multiple-Licensed". "Multiple-Licensed" means that the Initial Developer permits you to utilize portions of the Covered Code under Your choice of the SPL or the alternative licenses, if any, specified by the Initial Developer in the file described in Exhibit A.  
165 -KnowledgeTree Public License 1.1 - Exhibit A  
166 -  
167 -The contents of this file are subject to the KnowledgeTree Public License Version 1.1  
168 -("License"); You may not use this file except in compliance with the  
169 -License. You may obtain a copy of the License at http://www.ktdms.com/KPL  
170 -Software distributed under the License is distributed on an "AS IS" basis,  
171 -WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for  
172 -the specific language governing rights and limitations under the License.  
173 -  
174 -The Original Code is: KnowledgeTree Open Source  
175 -  
176 -The Initial Developer of the Original Code is The Jam Warehouse Software (Pty) Ltd, trading as KnowledgeTree.  
177 -Portions created by The Jam Warehouse Software (Pty) Ltd are Copyright (C) 2006 The Jam Warehouse Software (Pty) Ltd;  
178 -All Rights Reserved.  
179 -Contributor(s): ______________________________________.  
180 -  
181 -[NOTE: The text of this Exhibit A may differ slightly from the text of the notices in the Source Code files of the Original Code. You should use the text of this Exhibit A rather than the text found in the Original Code Source Code for Your Modifications.]  
182 -KnowledgeTree Public License 1.1.1 - Exihibit B  
183 -  
184 -Additional Terms applicable to the KnowledgeTree Public License.  
185 -  
186 -I. Effect.  
187 -These additional terms described in this KnowledgeTree Public License - Additional Terms shall apply to the Covered Code under this License.  
188 -  
189 -II. KnowledgeTree and logo.  
190 -This License does not grant any rights to use the trademarks "KnowledgeTree" and the "KnowledgeTree" logos even if such marks are included in the Original Code or Modifications.  
191 -  
192 -However, in addition to the other notice obligations, all copies of the Covered Code in Executable and Source Code form distributed must, as a form of attribution of the original author, include on each user interface screen (i) the "KnowledgeTree Document Management Made Simple" logo and (ii) the copyright notice in the same form as the latest version of the Covered Code distributed by The Jam Warehouse Software (Pty) Ltd. at the time of distribution of such copy. In addition, the "KnowledgeTree Document Management Made Simple" logo must be visible to all users and be located at the top right-hand corner of each user interface screen, other than the user log-in page, on which it must be located at the top-center of the user log-in form. Notwithstanding the above, the dimensions of the "KnowledgeTree Document Management Made Simple" logo must be at least 200 x 40 pixels. When users click on the "KnowledgeTree Document Management Made Simple" logo it must direct them back to http://www.knowledgetree.com. In addition, the copyright notice must remain visible to all users at all times at the bottom of the user interface screen. When users click on the copyright notice, it must direct them back to http://www.knowledgetree.com 1 +KNOWLEDGETREE PUBLIC LICENSE
  2 +Version 1.1.2
  3 +
  4 +1. Definitions.
  5 +
  6 +1.0.1. "Commercial Use" means distribution or otherwise making the Covered Code available to a third party.
  7 +
  8 +1.1. "Contributor" means each entity that creates or contributes to the creation of Modifications.
  9 +
  10 +1.2. "Contributor Version" means the combination of the Original Code, prior Modifications used by a Contributor, and the Modifications made by that particular Contributor.
  11 +
  12 +1.3. "Covered Code" means the Original Code or Modifications or the combination of the Original Code and Modifications, in each case including portions thereof.
  13 +
  14 +1.4. "Electronic Distribution Mechanism" means a mechanism generally accepted in the software development community for the electronic transfer of data.
  15 +
  16 +1.5. "Executable" means Covered Code in any form other than Source Code.
  17 +
  18 +1.6. "Initial Developer" means the individual or entity identified as the Initial Developer in the Source Code notice required by Exhibit A.
  19 +
  20 +1.7. "Larger Work" means a work which combines Covered Code or portions thereof with code not governed by the terms of this License.
  21 +
  22 +1.8. "License" means this document.
  23 +
  24 +1.8.1. "Licensable" means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently acquired, any and all of the rights conveyed herein.
  25 +
  26 +1.9. "Modifications" means any addition to or deletion from the substance or structure of either the Original Code or any previous Modifications. When Covered Code is released as a series of files, a Modification is:
  27 +
  28 +A. Any addition to or deletion from the contents of a file containing Original Code or previous Modifications.
  29 +
  30 +B. Any new file that contains any part of the Original Code or previous Modifications.
  31 +
  32 +1.10. "Original Code" means Source Code of computer software code which is described in the Source Code notice required by Exhibit A as Original Code, and which, at the time of its release under this License is not already Covered Code governed by this License.
  33 +
  34 +1.10.1. "Patent Claims" means any patent claim(s), now owned or hereafter acquired, including without limitation, method, process, and apparatus claims, in any patent Licensable by grantor.
  35 +
  36 +1.11. "Source Code" means the preferred form of the Covered Code for making modifications to it, including all modules it contains, plus any associated interface definition files, scripts used to control compilation and installation of an Executable, or source code differential comparisons against either the Original Code or another well known, available Covered Code of the Contributor's choice. The Source Code can be in a compressed or archival form, provided the appropriate decompression or de-archiving software is widely available for no charge.
  37 +
  38 +1.12. "You" (or "Your") means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License or a future version of this License issued under Section 6.1. For legal entities, "You" includes any entity which controls, is controlled by, or is under common control with You. For purposes of this definition, "control" means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity.
  39 +
  40 +2. Source Code License.
  41 +
  42 +2.1. The Initial Developer Grant.
  43 +The Initial Developer hereby grants You a world-wide, royalty-free, non-exclusive license, subject to third party intellectual property claims:
  44 +
  45 +(a) under intellectual property rights (other than patent or trademark) Licensable by Initial Developer to use, reproduce, modify, display, perform, sublicense and distribute the Original Code (or portions thereof) with or without Modifications, and/or as part of a Larger Work; and
  46 +
  47 +(b) under Patents Claims infringed by the making, using or selling of Original Code, to make, have made, use, practice, sell, and offer for sale, and/or otherwise dispose of the Original Code (or portions thereof).
  48 +
  49 +(c) the licenses granted in this Section 2.1(a) and (b) are effective on the date Initial Developer first distributes Original Code under the terms of this License.
  50 +
  51 +(d) Notwithstanding Section 2.1(b) above, no patent license is granted: 1) for code that You delete from the Original Code; 2) separate from the Original Code; or 3) for infringements caused by: i) the modification of the Original Code or ii) the combination of the Original Code with other software or devices.
  52 +
  53 +2.2. Contributor Grant.
  54 +Subject to third party intellectual property claims, each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license
  55 +
  56 +
  57 +(a) under intellectual property rights (other than patent or trademark) Licensable by Contributor, to use, reproduce, modify, display, perform, sublicense and distribute the Modifications created by such Contributor (or portions thereof) either on an unmodified basis, with other Modifications, as Covered Code and/or as part of a Larger Work; and
  58 +
  59 +(b) under Patent Claims infringed by the making, using, or selling of Modifications made by that Contributor either alone and/or in combination with its Contributor Version (or portions of such combination), to make, use, sell, offer for sale, have made, and/or otherwise dispose of: 1) Modifications made by that Contributor (or portions thereof); and 2) the combination of Modifications made by that Contributor with its Contributor Version (or portions of such combination).
  60 +
  61 +(c) the licenses granted in Sections 2.2(a) and 2.2(b) are effective on the date Contributor first makes Commercial Use of the Covered Code.
  62 +
  63 +(d) Notwithstanding Section 2.2(b) above, no patent license is granted: 1) for any code that Contributor has deleted from the Contributor Version; 2) separate from the Contributor Version; 3) for infringements caused by: i) third party modifications of Contributor Version or ii) the combination of Modifications made by that Contributor with other software (except as part of the Contributor Version) or other devices; or 4) under Patent Claims infringed by Covered Code in the absence of Modifications made by that Contributor.
  64 +
  65 +
  66 +3. Distribution Obligations.
  67 +
  68 +3.1. Application of License.
  69 +The Modifications which You create or to which You contribute are governed by the terms of this License, including without limitation Section 2.2. The Source Code version of Covered Code may be distributed only under the terms of this License or a future version of this License released under Section 6.1, and You must include a copy of this License with every copy of the Source Code You distribute. You may not offer or impose any terms on any Source Code version that alters or restricts the applicable version of this License or the recipients' rights hereunder. However, You may include an additional document offering the additional rights described in Section 3.5.
  70 +
  71 +3.2. Availability of Source Code.
  72 +Any Modification which You create or to which You contribute must be made available in Source Code form under the terms of this License either on the same media as an Executable version or via an accepted Electronic Distribution Mechanism to anyone to whom you made an Executable version available; and if made available via Electronic Distribution Mechanism, must remain available for at least twelve (12) months after the date it initially became available, or at least six (6) months after a subsequent version of that particular Modification has been made available to such recipients. You are responsible for ensuring that the Source Code version remains available even if the Electronic Distribution Mechanism is maintained by a third party.
  73 +
  74 +3.3. Description of Modifications.
  75 +You must cause all Covered Code to which You contribute to contain a file documenting the changes You made to create that Covered Code and the date of any change. You must include a prominent statement that the Modification is derived, directly or indirectly, from Original Code provided by the Initial Developer and including the name of the Initial Developer in (a) the Source Code, and (b) in any notice in an Executable version or related documentation in which You describe the origin or ownership of the Covered Code.
  76 +
  77 +3.4. Intellectual Property Matters
  78 +
  79 +(a) Third Party Claims.
  80 +If Contributor has knowledge that a license under a third party's intellectual property rights is required to exercise the rights granted by such Contributor under Sections 2.1 or 2.2, Contributor must include a text file with the Source Code distribution titled "LEGAL" which describes the claim and the party making the claim in sufficient detail that a recipient will know whom to contact. If Contributor obtains such knowledge after the Modification is made available as described in Section 3.2, Contributor shall promptly modify the LEGAL file in all copies Contributor makes available thereafter and shall take other steps (such as notifying appropriate mailing lists or newsgroups) reasonably calculated to inform those who received the Covered Code that new knowledge has been obtained.
  81 +
  82 +(b) Contributor APIs.
  83 +If Contributor's Modifications include an application programming interface and Contributor has knowledge of patent licenses which are reasonably necessary to implement that API, Contributor must also include this information in the LEGAL file.
  84 +
  85 +(c) Representations.
  86 +
  87 +Contributor represents that, except as disclosed pursuant to Section 3.4(a) above, Contributor believes that Contributor's Modifications are Contributor's original creation(s) and/or Contributor has sufficient rights to grant the rights conveyed by this License.
  88 +
  89 +
  90 +3.5. Required Notices.
  91 +You must duplicate the notice in Exhibit A in each file of the Source Code. If it is not possible to put such notice in a particular Source Code file due to its structure, then You must include such notice in a location (such as a relevant directory) where a user would be likely to look for such a notice. If You created one or more Modification(s) You may add your name as a Contributor to the notice described in Exhibit A. You must also duplicate this License in any documentation for the Source Code where You describe recipients' rights or ownership rights relating to Covered Code. You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Code. However, You may do so only on Your own behalf, and not on behalf of the Initial Developer or any Contributor. You must make it absolutely clear than any such warranty, support, indemnity or liability obligation is offered by You alone, and You hereby agree to indemnify the Initial Developer and every Contributor for any liability incurred by the Initial Developer or such Contributor as a result of warranty, support, indemnity or liability terms You offer.
  92 +
  93 +3.6. Distribution of Executable Versions.
  94 +You may distribute Covered Code in Executable form only if the requirements of Section 3.1-3.5 have been met for that Covered Code, and if You include a notice stating that the Source Code version of the Covered Code is available under the terms of this License, including a description of how and where You have fulfilled the obligations of Section 3.2. The notice must be conspicuously included in any notice in an Executable version, related documentation or collateral in which You describe recipients' rights relating to the Covered Code. You may distribute the Executable version of Covered Code or ownership rights under a license of Your choice, which may contain terms different from this License, provided that You are in compliance with the terms of this License and that the license for the Executable version does not attempt to limit or alter the recipient's rights in the Source Code version from the rights set forth in this License. If You distribute the Executable version under a different license You must make it absolutely clear that any terms which differ from this License are offered by You alone, not by the Initial Developer or any Contributor. You hereby agree to indemnify the Initial Developer and every Contributor for any liability incurred by the Initial Developer or such Contributor as a result of any such terms You offer.
  95 +
  96 +3.7. Larger Works.
  97 +You may create a Larger Work by combining Covered Code with other code not governed by the terms of this License and distribute the Larger Work as a single product. In such a case, You must make sure the requirements of this License are fulfilled for the Covered Code.
  98 +
  99 +4. Inability to Comply Due to Statute or Regulation.
  100 +
  101 +If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Code due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be included in the LEGAL file described in Section 3.4 and must be included with all distributions of the Source Code. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it.
  102 +
  103 +5. Application of this License.
  104 +
  105 +This License applies to code to which the Initial Developer has attached the notice in Exhibit A and to related Covered Code.
  106 +
  107 +6. Versions of the License.
  108 +
  109 +6.1. New Versions.
  110 +The Jam Warehouse Software (Pty) Ltd may publish revised and/or new versions of the License from time to time. Each version will be given a distinguishing version number.
  111 +
  112 +6.2. Effect of New Versions.
  113 +Once Covered Code has been published under a particular version of the License, You may always continue to use it under the terms of that version. You may also choose to use such Covered Code under the terms of any subsequent version of the License published by The Jam Warehouse Software (Pty) Ltd, trading as KnowledgeTree. No one other than The Jam Warehouse Software (Pty) Ltd has the right to modify the terms applicable to Covered Code created under this License.
  114 +
  115 +6.3. Derivative Works.
  116 +If You create or use a modified version of this License (which you may only do in order to apply it to code which is not already Covered Code governed by this License), You must (a) rename Your license so that the phrases "KnowledgeTree", "KPL" or any confusingly similar phrase do not appear in your license (except to note that your license differs from this License) and (b) otherwise make it clear that Your version of the license contains terms which differ from the KnowledgeTree Public License. (Filling in the name of the Initial Developer, Original Code or Contributor in the notice described in Exhibit A shall not of themselves be deemed to be modifications of this License.)
  117 +
  118 +7. DISCLAIMER OF WARRANTY.
  119 +
  120 +COVERED CODE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE COVERED CODE IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE COVERED CODE IS WITH YOU. SHOULD ANY COVERED CODE PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL DEVELOPER OR ANY OTHER CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY COVERED CODE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER.
  121 +
  122 +8. TERMINATION.
  123 +
  124 +8.1. This License and the rights granted hereunder will terminate automatically if You fail to comply with terms herein and fail to cure such breach within 30 days of becoming aware of the breach. All sublicenses to the Covered Code which are properly granted shall survive any termination of this License. Provisions which, by their nature, must remain in effect beyond the termination of this License shall survive.
  125 +
  126 +8.2. If You initiate litigation by asserting a patent infringement claim (excluding declatory judgment actions) against Initial Developer or a Contributor (the Initial Developer or Contributor against whom You file such action is referred to as "Participant") alleging that:
  127 +
  128 +(a) such Participant's Contributor Version directly or indirectly infringes any patent, then any and all rights granted by such Participant to You under Sections 2.1 and/or 2.2 of this License shall, upon 60 days notice from Participant terminate prospectively, unless if within 60 days after receipt of notice You either: (i) agree in writing to pay Participant a mutually agreeable reasonable royalty for Your past and future use of Modifications made by such Participant, or (ii) withdraw Your litigation claim with respect to the Contributor Version against such Participant. If within 60 days of notice, a reasonable royalty and payment arrangement are not mutually agreed upon in writing by the parties or the litigation claim is not withdrawn, the rights granted by Participant to You under Sections 2.1 and/or 2.2 automatically terminate at the expiration of the 60 day notice period specified above.
  129 +
  130 +(b) any software, hardware, or device, other than such Participant's Contributor Version, directly or indirectly infringes any patent, then any rights granted to You by such Participant under Sections 2.1(b) and 2.2(b) are revoked effective as of the date You first made, used, sold, distributed, or had made, Modifications made by that Participant.
  131 +
  132 +8.3. If You assert a patent infringement claim against Participant alleging that such Participant's Contributor Version directly or indirectly infringes any patent where such claim is resolved (such as by license or settlement) prior to the initiation of patent infringement litigation, then the reasonable value of the licenses granted by such Participant under Sections 2.1 or 2.2 shall be taken into account in determining the amount or value of any payment or license.
  133 +
  134 +8.4. In the event of termination under Sections 8.1 or 8.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or any distributor hereunder prior to termination shall survive termination.
  135 +
  136 +9. LIMITATION OF LIABILITY.
  137 +
  138 +UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL YOU, THE INITIAL DEVELOPER, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF COVERED CODE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER COMMERCIAL DAMAGES OR LOSSES, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION OF LIABILITY SHALL NOT APPLY TO LIABILITY FOR DEATH OR PERSONAL INJURY RESULTING FROM SUCH PARTY'S NEGLIGENCE TO THE EXTENT APPLICABLE LAW PROHIBITS SUCH LIMITATION. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS EXCLUSION AND LIMITATION MAY NOT APPLY TO YOU.
  139 +
  140 +10. U.S. GOVERNMENT END USERS.
  141 +
  142 +The Covered Code is a "commercial item," as that term is defined in 48 C.F.R. 2.101 (Oct. 1995), consisting of "commercial computer software" and "commercial computer software documentation," as such terms are used in 48 C.F.R. 12.212 (Sept. 1995). Consistent with 48 C.F.R. 12.212 and 48 C.F.R. 227.7202-1 through 227.7202-4 (June 1995), all U.S. Government End Users acquire Covered Code with only those rights set forth herein.
  143 +
  144 +11. MISCELLANEOUS.
  145 +
  146 +This License represents the complete agreement concerning subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. This License shall be governed by California law provisions (except to the extent applicable law, if any, provides otherwise), excluding its conflict-of-law provisions. With respect to disputes in which at least one party is a citizen of, or an entity chartered or registered to do business in the United States of America, any litigation relating to this License shall be subject to the jurisdiction of the Federal Courts of the Northern District of California, with venue lying in Santa Clara County, California, with the losing party responsible for costs, including without limitation, court costs and reasonable attorneys' fees and expenses. The application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not apply to this License.
  147 +
  148 +12. RESPONSIBILITY FOR CLAIMS.
  149 +
  150 +As between Initial Developer and the Contributors, each party is responsible for claims and damages arising, directly or indirectly, out of its utilization of rights under this License and You agree to work with Initial Developer and Contributors to distribute such responsibility on an equitable basis. Nothing herein is intended or shall be deemed to constitute any admission of liability.
  151 +
  152 +13. MULTIPLE-LICENSED CODE.
  153 +
  154 +Initial Developer may designate portions of the Covered Code as "Multiple-Licensed". "Multiple-Licensed" means that the Initial Developer permits you to utilize portions of the Covered Code under Your choice of the SPL or the alternative licenses, if any, specified by the Initial Developer in the file described in Exhibit A.
  155 +KnowledgeTree Public License 1.1.2 - Exhibit A
  156 +
  157 +The contents of this file are subject to the KnowledgeTree Public
  158 +License Version 1.1.2 ("License"); You may not use this file except in
  159 +compliance with the License. You may obtain a copy of the License at
  160 +http://www.knowledgetree.com/KPL
  161 +
  162 +Software distributed under the License is distributed on an "AS IS"
  163 +basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
  164 +See the License for the specific language governing rights and
  165 +limitations under the License.
  166 +
  167 +All copies of the Covered Code must include on each user interface screen:
  168 + (i) the "Powered by KnowledgeTree" logo and
  169 + (ii) the KnowledgeTree copyright notice
  170 +in the same form as they appear in the distribution. See the License for
  171 +requirements.
  172 +
  173 +The Original Code is: KnowledgeTree Open Source
  174 +
  175 +The Initial Developer of the Original Code is The Jam Warehouse Software
  176 +(Pty) Ltd, trading as KnowledgeTree.
  177 +Portions created by The Jam Warehouse Software (Pty) Ltd are Copyright
  178 +(C) 2007 The Jam Warehouse Software (Pty) Ltd;
  179 +All Rights Reserved.
  180 +Contributor( s): ______________________________________
  181 +
  182 +[NOTE: The text of this Exhibit A may differ slightly from the text of the notices in the Source Code files of the Original Code. You should use the text of this Exhibit A rather than the text found in the Original Code Source Code for Your Modifications.]
  183 +KnowledgeTree Public License 1.1.2 - Exihibit B
  184 +
  185 +Additional Terms applicable to the KnowledgeTree Public License.
  186 +
  187 +I. Effect.
  188 +These additional terms described in this KnowledgeTree Public License - Additional Terms shall apply to the Covered Code under this License.
  189 +
  190 +II. KnowledgeTree and logo.
  191 +This License does not grant any rights to use the trademarks "KnowledgeTree" and the "KnowledgeTree" logos even if such marks are included in the Original Code or Modifications.
  192 +
  193 +However, in addition to the other notice obligations, all copies of the Covered Code in Executable and Source Code form distributed must, as a form of attribution of the original author, include on each user interface screen (i) the "KnowledgeTree Document Management Made Simple" logo and (ii) the copyright notice in the same form as the latest version of the Covered Code distributed by The Jam Warehouse Software (Pty) Ltd. at the time of distribution of such copy. In addition, the "KnowledgeTree Document Management Made Simple" logo must be visible to all users and be located at the top right-hand corner of each user interface screen, other than the user log-in page, on which it must be located at the top-center of the user log-in form. Notwithstanding the above, the dimensions of the "KnowledgeTree Document Management Made Simple" logo must be at least 200 x 40 pixels. When users click on the "KnowledgeTree Document Management Made Simple" logo it must direct them back to http://www.knowledgetree.com. In addition, the copyright notice must remain visible to all users at all times at the bottom of the user interface screen. When users click on the copyright notice, it must direct them back to http://www.knowledgetree.com
docs/CREDITS.txt deleted
1 -KnowledgeTree(tm) makes use of the following components:  
2 ---------------------------------------------------------  
3 -  
4 -Email:  
5 -phpmailer - http://phpmailer.sourceforge.net (LGPL)  
6 -  
7 -Javascript:  
8 -MochiKit - http://www.mochikit.com/ (MIT License)  
9 -JS Calendar - http://dynarch.com/mishoo/calendar.epl (LGPL)  
10 -TinyMCE - http://sourceforge.net/projects/tinymce/ (LGPL)  
11 -Option Transfer Widget - http://www.mattkruse.com/ (Custom License)  
12 -  
13 -Tests:  
14 -simpletest - http://www.lastcraft.com/simple_test.php (LGPL)  
15 -  
16 -Icons:  
17 -"Silk" - http://www.famfamfam.com/lab/icons/silk/ (CC Attribution License)  
18 -  
19 -Alumni:  
20 --------  
21 -  
22 -KnowlegeTree has previously utilised code from the following sources:  
23 -  
24 -Mark Round's AuthLDAP class (class.AuthLDAP.php):  
25 -http://phpclasses.dknss.com/browse/package/893.html (GPL)  
26 -  
docs/FAQ.txt deleted
1 -KnowledgeTree(tm) DMS - Frequently Asked Questions  
2 -  
3 -Q: I can't seem to search inside my files?  
4 -  
5 -A: There are two things which may cause full-text search not to work:  
6 -  
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.  
12 -  
13 -Q: Where do I post questions about installing, configuring or using KnowledgeTree?  
14 -  
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.  
19 -  
20 - Click on the link below to access the forums:  
21 - http://forums.knowledgetree.com/  
22 -  
23 -Q: Where can I discuss document management best practices, change  
24 - management and training issues?  
25 -  
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.  
30 -  
31 - Click on the link below to access the forums:  
32 -  
33 - http://forums.knowledgetree.com/  
34 -  
35 -Q: Where can I report bugs in KnowledgeTree?  
36 -  
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  
41 - reported.  
42 -  
43 - Click on the link below to access the ticketing system:  
44 -  
45 - http://issues.knowledgetree.com/  
46 -  
47 -Q: I want to modify KnowledgeTree or develop new functionality for it.  
48 - Where do I find more information on how to go about doing this?  
49 -  
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!  
54 -  
55 - Click on the link below to access the Wiki:  
56 -  
57 - http://wiki.knowledgetree.com/  
58 -  
59 -  
60 -KnowledgeTree Document Management System  
61 -Web page: http://www.knowledgetree.com/  
62 -Wiki: http://wiki.knowledgetree.com/  
63 -Forums: http://forums.knowledgetree.com/  
64 -Bug reporting: http://issues.knowledgetree.com/  
65 -  
66 -$Id$  
docs/INSTALL.WIN32.txt deleted
1 -Windows Specific Installation Instructions  
2 -==========================================  
3 -  
4 -Installation on Windows XP and 2003 requires a slightly different approach to  
5 -the generic instructions.  
6 -  
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:  
10 -  
11 - http://sourceforge.net/projects/kt-dms  
12 -  
13 -Manual Install (XAMPP)  
14 -----------------------  
15 -  
16 -If you need to do a manual installation of KnowledgeTree for some reason,  
17 -we recommend using a bundled version of Apache, MySQL and PHP. For testing  
18 -purposes, we use XAMPP (version 1.5.1):  
19 -  
20 - http://www.apachefriends.org/en/xampp.html  
21 -  
22 -NOTE  
23 -  
24 - At this time, KnowledgeTree 3 supports only PHP 4.x, so please ensure that  
25 - your XAMPP install is using PHP 4.  
26 -  
27 - Details can be found inside the XAMPP control panel, under the menu item  
28 - PHP Switch.  
29 -  
30 -General procedure:  
31 -  
32 - * Install XAMPP  
33 -  
34 - * Extract the KnowledgeTree zipfile inside the XAMPP htdocs directory. If  
35 - you installed XAMPP in  
36 -  
37 - c:\Program Files\xampp  
38 -  
39 - then you need to extract KnowledgeTree so that its files are in  
40 -  
41 - c:\Program Files\xampp\htdocs\knowledgeTree  
42 -  
43 - This will be referred to as "<knowledgeTree>" in paths from here on.  
44 -  
45 - * Conduct the Pre-installation checkup. Assuming you are running XAMPP on  
46 - "localhost", visit  
47 -  
48 - http://localhost/knowledgeTree/setup/  
49 -  
50 - * Configure the Database. The most effective way to do this with XAMPP is  
51 - to use phpmyadmin:  
52 -  
53 - http://localhost/phpmyadmin/  
54 -  
55 - 1. Create a new database (call it "dms")  
56 - 2. Create the tables:  
57 -  
58 - - open the "dms" database from the left-menu/.  
59 - - go to "SQL" at the top of the screen.  
60 - - Where it says "Location of the text file" click browse and then run:  
61 -  
62 - * <knowledgeTree>\sql\mysql\install\structure.sql  
63 - * <knowledgeTree>\sql\mysql\install\data.sql  
64 - * <knowledgeTree>\sql\mysql\install\user.sql  
65 -  
66 - * Configure your installation in <knowledgeTree>config\config.ini:  
67 -  
68 - - The default configuration will determine many settings on your  
69 - installation automatically, and this is the preferred method of  
70 - running KnowledgeTree. Please do not manually set these settings  
71 - unless you know what you are doing.  
72 -  
73 - - The default configuration uses the database username and password  
74 - in the user.sql file mentioned above, use the local host for the  
75 - database, and use the database named 'dms'. If you follow the  
76 - examples above in setting up the database, this means KnowledgeTree  
77 - should be fully configured to start working.  
78 -  
79 - - However, you should change this once you've performed your initial  
80 - evalution of KnowledgeTree for the security of your documents.  
81 -  
82 - - The following settings in config/config.ini control the  
83 - database connectivity, and can be set as shown:  
84 -  
85 - [db]  
86 - dbHost = localhost  
87 - dbName = dms  
88 - dbUser = myuser  
89 - dbPass = mypassword  
90 -  
91 - * Check the post-installation checklist:  
92 -  
93 - If your knowledgeTree installation is at http://localhost/, go to:  
94 -  
95 - http://localhost/setup/  
96 -  
97 - And click on "Post-installation checkup".  
98 -  
99 - * Login:  
100 - - in a web browser go to your KnowledgeTree installation via the web  
101 - - default user is "admin" with password "admin"  
102 -  
103 - * Register the standard plugins.  
104 -  
105 - - in a web browser go to "DMS Administration" , then "Miscellaneous",  
106 - then "Manage Plugins"  
107 - - click "Reread plugins" to load the list of available plugins.  
108 - - enable the plugins as required.  
109 -  
110 - * Please note: *  
111 - Fulltext indexing of files (e.g. checking their contents) needs to be  
112 - activated from this menu or the full-text search WILL NOT work.  
113 -  
114 -  
115 -External applications  
116 ----------------------  
117 -  
118 -The file indexing and other facilities of KnowledgeTree make use of  
119 -external applications to perform their jobs.  
120 -  
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  
128 -consult the KnowledgeTree Wiki at http://wiki.knowledgetree.com/  
129 -to see how others have approached this on your platform.  
130 -  
131 -You can find Windows specific installation instructions here:  
132 -  
133 - http://wiki.knowledgetree.com/Windows_XP_installation_instructions  
134 -  
135 -  
136 -Troubleshooting  
137 ----------------  
138 -  
139 -Please make sure that your KnowledgeTree installation passes all the  
140 -pre- and post-installation checkups first.  
141 -  
142 -Refer to the Frequently Asked Questions list on the KnowledgeTree Wiki  
143 -at http://wiki.knowledgetree.com/  
144 -  
145 -Ask on the KnowledgeTree forums on http://forums.knowledgetree.com/.  
146 -  
147 -If you have found a bug, please report it to the KnowledgeTree bug  
148 -reporting system at http://issues.knowledgetree.com/.  
149 -  
150 -Upgrading  
151 ----------  
152 -  
153 -Refer to docs/UPGRADE.txt  
docs/INSTALL.txt deleted
1 -KnowledgeTree Installation Notes  
2 ---------------------------------  
3 -  
4 -* KnowledgeTree requires the following software to run:  
5 - - Apache 1.3 or above  
6 - - MySQL 4.1.6 or above, with InnoDB support  
7 - - PHP 4.3.0 or above, but not yet PHP 5.0  
8 -  
9 -* Move the knowledgeTree folder to the directory it is going to be served from:  
10 - $ mv knowledgeTree /path/to/your/html/directory/  
11 -  
12 -* Configure your web server to access the KnowledgeTree system.  
13 -  
14 - Due to the many different configuration possibilities, these can not  
15 - all be discussed here. Please consult the KnowledgeTree Wiki system  
16 - at http://wiki.knowledgetree.com/ to see what others have done  
17 - on your platform, and discuss the pros and cons of various options on  
18 - the KnowledgeTree Forums at http://forums.knowledgetree.com/  
19 -  
20 -* Check the pre-installation checkup:  
21 -  
22 - If your knowledgeTree installation is at http://localhost/, go to:  
23 -  
24 - http://localhost/setup/  
25 -  
26 -* Set up the database  
27 -  
28 - On a Unix-like system, the command line tools can generally be used:  
29 -  
30 - - Create a database:  
31 - $ mysqladmin -p create dms  
32 -  
33 - - Create and populate the tables:  
34 - $ mysql -p dms < sql/mysql/install/structure.sql  
35 - $ mysql -p dms < sql/mysql/install/data.sql  
36 -  
37 - - Create the database users  
38 - $ mysql -p dms < sql/mysql/install/user.sql  
39 -  
40 - These tools may requite the setting of the user (-u username) and of  
41 - a password (-p, and you will be asked for the password).  
42 -  
43 - Using other tools is beyond the scope of this document. Consult the  
44 - KnowledgeTree Wiki at http://wiki.knowledgetree.com/ to see how  
45 - others have approached this on your platform.  
46 -  
47 -* Configure your installation in config/config.ini:  
48 - - The default configuration will determine many settings on your  
49 - installation automatically, and this is the preferred method of  
50 - running KnowledgeTree. Please do not manually set these settings  
51 - unless you know what you are doing.  
52 -  
53 - - The default configuration uses the database username and password  
54 - in the user.sql file mentioned above, use the local host for the  
55 - database, and use the database named 'dms'. If you follow the  
56 - examples above in setting up the database, this means KnowledgeTree  
57 - should be fully configured to start working.  
58 -  
59 - - However, you should change this once you've performed your initial  
60 - evalution of KnowledgeTree for the security of your documents.  
61 -  
62 - - The following settings in config/config.ini control the  
63 - database connectivity, and can be set as shown:  
64 - [db]  
65 - dbHost = localhost  
66 - dbName = dms  
67 - dbUser = myuser  
68 - dbPass = mypassword  
69 -  
70 -* Check permissions on the folders  
71 - - The "var" folder in the root of the KnowledgeTree  
72 - installation MUST be able to be written to by your web server.  
73 -  
74 - - The pre-configuration checkup will display the user which must be  
75 - able to write to these folders.  
76 -  
77 - - The remaining folders should preferably not be able to be written  
78 - to by your web server.  
79 -  
80 - - eg.  
81 - If your web server is running as user "nobody" and group "nogroup"  
82 - then cd to the files directory and type:  
83 -  
84 - *nix: 'chown -R nobody.nogroup var'  
85 - Windows: Check the permissions and security tabs  
86 -  
87 -  
88 -* Check the post-installation checklist:  
89 -  
90 - If your knowledgeTree installation is at http://localhost/, go to:  
91 -  
92 - http://localhost/setup/  
93 -  
94 - And click on "Post-installation checkup".  
95 -  
96 -  
97 -* Login:  
98 - - in a web browser go to your KnowledgeTree installation via the web  
99 - - default user is "admin" with password "admin"  
100 -  
101 -* Register the standard plugins.  
102 - - in a web browser go to "DMS Administration" , then "Miscellaneous",  
103 - then "Manage Plugins"  
104 - - click "Reread plugins" to load the list of available plugins.  
105 - - enable the plugins as required.  
106 -  
107 - * Please note: *  
108 - Fulltext indexing of files (e.g. checking their contents) needs to be  
109 - activated from this menu or the full-text search WILL NOT work.  
110 -  
111 -External applications  
112 ----------------------  
113 -  
114 -The file indexing and other facilities of KnowledgeTree make use of  
115 -external applications to perform their jobs.  
116 -  
117 -For the Windows platform, these are:  
118 -  
119 -. catdoc - http://www.45.free.net/~vitus/ice/catdoc/  
120 -. xpdf - http://www.foolabs.com/xpdf/  
121 -. InfoZip unzip and zip - http://www.info-zip.org/  
122 -  
123 -Installing these packages is beyond the scope of this document - please  
124 -consult the KnowledgeTree Wiki at http://wiki.knowledgetree.com/  
125 -to see how others have approached this on your platform. We recommend  
126 -that you use the appropriate package management procedures for  
127 -installing these packages on your system to ensure ease of maintenance  
128 -and upgrade.  
129 -  
130 -NOTE: if you install the packages outside of the path normally searched  
131 -by your operating system (e.g. in c:\antiword or /usr/local/bin) you will  
132 -need to specify the _full_ path to the actual applications (e.g.  
133 -/usr/local/bin/pdftotext).  
134 -  
135 -Troubleshooting  
136 ----------------  
137 -  
138 -Please make sure that your KnowledgeTree installation passes all the  
139 -pre- and post-installation checkups first.  
140 -  
141 -Refer to the Frequently Asked Questions list on the KnowledgeTree Wiki  
142 -at http://wiki.knowledgetree.com/  
143 -  
144 -Ask on the KnowledgeTree forums on http://forums.knowledgetree.com/.  
145 -  
146 -If you have found a bug, please report it to the KnowledgeTree bug  
147 -reporting system at http://issues.knowledgetree.com/.  
148 -  
149 -Upgrading  
150 ----------  
151 -  
152 -Refer to docs/UPGRADE.txt  
153 -  
154 -  
155 -  
156 -KnowledgeTree Document Management System  
157 -Web page: http://www.knowledgetree.com/  
158 -Wiki: http://wiki.knowledgetree.com/  
159 -Forums: http://forums.knowledgetree.com/  
160 -Bug reporting: http://issues.knowledgetree.com/  
161 -  
162 -$Id$  
docs/README.txt
1 -KnowledgeTree Document Management System  
2 ----------------------------------------- 1 +=====================================================
  2 + Knowledgetree Documentation, Support and Community
  3 +=====================================================
3 4
4 -KnowledgeTree 3 is intended to be easier to use for users and  
5 -administrators (including a new user interface) and also easy for  
6 -developers to customise it and make plugins for it. 5 +* You can access all the KnowledgeTree documentation online at:
7 6
8 -KnowledgeTree 3 includes a set of core and standard plugins that broadly  
9 -cover the functionality offered by KnowledgeTree 2, although almost all  
10 -code has been rewritten or analysed before reuse. 7 +- http://docs.knowledgetree.com
11 8
12 -New and extended functionality includes:  
13 - * Entirely new template-based user interface, allowing for easy changes to  
14 - the application's look and feel and easy to implement co-branding  
15 - opportunities.  
16 - * On-demand indexing of files as opposed to scheduled indexing, ensuring  
17 - files are searchable immediately after uploading and simplifying the  
18 - installation of the server.  
19 - * Secure versioning of document metadata, not just the document itself.  
20 - This vastly increases the application's applicability in regulatory  
21 - compliance scenarios.  
22 - * A new tree document metadata type has been added with the tree being  
23 - represented graphically on the user interface.  
24 - * The User/Group schema has been extended to allow groups to be nested,  
25 - thus providing for the mapping of users in more complex organisations.  
26 - * The move folder and move file functionality is now transactional and  
27 - records a history of changes to the folder structure.  
28 - * Bulk import functionality allows administrators to import large numbers  
29 - of files from external data sources quickly and easily.  
30 - * KnowledgeTree administrators may customise and extend the KnowledgeTree  
31 - online help facilities using a web-based editor.  
32 - * A powerful plug-in architecture, providing KnowledgeTree developers with  
33 - the ability to easily create new application functionality, hook into  
34 - system events and expose the functionality on the user interface.  
35 - * A revamped permissions system which is easier to use and provides finer  
36 - grained control over a user's actions than in KnowledgeTree 2.x. The  
37 - extended functionality also lets KnowledgeTree community developers  
38 - create their own permissions on the system, allowing their plug-ins to  
39 - easily check permissions that they require to function.  
40 9
41 -For installation instructions please refer to docs/INSTALL.txt 10 +* To learn more about KnowledgeTree and the KnowledgeTree community you can start at:
42 11
43 -KnowledgeTree Document Management System  
44 -Web page: http://www.knowledgetree.com/  
45 -Wiki: http://wiki.knowledgetree.com/  
46 -Forums: http://forums.knowledgetree.com/  
47 -Bug reporting: http://issues.knowledgetree.com/ 12 +- http://www.knowledgetree.com/products/opensource/welcome/
48 13
49 -$Id$ 14 +where you will find many community resources including forums, wikis, irq, etc.
50 \ No newline at end of file 15 \ No newline at end of file
docs/TODO.txt deleted
1 -KnowledgeTree DMS Development TODO List  
2 ----------------------------------------  
3 -  
4 -- Reporting- Simple usage and statistics report generator  
5 -- Zip functions  
6 - - Mass download  
7 - - download- zip up and download file lists (folders, categories, document types, search list)  
8 -- Automated Test Suite  
9 - - For Coverage and performance tests  
10 -- Write custom error handler  
11 -- Security audit  
12 -- Logging  
13 - - Make logging robust  
14 - - Revisit application logging and tidy up logging levels.  
15 -- Allow thumbnails for image types (API for any other filetype)  
16 -  
17 -$Id$  
docs/UPGRADE.txt deleted
1 -KnowledgeTree Upgrade instructions  
2 -==================================  
3 -  
4 -Before you upgrade  
5 -------------------  
6 -  
7 -Before you upgrade, ensure that your data (KnowledgeTree, Documents, and  
8 -database) is backed up safely. An upgrade may fail to accurately change  
9 -the data to the format required by the next version of KnowledgeTree,  
10 -and a backup will allow you to return to the original version of  
11 -KnowledgeTree. Please report failed upgrades to the KnowledgeTree  
12 -developers.  
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 -  
21 -Automated upgrade  
22 ------------------  
23 -  
24 -The automated upgrade may be used from the command line or through a web  
25 -page. The web page is preferable, as it provides better error  
26 -reporting. The automated upgrade works between any version of  
27 -KnowledgeTree to the current version. The automated upgrade remembers  
28 -which upgrades it has performed, and will not perform them again, unless  
29 -forced to do so. Using the automated upgrade will create an upgrade  
30 -history that can be reviewed via the KnowledgeTree administrators  
31 -interface.  
32 -  
33 -If you are upgrading KnowledgeTree from versions prior to 3.0.0, see the  
34 -section at the bottom of this document to set up automated upgrades.  
35 -  
36 -Web page:  
37 -  
38 -- If your KnowledgeTree installation is at http://example.org/kt/,  
39 - visit:  
40 -  
41 - http://example.org/kt/setup/upgrade.php  
42 -  
43 -- Review the upgrades available to you, and select the button to perform  
44 - the upgrade.  
45 -  
46 -- Review the results of the upgrade.  
47 -  
48 -Command line:  
49 -  
50 -- Run bin/automated-upgrade.php  
51 -- Any errors will be reported.  
52 -  
53 -==========================================================================  
54 -  
55 -  
56 -Additional steps  
57 -----------------  
58 -  
59 -KnowledgeTree 2.0.6  
60 --------------------  
61 -  
62 -The automated upgrade requires that you set up a database administrator  
63 -user (name configurable in config/environment.php, defaults to  
64 -'dmsadmin') for the upgrade process to function. You need to run this  
65 -command on your database (say, 'dms') from the MySQL command prompt:  
66 -  
67 -mysql> use dms;  
68 -mysql> GRANT ALL PRIVILEGES ON * TO dmsadmin@localhost IDENTIFIED BY 'js9281djw';  
69 -  
70 -In config/environment.php, you should add:  
71 -  
72 -$default->dbAdminUser = "dmsadmin";  
73 -$default->dbAdminPass = "js9281djw";  
74 -  
75 -You should now be able to use the automated upgrade.  
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 -  
88 -  
89 ----------------------------------------------------------------------------  
90 -  
91 -KnowledgeTree Document Management System  
92 -Web page: http://www.knowledgetree.com/  
93 -Wiki: http://wiki.knowledgetree.com/  
94 -Forums: http://forums.knowledgetree.com/  
95 -Bug reporting: http://issues.knowledgetree.com/  
96 -  
97 -$Id$  
docs/developer/Browse.txt deleted
1 -KT3 Browse System  
2 -=================  
3 -  
4 -KnowledgeTree's browse view has been a serious bottleneck in terms of  
5 -performance, and makes extending the system in useful ways (and re-using items)  
6 -unnecessarily hard.  
7 -  
8 -To understand this code, you'll need to look at:  
9 -  
10 - - lib/browse/DocumentCollection.inc.php  
11 - - lib/browse/BrowseColumns.inc.php  
12 - - presentation/.../browse.php  
13 -  
14 -Objectives of the refactor:  
15 -  
16 - - improve code-reuse  
17 - - make more advanced document-sets possible  
18 - - unify all document-collection logic (where possible).  
19 -  
20 -BROWSE VIEW GENERATION  
21 -----------------------  
22 -  
23 -Generating a browse view is now done as follows:  
24 -  
25 - - create a DocumentCollection object  
26 - - add "BrowseColumns" to it.  
27 - - specify (on the collection) which column to sort on.  
28 - - specify any batching that may be required (count, start).  
29 - - execute the query (using generateCollection).  
30 - returns a set of document ids, in order (more info cached internally).  
31 - - for each row, use "getInfo(docid)" to extract the information from the database.  
32 - returns an array with info (more later), and caches this internally.  
33 - - at render-time, call "renderRow(docid)".  
34 -  
35 -Internally this does a fair bit more work. Particularly:  
36 -  
37 - - each Column can contribute JOINs, WHERE clauses. _if_ its the sort column,  
38 - it gets asked for an ORDER clause.  
39 - - the system fetches a LOT of information about each batched item - don't do too much.  
40 -  
docs/developer/Permissions.txt deleted
1 -KnowledgeTree Permission System  
2 -===============================  
3 -  
4 -Permission Object  
5 ------------------  
6 -Permissions on items in the DMS are handled via a Permission Object.  
7 -This permission object is where the permissions for the object are kept.  
8 -Previously, a permission folder was used, but this was changed to an  
9 -autonomous permission object to allow greater flexibility - such as  
10 -allowing documents to have their own permissions in future.  
11 -  
12 -Permission Assignments  
13 -----------------------  
14 -This permission object links the item with a number of permission  
15 -assignments - one permission assignment per permission. A permission  
16 -assignment is uniquely specified by a permission object and a  
17 -permission. The final component is a permission descriptor, which  
18 -describes the groups, users, or roles that have that permission on that  
19 -permission object.  
20 -  
21 -Permission Descriptor  
22 ----------------------  
23 -The permission descriptor is an indirection to reduce the number of rows  
24 -to describe which groups, users, and roles that have permissions on each  
25 -permission object. It allows assignments that cover the same groups,  
26 -users, and roles to be described textually and looked up quickly by a 32  
27 -character hash. A particular collection of groups, users, and roles  
28 -will always be described by a unique descriptor.  
29 -  
30 -Permission Lookup  
31 ------------------  
32 -Permission Lookup objects describe the collections of groups and users  
33 -that have each permission on the item in the repository. It is an  
34 -expanded form of the permission object - if an owner role has a  
35 -permission in terms of the permission object, the exact user with that  
36 -role on that object will be mentioned in the permission lookup.  
37 -  
38 -Permission lookups exist mostly for restricting a search for items in  
39 -the repository to those items for whom a particular user has a given  
40 -permission. The most obvious users of this are the content and metadata  
41 -searches, which need to restrict results to documents readable by the  
42 -current user. Other users may be the list of documents in a folder  
43 -readable by the current user, or the list of folders in the repository  
44 -that the user can add documents to.  
45 -  
46 -Managing Permissions  
47 ---------------------  
48 -  
49 -Permission lookups use descriptors that never expand groups. Changes in  
50 -membership of a group don't require permission lookups. When looking up  
51 -using permission lookups, the descriptors that the user has access to  
52 -are looked up at run-time first, and these are used to limit the  
53 -searches.  
54 -  
55 -On creation, folders and documents inherit the permission object of  
56 -their parent. They then update their own permission lookups.  
57 -(Document::create, Folder::create)  
58 -  
59 -When folders change their permission object (become their own master,  
60 -start using their parent again, are moved), they update all ancestor  
61 -folders and documents that had the old permission object to the new one.  
62 -Those changed then have their permission lookups updated.  
63 -(KTPermissionUtil::copyPermissionObject,  
64 -KTPermissionUtil::inheritPermissionObject)  
65 -  
66 -When documents change their permission object (become their own master,  
67 -start using their parent again, are moved), they update their own  
68 -permission lookups.  
69 -(KTPermissionUtil::copyPermissionObject,  
70 -KTPermissionUtil::inheritPermissionObject)  
71 -  
72 -  
docs/developer/RELEASE.txt deleted
1 -Here is the release process for KnowledgeTree.  
2 -  
3 -Test:  
4 -1.1. Testing.  
5 -  
6 -Prepare:  
7 -2.1. Update Changelog.  
8 -2.2. Put release date into Changelog.txt  
9 -2.3. Update database install and upgrade SQL scripts  
10 -2.4. Update version number in database install and upgrade scripts  
11 -2.5. Tag CVS - RELEASE_1_2_3_20040909  
12 -2.6. kt/releaseKT.sh -b RELEASE_1_2_3_20040909 -v 1.2.3  
13 -2.7. Test final release  
14 -  
15 -Release:  
16 -3.1. ncftpput upload.sourceforge.net /incoming knowledgeTree-1.2.3.tgz knowledgeTree-1.2.3.zip  
17 -3.2. Add to Sourceforge file manager  
18 -3.3. Update Web site version number and features.  
19 -  
20 -Inform:  
21 -4.1. Mail kt-dms-users and kt-dms-developers and kt-dms-announce  
22 -4.2. Add to Forums  
23 -  
24 -Post-release:  
25 -5.1. Prepare Changelog.txt for next release  
docs/developer/codingStandards.txt deleted
1 -Coding Standard Doc  
2 -=====================  
3 -(Inform - can be formalized later. Only standards above and beyond those in the original spec are included here)  
4 -  
5 -1) All functions return their required value on success or false otherwise. On returning false, all function  
6 - set the $_SESSION["errorMessage"] variable  
7 -2) All presentation layer files must contain a list of the expected querystring and form variables they will receive  
8 -3) Any function that inserts into a database table must begin its name with "create" e.g. createFolder(). The exception  
9 - to this is a function which inserts into a link table. It must begin its name with "add" e.g. addUserToGroup()  
10 -4) All database tables that consist of id, name pairs will end in the word "lookup" e.g. groups_lookup  
11 -5) All database tables that link two or more tables together will end in the word "link"  
12 -6) When using the @return tag in the case of mixed return types, the return type should always be the  
13 - type that is returned if the function succeedes i.e. does what it is supposed to do  
docs/developer/i18n.txt deleted
1 -KnowledgeTree Internationalisation (i18n)  
2 ------------------------------------------  
3 -  
4 -Generating the PO template file  
5 --------------------------------  
6 -  
7 -- install gettext command line utilities  
8 -- use bin/genpo.sh  
9 -  
10 -$Id$  
docs/developer/metadata-versions.txt deleted
1 -Metadata versions  
2 -=================  
3 -  
4 -KnowledgeTree can keep a historic view of both the physical document and  
5 -the associated metadata.  
6 -  
7 -Version creation  
8 -----------------  
9 -Metadata versions need to occur when:  
10 -- A new physical document is added  
11 -- Metadata is changed  
12 -  
13 -Database effects  
14 -----------------  
15 -Metadata versions are stored in the standard documents table, with the  
16 -document status set to STATUS_HISTORY (6). Metadata versions are copies  
17 -of the document table currently, and all associated generic and  
18 -type-specific metadata. Each metadata version has its own metadata  
19 -version number (metadata_version, getMetadataVersion()).  
20 -  
21 -This configuration makes searches much easier.  
22 -  
23 -Interface changes  
24 ------------------  
25 -Metadata versions are listed in the document detail view under "Metadata  
26 -Versions". When selected, the document detail view is updated to place  
27 -the metadata version on the right-hand side of the view, allowing  
28 -comparison.  
plugins/ktcore/KTBulkActions.php
@@ -232,7 +232,7 @@ class KTBulkMoveAction extends KTBulkAction { @@ -232,7 +232,7 @@ class KTBulkMoveAction extends KTBulkAction {
232 $this->iTargetFolderId = $_REQUEST['data']['fFolderId']; 232 $this->iTargetFolderId = $_REQUEST['data']['fFolderId'];
233 $this->oTargetFolder = Folder::get($this->iTargetFolderId); 233 $this->oTargetFolder = Folder::get($this->iTargetFolderId);
234 $_REQUEST['fReturnData'] = ''; 234 $_REQUEST['fReturnData'] = '';
235 - $_REQUEST['fFolderId'] = $this->iTargetFolderId; 235 + $_REQUEST['fFolderId'] = $this->iTargetFolderId;
236 236
237 // does it exists 237 // does it exists
238 if(PEAR::isError($this->oTargetFolder)) { 238 if(PEAR::isError($this->oTargetFolder)) {