- add user assistance infrastructure.

- incorporate basic information on the installation / howto side of things - highlight the beta state. git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@4258 c91229c3-7414-0410-bfa2-8a42b809f60b

- add user assistance infrastructure.
- incorporate basic information on the installation / howto side of things - highlight the beta state. git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@4258 c91229c3-7414-0410-bfa2-8a42b809f60b
Brad Shuttleworth
1 parent 3921a7d2
Showing 13 changed files with 243 additions and 4 deletions
plugins/ktcore/KTCorePlugin.php
plugins/ktcore/KTDashletPlugins.php
plugins/ktcore/assistance/KTUserAssistance.php
plugins/ktcore/assistance/docs/admin-guide-whats-new-in-kt3
plugins/ktcore/assistance/docs/admin-quickguide
plugins/ktcore/assistance/docs/base
plugins/ktcore/assistance/docs/kt-bug-reporting-guide
plugins/ktcore/assistance/docs/kt3b1-what-is-a-beta
templates/ktcore/dashlets/admintutorial.smarty
templates/ktcore/dashlets/beta1info.smarty
templates/ktcore/dashlets/checkedout.smarty
templates/ktcore/dashlets/usertutorial.smarty
thirdparty/.htaccess
@@ -18,9 +18,11 @@ require_once(&#39;KTPermissions.php&#39;);
 require_once('KTAdminPlugins.php');
 require_once('KTDashletPlugins.php');
  
-$oPlugin->registerAdminPage('authentication', 'KTAuthenticationAdminPage', 'principals', 'Authentication', 'FIXME: describe authentication', 'authentication/authenticationadminpage.inc.php');
  
+$oPlugin->registerAdminPage('authentication', 'KTAuthenticationAdminPage', 'principals', 'Authentication', 'FIXME: describe authentication', 'authentication/authenticationadminpage.inc.php');
 $oPlugin->register();
  
+require_once('assistance/KTUserAssistance.php');
+
 require_once(KT_LIB_DIR . '/storage/ondiskpathstoragemanager.inc.php');
  
@@ -5,6 +5,11 @@ require_once(KT_LIB_DIR . &#39;/plugins/plugin.inc.php&#39;);
 require_once(KT_LIB_DIR . '/dashboard/dashlet.inc.php');
 require_once(KT_LIB_DIR . "/templating/templating.inc.php");
 require_once(KT_LIB_DIR . "/dashboard/Notification.inc.php");
+require_once(KT_LIB_DIR . "/security/Permission.inc");
+
+
+$oRegistry =& KTPluginRegistry::getSingleton();
+$oPlugin =& $oRegistry->getPlugin('ktcore.plugin');
  
 /* 
 * The registration hooks. 
@@ -13,6 +18,23 @@ require_once(KT_LIB_DIR . &quot;/dashboard/Notification.inc.php&quot;);
 *
 */
  
+// ultra simple skeleton for the admin tutorial
+class KTBeta1InfoDashlet extends KTBaseDashlet {
+	function is_active($oUser) {
+		return true;
+	}
+	
+    function render() {
+		$oTemplating = new KTTemplating;
+		$oTemplate = $oTemplating->loadTemplate("ktcore/dashlets/beta1info");
+		$aTemplateData = array(
+		);
+		return $oTemplate->render($aTemplateData);
+    }
+}
+
+$oPlugin->registerDashlet('KTBeta1InfoDashlet', 'ktcore.dashlet.beta1info', __FILE__);
+
 class KTNotificationDashlet extends KTBaseDashlet {
  
 	var $oUser;
@@ -36,10 +58,33 @@ class KTNotificationDashlet extends KTBaseDashlet {
     }
 }
  
-$oRegistry =& KTPluginRegistry::getSingleton();
-$oPlugin =& $oRegistry->getPlugin('ktcore.plugin');
  
-$oPlugin->registerDashlet('KTNotificationDashlet', 'ktcore.notifications.dashlet', __FILE__);
+$oPlugin->registerDashlet('KTNotificationDashlet', 'ktcore.dashlet.notifications', __FILE__);
+
+// replace the old checked-out docs.
+class KTCheckoutDashlet extends KTBaseDashlet {
+
+	var $oUser;
+	
+	function is_active($oUser) {
+		$this->oUser = $oUser;
+		return true;
+	}
+	
+    function render() {
+	    
+        $checked_out_documents = Document::getList(array("checked_out_user_id = ?", $this->oUser->getId()));
+        
+		$oTemplating = new KTTemplating;
+		$oTemplate = $oTemplating->loadTemplate("ktcore/dashlets/checkedout");
+		$aTemplateData = array(
+		    "documents" => $checked_out_documents,
+		);
+		return $oTemplate->render($aTemplateData);
+    }
+}
+
+$oPlugin->registerDashlet('KTCheckoutDashlet', 'ktcore.dashlet.checkout', __FILE__);
  
  
 ?>
 \ No newline at end of file
+<?php
+
+/* quick help / tutorial / introduction for KT users / administrators. */
+
+require_once(KT_LIB_DIR . '/plugins/pluginregistry.inc.php');
+require_once(KT_LIB_DIR . '/plugins/plugin.inc.php');
+require_once(KT_LIB_DIR . '/dashboard/dashlet.inc.php');
+require_once(KT_LIB_DIR . "/templating/templating.inc.php");
+require_once(KT_LIB_DIR . "/dashboard/Notification.inc.php");
+require_once(KT_LIB_DIR . "/security/Permission.inc");
+
+/* 
+* The registration hooks. 
+* 
+* Since this is too small to _actually_ need a full plugin object, we go:
+*
+*/
+
+class KTUserAssistance extends KTPlugin {
+    var $sNamespace = 'ktcore.userassistance';
+}
+
+$oRegistry =& KTPluginRegistry::getSingleton();
+$oRegistry->registerPlugin('KTUserAssistance', 'ktcore.userassistance', __FILE__);
+$oPlugin =& $oRegistry->getPlugin('ktcore.userassistance');
+
+// ultra simple skeleton for the user tutorial
+class KTUserTutorialDashlet extends KTBaseDashlet {
+	function is_active($oUser) {
+	    // FIXME check if the user has "turned this off" for themselves.
+		return true;
+	}
+	
+    function render() {
+		$oTemplating = new KTTemplating;
+		$oTemplate = $oTemplating->loadTemplate("ktcore/dashlets/usertutorial");
+		$aTemplateData = array(
+		);
+		return $oTemplate->render($aTemplateData);
+    }
+}
+
+$oPlugin->registerDashlet('KTUserTutorialDashlet', 'ktcore.dashlet.usertutorial', __FILE__);
+
+// ultra simple skeleton for the admin tutorial
+class KTAdminTutorialDashlet extends KTBaseDashlet {
+	function is_active($oUser) {
+	    // FIXME check if the user has "turned this off" for themselves.
+		return Permission::userIsSystemAdministrator($oUser->getId());
+		return true;
+	}
+	
+    function render() {
+		$oTemplating = new KTTemplating;
+		$oTemplate = $oTemplating->loadTemplate("ktcore/dashlets/admintutorial");
+		$aTemplateData = array(
+		);
+		return $oTemplate->render($aTemplateData);
+    }
+}
+$oPlugin->registerDashlet('KTAdminTutorialDashlet', 'ktcore.dashlet.admintutorial', __FILE__);
+
+class KTUserAssistBasePage extends KTStandardDispatcher {
+    var $sSection = 'help';
+    var $aBreadcrumbs = array(
+	    array('action' => 'dashboard', 'name' => 'Dashboard'),
+		array('name' => 'User Assistance')
+	);
+    var $pagefile = 'base';
+	var $title = 'User Assistance';
+	function do_main() {
+	    $this->oPage->setBreadcrumbDetails($this->title);
+	    $contents = @file_get_contents(dirname(__FILE__) . '/docs/' . $this->pagefile);
+		if ($contents === false) { 
+		    $contents = '<div class="ktError"><p>Unable to find requested documentation.</p></div>';
+		}
+		$this->oPage->setTitle($this->title);
+		$this->oPage->setShowPortlets(false);
+		return $contents;
+	}
+}
+
+class KTUserAssistB1WhatIs extends KTUserAssistBasePage { var $pagefile = 'kt3b1-what-is-a-beta'; var $title = 'What is a Beta?'; }
+$oPlugin->registerPage('kt3b1-what-is-a-beta', 'KTUserAssistB1WhatIs', __FILE__);
+
+class KTUserAssistBugReportingGUide extends KTUserAssistBasePage { var $pagefile = 'kt-bug-reporting-guide'; var $title = 'Help! Something went wrong'; }
+$oPlugin->registerPage('kt-bug-reporting-guide', 'KTUserAssistBugReportingGUide', __FILE__);
+
+class KTUserAssistAdminQuickguide extends KTUserAssistBasePage { var $pagefile = 'admin-quickguide'; var $title = 'Quickstart Guide for Administrators'; }
+$oPlugin->registerPage('admin-quickguide', 'KTUserAssistAdminQuickguide', __FILE__);
+
+class KTUserAssistAdminGuideWhatsNew extends KTUserAssistBasePage { var $pagefile = 'admin-guide-whats-new-in-kt3'; var $title = 'What\'s new in KT3 for Administrators'; }
+$oPlugin->registerPage('admin-guide-whats-new-in-kt3', 'KTUserAssistAdminGuideWhatsNew', __FILE__);
+
+
+$oPlugin->register();
+
+?>
 \ No newline at end of file
+<h2>What's different in KT3</h2>
+
+<p><strong>Almost Everything.</strong> We have rewritten almost all of the KnowledgeTree DMS, and hope that the changes
+will be good.</p>
+
+<p>Things you need to be aware of in terms of major changes for administrators:</p>
+
+
+<ul>
+  <li>Document Indexing is now done from PHP, and uses <strong>catdoc</strong> to do its work.  More about this in the file <kbd>docs/INSTALL.txt</kbd></li>
+  <li>While we ship with a very basic set of icons, far better ones have been produced in the Open Source community.  This means
+  that you can take advantage of <strong>icon themes</strong> which follow the <a href="http://tango-project.org/Standard_Icon_Naming_Specification">Icon Naming Theme Specification</a> from <a href="http://freedesktop.org">freedesktop.org</a>.  
+In particular, the <a href="http://tango-project.org/">Tango Project icons</a> are a superb, Creative Commons licensed set of icons 
+which provide an improved user interface experience. <strong>Note that these icons are transparent PNG files, and as such may not
+appear correctly in Internet Explorer.</strong>  We are exploring various solutions to that issue.
+<p>To take advantage of a theme such as <strong>tango</strong>, copy its contents into the <kbd>thirdparty/icon-theme</kbd> directory.</p></li>
+</ul>
+<h2>Admin Quickguide</h2>
+
+<p><strong>FIXME</strong> we need a guide to getting started as an administrator.  Since this is Beta1, we
+assume that you have <strong>some</strong> history with KnowledgeTree&trade;, so we ask that you start at
+the "<a href="admin-guide-whats-new-in-kt3">what's new for administrators</a>" page.</p>
+OI!  This doesn't work.
+<h2>Help! Something went wrong!</h2>
+
+<p>Our community forums are a good place to ask questions about installing,
+configuring or using KnowledgeTree. Our developers, along with other
+members of the open source community and our partner network, will
+endeavour to answer your questions.</p>
+
+<p>Find the <a href="http://forum.ktdms.com">KnowledgeTree forums</a> online at <a href="http://forum.ktdms.com">forum.ktdms.com</a></p>
+
+<p>You can report bugs in the open source KnowledgeTree server software by
+accessing our online ticketing system. The ticketing system will also
+provide feedback on the status of the issue. You may view issues
+reported by other people and search the system to determine if your
+issue has already been reported.</p>
+
+<p>Access the <a href="http://support.ktdms.com">KnowledgeTree support</a> website online at <a href="http://support.ktdms.com">support.ktdms.com</a>.</p>
+<h2>What is a beta?</h2>
+
+<p>Beta software is pre-production quality software. It is released with
+the intention of providing the software's users with insight into where
+the software feature-set is going for a particular release cycle,
+getting as wide a base of testers for the release as possible and
+gauging the uptake of new features. </p>
+
+<p>The software may not be entirely complete yet and may be buggy. We
+highly value your input and urge you to evaluate the software in a test
+environment. We do however strongly suggest you do not to implement this
+version of KnowledgeTree in a production environment as we can't warrant
+it functioning correctly.</p>
+<h2>KnowledgeTree administrator's Guide</h2>
+<p class="descriptiveText">If this is your first KnowledgeTree installation,
+or if you've just upgraded from KnowledgeTree 2.x, we've put together some information
+which might help you get to grips with the new system.</p>
+
+<div class="ktError"><p class="descriptiveText"><strong>FIXME</strong> This currently doesn't work.</p></div>
+
+<a href="{$rootUrl}/plugin.php/ktcore.userassistance/admin-quickguide">Read the admin introduction.</a> |
+<a href="{$rootUrl}/plugin.php/ktcore.userassistance/admin-guide-whats-new-in-kt3">Find out what's different in <strong>KT 3</strong>.</a> |
+<a href="#">Don't show me this again.</a>
+<h2>Welcome to the KnowledgeTree 3 Beta</h2>
+<p class="descriptiveText">If this is your first KnowledgeTree installation,
+or if you've just upgraded from KnowledgeTree 2.x, we've put together some information
+which might help you get to grips with the new system.</p>
+
+<a href="{$rootUrl}/plugin.php/ktcore.userassistance/kt3b1-what-is-a-beta">What's a Beta?</a> |
+<a href="{$rootUrl}/plugin.php/ktcore.userassistance/kt-bug-reporting-guide">Help!  Something went wrong!</a>
+<h2>Your Checked-out Documents</h2>
+<p class="descriptiveText">Since a document
+which is checked out cannot be modified by anyone else,
+it is important to check them back in as soon as you have made
+the apppriate changes.</p>
+{if (!empty($documents))}
+<dl>
+{foreach item=oNotification from=$notifications}
+{$oNotification->render()}
+{/foreach}
+</dl>
+{else}
+<div class="ktInfo"><p>You have no documents which are currently checked out.</p></div>
+{/if}
 \ No newline at end of file
+<h2>Crash Course in KnowledgeTree</h2>
+<p class="descriptiveText">New to Document Management, or to 
+KnowledgeTree&trade; 3?  We've written some quick documentation</p>
+
+<div class="ktError"><p class="descriptiveText"><strong>FIXME</strong> This currently doesn't work.</p></div>
+
+<a href="#">Take the crash course.</a> |
+<a href="#">Learn about KnowledgeTree 3.</a> |
+<a href="#">Don't show me this again.</a>
 Order deny,allow
 Deny from all
+
+Options +FollowSymlinks