Information management withFreeplane add-on dView(indexfile)

From Freeplane - free mind mapping and knowledge management software
Revision as of 19:54, 26 January 2014 by Jokro (talk | contribs) (Basic dashboard)

Introduction

The add-on IndexFile can copy a folder structure directly into a Freeplane mindmap creating a dashboard with hyperlinks to folders and documents. Folders canto be given a meaning of organisation, theme, dossier, meeting or personal environment by putting an IndexFile of the appropriate index file-type into it. In the index hierarchy generated, an icon is automatically added to each node depict its meaning. Metadata can be added to an index file to describe its content for interpreting the folder's meaning, knowing its confidentiality and decisions to keep or dstroy it. A user may register his e-mail in an index file creating the opportunity to send an e-mail to all registered users at once. The folder hierarchy may be virtually extended with folders at a different location, also if the location itself needs access rights. Filenames can be automatically edited to comply to the structure of the NATO file naming standard. Filenames can be automatically extended with metadata so that filenames keep unique if documents are displaced and combined in a general eDepot or eShare. The following describes use cases for index files.


Basic dashboard

<fig 1> Each dashboard has a node called Index or Archive. When the litte button of this node is clicked, a hierarchy of files, folders and (other) dashboards is generated which corresponds to the content of the current folder. Each generated node contains a link to open the folder or file it represents. In this way the dashboard can be used to navigate to information in an easy and fast way, especially if used in combination with Freeplane's find and filter methods.

A basic dashboard has folders and files as its main content. Folders and files at the first hierarchical level are displayed on top of node Index, to make them readily available. They can be annotated with details and child nodes. Dashboards remain inside node Index and can be made visible by unfolding.
It is possible to exclude folders with irrelavant information, or stop indexing at a particular folder name, depth or number of files. Finally, indexing generates management information such as number of files, folders and dashboards.

Folder dashboard

A folders dashboard is a limited version of a Basic dashboard. Indexing generates only folders and other dashboards, not files. Also annotating is not standard. As a result indexing is faster than with the other dashboards. A folder dashboard can be suited when discussing and improving a folder structure, or when developing a new structure from scratch.

Fig 2. has been generated by storing an index file of type Folder into the main folder. Next the little button of node Index was pressed which ceated the subnodes of Index. If a child node of node Index contains an icon other than the folder icon, this depicts that this folder contains a index file of a particular type (organisation, person, theme, dossier or meeting). Below we will discuss these types.

If you have Freeplane installed, you may click here to open an interactive version of the figures on the right.

Dossier dashboard

Fig.3a Dossier template

Dashboard Dossier extends the Basic dashboard with nodes for management information and use.

Figure 3a shows that in node Management you can put information like the name of the organisation, the email address of the owner (information manager) and status information. This information can subsequently be used to automatically add metadata to document names according to e.g. the NATO statndard for file names. Or by clicking the owner's email icon, you can automatically open an email with the email adress of the owner filled in.
In node Users main users and passers by can register their e-mail addresses. Next all registered users can be send a common email by clicking the email icon in node Users. Of course one can add process information for visitors of the dossier, for example in floating nodes which behave like sticky ntes.
Node Favorites is meant for keeping links to documents, applications or whatever is important to have at hand when using the dossier. Finally, you could support new users by summarizing the goal of the dossier and adding links to e.g. the three most relevant documents.


Meeting dashboard

A meeting is a specialisation of a dossier. A meeting folder has years as subfolders and contains subsubfolders with the month and day of a meeting, see Fig.4. The documents of the meeting are contained in the subsubfolders. The index of of its indexfile is called Archive. In addition it has a node Meeting above the Index node. If the small button of the Meeting node is clicked, the Archive node unfolds to show the subsubfolder of the most recent meeting, see Fig.4. It makes sense to use standard, short document names like Agenda and Minutes. In that case freeplane filtering can be used to display e.g. (only) all Agenda documents.

Organizing dossiers and meetings in themes

Basically a theme can be used as a container for dossiers and/or meetings, see Figure 5. If the little button of node Index is pressed, available dossiers and meetings are displayed above node Index. Note in Fig. 5 that these nodes do not have children. This is because dossier- and meeting nodes link directly to their resp. index files. That is they open the dossier/meeting dashboard.

A difference between a dossier and a theme dossier might be that the owner of a dossier could be held responsible for the documents contained in the dossier subfolders, while the owner of the theme could be held responsible for the metadata of the theme index file only. Practically a theme is implemented as a dossier with a different icon, so both could be used interchangeably. Like a dossier, a theme can have subthemes.

Organization dashboard

Dashboard organisation implements a dashboard for displaying an organisation with suborganisations, themes, dossiers and meetings. A typical suborganisation is the staff, in which each member could have a personal folder.

When the Index node is clicked, suborganisations, themes, dossiers and meetings are displayed above the Index node, see Fig. 6. Again these items do not have children because the links directly open the resp. dashboards.


Personal dashboard

In general each staff memeber needs a folder/dashboard with handy access to all information needed in dayly work. This folder would contain work in progress not ready to be shared and shortcuts to relevant dossiers and meetings. It could contain favourite hyperlinks to other information or programs too. In this way the staff member can do all his work from his personal folder. The Person dashboard provides a dashboard view for this, see Fig. 7. N.B. It is important to know the user can choose to work from the personal folder only or also use his personal dashboard.


Virtual external folders

In Fig.7 node Dossier1 displays a second icon signalling that it links to folder whic could be outside the folderhierarchy, on a different disk internet or intranet. The link is created from a shorcut which is dragged to e,g, the personal folder. To be depicted as an index file the shortcut must have a name which is compliant with the name of an index file. Note that a shortcut to an intranet/internet address can be made by dragging the icon in the browser's address field to the folder you want it to be.

Annotating generated nodes

Fig.8 Children of dashboard node

When indexing, nodes with links to files, folders and dashboard are generated. The first level of generated nodes can have annotations: you can add node details, notes and child nodes which are kept when the index is refreshed. Also one can drag and drop files and folders from the linked object, e.g. a dashboard, on top of the generated node. This creates shortcut links to folders of the linked dashboard, which are displayed as child nodes of the dashboard node, see Fig 8 - the nodes with red arrow. In this way one can jump directly to a particular location inside the linked dashboard. To annotate the other generated (grandchild) nodes, these nodes can be dragged to a place outside the Index refresh area, e.g. Favourites.

Editing file names

Fig.9 Edit file name

When using a dashboard each node with a document link contains a small button. If you press it a context menu of button nodes is displayed. It shows that you can edit the file name, add metadata, or delete the file, see Fig.9. (N.B. These are the only functions of IndexFile which have impact on the files of your folders.)




Making a unique, short file name

Fig.10 Unique file name

If documents are kept within a hierarchy and with index files containing contextual information, document titles can be short indeed. If you would move a document without this context to a different surrounding, its meaning might get lost and there there may be name clashes. In situations like this you can automatically add basic metadata by pressing button Add metadata dossier in Fig. 10. Fig 12. shows that three metadata are added: the name of the dossier, the year of the dossier and the (sub)organisation owning the dossier. All this information is taken automatically from the current index file. If necessary you can edit these data as described for Nato metadata.

Complying to NATO filenaming convention

Fig.11 Nato convention

If you click the button node Add metadata Nato, a date and a classification are added. In Fig.11 the date is taken from the date the document was last modified. The classification "N" is taken from the field classification in the Management node. In this case the management node contains N which means No classification. You can edit the date and classification in the node text and then press button node Rename file to apply it to the real file.


Creating dashboard names

An index file which is saved with its template name, e.g. (i)_dosier, will not be shown in the generated index. To make these files appear in the Index hierarchy it can be renamed into a dashboard name. An example dashboard name for a dossier is:

  • (i)_myDossier(2014--ING-finance)_D

With this name it will appear in the index hiearchy of an index file higher in the folder structure with the icon for dossier (D).

Each time the small button of node Index is clicked, the default dashboard name is added to the clipboard. If you save the Index file and press Ctrl-V (paste), this name is automatically added as a new file name.

The metadata in the dashboard name are useful to find the dashboard, even if a the containg folder is moved to a different location. Once the dashboard is found, also the documents can be navigated to. This is why the documents themselves don't need to have metatdata and can have a short title as a file name.

N.B. In a multilingual environment is possible to have a dashboards for different languages in the same folder. In that case the dashboard name is extended with a (Freeplane) language code, e.g.:

  • (i)_myDossier(2014--ING-finance)_nl-D

In preferences this multilangual option can be set. Whenset the language code is automatically added.

Using IndexFile with Microsoft Sharepoint

Sharepoint uses open and closed libraries to store folders and files which can be accessed with read only or write access rights. The add-on can be used to index these libraries too. Folders with dashboard files could be moved to a Sharepoint library and work there if opened with write access rights. In case of read-only rights, Sharepoint opens a file in a Temporary folder, not in the original environment where the file is stored. This means that relative hyperlinks in Freeplane do not work. A Freeplane preference can be set to save links as absolute hyperlinks. When set, Once saved, these hyperlinks also work in the Temporary environment with read-only rights. Simarly a preference can be set an attribute is set with to the original directory. In that way the index can be refreshed even whne in themporary environment with read-only rghts.

Preferences

Fig.12 Preferences

IndeFile comes with a large number of options which can be set by the user. As an example, the number of files and/or the depth of the folder hierarchie can be preset to some value. This is useful in situations with an unknown, big number of files. For more information, see menu diView (IndexFile) > Help.


Menu diView

Fig.13 Menu IndexFile

When the add-on is installed, menu di-View is added to menu Tools. Here you can select the diView Help or one of the templates for Organisation, Dossier etc. Help describes how to implement the use cases described above. If the add-on is not installed, you can still use dashboards created by another user, as they are mind maps. Special functions like refreshing the Index and triggering a group mail are not active however.



Translations

At present IndexFile is available for English and Dutch. Menu IndexFile > Help contains instructions how you can translate menu's, templates and the Help file to other languages.

Installation and Help

There is a map with Online help. To use it, Freeplane must be installed. If you have installed the add-on this Help is available from menu Tools > diView too. Go to downloadpage Indexfile to download and install add-on diView (IndexFile).


If you have installed Freeplane you may click here to open an interactive version of the figures on the right, which you can fold or follow hyperlinks. You don't have to install the add-on for this.

N.B.1 The examples were saved with releative hyperlinks for indexing, to make sure the links work with the freeplane server as well. Yet, the Index button doesn't work with these examples either when the add-on is installed. You need write-rights for this.
N.B. 2. The example does work with Sharepoint in read-only mode. Sharepoint opens a temporary environment where the mind map is opened and can be written, without accessing the original location.