[1865] [Doc] Add documentation about how to activate a viewpoint

Bug: 1865 Change-Id: I085f96d1b3c3e792f1ada26098f036de10e36206 Signed-off-by: Jeremy Aubry <jaubry@obeo.fr>
eclipse-capella · Jan 2, 2018 · ee0f8fa · ee0f8fa
1 parent f1c54c7
commit ee0f8fa
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 0 deletions.
diff --git a/...ns/org.polarsys.capella.viewpoint.doc/html/Images/ShowView_ViewpointManager.png b/...ns/org.polarsys.capella.viewpoint.doc/html/Images/ShowView_ViewpointManager.png
diff --git a/...s/org.polarsys.capella.viewpoint.doc/html/Images/ViewpointManager_noContext.png b/...s/org.polarsys.capella.viewpoint.doc/html/Images/ViewpointManager_noContext.png
diff --git a/...s/org.polarsys.capella.viewpoint.doc/html/Images/ViewpointManager_reference.png b/...s/org.polarsys.capella.viewpoint.doc/html/Images/ViewpointManager_reference.png
diff --git a/...ugins/org.polarsys.capella.viewpoint.doc/html/Images/Windows_ShowView_Other.png b/...ugins/org.polarsys.capella.viewpoint.doc/html/Images/Windows_ShowView_Other.png
diff --git a/doc/plugins/org.polarsys.capella.viewpoint.doc/html/activation/activation.html b/doc/plugins/org.polarsys.capella.viewpoint.doc/html/activation/activation.html
@@ -0,0 +1,34 @@
+<?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>
+	<head>
+		<meta name="copyright" content="Copyright (c) Thales Global Services S.A.S, 2016. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." />
+		<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+		<link rel="stylesheet" type="text/css" href="PLUGINS_ROOT/org.polarsys.capella.doc/html/styles.css" media="all" />
+	</head>
+<body>
+
+<h2>Activation</h2>
+<p>To use Viewpoints, each projects must activate them by using the Viewpoint Manager view:<br/>
+Windows > Show View > Other... > Kitalpha > Viewpoint Manager</p>
+
+<img height="232" width="459" border="0" src="../Images/Windows_ShowView_Other.png"/><br/>
+
+<img height="491" width="342" border="0" src="../Images/ShowView_ViewpointManager.png"/><br/>
+
+<p>All Viewpoints installed are listed in this view:</p>
+
+<img height="136" width="564" border="0" src="../Images/ViewpointManager_noContext.png"/><br/>
+
+<p>To activate a viewpoint: open the session of a project, and select a model element to set the context of the view on this project.<br/>
+Then, Right-clic > Reference, to activate this specific viewpoint for this given project.</p>
+
+<img height="254" width="594" border="0" src="../Images/ViewpointManager_reference.png"/><br/>
+
+<p>To detach and remove all elements added by this viewpoint in this project, you can unreference it.<br/>
+<br/>
+For more informations:<br/>
+<a href="PLUGINS_ROOT/org.polarsys.kitalpha.ad.doc/html/usersguide/viewpointmanager.html">Kitalpha - Architecture Framework Technology Guide > Viewpoint Technology > User's Guide</a>
+</p>
+</body>
+</html>
diff --git a/doc/plugins/org.polarsys.capella.viewpoint.doc/toc.xml b/doc/plugins/org.polarsys.capella.viewpoint.doc/toc.xml
@@ -14,6 +14,8 @@
 <toc label="Viewpoints" link_to="PLUGINS_ROOT/org.polarsys.capella.doc/toc.xml#contribution">
 	<topic label="Viewpoints">
    		<topic href="html/introduction/index.html" label="Introduction"/>
+     <topic href="html/activation/activation.html" label="Activation">
+     </topic>
    		<topic href="html/migration/overview.html" label="Migration"/>
    		<anchor id="contribution"/>
    	</topic>