diff options
| author | Pierre-Charles David | 2016-05-30 11:59:47 +0000 |
|---|---|---|
| committer | Pierre-Charles David | 2016-05-30 14:14:31 +0000 |
| commit | e05d60934f10cd69e92ecd3eb453c60b13637dd9 (patch) | |
| tree | 4dc0d83624c24ee24dcd8296d34bf668518a92ac | |
| parent | 53cd12def24679d304e6ab1e75081de32fb400ae (diff) | |
| download | org.eclipse.sirius-e05d60934f10cd69e92ecd3eb453c60b13637dd9.tar.gz org.eclipse.sirius-e05d60934f10cd69e92ecd3eb453c60b13637dd9.tar.xz org.eclipse.sirius-e05d60934f10cd69e92ecd3eb453c60b13637dd9.zip | |
[490604] Improve documentation
Bug: 490604
Change-Id: Ic9640a028206d8e45c8369a104d201d0eaac62af
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
6 files changed, 129 insertions, 93 deletions
diff --git a/incubation/org.eclipse.sirius.editor.properties/doc/specifier/Properties_View_Description.html b/incubation/org.eclipse.sirius.editor.properties/doc/specifier/Properties_View_Description.html index 3fdff9a675..b10c8966c1 100644 --- a/incubation/org.eclipse.sirius.editor.properties/doc/specifier/Properties_View_Description.html +++ b/incubation/org.eclipse.sirius.editor.properties/doc/specifier/Properties_View_Description.html @@ -77,18 +77,19 @@ <p>Properties views are defined inside the VSM and identify a sub-set of the elements in the semantic model and associates an element to them in the properties view: it <em>maps</em> semantic elements onto some properties view elements. At runtime, each active properties element (pages, groups, widgets) will produce zero or more elements in the properties view, depending on how many semantic elements currently match the properties element’s definition. Whenever the current selection changes Sirius will automatically re-compute which elements should appear in the properties view according to the active widgets, and create or remove the necessary elements in the properties view. </p> + <p>Note that if you have the (optional) support for Sirius-defined properties views correctly installed but do not specify anything inside your VSMs, Sirius will apply default generic rules to provide a canonical properties view for your model elements. As soon as you specify your own configuration, as described in this document, the default rules will be ignored in favor of yours.</p> <p><span class="label label-danger">WARNING</span> This feature is first introduced in Sirius 4.0 as a “preview”. While the main mechanisms work, it should be considered in an <strong>experimental</strong> state with details subject to changes until Sirius 4.1. </p> <h2 id="properties_view_description">Properties View Description</h2> <p>Properties view are configured by creating a <em>Properties View Description</em> element (directly under the - <a href="Specifying_Viewpoints.html#vsm_organization)"> + <a href="/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Specifying_Viewpoints.html#vsm_organization"> <em>Group</em> - </a> and its sub-elements (which describe the widgets, the actions, the layout...). + </a> ) and its sub-elements (which describe the widgets, the actions, the layout...). </p> <p>Like many elements inside a - <a href="../../Glossary.html#VSM"> + <a href="/help/topic/org.eclipse.sirius.doc/doc/Glossary.html#VSM"> <em>VSM</em> </a>, <em>View Extension Description</em> have an optional @@ -101,19 +102,19 @@ <li> <a href="#pages"> <em>Page Descriptions</em> - </a>, which correspond to “tab” + </a>, which correspond to “tabs”; </li> <li> <a href="#groups"> <em>Group Descriptions</em> - </a> + </a>, which represent named sections inside a page/tab which contain the actual widgets; </li> </ul> <p>It is recommended that the <em>Properties View Description</em> be explicitly associated with the meta-model(s) of the semantic elements it will represent. You can add referenced meta-models from different sources in the <em>Metamodels</em> property section of the <em>Properties View Description</em>. Sirius will work even without this association, but setting it explicitly will give you better feedback when validating your - <a href="../../Glossary.html#VSM"> + <a href="/help/topic/org.eclipse.sirius.doc/doc/Glossary.html#VSM"> <em>VSM</em> </a>. </p> @@ -489,7 +490,7 @@ <h5 id="edit_text">Edit text</h5> <p>To define the behavior of the text when a change occurs, you simply specify the behavior associated to the edition inside the <em>Begin</em> element using all the standard - <a href="../general/Model_Operations.html">model operations</a>. + <a href="/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Model_Operations.html">model operations</a>. </p> <p>The expressions defined under the <em>Begin</em> can use the @@ -546,7 +547,7 @@ <h5 id="pushed_button">Pushed button</h5> <p>To define the behavior of the button when is pushed, you simply specify the behavior associated to the edition inside the <em>Begin</em> element using all the standard - <a href="../general/Model_Operations.html">model operations</a>. + <a href="/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Model_Operations.html">model operations</a>. </p> <h5 id="button_styles">Button styles</h5> <p>See the @@ -619,7 +620,7 @@ <h5 id="checkbox_change_value">Change value</h5> <p>To define the behavior of the checkbox when the status changes, you simply specify the behavior associated to the edition inside the <em>Begin</em> element using all the standard - <a href="../general/Model_Operations.html">model operations</a>. + <a href="/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Model_Operations.html">model operations</a>. </p> <p>The expressions defined under the <em>Begin</em> can use the @@ -661,7 +662,7 @@ <h5 id="select_change_value">Change value</h5> <p>To define the behavior of the select when the selection changes, you simply specify the behavior associated to the edition inside the <em>Begin</em> element using all the standard - <a href="../general/Model_Operations.html">model operations</a>. + <a href="/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Model_Operations.html">model operations</a>. </p> <p>The expressions defined under the <em>Begin</em> can use the @@ -703,7 +704,7 @@ <h5 id="radio_change_value">Change value</h5> <p>To define the behavior of the radio group when the selection changes, you simply specify the behavior associated to the edition inside the <em>Begin</em> element using all the standard - <a href="../general/Model_Operations.html">model operations</a>. + <a href="/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Model_Operations.html">model operations</a>. </p> <p>The expressions defined under the <em>Begin</em> can use the @@ -734,7 +735,7 @@ <h5 id="hyperlink_click_on_value">Click on value</h5> <p>To define the behavior of the hyperlinked when is clicked, you simply specify the behavior associated to the edition inside the <em>Begin</em> element using all the standard - <a href="../general/Model_Operations.html">model operations</a>. + <a href="/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Model_Operations.html">model operations</a>. </p> <h5 id="hyperlink_styles">Hyperlink styles</h5> <p>See the @@ -831,7 +832,7 @@ </ul> <p>To define the behavior, you simply specify the behavior associated to the edition inside the <em>Begin</em> element using all the standard - <a href="../general/Model_Operations.html">model operations</a>. + <a href="/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Model_Operations.html">model operations</a>. </p> <p>The expressions defined under the <em>Begin</em> can use the @@ -849,7 +850,7 @@ <h5 id="action_pushed_button">Action pushed button</h5> <p>To define the behavior of the button when is pushed, you simply specify the behavior associated to the edition inside the <em>Begin</em> element using all the standard - <a href="../general/Model_Operations.html">model operations</a>. + <a href="/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Model_Operations.html">model operations</a>. </p> <p>The expressions defined under the <em>Begin</em> can use the @@ -984,7 +985,7 @@ <h3 id="colors">Colors</h3> <p>Whenever you have to specify colors for a style, you can use either one of the pre-defined system colors or one which you have defined yourself in a <em>Users Color Palette</em>. See - <a href="../general/Colors.html">the general section on colors</a> for more details. + <a href="/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Colors.html">the general section on colors</a> for more details. </p> <h3 id="conditional_styles">Conditional styles</h3> <p>Conditional styles make it possible to support different graphical aspects for a single properties view element. The actual style used to render an element is determined dynamically depending on the current state of the models elements.</p> diff --git a/incubation/org.eclipse.sirius.editor.properties/doc/specifier/Properties_View_Description.textile b/incubation/org.eclipse.sirius.editor.properties/doc/specifier/Properties_View_Description.textile index 08945d5a15..dd90495bc6 100644 --- a/incubation/org.eclipse.sirius.editor.properties/doc/specifier/Properties_View_Description.textile +++ b/incubation/org.eclipse.sirius.editor.properties/doc/specifier/Properties_View_Description.textile @@ -8,19 +8,21 @@ Starting from version 4.0, Sirius supports the definition of properties views wi Properties views are defined inside the VSM and identify a sub-set of the elements in the semantic model and associates an element to them in the properties view: it _maps_ semantic elements onto some properties view elements. At runtime, each active properties element (pages, groups, widgets) will produce zero or more elements in the properties view, depending on how many semantic elements currently match the properties element's definition. Whenever the current selection changes Sirius will automatically re-compute which elements should appear in the properties view according to the active widgets, and create or remove the necessary elements in the properties view. +Note that if you have the (optional) support for Sirius-defined properties views correctly installed but do not specify anything inside your VSMs, Sirius will apply default generic rules to provide a canonical properties view for your model elements. As soon as you specify your own configuration, as described in this document, the default rules will be ignored in favor of yours. + <span class="label label-danger">WARNING</span> This feature is first introduced in Sirius 4.0 as a "preview". While the main mechanisms work, it should be considered in an *experimental* state with details subject to changes until Sirius 4.1. h2(#properties_view_description). Properties View Description -Properties view are configured by creating a _Properties View Description_ element (directly under the "_Group_":Specifying_Viewpoints.html#vsm_organization) and its sub-elements (which describe the widgets, the actions, the layout...). +Properties view are configured by creating a _Properties View Description_ element (directly under the "_Group_":/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Specifying_Viewpoints.html#vsm_organization ) and its sub-elements (which describe the widgets, the actions, the layout...). -Like many elements inside a "_VSM_":../../Glossary.html#VSM, _View Extension Description_ have an optional _Identifier_, which should be unique. +Like many elements inside a "_VSM_":/help/topic/org.eclipse.sirius.doc/doc/Glossary.html#VSM, _View Extension Description_ have an optional _Identifier_, which should be unique. Inside a _Properties View Description_ element, you can create: -* "_Page Descriptions_":#pages, which correspond to "tab" -* "_Group Descriptions_":#groups +* "_Page Descriptions_":#pages, which correspond to "tabs"; +* "_Group Descriptions_":#groups, which represent named sections inside a page/tab which contain the actual widgets; -It is recommended that the _Properties View Description_ be explicitly associated with the meta-model(s) of the semantic elements it will represent. You can add referenced meta-models from different sources in the _Metamodels_ property section of the _Properties View Description_. Sirius will work even without this association, but setting it explicitly will give you better feedback when validating your "_VSM_":../../Glossary.html#VSM. +It is recommended that the _Properties View Description_ be explicitly associated with the meta-model(s) of the semantic elements it will represent. You can add referenced meta-models from different sources in the _Metamodels_ property section of the _Properties View Description_. Sirius will work even without this association, but setting it explicitly will give you better feedback when validating your "_VSM_":/help/topic/org.eclipse.sirius.doc/doc/Glossary.html#VSM. The descriptions for all the different types of properties view elements share the same common principles: * Some of the elements of the semantic model are selected, using a combination of configuration attributes (see below). These elements are called _targets_, and each one has a single widget of this type representing it. @@ -160,7 +162,7 @@ For text areas, you must define the _Line Count_ which is represents the height h5(#edit_text). Edit text -To define the behavior of the text when a change occurs, you simply specify the behavior associated to the edition inside the _Begin_ element using all the standard "model operations":../general/Model_Operations.html. +To define the behavior of the text when a change occurs, you simply specify the behavior associated to the edition inside the _Begin_ element using all the standard "model operations":/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Model_Operations.html. The expressions defined under the _Begin_ can use the @newValue@ variable which represents the value entered by the user. @@ -193,7 +195,7 @@ For buttons, you must define the _Button Label Expression_ which is used to comp h5(#pushed_button). Pushed button -To define the behavior of the button when is pushed, you simply specify the behavior associated to the edition inside the _Begin_ element using all the standard "model operations":../general/Model_Operations.html. +To define the behavior of the button when is pushed, you simply specify the behavior associated to the edition inside the _Begin_ element using all the standard "model operations":/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Model_Operations.html. h5(#button_styles). Button styles @@ -236,7 +238,7 @@ For checkboxes, you must define the _Value Expression_ which is used to compute h5(#checkbox_change_value). Change value -To define the behavior of the checkbox when the status changes, you simply specify the behavior associated to the edition inside the _Begin_ element using all the standard "model operations":../general/Model_Operations.html. +To define the behavior of the checkbox when the status changes, you simply specify the behavior associated to the edition inside the _Begin_ element using all the standard "model operations":/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Model_Operations.html. The expressions defined under the _Begin_ can use the @newValue@ variable which represents the value set by the user. @@ -259,7 +261,7 @@ For selects, you must define : h5(#select_change_value). Change value -To define the behavior of the select when the selection changes, you simply specify the behavior associated to the edition inside the _Begin_ element using all the standard "model operations":../general/Model_Operations.html. +To define the behavior of the select when the selection changes, you simply specify the behavior associated to the edition inside the _Begin_ element using all the standard "model operations":/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Model_Operations.html. The expressions defined under the _Begin_ can use the @newValue@ variable which represents the value selected by the user. @@ -282,7 +284,7 @@ For radio groups, you must define : h5(#radio_change_value). Change value -To define the behavior of the radio group when the selection changes, you simply specify the behavior associated to the edition inside the _Begin_ element using all the standard "model operations":../general/Model_Operations.html. +To define the behavior of the radio group when the selection changes, you simply specify the behavior associated to the edition inside the _Begin_ element using all the standard "model operations":/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Model_Operations.html. The expressions defined under the _Begin_ can use the @newValue@ variable which represents the value selected by the user. @@ -302,7 +304,7 @@ For hyperlinks, you must define the _Value Expression_ which is used to compute h5(#hyperlink_click_on_value). Click on value -To define the behavior of the hyperlinked when is clicked, you simply specify the behavior associated to the edition inside the _Begin_ element using all the standard "model operations":../general/Model_Operations.html. +To define the behavior of the hyperlinked when is clicked, you simply specify the behavior associated to the edition inside the _Begin_ element using all the standard "model operations":/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Model_Operations.html. h5(#hyperlink_styles). Hyperlink styles @@ -344,7 +346,7 @@ If the _On Click Expression_ is set then: * if multiple *is not checked* : an hyperlink is used to represent the value. This expression then defines the behavior executed when the user clicks on the hyperlink. * if multiple *is checked* : a table is used to represent the values. This expression then defines the behavior executed when the user double-clicks on an element in the table. -To define the behavior, you simply specify the behavior associated to the edition inside the _Begin_ element using all the standard "model operations":../general/Model_Operations.html. +To define the behavior, you simply specify the behavior associated to the edition inside the _Begin_ element using all the standard "model operations":/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Model_Operations.html. The expressions defined under the _Begin_ can use the @selection@ variable which represents the values selected by the user. It could be at least one element or a list of elements in case of multiple flags is checked. @@ -356,7 +358,7 @@ For actions, you must define the _Label Expression_ which is used to compute the h5(#action_pushed_button). Action pushed button -To define the behavior of the button when is pushed, you simply specify the behavior associated to the edition inside the _Begin_ element using all the standard "model operations":../general/Model_Operations.html. +To define the behavior of the button when is pushed, you simply specify the behavior associated to the edition inside the _Begin_ element using all the standard "model operations":/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Model_Operations.html. The expressions defined under the _Begin_ can use the @selection@ variable which represents the values selected by the user in the reference field. @@ -428,7 +430,7 @@ One of the responsibility of widgets styles is to describe how labels will be fo h3(#colors). Colors -Whenever you have to specify colors for a style, you can use either one of the pre-defined system colors or one which you have defined yourself in a _Users Color Palette_. See "the general section on colors":../general/Colors.html for more details. +Whenever you have to specify colors for a style, you can use either one of the pre-defined system colors or one which you have defined yourself in a _Users Color Palette_. See "the general section on colors":/help/topic/org.eclipse.sirius.doc/doc/specifier/general/Colors.html for more details. h3(#conditional_styles). Conditional styles diff --git a/incubation/org.eclipse.sirius.editor.properties/doc/toc.xml b/incubation/org.eclipse.sirius.editor.properties/doc/toc.xml index 08b9c33d0c..e791c2284e 100644 --- a/incubation/org.eclipse.sirius.editor.properties/doc/toc.xml +++ b/incubation/org.eclipse.sirius.editor.properties/doc/toc.xml @@ -9,72 +9,70 @@ Contributors: Obeo - Initial API and implementation --> -<toc label="Sirius Properties Views" link_to="../org.eclipse.sirius.doc/doc/toc.xml#moreSpecifierRefs" topic="doc/specifier/Properties_View_Description.html"> +<toc label="Sirius Properties Views" link_to="../org.eclipse.sirius.doc/doc/toc.xml#moreSpecifierDialectRefs" topic="doc/specifier/Properties_View_Description.html"> <topic href="doc/specifier/Properties_View_Description.html" label="Properties View"> - <topic href="doc/specifier/Properties_View_Description.html" label="Properties View"> - <topic href="doc/specifier/Properties_View_Description.html#introduction" label="Introduction"></topic> - <topic href="doc/specifier/Properties_View_Description.html#properties_view_description" label="Properties View Description"> - <topic href="doc/specifier/Properties_View_Description.html#common_attributes" label="Common attributes"></topic> - <topic href="doc/specifier/Properties_View_Description.html#pages" label="Pages"></topic> - <topic href="doc/specifier/Properties_View_Description.html#groups" label="Groups"> - <topic href="doc/specifier/Properties_View_Description.html#group_styles" label="Group styles"></topic> - </topic> - <topic href="doc/specifier/Properties_View_Description.html#controls" label="Controls"></topic> - <topic href="doc/specifier/Properties_View_Description.html#widgets" label="Widgets"> - <topic href="doc/specifier/Properties_View_Description.html#text" label="Text / Text area"> - <topic href="doc/specifier/Properties_View_Description.html#edit_text" label="Edit text"></topic> - <topic href="doc/specifier/Properties_View_Description.html#text_styles" label="Text/Text area styles"></topic> - </topic> - <topic href="doc/specifier/Properties_View_Description.html#button" label="Button"> - <topic href="doc/specifier/Properties_View_Description.html#pushed_button" label="Pushed button"></topic> - <topic href="doc/specifier/Properties_View_Description.html#button_styles" label="Button styles"></topic> - </topic> - <topic href="doc/specifier/Properties_View_Description.html#label" label="Label"> - <topic href="doc/specifier/Properties_View_Description.html#label_styles" label="Label styles"></topic> - </topic> - <topic href="doc/specifier/Properties_View_Description.html#checkbox" label="Checkbox"> - <topic href="doc/specifier/Properties_View_Description.html#checkbox_change_value" label="Change value"></topic> - <topic href="doc/specifier/Properties_View_Description.html#checkbox_styles" label="Checkbox styles"></topic> - </topic> - <topic href="doc/specifier/Properties_View_Description.html#select" label="Select"> - <topic href="doc/specifier/Properties_View_Description.html#select_change_value" label="Change value"></topic> - <topic href="doc/specifier/Properties_View_Description.html#select_styles" label="Select styles"></topic> - </topic> - <topic href="doc/specifier/Properties_View_Description.html#radio_group" label="Radio group"> - <topic href="doc/specifier/Properties_View_Description.html#radio_change_value" label="Change value"></topic> - <topic href="doc/specifier/Properties_View_Description.html#radio_styles" label="Radio styles"></topic> - </topic> - <topic href="doc/specifier/Properties_View_Description.html#hyperlink" label="Hyperlink"> - <topic href="doc/specifier/Properties_View_Description.html#hyperlink_click_on_value" label="Click on value"></topic> - <topic href="doc/specifier/Properties_View_Description.html#hyperlink_styles" label="Hyperlink styles"></topic> - </topic> - <topic href="doc/specifier/Properties_View_Description.html#reference" label="Reference"> - <topic href="doc/specifier/Properties_View_Description.html#reference_click_on_value" label="Click on value"></topic> - <topic href="doc/specifier/Properties_View_Description.html#actions" label="Actions"></topic> - <topic href="doc/specifier/Properties_View_Description.html#action_pushed_button" label="Action pushed button"></topic> - <topic href="doc/specifier/Properties_View_Description.html#reference_styles" label="Reference styles"></topic> - </topic> - <topic href="doc/specifier/Properties_View_Description.html#custom" label="Custom"> - <topic href="doc/specifier/Properties_View_Description.html#custom_expression" label="Custom Expression/Operation"></topic> - <topic href="doc/specifier/Properties_View_Description.html#custom_styles" label="Custom styles"></topic> - </topic> - </topic> - <topic href="doc/specifier/Properties_View_Description.html#dynamic_mappings" label="Dynamic mappings"></topic> - <topic href="doc/specifier/Properties_View_Description.html#containers" label="Containers"> - <topic href="doc/specifier/Properties_View_Description.html#layout" label="Layout"></topic> - </topic> + <topic href="doc/specifier/Properties_View_Description.html#introduction" label="Introduction"></topic> + <topic href="doc/specifier/Properties_View_Description.html#properties_view_description" label="Properties View Description"> + <topic href="doc/specifier/Properties_View_Description.html#common_attributes" label="Common attributes"></topic> + <topic href="doc/specifier/Properties_View_Description.html#pages" label="Pages"></topic> + <topic href="doc/specifier/Properties_View_Description.html#groups" label="Groups"> + <topic href="doc/specifier/Properties_View_Description.html#group_styles" label="Group styles"></topic> + </topic> + <topic href="doc/specifier/Properties_View_Description.html#controls" label="Controls"></topic> + <topic href="doc/specifier/Properties_View_Description.html#widgets" label="Widgets"> + <topic href="doc/specifier/Properties_View_Description.html#text" label="Text / Text area"> + <topic href="doc/specifier/Properties_View_Description.html#edit_text" label="Edit text"></topic> + <topic href="doc/specifier/Properties_View_Description.html#text_styles" label="Text/Text area styles"></topic> </topic> - <topic href="doc/specifier/Properties_View_Description.html#styling" label="Styling"> - <topic href="doc/specifier/Properties_View_Description.html#widgets_styles" label="Widgets styles"></topic> - <topic href="doc/specifier/Properties_View_Description.html#colors" label="Colors"></topic> - <topic href="doc/specifier/Properties_View_Description.html#conditional_styles" label="Conditional styles"></topic> - <topic href="doc/specifier/Properties_View_Description.html#label_properties" label="Label properties"></topic> + <topic href="doc/specifier/Properties_View_Description.html#button" label="Button"> + <topic href="doc/specifier/Properties_View_Description.html#pushed_button" label="Pushed button"></topic> + <topic href="doc/specifier/Properties_View_Description.html#button_styles" label="Button styles"></topic> </topic> - <topic href="doc/specifier/Properties_View_Description.html#validation_rules" label="Validation rules"> - <topic href="doc/specifier/Properties_View_Description.html#page_semantic_validation_rule" label="Page semantic validation rule"></topic> - <topic href="doc/specifier/Properties_View_Description.html#group_semantic_validation_rule" label="Group semantic validation rule"></topic> - <topic href="doc/specifier/Properties_View_Description.html#group_property_validation_rule" label="Group property validation rule"></topic> + <topic href="doc/specifier/Properties_View_Description.html#label" label="Label"> + <topic href="doc/specifier/Properties_View_Description.html#label_styles" label="Label styles"></topic> </topic> + <topic href="doc/specifier/Properties_View_Description.html#checkbox" label="Checkbox"> + <topic href="doc/specifier/Properties_View_Description.html#checkbox_change_value" label="Change value"></topic> + <topic href="doc/specifier/Properties_View_Description.html#checkbox_styles" label="Checkbox styles"></topic> + </topic> + <topic href="doc/specifier/Properties_View_Description.html#select" label="Select"> + <topic href="doc/specifier/Properties_View_Description.html#select_change_value" label="Change value"></topic> + <topic href="doc/specifier/Properties_View_Description.html#select_styles" label="Select styles"></topic> + </topic> + <topic href="doc/specifier/Properties_View_Description.html#radio_group" label="Radio group"> + <topic href="doc/specifier/Properties_View_Description.html#radio_change_value" label="Change value"></topic> + <topic href="doc/specifier/Properties_View_Description.html#radio_styles" label="Radio styles"></topic> + </topic> + <topic href="doc/specifier/Properties_View_Description.html#hyperlink" label="Hyperlink"> + <topic href="doc/specifier/Properties_View_Description.html#hyperlink_click_on_value" label="Click on value"></topic> + <topic href="doc/specifier/Properties_View_Description.html#hyperlink_styles" label="Hyperlink styles"></topic> + </topic> + <topic href="doc/specifier/Properties_View_Description.html#reference" label="Reference"> + <topic href="doc/specifier/Properties_View_Description.html#reference_click_on_value" label="Click on value"></topic> + <topic href="doc/specifier/Properties_View_Description.html#actions" label="Actions"></topic> + <topic href="doc/specifier/Properties_View_Description.html#action_pushed_button" label="Action pushed button"></topic> + <topic href="doc/specifier/Properties_View_Description.html#reference_styles" label="Reference styles"></topic> + </topic> + <topic href="doc/specifier/Properties_View_Description.html#custom" label="Custom"> + <topic href="doc/specifier/Properties_View_Description.html#custom_expression" label="Custom Expression/Operation"></topic> + <topic href="doc/specifier/Properties_View_Description.html#custom_styles" label="Custom styles"></topic> + </topic> + </topic> + <topic href="doc/specifier/Properties_View_Description.html#dynamic_mappings" label="Dynamic mappings"></topic> + <topic href="doc/specifier/Properties_View_Description.html#containers" label="Containers"> + <topic href="doc/specifier/Properties_View_Description.html#layout" label="Layout"></topic> + </topic> + </topic> + <topic href="doc/specifier/Properties_View_Description.html#styling" label="Styling"> + <topic href="doc/specifier/Properties_View_Description.html#widgets_styles" label="Widgets styles"></topic> + <topic href="doc/specifier/Properties_View_Description.html#colors" label="Colors"></topic> + <topic href="doc/specifier/Properties_View_Description.html#conditional_styles" label="Conditional styles"></topic> + <topic href="doc/specifier/Properties_View_Description.html#label_properties" label="Label properties"></topic> + </topic> + <topic href="doc/specifier/Properties_View_Description.html#validation_rules" label="Validation rules"> + <topic href="doc/specifier/Properties_View_Description.html#page_semantic_validation_rule" label="Page semantic validation rule"></topic> + <topic href="doc/specifier/Properties_View_Description.html#group_semantic_validation_rule" label="Group semantic validation rule"></topic> + <topic href="doc/specifier/Properties_View_Description.html#group_property_validation_rule" label="Group property validation rule"></topic> </topic> </topic> </toc> diff --git a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html index cbd4958552..611d47b215 100644 --- a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html +++ b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html @@ -97,6 +97,32 @@ </ul> <h3 id="SpecifierVisibleChanges">Specifier-Visible Changes</h3> <ul> + <li><span class="label label-success">Added</span> Sirius 4.0 introduces + <strong>experimental</strong> support for specifying the properties views of your modelers directly from inside the VSM. This feature uses the same dynamic approach as for specifying diagrams, tables and trees, with a very flexible configuration language and no code generation involved (including live preview of any change). As of Sirius 4.0, this feature should be considered in an experimental state with details subject to changes until Sirius 4.1, and is not installed by default. To install it, make sure either + <a href="http://download.eclipse.org/releases/neon">the Eclipse Neon repositry</a> or the + <a href="http://download.eclipse.org/sirius/updates/releases/4.0.0/neon">Sirius 4.0</a> and + <a href="http://download.eclipse.org/modeling/emft/eef/updates/releases/1.6.0">EEF 1.6</a> repositories are available, and then to install the following features (from in the + <em>Modeling</em> category of Neon, or + <em>Sirius Experimental Features</em> of the Sirius repository ): + <ul> + <li> + <em>Sirius Properties Views – Runtime Support</em> ( + <code>org.eclipse.sirius.properties.feature.feature.group</code>): needed at runtime for deployed modelers which have properties views defined in their specification. + </li> + <li> + <em>Sirius Properties Views – Specifier Support</em> ( + <code>org.eclipse.sirius.specifier.properties.feature.feature.group</code>): provides support for editing the configuration model directly inside the VSM editor and the specifier documentation. + </li> + </ul> + </li> + </ul> + <p>Once this is done, you can find the actual documentation in the + <em>Sirius Specifier Manual</em>, under the + <a href="/help/topic/org.eclipse.sirius.editor.properties/doc/specifier/Properties_View_Description.html"> + <em>Properties View</em> + </a> section. + </p> + <ul> <li><span class="label label-success">Added</span> All static strings defined in the VSMs which are visible to the end-user of the modeler, like viewpoint and tools names, can now be internationalized. Simply replace the name with a translation key reference of the form <code>%myUniqueKey</code> in the VSM, and define the value in the <em>Viewpoint Specification Project</em>'s @@ -117,7 +143,11 @@ <li><span class="label label-success">Added</span> The specifier can now restrict the border node authorized sides. This new option is available in the advanced tab of the border node style. See the <a href="specifier/diagrams/Diagrams.html#authorizedsides">specifier documentation</a> for more details. </li> - <li><span class="label label-info">Modified</span> The use of type literals in operations like filter() or oclIsKindOf() requires to explicitly add the domain meta-models plug-ins to the dependencies of the Viewpoint Specification Project. The documentation has been modified to recommend this.</li> + <li><span class="label label-info">Modified</span> The use of type literals in operations like + <code>filter()</code> or + <code>oclIsKindOf()</code> requires to explicitly add the domain meta-models plug-ins to the dependencies of the + <em>Viewpoint Specification Project</em>. The documentation has been modified to recommend this. + </li> <li><span class="label label-info">Modified</span> <strong>Warning</strong>: Before this version, a style customization of an <code>EEnum</code> attribute, like diff --git a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile index 3a82f5beab..b49d641b05 100644 --- a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile +++ b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile @@ -20,11 +20,15 @@ h3. User-Visible Changes h3. Specifier-Visible Changes +* <span class="label label-success">Added</span> Sirius 4.0 introduces *experimental* support for specifying the properties views of your modelers directly from inside the VSM. This feature uses the same dynamic approach as for specifying diagrams, tables and trees, with a very flexible configuration language and no code generation involved (including live preview of any change). As of Sirius 4.0, this feature should be considered in an experimental state with details subject to changes until Sirius 4.1, and is not installed by default. To install it, make sure either "the Eclipse Neon repositry":http://download.eclipse.org/releases/neon or the "Sirius 4.0":http://download.eclipse.org/sirius/updates/releases/4.0.0/neon and "EEF 1.6":http://download.eclipse.org/modeling/emft/eef/updates/releases/1.6.0 repositories are available, and then to install the following features (from in the _Modeling_ category of Neon, or _Sirius Experimental Features_ of the Sirius repository ): +** _Sirius Properties Views - Runtime Support_ (@org.eclipse.sirius.properties.feature.feature.group@): needed at runtime for deployed modelers which have properties views defined in their specification. +** _Sirius Properties Views - Specifier Support_ (@org.eclipse.sirius.specifier.properties.feature.feature.group@): provides support for editing the configuration model directly inside the VSM editor and the specifier documentation. +Once this is done, you can find the actual documentation in the _Sirius Specifier Manual_, under the "_Properties View_":/help/topic/org.eclipse.sirius.editor.properties/doc/specifier/Properties_View_Description.html section. * <span class="label label-success">Added</span> All static strings defined in the VSMs which are visible to the end-user of the modeler, like viewpoint and tools names, can now be internationalized. Simply replace the name with a translation key reference of the form @%myUniqueKey@ in the VSM, and define the value in the _Viewpoint Specification Project_'s @plugin.properties@ (for the default value), or @plugin_XX.properties@ for locale @XX@. The underlying mechanism is the same as for Eclipse/OSGi plug-ins, so translations can even be contributed by physically separate plug-in fragments. See "the corresponding section":specifier/general/Specifying_Viewpoints.html#translatable_messages in the documentation for more details. * <span class="label label-success">Added</span> It is possible to create "Typed Variable":specifier/diagrams/Diagrams.html#filter_with_typed_variable under Variable Filter. * <span class="label label-success">Added</span> A new class @org.eclipse.sirius.ext.emf.edit.EditingDomainServices@ (from plug-in @org.eclipse.sirius.ext.emf.edit@) has been added with a complete set of service methods to leverage most of the features of the "EMF Edit" framework, for example the various _Item Providers_ associated to semantic elements. See "the documentation":specifier/general/Writing_Queries.html#editing_domain_services for details. * <span class="label label-success">Added</span> The specifier can now restrict the border node authorized sides. This new option is available in the advanced tab of the border node style. See the "specifier documentation":specifier/diagrams/Diagrams.html#authorizedsides for more details. -* <span class="label label-info">Modified</span> The use of type literals in operations like filter() or oclIsKindOf() requires to explicitly add the domain meta-models plug-ins to the dependencies of the Viewpoint Specification Project. The documentation has been modified to recommend this. +* <span class="label label-info">Modified</span> The use of type literals in operations like @filter()@ or @oclIsKindOf()@ requires to explicitly add the domain meta-models plug-ins to the dependencies of the _Viewpoint Specification Project_. The documentation has been modified to recommend this. * <span class="label label-info">Modified</span> *Warning*: Before this version, a style customization of an @EEnum@ attribute, like @labelFormat@, worked with a value expression using a Java service returning a @EEnumLiteral@. It is now forbidden. You must return an @Enumerator@. The documentation about "Styles Customization":specifier/diagrams/Diagrams.html#enum_customization now details this case. * <span class="label label-info">Modified</span> The @BorderSizeComputationExpression@ migration has been corrected to recursively handle the sub container mappings. VSM created or migrated with Sirius 3.1.0, 3.1.1 or 3.1.2 might require a manual modification for the style descriptions of sub container mappings with border size computation equals to 0 as we cannot determine if they were added (or updated) after or before the migration: starting with Sirius 3.1.0, no border will be displayed for a 0 pixel value whereas with older version container always had at least a 1 pixel border. * <span class="label label-info">Modified</span> The variable under VariableFilter, previously named "Variable", is renamed to "Select Model Element Variable". It is functionally equivalent. diff --git a/plugins/org.eclipse.sirius.doc/doc/toc.xml b/plugins/org.eclipse.sirius.doc/doc/toc.xml index 841ccfbb70..8c4ce613bc 100644 --- a/plugins/org.eclipse.sirius.doc/doc/toc.xml +++ b/plugins/org.eclipse.sirius.doc/doc/toc.xml @@ -117,6 +117,7 @@ <topic href="doc/specifier/trees/Trees.html#item_tools" label="Tree Item Tools" /> </topic> </topic> + <anchor id="moreSpecifierDialectRefs" /> <topic href="doc/specifier/general/ToolsSpecification.html" label="Tools Specification" /> <topic href="doc/specifier/general/Model_Operations.html" label="Model Operations" /> <topic href="doc/specifier/general/Colors.html" label="Color Palettes" /> |