[507180] Properties View documentation

Contribute documentation for the Properties View Preference Page and
mention it in the release notes.

Bug: 507180
Change-Id: I5bc635742812ba43e5b63cea02aecc2b9f4a0870
Signed-off-by: Mélanie Bats <melanie.bats@obeo.fr>

12 files changed, 133 insertions, 10 deletions

diff --git a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html
index 4455999c4b..0613ec5afd 100644
--- a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html
+++ b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html
@@ -16,6 +16,9 @@
 						<a href="#sirius4.1.2">Changes in Sirius 4.1.2</a>
 						<ol style="list-style: disc;">
 							<li>
+								<a href="#UserVisibleChanges">User-Visible Changes</a>
+							</li>
+							<li>
 								<a href="#DeveloperVisibleChanges">Developer-Visible Changes</a>
 							</li>
 						</ol>
@@ -24,7 +27,7 @@
 						<a href="#sirius4.1.1">Changes in Sirius 4.1.1</a>
 						<ol style="list-style: disc;">
 							<li>
-								<a href="#UserVisibleChanges">User-Visible Changes</a>
+								<a href="#UserVisibleChanges2">User-Visible Changes</a>
 							</li>
 							<li>
 								<a href="#DeveloperVisibleChanges2">Developer-Visible Changes</a>
@@ -35,7 +38,7 @@
 						<a href="#sirius4.1.0">Changes in Sirius 4.1.0</a>
 						<ol style="list-style: disc;">
 							<li>
-								<a href="#UserVisibleChanges2">User-Visible Changes</a>
+								<a href="#UserVisibleChanges3">User-Visible Changes</a>
 							</li>
 							<li>
 								<a href="#SpecifierVisibleChanges">Specifier-Visible Changes</a>
@@ -49,7 +52,7 @@
 						<a href="#sirius4.0.0">Changes in Sirius 4.0.0</a>
 						<ol style="list-style: disc;">
 							<li>
-								<a href="#UserVisibleChanges3">User-Visible Changes</a>
+								<a href="#UserVisibleChanges4">User-Visible Changes</a>
 							</li>
 							<li>
 								<a href="#SpecifierVisibleChanges2">Specifier-Visible Changes</a>
@@ -63,7 +66,7 @@
 						<a href="#sirius3.1.0">Changes in Sirius 3.1.0</a>
 						<ol style="list-style: disc;">
 							<li>
-								<a href="#UserVisibleChanges4">User-Visible Changes</a>
+								<a href="#UserVisibleChanges5">User-Visible Changes</a>
 							</li>
 							<li>
 								<a href="#SpecifierVisibleChanges3">Specifier-Visible Changes</a>
@@ -77,7 +80,7 @@
 						<a href="#sirius3.0.0">Changes in Sirius 3.0.0</a>
 						<ol style="list-style: disc;">
 							<li>
-								<a href="#UserVisibleChanges5">User-Visible Changes</a>
+								<a href="#UserVisibleChanges6">User-Visible Changes</a>
 							</li>
 							<li>
 								<a href="#SpecifierVisibleChanges4">Specifier-Visible Changes</a>
@@ -94,6 +97,15 @@
 			<a href="Release_Notes_Previous.html">the release notes from previous versions</a> for details about older releases.
 		</p>
 		<h2 id="sirius4.1.2">Changes in Sirius 4.1.2</h2>
+		<h3 id="UserVisibleChanges">User-Visible Changes</h3>
+		<ul>
+			<li><span class="label label-success">Added</span> </li>
+		</ul>
+		<p>A new preference named 
+			<em>Maximum size of tabs name</em> is available in the Sirius Properties View preference page. This preference is used to shorten the tabs names when the default rules are used to render the properties view.
+			<br/>
+			<img border="0" src="./images/PreferencePageMaxTabName.png"/> 
+		</p>
 		<h3 id="DeveloperVisibleChanges">Developer-Visible Changes</h3>
 		<ul>
 			<li><span class="label label-success">Added</span> 
@@ -125,7 +137,7 @@
 			<code>org.eclipse.sirius.diagram.ui.tools.api.format.SiriusFormatDataManagerWithMapping.addFormatData(FormatDataKey, RepresentationElementMapping, AbstractFormatData)</code> to better handle copy/paste format cases.
 		</p>
 		<h2 id="sirius4.1.1">Changes in Sirius 4.1.1</h2>
-		<h3 id="UserVisibleChanges">User-Visible Changes</h3>
+		<h3 id="UserVisibleChanges2">User-Visible Changes</h3>
 		<ul>
 			<li><span class="label label-info">Modified</span>The &#8220;straighten to&#8221; actions were previously disabled when an edge is connected to border nodes that have several edges. It is now allowed.</li>
 		</ul>
@@ -136,7 +148,7 @@
 			</li>
 		</ul>
 		<h2 id="sirius4.1.0">Changes in Sirius 4.1.0</h2>
-		<h3 id="UserVisibleChanges2">User-Visible Changes</h3>
+		<h3 id="UserVisibleChanges3">User-Visible Changes</h3>
 		<ul>
 			<li><span class="label label-success">Added</span> Copy/Paste Layout has been completed with Copy/Paste Style and Copy/Paste Format. 
 				<em>Paste Format</em> is equivalent to paste 
@@ -654,7 +666,7 @@
 			</li>
 		</ul>
 		<h2 id="sirius4.0.0">Changes in Sirius 4.0.0</h2>
-		<h3 id="UserVisibleChanges3">User-Visible Changes</h3>
+		<h3 id="UserVisibleChanges4">User-Visible Changes</h3>
 		<ul>
 			<li><span class="label label-success">Added</span> The user can now filter elements according to a Typed variable (String, Integer, EEnum or any EDataType). If a user applies a filter containing Typed Variables, a dialog is displayed to allow user entering the Typed Variable values. That values can be used as variables in the Condition Expression of the Variable Filter.</li>
 			<li><span class="label label-success">Added</span> When the diagram is larger than the editor, you can move it in all directions pressing the middle-button and dragging the mouse (keeping the button pressed).</li>
@@ -1136,7 +1148,7 @@
 			</li>
 		</ul>
 		<h2 id="sirius3.1.0">Changes in Sirius 3.1.0</h2>
-		<h3 id="UserVisibleChanges4">User-Visible Changes</h3>
+		<h3 id="UserVisibleChanges5">User-Visible Changes</h3>
 		<ul>
 			<li><span class="label label-success">Added</span> A new feature allows to snap to all shapes (instead of just to snap to sibling shapes). The <kdb>F4</kdb> shortcut key activates this mode when you resize a node, move a node or move a bendpoint of an edge, see 
 				<a href="./user/diagrams/Diagrams.html#snap_to_shapes">the documentation</a> for details.
@@ -1680,7 +1692,7 @@
 			</li>
 		</ul>
 		<h2 id="sirius3.0.0">Changes in Sirius 3.0.0</h2>
-		<h3 id="UserVisibleChanges5">User-Visible Changes</h3>
+		<h3 id="UserVisibleChanges6">User-Visible Changes</h3>
 		<ul>
 			<li><span class="label label-success">Added</span> The ability to print table representations has been re-introduced.</li>
 			<li><span class="label label-success">Added</span> The quick outline feature has been added for tree and table editors, see documentation for details.</li>
diff --git a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile
index b736dfb7ac..a601f9ca17 100644
--- a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile
+++ b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile
@@ -6,6 +6,12 @@ This document contains the release notes for recent major releases of Sirius. Se
 
 h2(#sirius4.1.2). Changes in Sirius 4.1.2
 
+h3. User-Visible Changes
+
+* <span class="label label-success">Added</span> 
+A new preference named _Maximum size of tabs name_ is available in the Sirius Properties View preference page. This preference is used to shorten the tabs names when the default rules are used to render the properties view.
+!./images/PreferencePageMaxTabName.png! 
+
 h3. Developer-Visible Changes
 
 * <span class="label label-success">Added</span> @org.eclipse.sirius.diagram.ui.tools.api.format.SiriusFormatDataManagerWithMapping@ class has  been added to handle copy/paste format with mapping information when an element target of a format pasting has many source diagram format corresponding to its key. In this case, we use the mapping information to get the more precise data format. And if no result matched, then we return the first found by using the key.
diff --git a/plugins/org.eclipse.sirius.doc/doc/images/PreferencePageMaxTabName.png b/plugins/org.eclipse.sirius.doc/doc/images/PreferencePageMaxTabName.png
new file mode 100644
index 0000000000..c7efb0665b
--- /dev/null
+++ b/plugins/org.eclipse.sirius.doc/doc/images/PreferencePageMaxTabName.png
diff --git a/plugins/org.eclipse.sirius.doc/doc/index.html b/plugins/org.eclipse.sirius.doc/doc/index.html
index 46ff430b25..2c300c360c 100644
--- a/plugins/org.eclipse.sirius.doc/doc/index.html
+++ b/plugins/org.eclipse.sirius.doc/doc/index.html
@@ -49,6 +49,9 @@
 	    <li>
 	      <a href="user/trees/Trees.html">Trees</a>
 	    </li>
+        <li>
+          <a href="user/properties/Properties%20View.html">Properties Views</a>
+        </li>
 	  </ul>
 	</li>
 	<li>
diff --git a/plugins/org.eclipse.sirius.doc/doc/toc.xml b/plugins/org.eclipse.sirius.doc/doc/toc.xml
index 352c1f808c..ab89dce06c 100644
--- a/plugins/org.eclipse.sirius.doc/doc/toc.xml
+++ b/plugins/org.eclipse.sirius.doc/doc/toc.xml
@@ -42,6 +42,7 @@
       <topic href="doc/user/trees/Trees.html#items" label="Adding and Removing Tree Items" />
       <topic href="doc/user/trees/Trees.html#editing" label="Editing Tree Items" />
     </topic>
+    <topic href="doc/user/properties/Properties%20View.html" label="Properties Views"/>
     <anchor id="moreUserRefs" />
   </topic>
   <topic href="doc/specifier/Sirius Specifier Manual.html" label="Sirius Specifier Manual">
diff --git a/plugins/org.eclipse.sirius.doc/doc/user/Sirius User Manual.html b/plugins/org.eclipse.sirius.doc/doc/user/Sirius User Manual.html
index ac9ab40155..2bf509a230 100644
--- a/plugins/org.eclipse.sirius.doc/doc/user/Sirius User Manual.html
+++ b/plugins/org.eclipse.sirius.doc/doc/user/Sirius User Manual.html
@@ -43,6 +43,11 @@
 					<strong>Trees</strong>
 				</a> describes the behavior of tree (hierarchical) editors built with Sirius.
 			</li>
+			<li>
+				<a href="properties/Properties%20View.html">
+					<strong>Properties Views</strong>
+				</a> describes behaviors specific to Sirius-defined properties views.
+			</li>
 		</ul>
 	</body>
 </html>
\ No newline at end of file
diff --git a/plugins/org.eclipse.sirius.doc/doc/user/Sirius User Manual.textile b/plugins/org.eclipse.sirius.doc/doc/user/Sirius User Manual.textile
index 07f1486309..4ddb13e808 100644
--- a/plugins/org.eclipse.sirius.doc/doc/user/Sirius User Manual.textile
+++ b/plugins/org.eclipse.sirius.doc/doc/user/Sirius User Manual.textile
@@ -10,3 +10,4 @@ You will find the following sections:
 * "*Sequence Diagrams*":sequences/Sequence%20Diagrams.html are a special case of diagram with some specific behaviors which are described here.
 * "*Tables*":tables/Tables.html covers how to use the two kinds of tabular representations supported by Sirius: edition tables and cross-tables.
 * "*Trees*":trees/Trees.html describes the behavior of tree (hierarchical) editors built with Sirius.
+* "*Properties Views*":properties/Properties%20View.html describes behaviors specific to Sirius-defined properties views.
diff --git a/plugins/org.eclipse.sirius.doc/doc/user/properties/Properties View.html b/plugins/org.eclipse.sirius.doc/doc/user/properties/Properties View.html
new file mode 100644
index 0000000000..febdafa648
--- /dev/null
+++ b/plugins/org.eclipse.sirius.doc/doc/user/properties/Properties View.html
@@ -0,0 +1,66 @@
+<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+	<head>
+		<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+		<title>Properties View</title>
+		<link type="text/css" rel="stylesheet" href="../../resources/bootstrap.css"/>
+		<link type="text/css" rel="stylesheet" href="../../resources/custom.css"/>
+	</head>
+	<body>
+		<h1 id="PropertiesViews">Properties Views</h1>
+		<p>This document describes behaviors specific to Sirius-defined properties views.</p>
+		<ol class="toc" style="list-style: disc;">
+			<li>
+				<a href="#PropertiesViews">Properties Views</a>
+				<ol style="list-style: disc;">
+					<li>
+						<a href="#preferences">Preferences</a>
+						<ol style="list-style: disc;">
+							<li>
+								<a href="#LegacySemanticPropertiesTabs">Legacy Semantic Properties Tabs</a>
+							</li>
+							<li>
+								<a href="#SiriusDefaultTabs">Sirius Default Tabs</a>
+							</li>
+						</ol>
+					</li>
+				</ol>
+			</li>
+		</ol>
+		<h2 id="preferences">Preferences</h2>
+		<p>Some preferences and configuration parameters are available for you to customize your experience. They can affect the look of the properties view.</p>
+		<p>
+			<img border="0" src="./images/PropertiesViewPreferencePage.png"/>
+		</p>
+		<h3 id="LegacySemanticPropertiesTabs">Legacy Semantic Properties Tabs</h3>
+		<p>This group contains preferences to show or hide tabs provided by Sirius which display the raw properties of all semantic elements currently selected in a representation or in the 
+			<em>Model Explorer</em>. Starting from version 4.0, Sirius provides better alternatives for showing these semantic properties, but the legacy tabs are still available if needed.
+		</p>
+		<ul>
+			<li>
+				<em>Show Default Tab:</em> This checkbox allows to hide the 
+				<code>Default</code> tab which is visible by default when you select an element from the 
+				<em>Model Explorer</em>.
+			</li>
+		</ul>
+		<p>
+			<img border="0" src="./images/DefaultTabPreference.png"/>
+		</p>
+		<ul>
+			<li>
+				<em>Show Semantic Tab:</em> This checkbox allows to hide the 
+				<code>Semantic</code> tab which is visible by default when you select an element from a Sirius representation.
+			</li>
+		</ul>
+		<h3 id="SiriusDefaultTabs">Sirius Default Tabs</h3>
+		<p>This group contains preferences to modify the behavior of the tabs rendered by the Sirius properties view default rules. Note that this will only apply to the generic properties views which are used when a modeler does not provide custom ones. </p>
+		<ul>
+			<li>
+				<em>Maximum size of tabs name:</em> This field defines the maximal length of tabs names. This is used to shorten the tabs names when the default rules are used to render the properties view. The default is 20 characters.
+			</li>
+		</ul>
+		<p>
+			<img border="0" src="./images/MaxTabNamePreference.png"/>
+		</p>
+	</body>
+</html>
\ No newline at end of file
diff --git a/plugins/org.eclipse.sirius.doc/doc/user/properties/Properties View.textile b/plugins/org.eclipse.sirius.doc/doc/user/properties/Properties View.textile
new file mode 100644
index 0000000000..12169d10f8
--- /dev/null
+++ b/plugins/org.eclipse.sirius.doc/doc/user/properties/Properties View.textile
@@ -0,0 +1,29 @@
+h1. Properties Views
+
+This document describes behaviors specific to Sirius-defined properties views.
+
+{toc:style=disc|minLevel=2|maxLevel=3}
+
+h2(#preferences). Preferences
+
+Some preferences and configuration parameters are available for you to customize your experience. They can affect the look of the properties view.
+
+!./images/PropertiesViewPreferencePage.png!
+
+h3. Legacy Semantic Properties Tabs
+
+This group contains preferences to show or hide tabs provided by Sirius which display the raw properties of all semantic elements currently selected in a representation or in the _Model Explorer_. Starting from version 4.0, Sirius provides better alternatives for showing these semantic properties, but the legacy tabs are still available if needed.
+
+* _Show Default Tab:_ This checkbox allows to hide the @Default@ tab which is visible by default when you select an element from the _Model Explorer_.
+!./images/DefaultTabPreference.png!
+
+* _Show Semantic Tab:_ This checkbox allows to hide the @Semantic@ tab which is visible by default when you select an element from a Sirius representation.
+
+
+h3. Sirius Default Tabs
+
+This group contains preferences to modify the behavior of the tabs rendered by the Sirius properties view default rules. Note that this will only apply to the generic properties views which are used when a modeler does not provide custom ones. 
+
+* _Maximum size of tabs name:_ This field defines the maximal length of tabs names. This is used to shorten the tabs names when the default rules are used to render the properties view. The default is 20 characters.
+
+!./images/MaxTabNamePreference.png!
diff --git a/plugins/org.eclipse.sirius.doc/doc/user/properties/images/DefaultTabPreference.png b/plugins/org.eclipse.sirius.doc/doc/user/properties/images/DefaultTabPreference.png
new file mode 100644
index 0000000000..8bbdc209c3
--- /dev/null
+++ b/plugins/org.eclipse.sirius.doc/doc/user/properties/images/DefaultTabPreference.png
diff --git a/plugins/org.eclipse.sirius.doc/doc/user/properties/images/MaxTabNamePreference.png b/plugins/org.eclipse.sirius.doc/doc/user/properties/images/MaxTabNamePreference.png
new file mode 100644
index 0000000000..423d2115f4
--- /dev/null
+++ b/plugins/org.eclipse.sirius.doc/doc/user/properties/images/MaxTabNamePreference.png
diff --git a/plugins/org.eclipse.sirius.doc/doc/user/properties/images/PropertiesViewPreferencePage.png b/plugins/org.eclipse.sirius.doc/doc/user/properties/images/PropertiesViewPreferencePage.png
new file mode 100644
index 0000000000..45222f40b4
--- /dev/null
+++ b/plugins/org.eclipse.sirius.doc/doc/user/properties/images/PropertiesViewPreferencePage.png