From 1ae08a37fda7efc6bd09b2795e98cdbff3b5f7bc Mon Sep 17 00:00:00 2001 From: Brad Shuttleworth Date: Fri, 17 Feb 2006 11:17:10 +0000 Subject: [PATCH] add help fix mimetype for pdf. --- browse.php | 2 +- dashboard.php | 1 + edit.php | 1 + kthelp/ktcore/EN/browse.html | 143 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ kthelp/ktcore/EN/dashboard.html | 20 ++++++++++++++++++++ kthelp/ktcore/EN/workflow.html | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ lib/actions/documentaction.inc.php | 1 + lib/actions/folderaction.inc.php | 1 + plugins/ktcore/KTDocumentActions.php | 2 ++ sql/mysql/install/data.sql | 4 ++-- sql/mysql/upgrade/2.99.9/mimetype-friendly.sql | 2 +- view.php | 1 + 12 files changed, 238 insertions(+), 4 deletions(-) create mode 100644 kthelp/ktcore/EN/browse.html create mode 100644 kthelp/ktcore/EN/dashboard.html create mode 100644 kthelp/ktcore/EN/workflow.html diff --git a/browse.php b/browse.php index ad6c33f..dcfb4cd 100755 --- a/browse.php +++ b/browse.php @@ -84,7 +84,7 @@ class BrowseDispatcher extends KTStandardDispatcher { var $browse_mode = null; var $query = null; var $resultURL; - var $sHelpPage = 'ktcore/browse/browse.html'; + var $sHelpPage = 'ktcore/browse.html'; var $editable; function BrowseDispatcher() { diff --git a/dashboard.php b/dashboard.php index eb068f7..dbc4486 100644 --- a/dashboard.php +++ b/dashboard.php @@ -44,6 +44,7 @@ $sectionName = "dashboard"; class DashboardDispatcher extends KTStandardDispatcher { var $notifications = array(); + var $sHelpPage = 'ktcore/dashboard.html'; function DashboardDispatcher() { $this->aBreadcrumbs = array( diff --git a/edit.php b/edit.php index d94f5bf..d965881 100644 --- a/edit.php +++ b/edit.php @@ -40,6 +40,7 @@ class KTEditDocumentDispatcher extends KTStandardDispatcher { var $oDocument = null; var $oFolder = null; var $sSection = "view_details"; + var $sHelpPage = 'ktcore/browse.html'; function check() { if (!parent::check()) { return false; } diff --git a/kthelp/ktcore/EN/browse.html b/kthelp/ktcore/EN/browse.html new file mode 100644 index 0000000..65a0c83 --- /dev/null +++ b/kthelp/ktcore/EN/browse.html @@ -0,0 +1,143 @@ + + + Browse Documents + + + +

Browse Documents

+

You use the Browse Documents section to navigate the +repository – either by folder, by document type, or by lookup value – the +default is browse by folder.

+

Folder Actions

+

You use the Folder Actions buttons to:

+ +

Subscriptions

+

Subscribing to a folder allows you to receive notifications +that tell you when that folder is modified. An email notification is sent to you +if you have provided your email address when subscribing. Your alerts and +notifications are also displayed on the Dashboard.

+

Search

+

KnowledgeTree provides three versatile search options – +simple (quick) search, advanced search, and saved searches. Search is +permissions-based, so the system only returns items that the logged in user is +allowed to access.

+

+
Simple (quick) search
+

Specify a search term to search all text – including +document metadata and the contents of the following file types (if your +administrator has configured these options): MS Word, MS Excel, MS PowerPoint, +Adobe PDF, and Plain Text files.

+
Advanced Search
+

Define criteria to launch a detailed Boolean search of the +repository. This search allows more detailed search requests (using document +metadata). For example, you can search for all MS Excel documents containing the +word 'Invoice'.

+
Saved search
+

The saved search function allows KnowledgeTree +administrators to pre-save useful advanced searches. For example, you may want +to save a search that shows all documents in a completed state of a workflow. +Saved searches save time on commonly used searches.

+

Document Actions

+

The Document Detail screen summarizes key information about +the currently selected document. The Document Actions pane on the left of the +screen provides a set of buttons for working with the document.

+

Download

+

You can download a file to open it, or to save it, without +checking it out of the repository.

+

Check-in / Check-out

+

Check out a document to temporarily remove it from the +repository while you update it. While it’s checked out, other users can’t check +it out to make changes. The version is incremented when the document is checked +in – a metadata version snapshot is created.

+

An administrator can override the checked out status of a +document if the user has failed to check-in a document. In this case, the user +needs to check-out the document again and redo their changes.

+

Metadata

+

Metadata is the information about a document that describes +how, and when, and by whom, a particular set of data was collected, and how the +data is formatted.

+

KnowledgeTree groups metadata fields into fieldsets. A +fieldset is a set of related information, which can be ‘attached’ to a +document. For example, let’s say we specify a ‘Project’ fieldset as follows:

+

Project

+ +

This project fieldset can be attached to any document type +that relates to a project; and all members of that fieldset (i.e. project name, +division, cost estimate, implementation status) would apply. A plug-in could be +written, which uses the information in the ‘Project’ fieldset, to provide +reporting information on a project level, or on a project-based hierarchy of +documents.

+

Delete

+

Deleted documents remain in the repository (in DMS +Administration) until the KnowledgeTree administrator either expunges them or +restores them.

+

See Administration – Document Storage – Restore or Expunge +Deleted Documents

+

Move

+

Only users with the required permissions for a folder are +allowed to move an item to another location in the repository.

+

Transaction History

+

This feature provides a record of all transactions +performed on the document: create date, uploads, downloads, check-out, check-in +and the previous deletion of the document if it has been restored.

+

Version History

+

This feature provides a record of all past and current +versions of a document. A new document version is created whenever a document is +checked-out then subsequently checked-in again. The version history feature +allows you to download older documents and compare them with more recent +versions.

+

Links

+

Document links allow you to establish +associations between documents in the repository. Your KnowledgeTree +administrator needs to create the Document Link Types that you use to link +documents. When creating a document link, the administrator specifies the type +of relationship that the link implies between the +linked documents – i.e. ‘associated with’, or ‘duplicated by’.

+

Version Control

+

KnowledgeTree has powerful document version control +features, which ensure that the editing and versioning of documents is done in a +controlled and auditable manner. Newly created documents are assigned as version +0.1. The first time you check it out for editing and then check it back in +again, the version number increments to version 1. Each subsequent check out / +check in causes the version number to increment by 1.

+

A document may only be checked out for editing by a single +user at a time. When a document is checked back in, you need to specify the +changes you made.

+

Users and groups who have read or write access to a +document are allowed to download it for viewing only – you can choose to open +the document in your Web browser or save it to your local computer. You can +view a version history of all changes to the document, and you can download +previous versions for comparison.

+

Any changes you make to the document you downloaded won't +display in the version in the repository unless you check out the document, and +then check it back into the repository with your changes.

+

Any user that logs in to KnowledgeTree can view the list of +documents they have checked out (if any) in the Checked-out documents section of +the Dashboard.

+

Permissions

+

Permissions in KnowledgeTree are +folder-based – permissions that have been allocated for a specific folder apply +to all the documents in that folder.

+

There are four default types of +permissions: Read, Write, Add Folder, and Manage Permissions.

+

Users that have only Read permission on +a document can view the document and its metadata, but are not allowed to change +it. Users that have Read and Write permissions are allowed to change the +contents of a document, as well as its metadata.

+

Users with the Add Folder permission are +allowed to create and edit sub-folders within their group folder.

+

Users with the Manage Permissions +permission are able to edit permissions within their group folder.

+ + diff --git a/kthelp/ktcore/EN/dashboard.html b/kthelp/ktcore/EN/dashboard.html new file mode 100644 index 0000000..d62c0af --- /dev/null +++ b/kthelp/ktcore/EN/dashboard.html @@ -0,0 +1,20 @@ + + + Dashboard + + + + +

Dashboard

+

The Dashboard displays information relevant to the logged +in user. It lists the documents you have checked out, and it displays items +requiring your attention, which may include:

+ + + + diff --git a/kthelp/ktcore/EN/workflow.html b/kthelp/ktcore/EN/workflow.html new file mode 100644 index 0000000..9d9e042 --- /dev/null +++ b/kthelp/ktcore/EN/workflow.html @@ -0,0 +1,64 @@ + + +Workflow + + + + +

Workflow

+

Workflow may be defined as the process a document goes +through to serve its purpose in an organization. For example, an invoice is +created, distributed, then paid; a report may be created, reviewed, edited, and +distributed.

+

Some documents, such as tenders, may have complex +workflows, requiring input from several people within and outside of your +organization before the work is complete.

+

The KnowledgeTree administrator defines and manages +document workflows in DMS administration, and any KnowledgeTree user may be +involved in a document workflow.

+

Workflows in KnowledgeTree involve three key areas:

+
    +
  1. Assigning workflows
    2. +
  2. States and Transitions
    3. +
  3. Workflow effects (Actions)
    4. +
+

Assigning workflows

+

A document in the repository can have +only one workflow attached to it at any given time. By default, workflows are +not automatically attached to new documents when they’re added to the +repository. However, the administrator may configure the system to assign +workflows when new documents are created, or to assign workflows only to +specific documents. Users are also allowed to select and assign workflows to the +documents they are working with – provided they have the permissions to do so. +

+

States and Transitions

+

Workflows consist of states and +transitions. A state may be defined as a stage in a document’s lifecycle, such +as ‘billed’ or ‘draft’. Each workflow has a starting state, which is the initial +state for any document in a workflow.

+

Transitions, which may be defined as the +way in which documents move between states, are an essential part of the +workflow. Each state can have one or more transitions, depending on how the +administrator has created the workflow.

+

Transitions point to the next step in +the workflow, such as send to client or review, which effectively changes the +state of the document. Transitions represent the actions that may be performed +on a document. For example, an invoice starts in the generated state; then it is +sent to client, before it is marked as billed. Transitions are said to be +guarded – not all users are allowed to access them. In a publication workflow +for example, only users with the role reviewer would be allowed to review a +document, and to move it from draft to published.

+

Workflow effects (Actions)

+

Workflows are more than just states and +transitions. Users and administrators use workflows to restrict, deny or grant +access to documents in the repository, based on the document’s position in the +workflow. For example, a state can restrict both actions and permissions on a +document – only reviewers may be allowed to discuss draft documents for +instance, while clients will be disallowed from viewing unbilled invoices, and +published documents will be prevented from being checked in or checked out of +the repository. Additionally, users in specified Roles or Groups can be notified +when a document reaches a certain state in a workflow. These notifications +display on the Dashboard and are emailed to users with specified email accounts.

+ + + diff --git a/lib/actions/documentaction.inc.php b/lib/actions/documentaction.inc.php index 453a7c3..95e874c 100644 --- a/lib/actions/documentaction.inc.php +++ b/lib/actions/documentaction.inc.php @@ -12,6 +12,7 @@ class KTDocumentAction extends KTStandardDispatcher { var $_sShowPermission = "ktcore.permissions.read"; var $_sDisablePermission; + var $sHelpPage = 'ktcore/browse.html'; var $sSection = "view_details"; var $aBreadcrumbs = array( diff --git a/lib/actions/folderaction.inc.php b/lib/actions/folderaction.inc.php index cbf7db9..fc41139 100644 --- a/lib/actions/folderaction.inc.php +++ b/lib/actions/folderaction.inc.php @@ -11,6 +11,7 @@ class KTFolderAction extends KTStandardDispatcher { var $_sShowPermission; var $_sDisablePermission; + var $sHelpPage = 'ktcore/browse.html'; var $_bAdminAlwaysAvailable = false; diff --git a/plugins/ktcore/KTDocumentActions.php b/plugins/ktcore/KTDocumentActions.php index 59029ff..7978f2f 100644 --- a/plugins/ktcore/KTDocumentActions.php +++ b/plugins/ktcore/KTDocumentActions.php @@ -822,6 +822,8 @@ class KTDocumentWorkflowAction extends KTDocumentAction { var $sDisplayName = 'Workflow'; var $sName = 'ktcore.actions.document.workflow'; var $_sShowPermission = "ktcore.permissions.write"; + + var $sHelpPage = 'ktcore/workflow.html'; function do_main() { $this->oPage->setBreadcrumbDetails(_("workflow")); diff --git a/sql/mysql/install/data.sql b/sql/mysql/install/data.sql index 49f84bd..cbc0065 100644 --- a/sql/mysql/install/data.sql +++ b/sql/mysql/install/data.sql @@ -436,14 +436,14 @@ INSERT INTO `mime_types` VALUES (64, 'nc', 'application/x-netcdf', NULL, ''); INSERT INTO `mime_types` VALUES (65, 'oda', 'application/oda', NULL, ''); INSERT INTO `mime_types` VALUES (66, 'pbm', 'image/x-portable-bitmap', 'image', ''); INSERT INTO `mime_types` VALUES (67, 'pdb', 'chemical/x-pdb', NULL, ''); -INSERT INTO `mime_types` VALUES (68, 'pdf', 'application/pdf', 'pdf', 'Acrobar PDF or Postscript Document'); +INSERT INTO `mime_types` VALUES (68, 'pdf', 'application/pdf', 'pdf', 'Acrobat PDF or Postscript Document'); INSERT INTO `mime_types` VALUES (69, 'pgm', 'image/x-portable-graymap', 'image', ''); INSERT INTO `mime_types` VALUES (70, 'pgn', 'application/x-chess-pgn', NULL, ''); INSERT INTO `mime_types` VALUES (71, 'png', 'image/png', 'image', 'JPEG Image'); INSERT INTO `mime_types` VALUES (72, 'pnm', 'image/x-portable-anymap', 'image', ''); INSERT INTO `mime_types` VALUES (73, 'ppm', 'image/x-portable-pixmap', 'image', ''); INSERT INTO `mime_types` VALUES (74, 'ppt', 'application/vnd.ms-powerpoint', 'office', 'Powerpoint Presentation'); -INSERT INTO `mime_types` VALUES (75, 'ps', 'application/postscript', 'pdf', 'Acrobar PDF or Postscript Document'); +INSERT INTO `mime_types` VALUES (75, 'ps', 'application/postscript', 'pdf', 'Acrobat PDF or Postscript Document'); INSERT INTO `mime_types` VALUES (76, 'qt', 'video/quicktime', NULL, 'Video File'); INSERT INTO `mime_types` VALUES (77, 'ra', 'audio/x-realaudio', NULL, ''); INSERT INTO `mime_types` VALUES (78, 'ram', 'audio/x-pn-realaudio', NULL, ''); diff --git a/sql/mysql/upgrade/2.99.9/mimetype-friendly.sql b/sql/mysql/upgrade/2.99.9/mimetype-friendly.sql index 5b17e7f..b70e293 100644 --- a/sql/mysql/upgrade/2.99.9/mimetype-friendly.sql +++ b/sql/mysql/upgrade/2.99.9/mimetype-friendly.sql @@ -10,7 +10,7 @@ UPDATE mime_types SET friendly_name = 'GIF Image' WHERE id IN (27); UPDATE mime_types SET friendly_name = 'TIFF Image' WHERE id IN (110,111); UPDATE mime_types SET friendly_name = 'HTML Webpage' WHERE id IN (31,32); UPDATE mime_types SET friendly_name = 'Tar or Compressed Tar File' WHERE id IN (105,129); -UPDATE mime_types SET friendly_name = 'Acrobar PDF or Postscript Document' WHERE id IN (75,68); +UPDATE mime_types SET friendly_name = 'Acrobat PDF or Postscript Document' WHERE id IN (75,68); UPDATE mime_types SET friendly_name = 'Excel Spreadsheet' WHERE id IN (122); UPDATE mime_types SET friendly_name = 'Excel Template' WHERE id IN (140); UPDATE mime_types SET friendly_name = 'Word Template' WHERE id IN (141); diff --git a/view.php b/view.php index 028281b..c9629a6 100755 --- a/view.php +++ b/view.php @@ -28,6 +28,7 @@ require_once(KT_LIB_DIR . "/browse/browseutil.inc.php"); class ViewDocumentDispatcher extends KTStandardDispatcher { var $sSection = "view_details"; + var $sHelpPage = 'ktcore/browse.html'; function ViewDocumentDispatcher() { $this->aBreadcrumbs = array( -- libgit2 0.21.4