OPEN SOURCE COLLABORATION & INTEGRATION
sales: 1.866.646.3868
solutions
support
partners

User Manual

Table of contents
  1. 1. MindTouch Deki User Manual
  2. 2. Table of Contents
    1. 2.1. Welcome
    2. 2.2. Intuitive and Familiar User Interface
  3. 3. Content Creation
    1. 3.1. Creating a Page
    2. 3.2. Editing a Page
    3. 3.3. Insert Image
    4. 3.4. Insert Extension
    5. 3.5. Create and Insert Templates
      1. 3.5.1. Tips
    6. 3.6. Commenting
    7. 3.7. Content Transformations
    8. 3.8. Linking
    9. 3.9. Multiple Edits - Merge Conflicts
  4. 4. File Attachments
    1. 4.1. Classic File Uploader - Attach File or Image
    2. 4.2. Managing Attachments
    3. 4.3. New Flash Uploader- Attach File or Image
    4. 4.4. Desktop Connector
  5. 5. Managing Content
    1. 5.1. Deleting Pages
    2. 5.2. Delete Files
    3. 5.3. Move Page
    4. 5.4. Move File
    5. 5.5. Reordering the Hierarchy/Display Titles
  6. 6. Content Versioning
    1. 6.1. Page Versioning
    2. 6.2. File Versioning
  7. 7. Search and Discovery
    1. 7.1. Search
    2. 7.2. Linking
    3. 7.3. Hierarchy
    4. 7.4. Chronology
    5. 7.5. User Contributions
    6. 7.6. Watch List
    7. 7.7. Tags
      1. 7.7.1. Display
      2. 7.7.2. Tag types
        1. 7.7.2.1. definition tags (define:)
        2. 7.7.2.2. chronotags (date:)
      3. 7.7.3. Misc notes
  8. 8. Alerts and Notifications
  9. 9. Advanced Access Controls
    1. 9.1. Restrict Pages and Hierarchies
  10. 10. Accessing Deki Root directory
    1. 10.1. SSH
    2. 10.2. SFTP
    3. 10.3. Samba
      1. 10.3.1. If Vista is Host Operating System
  11. 11. Understanding the MindTouch Deki Control Panel
    1. 11.1. Bans
    2. 11.2. Configuration
    3. 11.3. Double Redirects
    4. 11.4. Configuration of FCKeditor
    5. 11.5. Group Management
      1. 11.5.1. Configuring Local Groups
      2. 11.5.2. Configuring External Authentication Groups
      3. 11.5.3. Deleting and Editing Groups
    6. 11.6. Deleted Files
    7. 11.7. Restore
    8. 11.8. Roles management
    9. 11.9. Service Management
      1. 11.9.1. Adding an Extension
    10. 11.10. Site Settings
    11. 11.11. Visual Appearances
      1. 11.11.1. Customize site styles
      2. 11.11.2. Change your styles
      3. 11.11.3. Customize Site HTML
    12. 11.12. Unused Redirects
    13. 11.13. MindTouch Deki Product Activation
    14. 11.14. User Management

MindTouch Deki User Manual

This user manual is an overview of the MindTouch Deki functionality. For more in depth review of functionality review our Developer Center. If you require more assistance with MindTouch Deki, the enterprise edition of MindTouch Deki may be right for you.

If you are having problems viewing the User Manual or would like a local copy, download the PDF version of the User Manual. 

Table of Contents

  1. 1. MindTouch Deki User Manual
  2. 2. Table of Contents
    1. 2.1. Welcome
    2. 2.2. Intuitive and Familiar User Interface
  3. 3. Content Creation
    1. 3.1. Creating a Page
    2. 3.2. Editing a Page
    3. 3.3. Insert Image
    4. 3.4. Insert Extension
    5. 3.5. Create and Insert Templates
      1. 3.5.1. Tips
    6. 3.6. Commenting
    7. 3.7. Content Transformations
    8. 3.8. Linking
    9. 3.9. Multiple Edits - Merge Conflicts
  4. 4. File Attachments
    1. 4.1. Classic File Uploader - Attach File or Image
    2. 4.2. Managing Attachments
    3. 4.3. New Flash Uploader- Attach File or Image
    4. 4.4. Desktop Connector
  5. 5. Managing Content
    1. 5.1. Deleting Pages
    2. 5.2. Delete Files
    3. 5.3. Move Page
    4. 5.4. Move File
    5. 5.5. Reordering the Hierarchy/Display Titles
  6. 6. Content Versioning
    1. 6.1. Page Versioning
    2. 6.2. File Versioning
  7. 7. Search and Discovery
    1. 7.1. Search
    2. 7.2. Linking
    3. 7.3. Hierarchy
    4. 7.4. Chronology
    5. 7.5. User Contributions
    6. 7.6. Watch List
    7. 7.7. Tags
      1. 7.7.1. Display
      2. 7.7.2. Tag types
        1. 7.7.2.1. definition tags (define:)
        2. 7.7.2.2. chronotags (date:)
      3. 7.7.3. Misc notes
  8. 8. Alerts and Notifications
  9. 9. Advanced Access Controls
    1. 9.1. Restrict Pages and Hierarchies
  10. 10. Accessing Deki Root directory
    1. 10.1. SSH
    2. 10.2. SFTP
    3. 10.3. Samba
      1. 10.3.1. If Vista is Host Operating System
  11. 11. Understanding the MindTouch Deki Control Panel
    1. 11.1. Bans
    2. 11.2. Configuration
    3. 11.3. Double Redirects
    4. 11.4. Configuration of FCKeditor
    5. 11.5. Group Management
      1. 11.5.1. Configuring Local Groups
      2. 11.5.2. Configuring External Authentication Groups
      3. 11.5.3. Deleting and Editing Groups
    6. 11.6. Deleted Files
    7. 11.7. Restore
    8. 11.8. Roles management
    9. 11.9. Service Management
      1. 11.9.1. Adding an Extension
    10. 11.10. Site Settings
    11. 11.11. Visual Appearances
      1. 11.11.1. Customize site styles
      2. 11.11.2. Change your styles
      3. 11.11.3. Customize Site HTML
    12. 11.12. Unused Redirects
    13. 11.13. MindTouch Deki Product Activation
    14. 11.14. User Management


Welcome

Congratulations on your decision to deploy MindTouch Deki, the new standard for ease of use, speed and functionality in business wikis! While so easy to use that you can start without any training, this guide will accelerate your learning and point out the many features and benefits of the product. The product is so flexible and rich in features that you will most likely find more uses for it after playing with it for a while. So without out any further delay, let's dive in.

Intuitive and Familiar User Interface

If MindTouch Deki's user interface looks familiar, you're right because it's basically a word processor in a web browser. You get all of the benefits of a lightweight word processor and the properties of a webpage in one package. Thus, any wikipage you or your colleagues have created can be accessed 24/7 via the Internet or internal network. Once you understand this concept, everything in the product will make sense to you.

1.1 Intuitive and Familiar User Interface 1 (3).jpg

Content Creation

When you're using MindTouch Deki, pages are the most fundamental component. Pages are like any other web page, but in this case you can create, edit, and process them in a variety of ways. Let's further investigate all of the operations that one can perform on a page.

Creating a Page

Creating a new page can be done with a single click. On the page toolbar click New page.


2.5 creating a page 1.jpg
Creating a page is just a click away

You have just created a sub-page of the page you were previously viewing. This new page is titled Page Title and you see the editor is already open for you to change the contents of this page. You can now click Save or add the content you desire and then click Save.

Let's assume you were viewing a page titled "Project" and you decide to add a new sub-page. You create a page titled "Jim's Seed Company” and click save. What you just did was create a sub-page, or a child page, to the page titled "Project". This is a hierarchy. We'll discuss this more later.

2.5 creating a page 2.jpg
A sub-page makes it easy to organize information in a logical manner

There is another way to easily create a new page too. If you create a link to a page that doesn't exist you have created a wanted page. This page is denoted by the link being in red text with an underline as you see above. If any user clicks on a link to a wanted page they will browse to the new page and be presented with the editor as if they just created a new page. If the user clicks Save they have just created a new page from the wanted page.

Editing a Page

Browse to the page of interest and click Edit Page on the page toolbar.

2.1 Editing a Page 1.jpg
Page editing is only a click away

You will now see a simple, but very sophisticated rich text (WYSIWYG) editor.

2.1 Editing a Page 2.jpg
The rich text editor has all the features you need to create rich content

Changing the content of the page is as simple as typing your text and clicking Save in the editor's toolbar (top left). This will save your changes and close the editor.

If you wish to create richly formatted text you can do so by changing the text style, color or background color, and much more. There are many options available to you in the editor. If you're using it for the first time explore all the options available to you.


2.1 Editing a Page 3.jpg
2.1 Editing a Page 4.jpg
2.1 Editing a Page 5.jpg
The rich text editor provides you with many ways to style your content

Notice you can edit in full screen mode by selecting the Toggle Full Screen Mode icon. When in full screen editing mode the user only sees the editor. This is more comfortable for some users because it is exactly like the experience in word processors.

2.1 Editing a Page 6.jpg
Full screen mode simplifies the interface

Insert Image

Adding an image to a page is easy. You can insert an image that you've attached to a page or insert an image from external resource. To insert an image first click Edit page then select Insert image from the editor toolbar.

Insert image dialog
Inserting an image is easy

One of the many ways MindTouch Deki stands out is the ability to browse all pages and their contents, just like a word processor. In the insert image dialog box, browse to the location of the image you wish to insert. You browse by double-clicking the pages and navigating the page hierarchy. When you single-click to select an image you will be presented with a preview of the image in the right most pane. When you've selected the image you wish to insert you can then change aspects of how it is inserted. These include alignment and image size.

Insert image 2
Inserting an image is easy

MindTouch Deki also allows you to search the entire site for the image that you want to insert, making it easy to find the right image regardless of location on the wiki. If you want to embed an external image* then you would paste the url in the Link to field and then select Insert image.

*Note: If you're inserting an external image you can provide the URL in the link field. Keep in mind, if the image is removed from this external resource or the address is changed, the inserted image will no longer be viewable.

Insert Extension

MindTouch Deki is a powerful application that not only allows easy collaboration but also allows you to create mashups and integrate with applications and web services. The extensions dialog in the WYSISYG editor gives an intuitive user interface for users to insert the extensions. To get started click on the cog icon in the upper right hand corner of the WYSIWYG editor.

This will open a directory of extensions that you have installed on your Deki. Select the extension that you want to insert and then fill out the appropriate fields. Click insert and the extension will be inserted in your Deki page. On save you will be able to see the extension in fruition.

In the screenshot seen below we have selected to embed an RSS feed in a wiki page. After selecting Atom/RSS Feeds we then choose between the way we want the feed to be displayed, in a table or a list, and finally we copy and paste the feed into the feed field. We can then select Insert Extension to embed the extension in the page. Extensions have varying requirements and setup. Consult the extension documentation to learn more about the specifics of each extension.

Inserting Extensions

Create and Insert Templates

One way of adding content to your wiki while ensuring it abides by certain formatting and layout standards is to use MindTouch Deki Templates.  

To create a template do the following:

  1. Go to Tools -> Templates
  2. Next click New Page
  3. This will create a New Page with the title Template: Page Title, to use it as a template you need to keep the Template: in the title of the page otherwise the system will perceive it as a normal page.
  4. If you'd like to add subpages to the template you can do so by clicking New Page while being on the parent Template: page for your template
  5. Once you create your page(s) you can add content like images, attachments, and dekiscript that will dynamically react to the location of the template or other variables once it is inserted into the main hierarchy.
  6. Once your Template is created you can use it by going to a page and clicking the insert Template button which looks like this: template.png and then selecting the template from the dropdown

Tips

  • You can add subpages with your Templates so that you can insert subtrees
  • Add Dekiscript to dynamically pull in the page name or username to provide a customized experience

**Notes: If you tag pages in a template, those will not be inserted when you select the template. Permissions will also not be inserted if you try to apply them to the Template. Permissions and Tags can be added after the Template is inserted. **

Commenting

To add comments to a page, login and scroll to the bottom of the page. There you can type your comment in the "Add Comment" box and then click Add Comment to have it update and posted to the page.

add comment.jpg
Add a comment to any page

Content Transformations

There is an edit menu item called Transformations or Transform Content depending upon which skin you are using. The purpose of this Transformations or Transform Content menu item is to allow you to attach a Dekiscript function to HTML elements (mostly <pre> elements). The content of these elements is then sent to the extension function for transformation. Content transforms include: syntax highlighting, graphviz graph scripts, mathematical expressions, silverlight, spoiler text, etc.

How are "content transforms" different from regular DekiScript functions? Each content transform is a function, but not each function is a transform. The function has to explicitly declare itself to be a content transform and identify to which HTML elements it's applicable.

You must already have encoded the content to be transformed in a <pre></pre> element. Select the content to be transformed and you will see a dropdown box listing the available transformations in the installation of MindTouch Deki that you are using. Choose the transformation you wish to use, select it and the content will be transformed according to the function which was selected. Selecting "Transformations" or "Transform Content" for items which are not in <pre></pre> elements will result in the display of "No Transformations" in the drop down box and no transformation will be performed.

Creating a new content transform is as easy as registering a new extension in the Services Management Console of the Control Panel.

Here is an example using some php code:

Transformations Menu.png

Highlighting the php code in the <pre></pre> section, select Transformations and choose syntax.Php results in the following:

<?php
/**
 * Smarty plugin
 * @package Smarty
 * @subpackage plugins
 */

/**
 * Get seconds and microseconds
 * @return double
 */
function smarty_core_get_microtime($params, &$smarty)
{
    $mtime = microtime();
    $mtime = explode(" ", $mtime);
    $mtime = (double)($mtime[1]) + (double)($mtime[0]);
    return ($mtime);
}

/* vim: set expandtab: */

?>

Linking

Linking is another way MindTouch Deki excels. Adding links to pages, files, or external resources is pleasantly simple. Click Edit page, highlight the text you wish to link, select Insert/modify link from the editor toolbar.


2.4 linking 1.jpg
Links establish relationships in your content that makes it easier to understand meaning

Browse to the location of the page or file you wish to link by double-clicking. When you see the page or file you wish to link single-click it to select it. Finally, click Update link to commit your change and click Save in the Editor.


Link2
Creating links to pages or files could not be easier

If there is a new version of a linked file, MindTouch Deki will version the file (we'll discuss this more later) and the link will point to the most recent version of the file. Similarly, if a linked page is later moved or renamed, your link will be redirected to the page's new location or name.

MindTouch Deki also allows you to search for the content that you want to link to. To do this select the Search tab at the top of the link window then type the term that you are searching for. This will bring up results for your search that you can easily select and link to.

If you wish to link to an external web page or file simply paste the URL in the link field and click Update link. Any resource external to MindTouch Deki that is moved cannot be found, therefore updated, in the new location.

There are other ways you can make links. If you don't want to use the Create or modify link dialog you can do it with a simple syntax. For example, if you wish to link to a page titled "A Page" type this into the editor: [ [A Page] ] (Note: you must use "[[", where the brackets do not have a space between them) and then Save the page. When the page saves you'll see that you just made a link to the page titled "A Page". Alternatively you can type "A Page" into the editor, select the text, and on your keyboard hold down the control key and the w key, Save. You've just created a link to the page titled "A Page". The same can be done for subpages with [ [A Page/Subpage] ] or "A Page/Subpage".

Whether you're linking to pages or files internal to MindTouch Deki or external ones, do so liberally because links make it easier to understand meaning and relevance of content.

        

Multiple Edits - Merge Conflicts

        

MindTouch Deki has a sophisticated merging engine that will recognize separate changes down to the word and accurately merge the revisions together. This helps with collaboration as there are less chances that if more than one user is editing a page there will be conflicts.

First let’s examine at a high level how MindTouch Deki handles a merge.

Say you have the following set of sentences:

The dog ran along the fence while the boy biked away.
The boy was heading off to college to pursue his lifelong dream of being a developer.

Bob edits the first sentence to read this: The black dog ran along the white fence while the boy biked away.

And Tim edits the second sentence to read: The boy was heading off to college to pursue his lifelong dream of being a baker.

These edits occur at the same time but are saved at different times. Regardless of who started the edit first and who saved first, MindTouch Deki will merge the sentences together to form a comprehensive set of sentences as it is intended:

The black dog ran along the white fence while the boy biked away.
The boy was heading off to college to pursue his lifelong dream of being a baker.

This is also true on a Section and Page level.

Now if Bob and Tim’s edits were to overlap then both edits will still be saved, but the last person to save will have the opportunity to review and compare the edits and confirm that nothing has been lost that should be kept.

Example:

Using the same sentences from above. Bob edits the first sentence to read:

The black duck waddled next to the white fence while the boy biked away.

While Tim edits the first sentence to read:

The black cat walked on top of the white fence while the boy biked away.

Bob saves his changes first which is accepted by the system. Tim saves his changes which is also accepted by the system. The system notices that there is some overlap and notifies Tim that there is a difference between his edit and what Bob had changed along with prompting him to compare versions to see the difference. This allows Tim to review Bob’s changes at a glance. If Bob’s changes need to be reincorporated, Tim can do so by re-edting the page. Otherwise Tim can also chose to leave the page as is.

We have put a lot of work into our conflict merging to ensure that you don’t lose content and to maintain the integrity of edits so that they can be integrated manually by the user as opposed to removing the edit because of a conflict.

        

File Attachments

MindTouch Deki allows users to easily attach files to any page. This is significant because it makes capturing and sharing information quick and easy and the consumption of that information quicker than traditional methods. Let's see how this would work.

Classic File Uploader - Attach File or Image

At the bottom of every page you see a Files section. To the bottom right click Attach file or image.


3.1 attach file or image 1.jpg
Attaching files to a page and adding additional information is an easy to use and powerful way to share information

Now you'll see the Attach file dialog. Click Browse. This opens a dialog that allows you to browse your computer locally for the file(s) you wish to attach. You can select as many files as you like, but you must do so one at a time. Click the + sign to add more rows if you have more than three files you wish to attach. Once you've selected all of the files you wish to attach you may opt to add a Description. When you are satisfied click Upload now.

3.1 attach file or image 2.jpg
You can attach as many files as you like to a page

Wait until your files have uploaded. Depending upon the number of files and their size this can take up to several minutes. After you've completed uploading your files you will be presented with the attached files on the page. Notice you are shown the size of the file, the date it was attached, by whom it was attached, and the attached files' descriptions. An attached image is presented as a thumbnail in the image gallery section.


3.1 attach file or image 3.jpg
Attached images are shown as thumbnails in an image gallery section

If at any point you attach a file with the same name to the same page, MindTouch Deki interprets this as a new version of the file and saves it as a new revision, replacing the old. However, old versions of the file are available by clicking the [+] button next to the file name, allowing you to access and revert to old versions of the file.

Clicking the name of your uploaded files will initiate a download of that file to your desktop. Click on your uploaded pictures and you can browse through them in our lightbox.

3.1 attach file or image 4.jpg


Microsoft Office documents can be previewed too by clicking the preview link next to the attachment. This will open ThinkFree, a web based document viewer. Currently this is setup for view only and any changes made will not be saved back to the wiki or anywhere else.

Managing Attachments

After a file is attached you can move it to another page or change the description by using the file action menu. If you wish to change the description select Actions adjacent to the file in question. Click Edit description to add the description and click Save description. Likewise, if you wish to move a file, select Actions adjacent to the file in question, Move, then using the Move file dialog navigate to the page you wish to move the file.

3.2 Managing Attachments 1.jpg
Attached files can be moved using the File Actions menu

If you wish to delete a file, you may do so by selecting Actions > Delete > Ok.

New Flash Uploader- Attach File or Image

MindTouch has another option for uploading attachments, the new Flash uploader. The Flash uploader gives a progress bar of the upload to Deki along with allowing you to easily upload multiple files at once. By default both the classic uploader and the flash uploader are enabled. To use the flash uploader click Attach File or Image and then select the Flash Uploader tab within the dialog. To see a demo of the flash uploaded click here.

Desktop Connector

The Desktop Connector allows you to drag and drop files and entire folder structures into the wiki. If you drag a folder with subfolders, the folders will be converted to pages in the wiki and attach the files in that folder to the bottom of the page. This is a great tool to use when setting up your Wiki and moving/uploading content.

Managing Content

MindTouch Deki makes it pretty easy to manage pages and files. Here we'll look at how this is done.

Deleting Pages

Browse to the page you wish to delete, click “More” on the page toolbar and then select “Delete.”

4.1 Deleting Pages 1.jpg

Delete Files

Files or images that have been attached to a page can also be deleted. Just like with pages though, an administrator can restore deleted files. To delete a file, scroll to the Files section at the bottom of the page. Click the Actions menu to the right of the attached file or image. Select Delete, confirm the deletion with Ok.

*Note: When you delete a file you will delete all of the versions of that file too. To restore a file you can do so through the Deleted Files page in the Control Panel

Move Page

Browse to the page you wish to move, click “More” on the page toolbar and select “Move.”


4.3 Move Page 1.jpg
When you move a page, you also move that page's sub-pages

A dialog box will prompt you to choose the new destination. You may browse all pages of MindTouch Deki by double-clicking and single-clicking to select. If you move a page, you also move all its sub-pages. When you've selected the page you wish to be the new parent of the page(s) you're moving click Move page.


4.3 Move Page 2.jpg
You can browse all pages of MindTouch Deki in the Move dialog

Move File

You can move a file by selecting the Actions item and then select Move.


4.4_Move_File_1.jpg

Reordering the Hierarchy/Display Titles

MindTouch Deki orders pages according to the url. It also has the ability for the name of the page and how it appears in the hierarchy to be different than the actual url. This gives flexibility to organize the hierarchy according to the url while maintaining user facing friendly titles. To reorder a hierarchy do the following:

If your hierarchy is as follows:

  • Home
    • A
    • B
    • C

Now if you want to move A below C we would move the page by clicking More -> Move and then in the Title field in the Move dialog you would give the page a title that would place it below C, like D. This will only change the URL of the page but still maintain the the Display title. The hierarchy will then show the following:

  • Home
    • B
    • C
    • A

The url for A is now http://yourwiki/D but it is displayed as A on the Page Title and in the hierarchy.

        

Content Versioning

We have discussed how easy it is to create and edit a page and you've seen how easy it is to attach a file or image. Now let's take a look at another easy to use, but very powerful, feature of MindTouch Deki: versioning.

Page Versioning

Whenever you edit a page you are creating a new version of that page. Every version of every page is retained as part of MindTouch Deki's audit log, as is the person who edited the page, and the date and time that it was edited. To view any page's history, select the link that dynamically tells you the last time the page was modified (located in the page information box to the top right of the page). Let's look at a page's history and see how easy it is to revert a page to a previous version. Click the last modified date on a page.

Page Versioning
A page's history is just one click away

You are presented with the history of the page. You can see when it was edited and by whom. You can also walk backward in time and view each version individually.

1 Page Versioning 2.jpg
Every edit on every page is retained and acts as an audit trail

Or you can view a comparison between two pages by clicking Revision comparison, which will present you the differences between these two page versions.

5.1 Page Versioning 3.jpg
Comparing versions of a page is as easy as it is to revert to an older version

Finally, you can Revert to the older of these two versions by clicking the button.

File Versioning

If you attach a file with the same name to the same page more than once you are creating a new version of this file. MindTouch Deki by default retains every version of the file and the links that point to it. MindTouch Deki always point to the most recent version of the file. You'll know there is another file if you see a plus icon adjacent to the file.


2 File Versioning 1.jpg
Attached files are automatically versioned

If you wish to view every version of a given file click the [+] sign adjacent to the file in question. You'll be presented with every version of this file attached to the page you're viewing. You can also see each version's original file details.

2 File Versioning 2.jpg
Page links to files always point to the most recent version of the file

Search and Discovery

We've seen how easy it is to capture information and files in MindTouch Deki. Now let's take a look at how easy it is to organize information so anyone can find and discover useful content that has been contributed.

Search

Searching is as easy as providing your query in the search field at the top left of MindTouch Deki. Your result set can include pages, the contents of many types of attached files, and the descriptions of files and images. When you're presented with your result set those that rank at the top are determined by relevance and how recent they are. You can view only pages, only files, or only images if you wish to narrow the result set.

Linking

A great way to organize content is by linking. When you create links to pages or files you're creating relationships in the content that make it easier for users to understand and establish relevance. This is one of many ways MindTouch Deki excels. It is really easy to link pages and files, making it really easy to see how content relates. When these relationships in data are established, it makes it very easy to consume the information. This allows users to understand if and how something is relevant to them and their work.

Hierarchy

MindTouch Deki provides a flexible means of organizing pages hierarchically. The hierarchy is created by adding New Pages. To add a subpage, select the page that you want as the parent and then click New Page. This will help segment out the information in your wiki along with allowing easy navigation of your content.

Chronology

How recent information is often impacts how important or relevant it is. With MindTouch Deki there are many ways to determine how current content is. The most obvious way is to look at the top right of a page at the page information bar. This tells you when the page was last modified. For files and images you can see how recently they were attached as well by reviewing the date and time stamp.

6.4 Chronology 1.jpg
6.4 Chronology 2.jpg
Quickly see how recently content was added or modified

You can also look at a page's history by selecting Recent Changes from the menu bar. This give you a global view of which pages have been edited or had files attached, and by whom, in order of newest to oldest. This is a commonly used method of tracking what's going on in an organization and is a powerful discovery tool. At a glance you can see what your colleagues are working on and quickly realize if there is content you can benefit from.

User Contributions

In Recent Changes you can also elect to see changes on a per user basis in order of newest to oldest. To do this, select the user whose contributions you wish to see from the drop down menu at the top of the page. You may then walk backward in time through these contributions using the Next 100 >> control at the top and bottom of the table that contains the contributions.

By reviewing other users' contributions chronologically you are able to very quickly find information that can benefit you. For example, if you are working on a project and know a colleague has experience that could benefit you from their work months ago you can quickly find that information. Or, in the event you’re new to a position you can quickly get up to speed by reusing established content.

Watch List

Every user is able to create a list of watched pages. Then they can see whenever changes are made to these pages. This is useful in monitoring projects or topics of interest. To add a page to your watch list, click More from the page tool bar.

6.6 Watch List 1.jpg
Adding a page to your watch list is easy

To review your watched pages click Tools, then Watched Pages. This shows you all the pages you are watching, when they were last modified, and by whom. This is a great way to discover information and topics of interest. To monitor your WatchList, Select Tools -> RSS Feeds -> then select the Watchlist link next to your name. You can then put this RSS feed into your favorite reader.

Tags

Tags are added to a page through the "Tags" option under the "More" menu:

/tagging.png

The tags dialog accepts all text, with the condition of each tag being on its own line. Tags are automatically stripped of HTML tags, trimmed of whitespace (extra spaces before and after the tags are removed), and are converted to lowercase characters for visual consistency.

Display

The tag list appears after a page's contents if tags exist for a page. Tags are sorted first by tag types, with define: and date: types taking precedence over "normal" (no special types) tags. Each tag links to the tag explorer view, which provides a list of all pages with the same tag - this allows for discoverability of related pages outside of the hierarchical structure of Deki.

tagging output

  1. An example of a defined tag ("define:dekiwiki") - any page which has this tag now links to this page
  2. An example of a chronotag - converted to a consistency user-friendly output format
  3. Since this page has defined dekiwiki, it has a list of Related Pages, which is a list of all pages which are tagged "dekiwiki"

Tag types

There are two special classes of tags: define and date. Tags which are prefixed with these two types become assigned to these special types (for example, "define:tagging" would be input into the dialog to create a "tagging" define tag).

definition tags (define:)

define takes ownership of a tag; all references to that tag in other pages automatically link to the page which holds the definition of the tag instead of the explorer view. The page which holds the define tag also displays a "Related Pages" list, which contains a list of pages which contain the defined tag. Only one page may hold the definition for a tag, but one page can have multiple defined tags.

chronotags (date:)

date are tags which are associated specifically with a date. The input form accepts most natural language inputs: date:now, date:tomorrow, date:2007/08/13, date:January 12th, 2005. Clicking a chronotag link exposes an events view. Much like the explorer view, the events view displays all pages with the same date, but it also allows the selection of a dates to display all pages that fall within a range of dates. Sometimes the natural language processor will fail to convert your input into a date (example: "date:oaiwjeoifajf") - in that case, the whole tag is treated as a normal-class of tags.

Misc notes

Tags are indexed by the search engine and appear on the recent changes log when updated.

Alerts and Notifications

In addition to the web interfaces for content changes, watch lists, and user contributions, MindTouch Deki provides a plethora of feeds that can be consumed by any RSS reader. To access the RSS feeds select Tools then RSS feeds. To subscribe to the feed simply right-click (option click on Mac) the link to the feed you wish to subscribe to and select Copy Link Location (in Firefox) or Copy Shortcut (in IE). Then launch your RSS reader and paste the URL to the feed.

If you aren't sure what RSS is, it's a way for you to be notified of changes on webpages of interest and be provided with these changes. To really understand this, you should probably run an Internet search for "What is RSS" and you'll find many resources to explain this further. If you don't have an RSS reader, don't worry because there are dozens of free RSS readers you can download and install.

Advanced Access Controls

There are many ways to grant access to Deki including integration with a current authentication server, HTTP authentication against the Web Server, or using Deki's Authentication Settings.

  • LDAP
  • HTTP
  • Internal Auth

Restrict Pages and Hierarchies

Any user can easily restrict access to a page and subpages. To do this, select the More menu from the page bar and select Restrict access.

8.1 Restrict Pages and Hierarchies.jpg
The More menu (found on the page bar) expanded to show the Restrict access control

Then select the users or groups (using control or Apple key to select multiple users or groups) and level of permissions you wish to give them. Finally, select Restrict access.

8.1 Restrict Pages and Hierarchies 2.jpg
The Restrict access dialog allows you to change who can edit or view a given page

Any sub-page of the page just restricted will inherit the permissions of this page if you select the Apply these permission changes to all children pages. If you want to restrict a single page/sub-page you can do so by doing the above and making sure that the Apply these permission changes to all children pages isn't checked.
Note: Administrators override all page permissions, meaning they have access to all pages regardless of the page's restrictions. Be very careful to whom you grant administrator access.

Accessing Deki Root directory

Below are different ways to access the root directory of Deki to make changes to the system and to transfer files in/out. This is intended for Advanced users or users with a support plan.

SSH

If you'd like to enable SSH on Deki, do the following:

  1. Open the VMWare console
  2. Log in with your root login and password
  3. Modify your ssh config as follows: nano /etc/ssh/sshd_config
  4. Then change this value: PermitRootLogin no to: PermitRootLogin yes
  5. Hit Control-X to exit and "Y" to save
  6. restart ssh: /etc/init.d/ssh restart
  7. modify your firewall rules to allow external access using TCP port 22

SFTP

Once SSH is enabled you will be able to access your Deki via SFTP which is Secure File Transfer Protocol. In order to access your Deki via SFTP you need to have an SFTP client like FileZilla.

Samba

When you are customizing Deki you'll want to be able to easily drag and drop files from your windows environment into the root directory to apply changes. In order to integrate the Deki with Explorer you need to use Samba, which comes installed on the Deki WM. More information about Samba can be found at Wikipedia and the official Samba website.

Here is how you configure Samba:

  1. Log in as the root user.
  2. Create the user that you want to use to login into Deki:
    useradd yourusername
  3. Create a Samba password for the user: 
    smbpasswd -a yourusername

    NOTE: if you want to use the root password then yourusername=root and use the same password that you have for your root password account.
  4. Update the Samba configuration file (/etc/samba/smb.conf):
    workgroup = WORKGROUP (replace by your Windows value) 
# File creation mask is set to 0700 for security reasons. If you want to 
# create files with group=rw permissions, set next parameter to 0775. 
create mask = 0644 
# Directory creation mask is set to 0700 for security reasons. If you want to 
# create dirs. with group=rw permissions, set next parameter to 0775. 
directory mask = 0775 
[MyWWW] 
comment = Deki /var/www folder 
path = /var/www 
public = yes 
writeable = yes 
read only = no 
valid users = yourusername 
create mode = 0666

    Note for users not familiar with the smb.conf file: the directory mask and create mask lines exist in the default smb.conf file, and they must be modified. The [MyWWW] section does not. Add the [MyWWW] section at the very end of the smb.conf file to make sure that you are not interrupting another already existing section.

    If you want to connect as the root user, make sure to comment the following line like this:

    ;invalid users = root
  5. Restart Samba: /etc/init.d/samba restart

If Vista is Host Operating System

If Vista is your Host operating system that VM Player is running on then you'll want to update Samba to the most recent version to avoid a glitch that slows transfer to a trickle. Run the following code to update Samba:

apt-get install samba samba-common samba-client

    

Understanding the MindTouch Deki Control Panel

=Understanding_the_MindTouch_Deki_Control_Panel.png?revision=1

Above is the default MindTouch Deki Control Panel for releases before Kilen Woods 8.08. To see the default Control Panel for Kilen Woods and later look at the documentation(link to new cp)

Bans

=Bans.png?revision=1

Bans allow you to block users from logging into your MindTouch Deki install by banning their username or the IP address that they are accessing your MindTouch Deki from. To ban a user do the following:

  1. Select the ban type from the dropdown. You can ban a user by IP or Username
  2. Once you have selected what type of ban to add, add the username or IP address. The username will be case sensitive, and the IP address will be formatted like this: 192.168.1.1
  3. Next select the duration of the ban. It can be as short as 1 day and as long as Forever. Note: You can always delete a ban if you made it for too long or made a mistake.
  4. Add a reason for the ban so that you don't forget the reasoning behind it.
  5. Click Save and the user will then be added to your list of bans.
=media_1218499062187.png?revision=1

Once you click Save, the user will then appear below the ban form and will give you details about the banned user. In the case above, the user was banned by their IP on Aug 11 2008 with a duration of forever. The user was banned by the Admin and the reason was because they vandalized the front page. As stated above you can always edit or delete any ban by selecting it and then clicking the Edit link or clicking the "delete selected bans" button.

Configuration

=Configuration.png?revision=1

The Configuration page in the Control Panel allows you to make changes to the MySQL config table through an interface. Any changes to the Configuration values should be made with caution and only by the Admin. Here is an explanation of all of the configuration settings:

  1. Default id
  2. Enable caching of pages to reduce database calls. (default: false)
  3. Enable caching of permissions to reduce database calls. (default: false)
  4. Enable caching of permission roles to reduce database calls. (default: false)
  5. Enable caching of authentication providers and extensions to reduce database calls. (default: false)
  6. Enable caching of user data to reduce database calls. (default: false)
  7. Whether or not to remove potentially unsafe html tags
  8. Unallowed extensions as file attachments
  9. File extensions that will generate image previews
  10.  Maximum image size for preview generation (setting this value too high may choke your memory usage)
  11. Max file size for any attachment being attached to MindTouch Deki
  12. To enable Multi Lingual support in MindTouch Deki add the appropriate Language acronyms here, see the User Manual for details on configuration and use of Multi Lingual
  13. Username to associate with the main Administrator in case the Administrator uses a different username than Admin
  14. Allowing Anonymous account creation will add a link on the Login Page that will allow anyone visiting the site to create an account, make sure you look at point 16 to ensure you have the proper role assigned if this is enabled
  15. Length of Cookie expiration, used to managed logged in users session length before requiring additional login
  16. Default user role that is assigned to newly created users through the web registration form
  17. This is the location of your attachments within the
  18. Default storage type
  19. Google Analytics key, Manage through Site Settings
  20. Current user interface language, Manage through Site Settings
  21. Site Name of your MindTouch Deki install, Manage through Site Settings
  22. Current Skin that is being used by MindTouch Deki, Manage this through Visual Appearances
  23. Current Template that is being used by MindTouch Deki, Manage this through Visual Appearances
  24. Name of the MySQL catalog that MindTouch Deki uses for storage
  25. Default database options
  26. Default port to access the MySQL database
  27. MySQL Server Name
  28. Default user that MindTouch Deki uses to access MySQL
  29. MySQL Server Host

          

Double Redirects

=Double_Redirects.png?revision=1

The Double Redirects management screen allows you to remove double redirects within the system. A double redirect occurs when a page is moved twice so that when you go to the original link it will redirect you to the final page. When managing these, make sure that the double redirect is not being referenced anywhere before you remove it.

Configuration of FCKeditor

=Configuration_of_FCKeditor.png?revision=1

The Configuration of the FCKeditor screen allows you to add/remove functionality of the default MindTouch Deki editor which is FCKeditor

Group Management

=Group_Management.png?revision=1

To add a group into MindTouch enter the group(s) name(s) in the text box separated with semicolons. If you integrate with any external authentication services then the group name needs to be exactly the same as the group name in the external authentication service.

=media_1218829378618.png?revision=1
  1. Choose the access level that you want for the Group (Access levels are defined through the Roles Screen)
  2. Select the Service that you want to associate the group with. C
  3. Click add groups.

Configuring Local Groups

=Configuring_Local_Groups.png?revision=1

To configure Local groups click on the Edit Users.

=media_1218830370949.png?revision=1

Now select from the your desired users from the Available users list and click the Left arrow highlighted above (#1) to add the users to the group. Once you have selected all of the users that you want in the group select the update group (#2). To remove users from a group click on the selected user(s) in the Group users column and then click the right arrow button. Note: only local users can be added to local groups.

Configuring External Authentication Groups

When you add an External Authentication Group, the users are automatically associated with that group. When the user logs in to MindTouch Deki it will check what groups it is a part of and will apply permissions accordingly.

Deleting and Editing Groups

=Deleting_and_Editing_Groups.png?revision=1

To delete a group, select the group you want to delete, make sure that Delete is selected in the Drop Down, and click the right arrow.
To edit a group, follow the same steps for deleting except select Edit in the dropdown.

Deleted Files

=Deleted_Files.png?revision=1

Whenever a file is deleted on a Deki page, it will go into the Deleted files queue waiting for the Admin to approve it to be deleted or restored if it was accidently removed. To restore file(s), select the file(s) and then click the restore files button. To delete them, select the files you want to delete and then click the delete permanently button.

Restore

=Restore.png?revision=1

The Restore screen allows you to restore pages that have been deleted in the system. If you have a lot of deleted pages you can search for the pages that you want to restore.

Roles management

=Roles_management.png?revision=1

Role Management allows you to specify the Roles for users and Groups. Each Role has the following role attribute that can be applied to a Role:

LOGIN
The Login Attribute stipulates if a user is able to login when they reach the site. This, with READ, are the most fundamental of roles.

BROWSE
The BROWSE Attribute stipulates if a user is able to browse the hierarchy or discover content within the wiki via search.

READ
The READ Attribute stipulates if a user is able to view a page, comments, or attachments.

SUBSCRIBE
The Subscribe Attribute stipulates if a user is able to subscribe to the RSS feeds of the system which will show pages changes.

UPDATE
The UPDATE Attribute stipulates if a user is able to make changes to a page or attach files in the wiki.

CREATE
The CREATE Attribute stipulates if a user is able to create a New Page within the wiki.

DELETE
The DELETE Attribute stipulates if a user is able to Delete an existing page within the wiki.

CHANGE PERMISSIONS
The CHANGE PERMISSIONS Attribute stipulates if a user is able to Change or Add Permissions of a page.

CONTROL PANEL
The CONTROL PANEL Attribute stipulates if a user has access to the Control Panel - This should only be accessible to the Admins of the wiki, use sparingly.

UNSAFE CONTENT
The UNSAFE CONTENT Attribute stipulates whether or not a user is able to add unsafe scripts or HTML into a wiki page without it being stripped out. If you want the users to be able to add Unsafe Content then take a look at adding an extension for it.

ADMIN
The ADMIN Attribute stipulates if a user has Admin privileges which overrides all other permissions and restrictions. Use sparingly.

           

If you want to add a new Role, give it a name and then select the roles that will be associated with it. You can also manage the default role that a newly created user is assigned with.

Service Management

=Service_Management.png?revision=1

Service Management allows you to add Deki extensions that integrate with external applications, services, and external authentication. By default the following extensions come pre-installed on Deki:

  • RSS/Atom Reader
  • Digg
  • Flickr
  • Gabbly
  • Multimedia
  • WidgetBox
  • Windows Live
  • Syntax Highlighter

Adding an Extension

=Adding_an_Extension.png?revision=1

To add an extension click the Local link

=media_1218842337210.png?revision=1
  1. The first step of adding an extension is to select whether it is an Authentication service or an Extension. An Authentication service allows you to integrate with external authentication providers like LDAP, AD, and more. Extension allows you to add integration with external applications and web services.
  2. Once you select the correct service, give it a name in the Description field. This will be what the service is referenced as in the list of extensions.
  3. SID is a string that is associated with the extension that is included in the installation documentation for the extension.
  4. Config are various values that are required by extensions in order to work. These too are referenced in the install documentation.
  5. Preferences are also values, like parameters, that the extension will need. This is included in the install documentation.
  6. By default the status of the extension is set to Enabled. If you are not ready to go live with the extension just yet then you can select Disabled.
  7. The "Make default" option is unique to Authentication services and will make it the default authentication service on the login page. If you enable this you will see that the radio button will be selected next to this service on the login page.
  8. Once you have all of the required information included in the form, click the add service button and your service will be enabled in MindTouch Deki and will be visible in the Insert Extension Dialog.

Site Settings

=Site_Settings.png?revision=1

  1. Set the Site Language allows you to change the localization of MindTouch Deki. MindTouch Deki currently supports over 15 Languages.
  2. The Site Name is the name that will appear at the top of your MindTouch Deki hierarchy and in the Header of the browser.
  3. Rebuild Search Index allows you to rescan your MindTouch Deki Site and update your Search index.
  4. Allow anonymous account creation adds a "Register" link to the site along with a "Create Account" link on the Login Page which allows any visitor to your site to create an account on the site. Make sure you look at the Default Role for newly created users which is an option under Roles.
  5. Disable Searching will turn off the search indexing which will not allow you to search any content on the wiki.
  6. Use content distribution networks for Javascript libraries helps increase the speed of javascript based content by using distributed libraries.
  7. If you want to add analytics quickly to your MindTouch Deki site you can do so by pasting your account ID in the text field.

Visual Appearances

=Visual_Appearances.png?revision=1

Visual appearances allows you to change the skinning and templating look for your MindTouch Deki install. To start select a Site logo by clicking Browse and selecting a logo from your local hard drive. Click upload specified logo. Note that the logo will be scaled down to 500 x 50.

Customize site styles

=Customize_site_styles.png?revision=1

Customize site styles allows you to override the CSS of the skin and of the content. The content is defined as the content on a wiki page, i.e. anything that is editable by the WYSIYWYG editor. The template CSS is the actual skin of the wiki, i.e. anything outside of the editable WYSIWYG area.

Change your styles

=Change_your_styles.png?revision=1

Changing the styles allows you to add a new look and feel to your wiki. If you add any custom templates/skins they will show up here to be activated by the admin.

Customize Site HTML

=Customize_Site_HTML.png?revision=1

Customizing the site HTML gives you more control over areas of the skin/template. To customize the HTML areas, add HTML content in any of the boxes and then click the customize site html button. The areas are defined as follows:

=168.2.4.png?revision=1
  1. HTML Section 1 is helpful for adding a custom header to the site to give your wiki a custom look.
  2. HTML Section 2 is good to add an extra link/button/image to spice up the side.
  3. HTML Section 3 is a good block to add content like RSS feeds or widgets.
  4. HTML Section 4 is a great place to add Google Adsense as it will be visible on everypage and will be inline with the content. Also a good spot for information relavent to the content.
  5. HTML Section 5 is a block that you can add copyright notices, privacy policy links, and any other verbiage that is best places in the footer.
  6. HTML Section 6 is good for Analytics and tracking code as this is right before the end of the body of the site.

Unused Redirects

=Unused_Redirects.png?revision=1

Unused redirects is the management screen for pages that have been moved once as well as their respective redirect. It is recommended to confirm that the redirect isn't being used any more before deleting it. To delete a redirect, select it by checking the checkbox next to its name. Then at the top click the Delete All Selected link.

MindTouch Deki Product Activation

=MindTouch_Deki_Product_Activation.png?revision=1

The MindTouch Deki Product Avtivation screen allows you to easily activate your MindTouch Deki Enterprise edition. If you purchase a MindTouch Deki Enterprise license, navigate to this screen, copy the API Key and send it to support. Support will then email you back your MindTouch Deki Enterprise ID which you will copy into the MindTouch Deki Enterprise ID field and then click upgrade. If you would like to get a MindTouch Deki Enterprise ID, contact a MindTouch Sales Representative with the information above.

User Management

=User_Management.png?revision=1

The User management page allows you to Add, Edit, and Deactivate users in MindTouch Deki. To add a user do the following:

  1. Select the service that the user belongs to. By default the service will be Local. If you are adding users through an External Authentication service, you'll need to add them through the External Auth interface as opposed to MindTouch Deki's interface.
  2. Add a username for the user. Note: This will be a visible username to all users on the wiki so it is best not to use private information such as an email address.
  3. Add the email address of the new user so that they can receive system notifications including their new login credentials.
  4. If you don't type, and verify, a password for the user then the system will automatically generate one for them and send it to them in an email
  5. Verify the password here (or leave it blank as in step #4 to have an automatically generated one).
  6. Specify the role that you want this user to have - See Role Management for more details on what roles are available.
  7. Click add user. The user will then be email their login credentials and they will be listed in the User Management list below this form.

If you want to add multiple users faster, click the Create multiple users link:

=media_1219029660413.png?revision=1

Once users are added, you will be able to Edit or Deactivate them. Note: Users aren't Deleted from the system when you click Deactivate, as this would lose all version history associated with that user along with other content on their User Page. To Edit or Deactivate a user click the checkbox next to the user and then select either Edit or Deactivate and then click the right arrow. The Search field and the Filter field help narrow down the users for editing/deactivating in a large user base.

         

Powered by MindTouch Deki Enterprise Edition v.8.08 RC1