Peter M. Groen / knowledgetree

Commit 1ae08a37fda7efc6bd09b2795e98cdbff3b5f7bc

Authored by Brad Shuttleworth
1 parent 984549bf

add help 

fix mimetype for pdf.


git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@4941 c91229c3-7414-0410-bfa2-8a42b809f60b
Inline Side-by-side
Showing 12 changed files with 238 additions and 4 deletions
browse.php
  View file @1ae08a3
... ... @@ -84,7 +84,7 @@ class BrowseDispatcher extends KTStandardDispatcher {
84 84 var $browse_mode = null;
85 85 var $query = null;
86 86 var $resultURL;
87   - var $sHelpPage = 'ktcore/browse/browse.html';
  87 + var $sHelpPage = 'ktcore/browse.html';
88 88 var $editable;
89 89  
90 90 function BrowseDispatcher() {
... ...
dashboard.php
  View file @1ae08a3
... ... @@ -44,6 +44,7 @@ $sectionName = "dashboard";
44 44 class DashboardDispatcher extends KTStandardDispatcher {
45 45  
46 46 var $notifications = array();
  47 + var $sHelpPage = 'ktcore/dashboard.html';
47 48  
48 49 function DashboardDispatcher() {
49 50 $this->aBreadcrumbs = array(
... ...
edit.php
  View file @1ae08a3
... ... @@ -40,6 +40,7 @@ class KTEditDocumentDispatcher extends KTStandardDispatcher {
40 40 var $oDocument = null;
41 41 var $oFolder = null;
42 42 var $sSection = "view_details";
  43 + var $sHelpPage = 'ktcore/browse.html';
43 44  
44 45 function check() {
45 46 if (!parent::check()) { return false; }
... ...
kthelp/ktcore/EN/browse.html 0 → 100644
  View file @1ae08a3
  1 +<html>
  2 +<head>
  3 + <title>Browse Documents</title>
  4 +</head>
  5 +<body>
  6 +
  7 +<h2>Browse Documents</h2>
  8 +<p>You use the Browse Documents section to navigate the
  9 +repository – either by folder, by document type, or by lookup value – the
  10 +default is browse by folder.</p>
  11 +<h3>Folder Actions</h3>
  12 +<p>You use the Folder Actions buttons to:</p>
  13 +<ul>
  14 + <li>Add new folders.</li>
  15 + <li>Add multiple documents to the repository at once –
  16 + either by uploading a zip file (bulk import), or by specifying a server path
  17 + (bulk upload) to a location to upload all the documents and files at that
  18 + location to the repository.</li>
  19 +</ul>
  20 +<h4>Subscriptions</h4>
  21 +<p>Subscribing to a folder allows you to receive notifications
  22 +that tell you when that folder is modified. An email notification is sent to you
  23 +if you have provided your email address when subscribing. Your alerts and
  24 +notifications are also displayed on the Dashboard. </p>
  25 +<h4>Search</h4>
  26 +<p>KnowledgeTree provides three versatile search options –
  27 +simple (quick) search, advanced search, and saved searches. Search is
  28 +permissions-based, so the system only returns items that the logged in user is
  29 +allowed to access. </p>
  30 +<p> </p>
  31 +<h5>Simple (quick) search</h5>
  32 +<p>Specify a search term to search all text – including
  33 +document metadata and the contents of the following file types (if your
  34 +administrator has configured these options): MS Word, MS Excel, MS PowerPoint,
  35 +Adobe PDF, and Plain Text files.</p>
  36 +<h5>Advanced Search</h5>
  37 +<p>Define criteria to launch a detailed Boolean search of the
  38 +repository. This search allows more detailed search requests (using document
  39 +metadata). For example, you can search for all MS Excel documents containing the
  40 +word 'Invoice'.</p>
  41 +<h5>Saved search</h5>
  42 +<p>The saved search function allows KnowledgeTree
  43 +administrators to pre-save useful advanced searches. For example, you may want
  44 +to save a search that shows all documents in a completed state of a workflow.
  45 +Saved searches save time on commonly used searches. </p>
  46 +<h3>Document Actions</h3>
  47 +<p>The Document Detail screen summarizes key information about
  48 +the currently selected document. The Document Actions pane on the left of the
  49 +screen provides a set of buttons for working with the document. </p>
  50 +<h4>Download</h4>
  51 +<p>You can download a file to open it, or to save it, without
  52 +checking it out of the repository. </p>
  53 +<h4>Check-in / Check-out</h4>
  54 +<p>Check out a document to temporarily remove it from the
  55 +repository while you update it. While it’s checked out, other users can’t check
  56 +it out to make changes. The version is incremented when the document is checked
  57 +in – a metadata version snapshot is created.</p>
  58 +<p>An administrator can override the checked out status of a
  59 +document if the user has failed to check-in a document. In this case, the user
  60 +needs to check-out the document again and redo their changes.</p>
  61 +<h4>Metadata</h4>
  62 +<p>Metadata is the information about a document that describes
  63 +how, and when, and by whom, a particular set of data was collected, and how the
  64 +data is formatted.</p>
  65 +<p>KnowledgeTree groups metadata fields into fieldsets. A
  66 +fieldset is a set of related information, which can be ‘attached’ to a
  67 +document. For example, let’s say we specify a ‘Project’ fieldset as follows:</p>
  68 +<p><b>Project</b></p>
  69 +<ul>
  70 + <li>Project Name</li>
  71 + <li>Division</li>
  72 + <li>Cost Estimate</li>
  73 + <li>Implementation Status</li>
  74 +</ul>
  75 +<p>This project fieldset can be attached to any document type
  76 +that relates to a project; and all members of that fieldset (i.e. project name,
  77 +division, cost estimate, implementation status) would apply. A plug-in could be
  78 +written, which uses the information in the ‘Project’ fieldset, to provide
  79 +reporting information on a project level, or on a project-based hierarchy of
  80 +documents.</p>
  81 +<h4>Delete</h4>
  82 +<p>Deleted documents remain in the repository (in DMS
  83 +Administration) until the KnowledgeTree administrator either expunges them or
  84 +restores them. </p>
  85 +<p>See Administration – Document Storage – Restore or Expunge
  86 +Deleted Documents</p>
  87 +<h4>Move</h4>
  88 +<p>Only users with the required permissions for a folder are
  89 +allowed to move an item to another location in the repository. </p>
  90 +<h4>Transaction History</h4>
  91 +<p>This feature provides a record of all transactions
  92 +performed on the document: create date, uploads, downloads, check-out, check-in
  93 +and the previous deletion of the document if it has been restored.</p>
  94 +<h4>Version History</h4>
  95 +<p>This feature provides a record of all past and current
  96 +versions of a document. A new document version is created whenever a document is
  97 +checked-out then subsequently checked-in again. The version history feature
  98 +allows you to download older documents and compare them with more recent
  99 +versions.</p>
  100 +<h4>Links</h4>
  101 +<p >Document links allow you to establish
  102 +associations between documents in the repository. Your KnowledgeTree
  103 +administrator needs to create the Document Link Types that you use to link
  104 +documents. When creating a document link, the administrator specifies the type
  105 +of relationship that the link implies between the
  106 +linked documents – i.e. ‘associated with’, or ‘duplicated by’. </p>
  107 +<h4>Version Control</h4>
  108 +<p>KnowledgeTree has powerful document version control
  109 +features, which ensure that the editing and versioning of documents is done in a
  110 +controlled and auditable manner. Newly created documents are assigned as version
  111 +0.1. The first time you check it out for editing and then check it back in
  112 +again, the version number increments to version 1. Each subsequent check out /
  113 +check in causes the version number to increment by 1. </p>
  114 +<p>A document may only be checked out for editing by a single
  115 +user at a time. When a document is checked back in, you need to specify the
  116 +changes you made.</p>
  117 +<p>Users and groups who have read or write access to a
  118 +document are allowed to download it for viewing only – you can choose to open
  119 +the document in your Web browser or save it to your local computer. You can
  120 +view a version history of all changes to the document, and you can download
  121 +previous versions for comparison. </p>
  122 +<p>Any changes you make to the document you downloaded won't
  123 +display in the version in the repository unless you check out the document, and
  124 +then check it back into the repository with your changes.</p>
  125 +<p>Any user that logs in to KnowledgeTree can view the list of
  126 +documents they have checked out (if any) in the Checked-out documents section of
  127 +the Dashboard. </p>
  128 +<h4>Permissions</h4>
  129 +<p >Permissions in KnowledgeTree are
  130 +folder-based – permissions that have been allocated for a specific folder apply
  131 +to all the documents in that folder.</p>
  132 +<p >There are four default types of
  133 +permissions: Read, Write, Add Folder, and Manage Permissions. </p>
  134 +<p >Users that have only Read permission on
  135 +a document can view the document and its metadata, but are not allowed to change
  136 +it. Users that have Read and Write permissions are allowed to change the
  137 +contents of a document, as well as its metadata. </p>
  138 +<p >Users with the Add Folder permission are
  139 +allowed to create and edit sub-folders within their group folder. </p>
  140 +<p >Users with the Manage Permissions
  141 +permission are able to edit permissions within their group folder.</p>
  142 +</body>
  143 +</html>
... ...
kthelp/ktcore/EN/dashboard.html 0 → 100644
  View file @1ae08a3
  1 +<html>
  2 +<head>
  3 + <title>Dashboard</title>
  4 +</head>
  5 +<body>
  6 +
  7 +
  8 +<h2>Dashboard</h2>
  9 +<p>The Dashboard displays information relevant to the logged
  10 +in user. It lists the documents you have checked out, and it displays items
  11 +requiring your attention, which may include:</p>
  12 +<ul>
  13 + <li>Pending documents – documents that need to be approved</li>
  14 + <li>Subscription alerts and Notifications – documents
  15 + you’re subscribed to that have been added, deleted, or modified. This
  16 + section also lists document requiring your input in the workflow cycle.</li>
  17 +</ul>
  18 +
  19 +</body>
  20 +</html>
... ...
kthelp/ktcore/EN/workflow.html 0 → 100644
  View file @1ae08a3
  1 +<html>
  2 +<head>
  3 +<title>Workflow</title>
  4 +</head>
  5 +
  6 +<body>
  7 +
  8 +<h2>Workflow</h2>
  9 +<p>Workflow may be defined as the process a document goes
  10 +through to serve its purpose in an organization. For example, an invoice is
  11 +created, distributed, then paid; a report may be created, reviewed, edited, and
  12 +distributed. </p>
  13 +<p>Some documents, such as tenders, may have complex
  14 +workflows, requiring input from several people within and outside of your
  15 +organization before the work is complete. </p>
  16 +<p>The KnowledgeTree administrator defines and manages
  17 +document workflows in DMS administration, and any KnowledgeTree user may be
  18 +involved in a document workflow. </p>
  19 +<p>Workflows in KnowledgeTree involve three key areas:</p>
  20 +<ol>
  21 + <li><a href="#assign">Assigning workflows</a></li>
  22 + <li><a href="#states">States and Transitions</a></li>
  23 + <li><a href="#effects">Workflow effects (Actions)</a></li>
  24 +</ol>
  25 +<h3><a name="assign"></a>Assigning workflows</h3>
  26 +<p >A document in the repository can have
  27 +only one workflow attached to it at any given time. By default, workflows are
  28 +not automatically attached to new documents when they’re added to the
  29 +repository. However, the administrator may configure the system to assign
  30 +workflows when new documents are created, or to assign workflows only to
  31 +specific documents. Users are also allowed to select and assign workflows to the
  32 +documents they are working with – provided they have the permissions to do so.
  33 +</p>
  34 +<h3><a name="states"></a>States and Transitions</h3>
  35 +<p >Workflows consist of states and
  36 +transitions. A state may be defined as a stage in a document’s lifecycle, such
  37 +as ‘billed’ or ‘draft’. Each workflow has a starting state, which is the initial
  38 +state for any document in a workflow.</p>
  39 +<p >Transitions, which may be defined as the
  40 +way in which documents move between states, are an essential part of the
  41 +workflow. Each state can have one or more transitions, depending on how the
  42 +administrator has created the workflow.</p>
  43 +<p >Transitions point to the next step in
  44 +the workflow, such as send to client or review, which effectively changes the
  45 +state of the document. Transitions represent the actions that may be performed
  46 +on a document. For example, an invoice starts in the generated state; then it is
  47 +sent to client, before it is marked as billed. Transitions are said to be
  48 +guarded – not all users are allowed to access them. In a publication workflow
  49 +for example, only users with the role reviewer would be allowed to review a
  50 +document, and to move it from draft to published.</p>
  51 +<h3><a name="effects"></a>Workflow effects (Actions)</h3>
  52 +<p >Workflows are more than just states and
  53 +transitions. Users and administrators use workflows to restrict, deny or grant
  54 +access to documents in the repository, based on the document’s position in the
  55 +workflow. For example, a state can restrict both actions and permissions on a
  56 +document – only reviewers may be allowed to discuss draft documents for
  57 +instance, while clients will be disallowed from viewing unbilled invoices, and
  58 +published documents will be prevented from being checked in or checked out of
  59 +the repository. Additionally, users in specified Roles or Groups can be notified
  60 +when a document reaches a certain state in a workflow. These notifications
  61 +display on the Dashboard and are emailed to users with specified email accounts.</p>
  62 +
  63 +</body>
  64 +</html>
... ...
lib/actions/documentaction.inc.php
  View file @1ae08a3
... ... @@ -12,6 +12,7 @@ class KTDocumentAction extends KTStandardDispatcher {
12 12  
13 13 var $_sShowPermission = "ktcore.permissions.read";
14 14 var $_sDisablePermission;
  15 + var $sHelpPage = 'ktcore/browse.html';
15 16  
16 17 var $sSection = "view_details";
17 18 var $aBreadcrumbs = array(
... ...
lib/actions/folderaction.inc.php
  View file @1ae08a3
... ... @@ -11,6 +11,7 @@ class KTFolderAction extends KTStandardDispatcher {
11 11  
12 12 var $_sShowPermission;
13 13 var $_sDisablePermission;
  14 + var $sHelpPage = 'ktcore/browse.html';
14 15  
15 16 var $_bAdminAlwaysAvailable = false;
16 17  
... ...
plugins/ktcore/KTDocumentActions.php
  View file @1ae08a3
... ... @@ -822,6 +822,8 @@ class KTDocumentWorkflowAction extends KTDocumentAction {
822 822 var $sDisplayName = 'Workflow';
823 823 var $sName = 'ktcore.actions.document.workflow';
824 824 var $_sShowPermission = "ktcore.permissions.write";
  825 +
  826 + var $sHelpPage = 'ktcore/workflow.html';
825 827  
826 828 function do_main() {
827 829 $this->oPage->setBreadcrumbDetails(_("workflow"));
... ...
sql/mysql/install/data.sql
  View file @1ae08a3
... ... @@ -436,14 +436,14 @@ INSERT INTO `mime_types` VALUES (64, &#39;nc&#39;, &#39;application/x-netcdf&#39;, NULL, &#39;&#39;);
436 436 INSERT INTO `mime_types` VALUES (65, 'oda', 'application/oda', NULL, '');
437 437 INSERT INTO `mime_types` VALUES (66, 'pbm', 'image/x-portable-bitmap', 'image', '');
438 438 INSERT INTO `mime_types` VALUES (67, 'pdb', 'chemical/x-pdb', NULL, '');
439   -INSERT INTO `mime_types` VALUES (68, 'pdf', 'application/pdf', 'pdf', 'Acrobar PDF or Postscript Document');
  439 +INSERT INTO `mime_types` VALUES (68, 'pdf', 'application/pdf', 'pdf', 'Acrobat PDF or Postscript Document');
440 440 INSERT INTO `mime_types` VALUES (69, 'pgm', 'image/x-portable-graymap', 'image', '');
441 441 INSERT INTO `mime_types` VALUES (70, 'pgn', 'application/x-chess-pgn', NULL, '');
442 442 INSERT INTO `mime_types` VALUES (71, 'png', 'image/png', 'image', 'JPEG Image');
443 443 INSERT INTO `mime_types` VALUES (72, 'pnm', 'image/x-portable-anymap', 'image', '');
444 444 INSERT INTO `mime_types` VALUES (73, 'ppm', 'image/x-portable-pixmap', 'image', '');
445 445 INSERT INTO `mime_types` VALUES (74, 'ppt', 'application/vnd.ms-powerpoint', 'office', 'Powerpoint Presentation');
446   -INSERT INTO `mime_types` VALUES (75, 'ps', 'application/postscript', 'pdf', 'Acrobar PDF or Postscript Document');
  446 +INSERT INTO `mime_types` VALUES (75, 'ps', 'application/postscript', 'pdf', 'Acrobat PDF or Postscript Document');
447 447 INSERT INTO `mime_types` VALUES (76, 'qt', 'video/quicktime', NULL, 'Video File');
448 448 INSERT INTO `mime_types` VALUES (77, 'ra', 'audio/x-realaudio', NULL, '');
449 449 INSERT INTO `mime_types` VALUES (78, 'ram', 'audio/x-pn-realaudio', NULL, '');
... ...
sql/mysql/upgrade/2.99.9/mimetype-friendly.sql
  View file @1ae08a3
... ... @@ -10,7 +10,7 @@ UPDATE mime_types SET friendly_name = &#39;GIF Image&#39; WHERE id IN (27);
10 10 UPDATE mime_types SET friendly_name = 'TIFF Image' WHERE id IN (110,111);
11 11 UPDATE mime_types SET friendly_name = 'HTML Webpage' WHERE id IN (31,32);
12 12 UPDATE mime_types SET friendly_name = 'Tar or Compressed Tar File' WHERE id IN (105,129);
13   -UPDATE mime_types SET friendly_name = 'Acrobar PDF or Postscript Document' WHERE id IN (75,68);
  13 +UPDATE mime_types SET friendly_name = 'Acrobat PDF or Postscript Document' WHERE id IN (75,68);
14 14 UPDATE mime_types SET friendly_name = 'Excel Spreadsheet' WHERE id IN (122);
15 15 UPDATE mime_types SET friendly_name = 'Excel Template' WHERE id IN (140);
16 16 UPDATE mime_types SET friendly_name = 'Word Template' WHERE id IN (141);
... ...
view.php
  View file @1ae08a3
... ... @@ -28,6 +28,7 @@ require_once(KT_LIB_DIR . &quot;/browse/browseutil.inc.php&quot;);
28 28 class ViewDocumentDispatcher extends KTStandardDispatcher {
29 29  
30 30 var $sSection = "view_details";
  31 + var $sHelpPage = 'ktcore/browse.html';
31 32  
32 33 function ViewDocumentDispatcher() {
33 34 $this->aBreadcrumbs = array(
... ...