Difference between revisions of "HTML Chat"

From Protege Wiki
Jump to: navigation, search
(Example)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Plugin
 
{{Plugin
|PluginType=Application
+
|Description=Allows users logged into a client-server version of Protege to chat in real time. Supports HTML-style editing (Bold, Italics, Underline, Strikethrough) along with dynamic hyperlink detections and internal link detections.
 +
|PluginType=Tab Widget
 
|ForApplication1=Protege Client-Server
 
|ForApplication1=Protege Client-Server
 +
|Screenshot=HTMLChat2.jpg
 +
|HomepageURL=http://protegewiki.stanford.edu/index.php/HTML_Chat
 
|DeveloperID1=Tania Tudorache
 
|DeveloperID1=Tania Tudorache
 
|DeveloperID2=Vivek Tripathi
 
|DeveloperID2=Vivek Tripathi
|LastUpdated=2008/01/20
+
|LastUpdated=January 20, 2008
|Topic1=BioMedical Informatics
 
 
|Topic2=Visualization
 
|Topic2=Visualization
|License=Mozilla Public License (MPL)
+
|Topic3=Project Management
 +
|License=Mozilla Public License
 
|Affiliation1=Stanford Center for Biomedical Informatics Research
 
|Affiliation1=Stanford Center for Biomedical Informatics Research
|Description=The chat for Protege Client Server now supports HTML editing (Bold, Italics, Underline, StrikeThrough) along with dynamic Hyperlink detections and internal link detections.
 
 
}}
 
}}
 
<div style="float:left;">
 
<div style="float:left;">
==Description==
+
== Description ==
The chat for Protege Client-Server now supports HTML editing. The text can be made Bold, Italics, Underlined or StrikeThrough. Also the chat provides dynamic Hyperlink detection and any URL (example www.google.com) typed in would be enabled automatically.  There is also support provided for internal links which is explained in the example below.
+
Allows users logged into a client-server version of Protege to chat in real time.  Aims to provide the same sort of functionality as Yahoo! Messenger or Google Talk.  The HTML Chat tab supports HTML-style editing (Bold, Italics, Underline, Strikethrough) along with dynamic hyperlink detections and internal link detections (more on internal links below).
  
==Example==
+
== Example ==
Example: Consider the newspaper example which is included with Protégé. You need to be running in the Client-Server mode to use the Chat Component.  
+
Consider the newspaper example which is included by default with Protege. Remember that you need to be running in client-server mode to use the HTML Chat tab.  
  
1. Get the Chat Tab by enabling it from Project->Configure.
+
1. Get the Chat tab by enabling it from the Project | Configure... menu item.
  
2. As you go on typing, the chat automatically detects any hyperlinks that you enter and enables them. Clicking the link opens it in a separate browser.
+
2. As you type, the Chat tab automatically detects any hyperlinks that you enter and enables them. Clicking the link opens it in a separate browser.
  
3. If you want to add an internal link say pointing to some Class (say Library) in the project, just type @'Library' as shown in the screenshot below. The link gets enabled. In other words to create internal link to "XXX XXX" we need to type @'XXX XXX'
+
3. If you want to add an internal link pointing to a Protege class (e.g., Library) in the project, just type @'Library' as shown in the screenshot below. Notice that the link becomes enabled. In other words, to create internal link to "XXX XXX" we need to type @'XXX XXX'.
  
[[Image:HTMLChat.jpg]]
 
  
4. When you click on the internal link, the window with Library class opens up. The internal link works for classes, slots, instances etc in the project. Chat now also supports text formatting as shown in the screenshot above.
+
[[Image:HTMLChat2.jpg]]
  
==NOTE==
 
  
1. Internal links: If the size of knowledgebase is huge (ie. it contains many classes, instances, slots) then searching the internal names is more efficient if done using the "Actual name" of the class, slot, instance instead of the "Displayed name". This consideration becomes important for Instances because their "Actual name" often differ from the "Displayed name". Most instances have automatically generated names like "newspaper_instance_10000" etc. The "Displayed name" could be something as simple as "Ms Gardnier". The threshold (maximum number of frames allowed to be searched by "Displayed name") can be specified in the properties file by changing value of "editor.pane.browsertext.frame.limit". Default is set to 10000. This means if the total number of classes, slots, instances in the knowledgebase exceeds 10000 then the search for internal links would be done by the "Actual names" and not by the "Displayed names".
+
4. When you click on the internal link, the class form for the Library class opens. The internal link functionality works for classes, slots, and instances in the project. The Chat tab also supports text formatting as shown in the screenshot above.
 +
 
 +
== PLEASE NOTE ==
 +
 
 +
Internal links: If the size of your knowledge base is huge (i.e., it contains many classes, instances, and slots), then searching is more efficient if done using the "internal name" of the class, slot, or instance instead of the "display name". This consideration becomes important for instances because their "internal name" often differs from the "display name". Most instances have system generated names like "newspaper_instance_10000", etc. The "display name" could be something as simple as "Ms Gardiner". The threshold (maximum number of frames allowed to be searched by "display name") can be specified in the properties file by changing value of "editor.pane.browsertext.frame.limit". The default value is set to 10000. This means that if the total number of classes, slots, and instances in the knowledge base exceeds 10000, then the search for internal links would be done by the "internal name" and not by the "display name".
  
 
==Installation==
 
==Installation==
  
Chat is bundled with the "full" installation of Protege (versions 3.4 beta 110 and higher).
+
The HMTL Chat tab is bundled with the "full" installation of Protege (version 3.4 beta, build 110 and higher). The source code for is available from the Protege Subversion repository:
The source code for ChatComponent is available from the Protege Subversion repository.
+
 
 +
http://smi-protege.stanford.edu/svn/chat/trunk/
  
  
 
</div>
 
</div>

Latest revision as of 18:30, July 21, 2008

Screenshot

Type Tab Widget
Author(s) Tania Tudorache, Vivek Tripathi
Last Update January 20, 2008
License Mozilla Public License
Homepage HTML Chat website
For Application
Topic(s)
Affiliation

Allows users logged into a client-server version of Protege to chat in real time. Supports HTML-style editing (Bold, Italics, Underline, Strikethrough) along with dynamic hyperlink detections and internal link detections.

Versions & Compatibility

This section lists available versions of HTML Chat.

No version information available.

If you click on the button below to add a new version of HTML Chat, you will be asked to define a page title for the new version. Please adhere to the naming convention of HTML Chat X.X.X when you define the new page!

Changelog

No version information available.


Description

Allows users logged into a client-server version of Protege to chat in real time. Aims to provide the same sort of functionality as Yahoo! Messenger or Google Talk. The HTML Chat tab supports HTML-style editing (Bold, Italics, Underline, Strikethrough) along with dynamic hyperlink detections and internal link detections (more on internal links below).

Example

Consider the newspaper example which is included by default with Protege. Remember that you need to be running in client-server mode to use the HTML Chat tab.

1. Get the Chat tab by enabling it from the Project | Configure... menu item.

2. As you type, the Chat tab automatically detects any hyperlinks that you enter and enables them. Clicking the link opens it in a separate browser.

3. If you want to add an internal link pointing to a Protege class (e.g., Library) in the project, just type @'Library' as shown in the screenshot below. Notice that the link becomes enabled. In other words, to create internal link to "XXX XXX" we need to type @'XXX XXX'.


HTMLChat2.jpg


4. When you click on the internal link, the class form for the Library class opens. The internal link functionality works for classes, slots, and instances in the project. The Chat tab also supports text formatting as shown in the screenshot above.

PLEASE NOTE

Internal links: If the size of your knowledge base is huge (i.e., it contains many classes, instances, and slots), then searching is more efficient if done using the "internal name" of the class, slot, or instance instead of the "display name". This consideration becomes important for instances because their "internal name" often differs from the "display name". Most instances have system generated names like "newspaper_instance_10000", etc. The "display name" could be something as simple as "Ms Gardiner". The threshold (maximum number of frames allowed to be searched by "display name") can be specified in the properties file by changing value of "editor.pane.browsertext.frame.limit". The default value is set to 10000. This means that if the total number of classes, slots, and instances in the knowledge base exceeds 10000, then the search for internal links would be done by the "internal name" and not by the "display name".

Installation

The HMTL Chat tab is bundled with the "full" installation of Protege (version 3.4 beta, build 110 and higher). The source code for is available from the Protege Subversion repository:

http://smi-protege.stanford.edu/svn/chat/trunk/