Surfulater - What's New


Surfulater& Surfulater - What's New17 Jul 2008 07:09 pm

As mentioned a few posts back we have a shiny new Surfulater pre-release available for you to take for spin.

The focus of this release is the new  Tags dialog, which I blogged about in Tags - we need your help. Part 1.  Avi has written several follow on posts: Tags and Whitespace - more feedback requested, Tag Management Part III - adding new tags (I’m not sure what happened to Part II) and Tag Management - Live Example Page

We’ve received a lot of great feedback, which we thank you very much for. And we look forward to more.

After weighing things up we’ve settled on using the combined Add and Remove Tags dialog implementation I presented in Part 1, with a change to the Keep column, making it Remove, as suggested by Craig Prichard.

Avi has put together a sample presenting various alternate combinations (18 I think he said) in his Tag Management - Live Example Page post. Do comment on these.

In case you haven’t been following the recent flurry of recent articles, the new  Add and Remove Tags dialog enables you to quickly add new tags to a group of selected articles and remove tags from them. I don’t want to repeat the earlier discussions here, so please go and read those posts for details.

The Surfulater Help Topic: The Basics | Tags and Tagging Articles has been updated to cover the new Add and Removes Tags dialog and the Release Notes in the Help cover some of the other changes in this release. There is more going on under the cover, but we aren’t quite ready to talk about them yet.

Without further ado you can download the new release here.

Neville.

Surfulater& Surfulater - What's New& Surfulater - Tech Info14 Jul 2008 06:37 pm

We are currently working on the next part of the new Surfulater Tagging capability and would like some guidance from you, our users. We are working on two new and related features that revolve around letting you add and remove tags from a group of selected articles. For example you might select six articles and then want to add one or more tags to these articles. Or you might want to delete a tag or two from them. To do this now you would have to select each article in turn and edit its Tags field, to add or remove the tags, which is cumbersome to say the least. 

There are ways to make this task a lot quicker and easier, which is the focus of this post. How are we proposing to do this? Lets start with adding tags. First you select all of the articles in the Knowledge Tree that you want to add some tags to, then right click on one and select Add Tags… from the context menu, which opens this dialog.

Add Tags Dialog

You can type in one or more tags, and auto-suggest lets you choose from the list of existing tags. When you press Save, the Tags you entered are added to the selected articles. Any tags already present in an article will not be added again, so you don’t end up with duplicates. This process works just like the Tags field in your Surfulater Articles.

Some tagging systems let you add tags by displaying a list of all available tags and getting you to tick a checkbox for each tag you want to add. This is simple, intuitive and works very well when you have a smallish number of tags. However as the number of tags you add grows, this quickly gets unwieldy and you spend more and more time scrolling back and forth through the list to locate and choose the tags you want.

Our approach of quickly locating tags using auto-suggest, and of adding new tags to the tags database at the same time, delivers a much better user experience, especially as the number of tags you use grows, which it will.

Now lets talk about removing tags from articles. Assume we have three articles with the following tags:

  1. Cat, Pet
  2. Dog, Pet
  3. Cow, Herbivore

As before we’ll select all of the articles of interest, right click and choose Remove Tags… from the context menu which will open this dialog.

Tags Remove Dialog

This shows a list of all of the tags in the selected articles, with duplicates removed. In this example Pet is in two articles, but only appears once in the list. Beside each tag is a checkbox, with the heading Keep? and all checkboxs are checked. To remove the tag Pet from the selected articles it is in, you uncheck its checkbox and then press Save. If you wanted to remove other tags at the same time, you would uncheck those as well, before pressing Save.

So far so good, or at least I hope so.

Our next step in evolving these designs was to look at a further simplification which would enable you to both Add and Remove Tags within the one dialog, starting from a single context menu selection Tags…. Most of the time you want to either Add or Remove, but there are times when you want to do both. The new combined dialog looks like this.

Add and Remove Tags Dialog

When Save is pressed in this example animal and herbivore will be added to the selected articles and pet will be removed. If the New tags field had been empty, no new tags would have been added. Likewise of no tags were unchecked in the list, none would have been removed from the selected articles. All quite straightforward.

On closer examination one issue became evident and that is there can be some confusion when a tag you want to Add is shown in the Existing Tags list. In our example this is the tag herbivore

When you notice herbivore in the list you might decide not too include it as a New tag, which would be a mistake. Referring back to the articles and tags summary:

  1. Cat, Pet
  2. Dog, Pet
  3. Cow, Herbivore

you see that herbivore is only in one of the three selected articles, but there is no way to tell this from the Existing Tags list. Because you didn’t include herbivore in New tags, it won’t be added to articles one and two, which isn’t the desired outcome.

To help to resolve this we concluded that you need some indicator in the Existing Tags list which clearly shows which tags are in All of the selected articles and which are not. The outcome is this dialog.

Revised Tags... Dialog

Note the new In All… column, which in this example is completely empty, because there are no tags which are in all of the selected articles. After we press Save the story changes to.

Revised Tags.. Dialog

You now see animal and herbivore are clearly identified as being in all of the selected articles. You can group the tags that are in all articles together by clicking on the In All… column heading. Now when you see a tag that you want to add is already in the Existing Tags list and it is In All articles, you can skip it if you want, or you might find it easier just to add it and let Surfulater look after things.

The bottom line is that there really isn’t any point in scrolling through a long list of Existing Tags to see if a tag you want to add is there or not, just go ahead and add it.

Where do we need your help?

First does this all make sense? Can you think of better ways to add and removes tags from a group of articles? Should we have separate Add and Remove processes or does combining them into one dialog deliver a better user experience? If so, does the combined dialog we’ve presented above, work for you?

Do you find the user interface for removing tags intuitive? Could you work out how to use it just by looking at the dialog or is it confusing or difficult to grasp?

Please do give us your feedback and help us make some important decisions on this aspect of tagging and untagging multiple articles at once. All our lines are open. ;-)

The Next Pre-Release

I am in the midst of wrapping up another new pre-release which will include the combined Add + Remove Tags dialog as described here. It should be available this week. Keep your eye on the Blog for details.

To be continued…

The Topic for this post says Part 1. We have an alternate combined Add/Remove dialog user interface on the drawing board, which we will present here as soon as it is ready, so stay tuned.

Surfulater& Surfulater - What's New& Surfulater - Tech Info30 May 2008 04:43 pm

The next Surfulater Pre-Release, Version 2.92.0.0 is now available. If you haven’t already read about Version 2.91 and its Tagging goodness, I suggest you start there.

V2.92 addresses the pending issues noted in the Release Notes for the last release, namely Article Tags now copy when Articles are copied across KB’s, Search searches Article Tags and the Tags auto-suggest list vertical position is now correct when the Content window is scrolled.

We have also revamped the Tags Tree to remove the unnecessary root node, as well as the vertical lines that connect the top level tags. The image used for the nested sub-tags has also been changed, so they look different to the top level tags. This is what it looks like now.

Updated Tags Tree

These updates simplify and improve the look of the tree and make it easier to use.

We still have further work to do on Tagging, including the ability to Tag multiple articles at once, remove tags from multiple articles, show all UnTagged articles in the Tags Tree and more, so stay tuned.

If you held of installing the last pre-release I am pleased to report it has proven stable with no significant problems showing up.

Click this pre-release and do keep your comments and suggestions coming. Full Release Notes are in the Help as always.

Surfulater& Surfulater - What's New& Surfulater - Tech Info05 May 2008 05:56 pm

Surfulater Pre-Release version 2.91.0.0 is now available. This has been the longest gap between releases that I can think of, and the greatest overall changes to the code base for some time. This release includes the ability to add Tags to Articles and view Articles based on their Tags. It also includes the start of a move to a new embedded SQL Database engine. The last few Blog posts have largely been about tagging and are worth a read if you haven’t already done so.

We have done this as a pre-release to elicit your comments on the new Tagging system and to resolve any issues prior to a full release. This release sees changes in a broad number of areas and although we feel we have tested most every aspect, real world use will help sort out anything we may have missed. We also want to resolve a few more outstanding bugs and possibly add some more new features before a full release. And most importantly we want to get your feedback on the new Tags implementation.

This release is backwards compatible with previous releases. You should backup your Knowledge Base files before using this release, in addition to performing your daily backups. A third file which contains the new SQL Database is now used with each Knowledge Base. As we move forward, the current three KB files will be merged into a single SQL Database file. This will also enable backups to be done with Surfulater running as well as making for an even more robust database system.

A new Tags field has been added to each Article template, except the Notes template. Simply add your tags here and they will be added to the database. Any duplicate tags or invalid characters are removed when the article is saved. Auto-suggest makes it quick and easy to enter existing tags. 

The new Tags Tree displays all of your tags along with the articles associated with each tag.

Tags Tree

  You can also manage your tags here using the Tags Tree context menu.

Tags Tree context menu

Tags can be renamed and merged with existing tags, deleted and new tags added.

You will notice that the sample Tags Tree above includes some Tags nested below the top level tags. These are tags which are in the articles in the top level tag. For the tag Borneo, one or more articles with this tag also include tags Asia, Sabah and Travel. In other words the nested tags form an and relationshipTheir articles contain Borneo and Asia, Borneo and Sabah and Borneo and Travel respectively. This lets you easily see and navigate to interesting relationships between tags. The best way to understand this is to use it.

In addition to the inclusion of these related article tags, I have been thinking of enabling you to specify  Tag search expressions, which would appear as virtual Tags in the tree. For example you could specify “car and ford and not 2006″ and all matching articles would be displayed. This may well be added in the future, but first I want see what folks think of the current implementation.

I know many Surfulater users have been eagerly awaiting the ability to Tag content and I very much look forward to hearing what you think of this first release with tagging.

Full release notes are in the Surfulater Help and a new topic: The Basics | Tags and Tagging Articles has been added. Known problems with tagging are in the release notes. Note that some keys have changed in this release. See the release notes for details.

Click here to download this pre-release and when you have used it for a while do let us know how well it meets your needs, or doesn’t!

Surfulater& Surfulater - What's New& Surfulater - Tech Info25 Mar 2008 07:51 pm

This is a quick update on how the new Tagging system is coming along, and to show you the new Tags Tree. Without further ado here it is:

The Tags Tree

The first thing to note is the new Tags Tree button on the Knowledge Tree bar. The Tags Tree presents each Tag as a Folder, which in turn contains the Articles which include that Tag. Like the Knowledge Tree you click on a Folder and see all the articles in that folder in the content window, or select and display specific articles.

Next you can see the same article tagged into multiple folders. For example the article titled CodeProject: CppSQLite … is tagged with C++, Database, Library and SQL as shown in the next screen shot. If you look back at the first screen shot you will see three of the Tag folders expanded and this article in them. The fourth tag Library, is collapsed.

Example Article Tags field 

Editing an articles Tags in the content window, updates the Tags Tree accordingly. For example if you delete the tag SQL for this article, the article will be removed from the SQL folder. Similarly adding new tags to the article, will make it appear in the folders for those tags.

You can also edit the Tags themselves, either in the Tree or via. their Folder in the content window. When you rename a tag one of two things happen. If the new name doesn’t already exist, the tag simply changes to the new name and the tree is updated. If the new name does exist then all of the articles with the original tag are moved to the folder with the new name, and the original tag is deleted. Where an article has both the new and the original tag, the original tag is deleted from the articles tags field. A prompt is displayed allowing you to Cancel a rename where the new name already exists, preventing the articles from being moved and merged.

The ability to rename and merge tagged articles is an important one. For example if you had created the tags cattle and cow, used these these in lots of articles and then realized this was a mistake and you should have only used cattle, then all you need to do is rename the tag cow to cattle.

Tags can also be deleted via. the new Tags context menu.

The design of the the Tags system is such that rename and deletion of tags happens very quickly. In the case of  renaming a tag to a non-existing name, the entire knowledge base is updated instantly, even if that tag is used in a large number of articles.

As mentioned in recent posts the new tags system has been implemented using the a new SQL Database Engine and so far, I am very pleased with how this has come together and is how well it is working. But it is early days and so far only Tags use the new database. The design work for moving all existing Knowledge Base content to the SQL Database Engine is progressing smoothly.

There is still a bit more code to write and more testing to be done, but a release with Tagging isn’t far away now.

Surfulater& Surfulater - What's New& Surfulater - Tech Info20 Feb 2008 06:42 am

It is time to do a bit of show and tell about the new Tagging capability being added to Surfulater. The ability to add tags or keywords to articles and then locate articles for specific tags, has been a reasonably common user request. Tagging of content has become extremely popular in recent times, especially on Web sites. I have done a fair amount of research into tagging, folksonomyontology, semantic web etc. over the post few years and it is clear there is a lot happening in these areas and we are in many ways still in the early days.

A problem with tags is that single words on their own, are often ambiguous and have no context. For example what does “disk” mean? Is it a hard disk, a record, a CD, a disk in your back or maybe even a plate.

CamelCase (or WikiWords) offer one solution to this, but one I don’t personally like, not that I’ve actually used it much. To quote Wikipedia

CamelCase is the practice of writing compound words or phrases in which the words are joined without spaces and are capitalized within the compound. ex. HardDisk … CamelCase is rarely used in formal written English, and most style guides recommend against its use.

Hierarchical tags are another way to add extra meaning. ex. hard.disk For some time I thought that the ability to use hierarchical tags would be worthwhile, but have in the end decided against that.

To locate articles using tags, my current plan is to enable expressions to be used to specify tag groups. For example: car AND porsche. A tag hierarchy would use car.porsche for this. The problem here is if someone tags porsche instead of car.porsche, then the former won’t appear under the car.porsche listing. It is also more effort to enter hierarchical tags. Expressions offer endless flexibility here. You can find just “car”, just “porsche” “car and porsche”, “car and porsche and not 911″ for example.

A tree will be used to show all Tags (as folders) and their matching Articles as children. The aforementioned expressions can be used to specify virtual folders in the tree, along with the matching articles. This will be a new tree in the Knowledge Tree bar.

Until this is all in place and in use, it is difficult to say how well it will work in practice, but I feel it is a good solid starting point.

The next issue is that the use of Tags is a bit of a mess, everyone does their own thing, and there is little standardization, which of course makes using them to find things is less than ideal.

To quote from Wikipedia again:

There are drawbacks to such tag-based systems as well: no standard set of keywords (also known as controlled vocabulary), no standard for the structure of such tags (e.g. singular vs. plural, capitalization, etc.), mistagging due to spelling errors, tags that can have more than one meaning, unclear tags due to synonym/antonym confusion, highly unorthodox and “personalized” tag schemas from some users, and no mechanism for users to indicate hierarchical relationships between tags (e.g. a site might be labeled as both cheese and cheddar, with no mechanism that might indicate that cheddar is a refinement or sub-class of cheese). Services which allow both tags and folders for organizing bookmarks (such as Netvouz) make this less of a problem though. 

I’ll add Surfulater to that list. It goes further by enabling an article to be in many folders at once and letting you add links between articles, to build a web of related information.

In this situation all that folks like me can do is provide the best tools we can and hope they are used wisely. To this end it is important to use a well defined set of tags (see controlled vocabulary), instead of any old ad-hoc words. To help ensure consistent use of specific words I’ve implemented an auto-suggest list which displays words matching the characters typed so far, which you can then pick from. The first image shows the auto-suggest list with matches for the letter d, along with the matching characters bold and underlined as a visual cue. The second image shows the selected word entered as a tag.

Tag auto-suggest list  Word chosen from list

You can also press the Down Arrow key to access a list of all defined tags, as shown here.

Complete auto-suggest list

 

When you enter a tag word that isn’t present in the tags list, it is automatically added. Next a window opens showing the newly added tags, enabling you to correct or delete these tags as required, as well as add a description. If you are happy with the newly added tags just click “Close” to continue. The design here is to try and impinge as little as possible on your work-flow. An alternative approach would be to prompt you each time you typed a word that didn’t exist and ask if you wanted to add it. This could be quite tiresome, especially during the early stages of building your list of tag words.

As I mentioned on the blog recently the inclusion of tagging has dictated extensive changes to the underlying database engine that Surfulater uses, as  well as several other fairly major framework enhancements. This means that the time to the next release will be a bit longer than usual, but hopefully well worth the wait.

Surfulater& Surfulater - What's New17 Jan 2008 12:00 pm

The first release for 2008, Version 2.52 Build 10.0 is now available for download. This is primarily a maintenance update to address some issues with the new Web KB Publishing capability. It also includes two new, user contributed, article templates, “Texts and Authors” by Edwin Relf and “Quotation” by Ed Taylor. Full release notes are in the Help and online.

Looking ahead the plan is to immediately commence work on implementing Tags, as I mentioned in my last blog post and to incorporate a new SQL Database Engine. Tags will be the first use of the new database, with other areas to follow.

Tags and the move to SQL are both very interesting new developments for Surfulater, which I’m sure will hold us in good stead for important and impressive new releases during 2008. Thanks to everyone for your continued great support and I look forward to working with you all to continue to evolve Surfulater in the year ahead.

Surfulater& Surfulater - What's New19 Dec 2007 06:03 pm

Let me start by wishing everyone a very merry xmas and a prosperous and healthy 2008. I’d also like to thank everyone for the great support you’ve given to Surfulater and myself this past year. Your e-mails and forum posts praising Surfulater and also being critical, from time to time, are always very well received and help keep us on course. We have lots more to do with Surfulater in the coming year. I’m sure you won’t be disappointed as the new releases continue to deliver more capabilities as well as enhanced functionality, while hopefully remaining true to our goal of ease of use.

Actions speak louder than words, so let me show you the big new feature in this release; click here*.

If you’ve been reading the blog, this won’t come as a surprise. If you haven’t, then what you are seeing is the sample Surfulater Knowledge Base displayed in your Web Browser. What does this mean? Well it enables you to Publish your Knowledge Base files and view them in a Web Browser, without any need to have Surfulater present.

Various uses quickly come to mind.

  • You can carry your KB’s around on a USB Stick and view them on any PC, which has a Web Browser. No other software is needed.
  • You can Publish them to a PC on your Network (LAN) for others on the Network to access.
  • And as you’ve just witnessed you can put them on a Web Site, for anyone with Internet access to see.

This new Web Publishing capability makes it easy to share your content with friends and colleagues and paves the way for even more interesting new ways of working with knowledge bases in the future. You can think of it as setting your content free.

It is clear from the comments in my previous blog post, that this is a very important step in Surfulater’s evolution.

For more information see View Surfulater KB’s in any Web Browser, wherever you are, read the Help file topic Power Features|Publish to a Web KB and read the Release Notes in the Help or here.

Well that’s it for now and probably for 2007. Have a great Xmas and do let me know what you think of the new Web KB publishing capability.

Neville

* To view Web KB’s Javascript must be enabled in your Web Browser. To view Web KB’s on a Local Drive, IE users need to either enable: Tools|Internet Options…|Advanced|Allow active content to run in files on My Computer or select ‘Allow Blocked Content’ from the context menu when prompted.

Surfulater& Surfulater - What's New& Surfulater - Tech Info27 Nov 2007 10:36 am

We all want access to our information wherever we happen to be, assuming of course there is a PC available, or maybe even a Smart-phone. Various technologies are making this possible, all the more so as our lives become ”always connected” to the Net and as data speeds continue to improve. There is interest in moving content out of Surfulater for access by other programs and for viewing it when Surfulater isn’t available. For the former Perry Mowbray has written SUL2Text which extracts the text from a Knowledge Base and dumps it into a text file.  And Perry also wrote HTMLView which generates a Surfulater TreeView and Articles. You may also be aware that Surfulater’s main content is stored in an open standard XML file, which can be accessed by other applications.

If you read Perry’s HTML view article you will see I sparked his interest, as I’d thought for some time that the ability to view Surfulater Knowledge Bases in a Web browser would be a very, very useful. This capability delivers important new ways to access all of the valuable content you’ve put so much effort into collecting and most importantly does so without any need to have Surfulater installed on the PC you want to view it on.

Without further ado here is a screen shot showing content from the MyKnowledge example Knowledge Base in Internet Explorer.

Surfulater Web Viewer

As you can see we’ve got the Knowledge Tree and the Content window, just like in Surfulater. Clicking on any folder or article in the tree displays its contents, and the keyboard cursor keys also navigate around the tree. The tree is expanded to match how it was in Surfulater when it was published.

To play with a real live demo click here. Note that Javascript must be enabled in your Web Browser and this being an alpha-release there are some known problems. Depending on your Internet connection speed and the phase of the moon, this will take around 10 seconds to load. We will likely be able to speed it up a bit in the final release.

Noteworthy features in the demo include the ability to hide or show the tree by clicking on the [< <] button.  When hidden, you can click on the vertical bar to auto-show it or the [>>] button to lock it open. You can resize the knowledge tree panel by dragging its border and you can right click on a folder to access its context menu, which in turn lets you expand and collapse all of its folders. Capabilities like toolbars, more menu functions etc. will likely be added in the future.

By now you may be thinking this is all well and good but what would I use it for. I see three main use cases. First you can publish your content to a PC on your LAN so anyone on the Network can view it. Second you can publish it to a USB Memory Stick or USB Hard Drive and then access it on any PC, wherever you happen to be. And third you can publish it to a Web Server enabling anyone with an Internet connection to view your knowledge bases.

This new publishing capability sets your information free, enabling you to view it on any PC, without any need for Surfulater to be available on the PC. It takes our open XML format Knowledge Base a step further, allowing you to share your information on the Web or a LAN, or carry it on a USB Stick, so you can see always see your content, wherever you happen to be.

Once your Surfulater information is accessible from a Web Browser, it’s not hard to see the potential this offers for the future.

Surfulater& Surfulater - What's New15 Oct 2007 04:58 pm

The first big new feature in this release is the ability to link from other application documents directly to Surfulater articles. For example you can add an article link to a Microsoft Word Document and then click on that link and open the article in Surfulater, as shown in this picture.

Link from Word Document to Surfulater Article

 

‘See Also’ links have always been invaluable in creating webs of related information within Surfulater, and this new external linking capability extends that to enable using links from other applications. This important new capability opens up your Surfulater content, making it quick and easy to access from other applications.

To create an External link right click on the Surfulater article and select Copy As from the context menu.

'Copy As' on context menu

 

For this example we choose Plain External Link as that’s what we need for the MS Word document. This copies the link to the Windows Clipboard.

The next step is select the text in our Word document which we want to add the link to and press Ctrl+K or use the Hyperlink toolbar button or menu option. Then paste the link into the dialog as shown here and press OK.

Word Insert Hyperlink dialog

 

The result is a link we can click on to open the referenced article in Surfulater, as shown in the first image above. Note that Surfulater doesn’t need to be running for external links to work.

These external links to Surfulater articles can be used in any applications that let you use Hyperlinks. They can also be used from a Windows Command Prompt and on the Surfulater command line. For more information on External Links see the Surfulater Help topic: Power Features|External Links.

The next important new feature in this release is the ability to use ‘See Also’ links to connect articles in different knowledge bases to each other. This extends the existing ‘See Also’ links, making them even more useful.

'See Also' links across knowledge bases

 

This screen shot shows a ‘See Also’ link in the Hardware knowledge base which accesses an article in the Home knowledge base and vice-versa. Clicking on either link opens the referenced knowledge base, if it isn’t already open and then displays the linked article.

‘See Also’ links across knowledge bases are created in the same way as links within a knowledge base, using “Copy” and then “Paste as reciprocal ‘See also’ links”. See the Surfulater Help topic: Power Features|Creating Cross Reference links.

Also updated in this release is the use of Cut, Copy and Paste, including their use on the Edit menu and Toolbar buttons, along with with the Ctrl+X, Ctrl+C and Ctrl+V keyboard shortcuts. All methods of issuing Cut & Copy are now available both in the Knowledge Tree and in the Content window, with the action they perform based on which window has focus and whether there is any text and/or images selected in the content window. These changes improve the availability and uniform use of Cut & Copy.

The final new feature to point out is Copy Image and Cut Image, which enable images to be copied to the clipboard, without having to first select them.

For more information on Cut/Copy & Paste and Cut/Copy Image see the new Help topic: The Basics|Cut, Copy, Paste & Cut/Copy Image.

That’s all for now, I hope you like the new features in this release. As always your Comments are most welcome.

Version 2.30.10.0 will be available shortly from our Download page.

Next Page »