WebProtegeLayoutConfig - Revision history

TaniaTudorache at 22:30, February 27, 2014

2014-02-27T22:30:08Z

Csnyulas: /* Embedding HTML in a portlet */ documented another configuration property

2013-01-23T21:13:20Z

‎Embedding HTML in a portlet: documented another configuration property

TaniaTudorache at 19:28, August 8, 2011

2011-08-08T19:28:47Z

Han at 13:47, June 24, 2011

2011-06-24T13:47:12Z

Csnyulas: /* Make the tabs not closable */

2010-06-16T06:43:30Z

‎Make the tabs not closable

Csnyulas: /* Hide the ontology toolbar */

2010-06-16T06:43:04Z

‎Hide the ontology toolbar

TaniaTudorache at 05:59, June 16, 2010

2010-06-16T05:59:31Z

TaniaTudorache at 05:22, June 16, 2010

2010-06-16T05:22:33Z

TaniaTudorache at 05:16, June 16, 2010

2010-06-16T05:16:18Z

TaniaTudorache at 05:11, June 16, 2010

2010-06-16T05:11:30Z

@@ Line 135: / Line 135: @@
 It is possible to define a ''project'' and a ''project and user'' specific layout configuration.
-The default layout configuration for any project in WebProtege is given by the <code>war/projectConfigurations/configuration.xml</code> file.
+You may use the ''Save layout'' function in WebProtege to save a custom layout that you have defined through the user interface. However, there are a few features, such as the forms, that cannot be configured through the user interface, but require a manual editing of the configuration file for now. In future releases, we plan to have all the features configurable through the user interface.
-If you want to define a '''custom layout for one of the projects''' in WebProtege, then add a new configuration XML file in the same directory as the default one, and name it:
+The default layout configuration for any project in WebProtege is stored in the <code>default-ui-configuration-data</code> directory in the [[WebProtegeAdminGuide#Create_a_data_directory|WebProtege data directory]]. You will find in this directory a file for OWL and one for OBO project configurations:
-  configuration_MyProjectName.xml
+  default-owl-configuration.xml
-For example, if you want to create a specific configuration file for the project ''Collaborative Pizza'' (the name of the project is defined in the metaproject), then you would create a file: <code>configuration_Collaborative Pizza.xml</code> that contains the custom layout (e.g. you hide some tabs, add new portlets, etc.)
+These are the default configuration files that are used, if no project specific configuration is defined.
-If you want to create a '''specific configuration for a user and a project''' (the user and project name are defined in the metaproject), then create a new configuration file and call it:
+If you want to define a '''custom layout for one of the projects''' in WebProtege, then you need to create/edit a UI configuration file, called <code>ui-configuration.xml</code> in the <code>configuration-data</code> folder of your project stored in the [[WebProtegeAdminGuide#Create_a_data_directory|WebProtege data directory]].
- configuration_MyProjectName_UserName.xml
+To do so, you need to find out the ID of your project. If you browse your project in WebProtege, you will find the <code>projectID</code> in your browser's address bar. For example, for the ''Aero'' project on the Stanford WebProtege server (http://webprotege.stanford.edu/#Edit:projectId=987d9f04-f085-4534-be1f-8619aa5f0c4d), the <code>projectId</code> is <code>987d9f04-f085-4534-be1f-8619aa5f0c4d</code>.
-For example, to define a custom layout for ''Collaborative Pizza'' for user ''Guest'', then create a configuration file called: <code>configuration_Collaborative Pizza_Guest.xml</code>
+Once you found the <code>projectID</code>, you can find the directory where the project specific configurations are stored, which is:

@@ Line 232: / Line 232: @@
 <pre>
 <portlet>
-     <name>edu.stanford.bmir.protege.web.client.ui.portlet.html.HtmlMessagePortlet</name>
+    <name>edu.stanford.bmir.protege.web.client.ui.portlet.html.HtmlMessagePortlet</name>
-     <height>500</height> <!-- Optional -->
+    <height>500</height> <!-- Optional -->
-     <properties>
+    <properties>
          <entry>
-             <string>label</string>
+            <string>label</string>
-	     <string>This is the title of the portlet</string>
+            <string>This is the title of the portlet</string>
-	</entry>
+        </entry>
-	<entry>
+        <entry>
-	     <string>load_url</string>
+            <string>load_url</string>
-	     <string>http://mydomain/mypage.html</string> <!-- add here the HTML page to display -->
+            <string>http://mydomain/mypage.html</string> <!-- add here the HTML page to display -->
-	</entry>
+        </entry>
-      </properties>
+    </properties>
 </portlet>
 </pre>
 = Available tabs and portlets =

← Older revision		Revision as of 19:28, August 8, 2011
Line 220:		Line 220:

	'''Note'''. Other properties are available, and we are in the process of documenting them.		'''Note'''. Other properties are available, and we are in the process of documenting them.
		+
		+
		+	= Useful portlets =
		+
		+	== Embedding HTML in a portlet ==
		+
		+	To show in a portlet content from an external HTML page (e.g. extra documentation, intergation with other applications, etc.), you can use the <code>HTML Portlet</code>.
		+
		+	Below is an example on how you can configure it:
		+
		+	<pre>
		+	<portlet>
		+	<name>edu.stanford.bmir.protege.web.client.ui.portlet.html.HtmlMessagePortlet</name>
		+	<height>500</height> <!-- Optional -->
		+	<properties>
		+	<entry>
		+	<string>label</string>
		+	<string>This is the title of the portlet</string>
		+	</entry>
		+	<entry>
		+	<string>load_url</string>
		+	<string>http://mydomain/mypage.html</string> <!-- add here the HTML page to display -->
		+	</entry>
		+	</properties>
		+	</portlet>
		+	</pre>

← Older revision		Revision as of 13:47, June 24, 2011
Line 293:		Line 293:

	http://smi-protege.stanford.edu/repos/protege/web-protege/branches/who/war/projectConfigurations/		http://smi-protege.stanford.edu/repos/protege/web-protege/branches/who/war/projectConfigurations/
		+
		+	[[Category:WebProtege documentation]]

@@ Line 185: / Line 185: @@
        <string>closable</string>
        <boolean>false</boolean>
    <!-- (other properties...) -->
 </properties>

← Older revision		Revision as of 05:59, June 16, 2010
Line 285:		Line 285:

	</pre>		</pre>
		+
		+	= Examples =
		+
		+	You can find examples of XML configuration files here:
		+
		+	http://smi-protege.stanford.edu/repos/protege/web-protege/branches/who/war/projectConfigurations/

@@ Line 1: / Line 1: @@
 <p style="padding:0; margin:0; font-size:1.9em; font-weight:bold; word-spacing:-2px;">WebProtege Layout Configuration</p>
 __TOC__
@@ Line 151: / Line 150: @@
 '''Note''': When the ''Save Layout'' function will be enabled in WebProtege, it will be much easier to create these configurations directly from the UI, rather than editing the XML file.

@@ Line 241: / Line 241: @@
 <pre>
   -- Classes --
-edu.stanford.bmir.protege.web.client.ui.ontology.classes.ClassTreePortlet - shows class tree
+edu.stanford.bmir.protege.web.client.ui.ontology.classes.ClassTreePortlet - shows the class tree
-edu.stanford.bmir.protege.web.client.ui.ontology.hierarchy.ManageHierarchyPortlet - manage hierarchy operations: move in hierarchy
+edu.stanford.bmir.protege.web.client.ui.ontology.hierarchy.ManageHierarchyPortlet - manage hierarchy operations: move in hierarchy, add/remove parents, retire
 edu.stanford.bmir.protege.web.client.ui.ontology.restrictions.RestrictionsPortlet - shows the class conditions and restrictions
-edu.stanford.bmir.protege.web.client.ui.ontology.classes.SuperclassesPortlet - shows direct parents of a class
+edu.stanford.bmir.protege.web.client.ui.ontology.classes.SuperclassesPortlet - shows the direct parents of a class
   -- Properties --
@@ Line 259: / Line 259: @@
 edu.stanford.bmir.protege.web.client.ui.ontology.changes.ChangeSummaryPortlet - shows the list of all changes in the ontology
 edu.stanford.bmir.protege.web.client.ui.ontology.changeanalysis.ChangeTreePortlet - shows the class tree with the number of changes attached to each node
-edu.stanford.bmir.protege.web.client.ui.ontology.changeanalysis.ChangeTablePortlet - shows the
+edu.stanford.bmir.protege.web.client.ui.ontology.changeanalysis.ChangeTablePortlet - shows the changes of the selected entity and supports filtering of authors
   -- Notes and discussions --
-edu.stanford.bmir.protege.web.client.ui.ontology.notes.NotesPortlet
+edu.stanford.bmir.protege.web.client.ui.ontology.notes.NotesPortlet - shows in a table format all notes attached to the selected entity (deprecated by the NotesTreePortlet)
-edu.stanford.bmir.protege.web.client.ui.ontology.notes.NotesTreePortlet
+edu.stanford.bmir.protege.web.client.ui.ontology.notes.NotesTreePortlet - shows in a threaded view the notes attached to the selected entity
-edu.stanford.bmir.protege.web.client.ui.ontology.reviews.ReviewsPortlet
+edu.stanford.bmir.protege.web.client.ui.ontology.reviews.ReviewsPortlet - request and add reviews to an entity
   -- Metadata --
-edu.stanford.bmir.protege.web.client.ui.ontology.metadata.ImportsTreePortlet
+edu.stanford.bmir.protege.web.client.ui.ontology.metadata.ImportsTreePortlet - shows the ontology imports tree
-edu.stanford.bmir.protege.web.client.ui.ontology.metadata.AnnotationsPortlet
+edu.stanford.bmir.protege.web.client.ui.ontology.metadata.AnnotationsPortlet - shows the ontology annotations
-edu.stanford.bmir.protege.web.client.ui.ontology.metadata.MetricsPortlet
+edu.stanford.bmir.protege.web.client.ui.ontology.metadata.MetricsPortlet - shows the metrics of an ontology (expensive operation)
-edu.stanford.bmir.protege.web.client.ui.ontology.home.OntologiesPortlet
+edu.stanford.bmir.protege.web.client.ui.ontology.home.OntologiesPortlet - shows the list of available ontologies
   -- Other --
-edu.stanford.bmir.protege.web.client.ui.portlet.html.HtmlMessagePortlet
+edu.stanford.bmir.protege.web.client.ui.portlet.html.HtmlMessagePortlet - allows the embedding of any HTML in the UI of a tab
-edu.stanford.bmir.protege.web.client.ui.ontology.search.BioPortalSearchPortlet
+edu.stanford.bmir.protege.web.client.ui.ontology.search.BioPortalSearchPortlet - supports searches in BioPortal
-edu.stanford.bmir.protege.web.client.ui.ontology.changes.WatchedEntitiesPortlet
+edu.stanford.bmir.protege.web.client.ui.ontology.changes.WatchedEntitiesPortlet - watch entities and get email notifications on changes
 </pre>

@@ Line 243: / Line 243: @@
 edu.stanford.bmir.protege.web.client.ui.ontology.classes.ClassTreePortlet - shows class tree
 edu.stanford.bmir.protege.web.client.ui.ontology.hierarchy.ManageHierarchyPortlet - manage hierarchy operations: move in hierarchy
-edu.stanford.bmir.protege.web.client.ui.ontology.restrictions.RestrictionsPortlet - shows
+edu.stanford.bmir.protege.web.client.ui.ontology.restrictions.RestrictionsPortlet - shows the class conditions and restrictions
-edu.stanford.bmir.protege.web.client.ui.ontology.classes.SuperclassesPortlet
+edu.stanford.bmir.protege.web.client.ui.ontology.classes.SuperclassesPortlet - shows direct parents of a class
   -- Properties --
-edu.stanford.bmir.protege.web.client.ui.ontology.classes.AllPropertiesPortlet
+edu.stanford.bmir.protege.web.client.ui.ontology.properties.PropertiesTreePortlet - the property tree
-edu.stanford.bmir.protege.web.client.ui.ontology.properties.PropertiesTreePortlet
+edu.stanford.bmir.protege.web.client.ui.ontology.classes.AllPropertiesPortlet - shows the annotation properties (and own slots in frames), and other properties attached to the selected entity
-edu.stanford.bmir.protege.web.client.ui.ontology.classes.PropertiesViewPortlet
+edu.stanford.bmir.protege.web.client.ui.ontology.classes.PropertiesViewPortlet - shows the classes that are in the domain of the selected class (similar to the rich client)
-edu.stanford.bmir.protege.web.client.ui.portlet.propertyForm.PropertyFieldPortlet
+edu.stanford.bmir.protege.web.client.ui.portlet.propertyForm.PropertyFieldPortlet - form-based editing; see additional page for documentation
   -- Individuals --
-edu.stanford.bmir.protege.web.client.ui.ontology.individuals.IndividualsListPortlet - show the list of individuals of a class
+edu.stanford.bmir.protege.web.client.ui.ontology.individuals.IndividualsListPortlet - shows the list of individuals of a class
   -- Changes --
-edu.stanford.bmir.protege.web.client.ui.ontology.changes.ChangesPortlet
+edu.stanford.bmir.protege.web.client.ui.ontology.changes.ChangesPortlet - shows the list of changes for the selected entity
-edu.stanford.bmir.protege.web.client.ui.ontology.changeanalysis.ChangeTablePortlet
+edu.stanford.bmir.protege.web.client.ui.ontology.changes.ChangeSummaryPortlet - shows the list of all changes in the ontology
-edu.stanford.bmir.protege.web.client.ui.ontology.changes.ChangeSummaryPortlet
+edu.stanford.bmir.protege.web.client.ui.ontology.changeanalysis.ChangeTreePortlet - shows the class tree with the number of changes attached to each node
-edu.stanford.bmir.protege.web.client.ui.ontology.changeanalysis.ChangeTreePortlet
+edu.stanford.bmir.protege.web.client.ui.ontology.changeanalysis.ChangeTablePortlet - shows the
   -- Notes and discussions --