Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNicolas FAUVERGUE2019-11-05 09:23:55 +0000
committerQuentin Le Menez2019-11-08 08:59:13 +0000
commit2daf6835b0bbca35cec9af252861c682e9d343cc (patch)
tree15ff15bed6c655839f2109b72697fd498c483d5a
parent961efc930f4df0d5cae8eabc20272cfc663391a1 (diff)
downloadorg.eclipse.papyrus-2daf6835b0bbca35cec9af252861c682e9d343cc.tar.gz
org.eclipse.papyrus-2daf6835b0bbca35cec9af252861c682e9d343cc.tar.xz
org.eclipse.papyrus-2daf6835b0bbca35cec9af252861c682e9d343cc.zip
Bug 550902: [Doc] The papyrus embedded documentation must be the same
than the documentation on the wiki - Add the oxygen works documentation: - Search in Model Explorer - Customize UML Label in Model Explorer - Expand in Model Explorer - Internationalization developer guide Change-Id: I99f1ca7ca8e0f6673e16c903cd97840f266505d4 Signed-off-by: Nicolas FAUVERGUE <nicolasfauvergue@gmail.com>
-rw-r--r--plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/images/Internationalization_Requirements.pngbin0 -> 71822 bytes
-rw-r--r--plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/images/Internationalization_Resource_Load.pngbin0 -> 6052 bytes
-rw-r--r--plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/images/Internationalization_Resource_MetaModel.pngbin0 -> 21360 bytes
-rw-r--r--plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/images/Internationalization_UseCase.pngbin0 -> 23515 bytes
-rw-r--r--plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/internationalizationDev.mediawiki52
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.doc/plugin.xml24
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.doc/resource/customizeUMLLabelInModelExplorer-main-toc.xml7
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.doc/resource/customizeUMLLabelInModelExplorer.mediawiki26
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.doc/resource/expandInModelExplorer-main-toc.xml7
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.doc/resource/expandInModelExplorer.mediawiki7
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ExpandInModelExplorer.jpgbin0 -> 16441 bytes
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/FilterInModelExplorer.pngbin0 -> 7452 bytes
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/LabelUMLCusto.pngbin0 -> 19024 bytes
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/SearchInModelExplorerPreferences.pngbin0 -> 2594 bytes
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.doc/resource/searchModelExplorer-main-toc.xml7
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.doc/resource/searchModelExplorer.mediawiki28
16 files changed, 157 insertions, 1 deletions
diff --git a/plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/images/Internationalization_Requirements.png b/plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/images/Internationalization_Requirements.png
new file mode 100644
index 00000000000..83481901752
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/images/Internationalization_Requirements.png
Binary files differ
diff --git a/plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/images/Internationalization_Resource_Load.png b/plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/images/Internationalization_Resource_Load.png
new file mode 100644
index 00000000000..76fededc4ce
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/images/Internationalization_Resource_Load.png
Binary files differ
diff --git a/plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/images/Internationalization_Resource_MetaModel.png b/plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/images/Internationalization_Resource_MetaModel.png
new file mode 100644
index 00000000000..cb63cc07d84
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/images/Internationalization_Resource_MetaModel.png
Binary files differ
diff --git a/plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/images/Internationalization_UseCase.png b/plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/images/Internationalization_UseCase.png
new file mode 100644
index 00000000000..4993e745023
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/images/Internationalization_UseCase.png
Binary files differ
diff --git a/plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/internationalizationDev.mediawiki b/plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/internationalizationDev.mediawiki
index 9bbaab7b18f..29b2e89db2b 100644
--- a/plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/internationalizationDev.mediawiki
+++ b/plugins/doc/org.eclipse.papyrus.infra.internationalization.doc/src/site/mediawiki/internationalizationDev.mediawiki
@@ -1,4 +1,17 @@
= Internationalization =
+
+== Requirements ==
+Requirements for the internationalization are this following:
+
+[[File:images/Internationalization_Requirements.png]]
+
+== Use case ==
+The principal use case for this feature is this following:
+
+[[File:images/Internationalization_UseCase.png]]
+
+== Description ==
+
The internationalization is the way to manage your model with a specific language by labels. Like Eclipse, the internationalization is managed by the 'properties' file which are defined depending language as following (with for example, english language in US country):
* ''modelName'''''_en_US.properties'''
* ''modelName'''''_en.properties'''
@@ -208,6 +221,43 @@ The <code>InternationalizationResource</code> need options for its load and save
The <code>InternationalizationResource</code> are managed with a <code>ModelResource</code>.
For the internationalization, the model resource is the <code>UMLInternationalizationModelResource</code> (UML plugins) inherit from <code>InternationalizationModelResource</code> (infra plugins).
+The internationalization must be managed by a resource containing data from EMF meta-model according to the ‘*.properties’ file.
+The EMF meta-model can be similar to this one:
+
+[[File:images/Internationalization_Resource_MetaModel.png]]
+
+This data must be loaded and set when the resource set of the project will be opened. This must be managed as following:
+
+[[File:images/Internationalization_Resource_Load.png]]
+
+To read the ‘*.properties’ file (if exists), the ‘ResourceBundle’ simplify this one. By example:
+
+<source lang="java">
+InternationalisationLibrary library = InternationalisationFactory.eINSTANCE.createInternationalisationLibrary();
+
+ResourceBundle resourceBundle = ResourceBundle.getBundle(eObject, localize);
+
+Enumeration keys = resourceBundle.getKeys();
+
+while (keys.hasMoreElements()) {
+
+ InternationalisationEntry entry = InternationalisationFactory.eINSTANCE.createInternationalisationEntry();
+
+ String key = (String)keys.nextElement();
+
+ entry.setKey(key);
+
+ entry.setValue(resourceBundle.getString(key));
+
+ library.getEntries().add(entry);
+
+}</source>
+
+The internationalization library must be created as previously with String ‘key’ in a first way.
+To create the UML Element reference in a second way, two ways are possible:
+* Browse all the UML elements in model and search the qualified name match
+* Retrieve the UML Element by its qualified name using ‘NameResolutionUtils’
+
=== InternationalizationKeyResolver ===
The <code>InternationalizationKeyResolver</code> and <code>UMLInternationalizationKeyResolver</code> manage the correct retrieve of Diagrams, Tables (infra plugins) and UML elements (UML plugins) by the keys and the correct save elements keys as specified previously.
@@ -224,4 +274,4 @@ The diagrams and the tables are managed in the infra plugins, however, the owner
=== Editors ===
The diagrams and tables are managed by the internationalization. To do this, the diagram and table editor must inherit from <code>IInternationalizationEditor</code> which allows to modify part name and refresh the editor with the label.
-If any new editor is comming with internationalization management, this one must ihnerit from <code>IInternationalizationEditor</code> too. \ No newline at end of file
+If any new editor is comming with internationalization management, this one must ihnerit from <code>IInternationalizationEditor</code> too.
diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.uml.doc/plugin.xml
index 4462e291b81..ed3a352e2f7 100644
--- a/plugins/doc/org.eclipse.papyrus.uml.doc/plugin.xml
+++ b/plugins/doc/org.eclipse.papyrus.uml.doc/plugin.xml
@@ -55,6 +55,30 @@
file="target/generated-eclipse-help/obfuscation-toc.xml"
primary="false">
</toc>
+ <toc
+ file="target/generated-eclipse-help/searchModelExplorer-main-toc.xml"
+ primary="false">
+ </toc>
+ <toc
+ file="target/generated-eclipse-help/searchModelExplorer-toc.xml"
+ primary="false">
+ </toc>
+ <toc
+ file="target/generated-eclipse-help/customizeUMLLabelInModelExplorer-main-toc.xml"
+ primary="false">
+ </toc>
+ <toc
+ file="target/generated-eclipse-help/customizeUMLLabelInModelExplorer-toc.xml"
+ primary="false">
+ </toc>
+ <toc
+ file="target/generated-eclipse-help/expandInModelExplorer-main-toc.xml"
+ primary="false">
+ </toc>
+ <toc
+ file="target/generated-eclipse-help/expandInModelExplorer-toc.xml"
+ primary="false">
+ </toc>
</extension>
</plugin>
diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/customizeUMLLabelInModelExplorer-main-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/customizeUMLLabelInModelExplorer-main-toc.xml
new file mode 100644
index 00000000000..1b2e925d905
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/customizeUMLLabelInModelExplorer-main-toc.xml
@@ -0,0 +1,7 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc label="Papyrus Modeling Tools" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusTipsAndTricks">
+ <topic href="target/generated-eclipse-help/customizeUMLLabelInModelExplorer.html" label="Customize Label in Model Explorer">
+ <link toc="target/generated-eclipse-help/customizeUMLLabelInModelExplorer-toc.xml"/>
+ <anchor id="PapyrusCustomizeUMLLabelInModelExplorer"/>
+ </topic>
+</toc>
diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/customizeUMLLabelInModelExplorer.mediawiki b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/customizeUMLLabelInModelExplorer.mediawiki
new file mode 100644
index 00000000000..e281bce2873
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/customizeUMLLabelInModelExplorer.mediawiki
@@ -0,0 +1,26 @@
+= It's possible to directly customize labels from model explorer =
+
+For example to have:
+ * Only the name
+ * The entire label with the stereotype, the metaclass and name
+ * the actual label
+ * the name, the stereotype in cold grey color.
+
+By default, the customized label is not activate.
+To activate click at the icon "Customize Model Explorer". Add CustomizableUMLLabel to loaded customization then move it to the top of the list for the highter priority. Validate Changes.
+Then clic on "Customize UML Label..." to customize the label visualization:
+
+[[File:images/LabelUMLCusto.png]]
+
+= Customize labels from embedded preferences in your product application =
+
+In your plugin_customization.ini file:
+
+<source lang="text">
+##Ensure facet is loading in the right order
+org.eclipse.papyrus.infra.ui.emf/defaultLoadedFacet=platform\:/plugin/org.eclipse.papyrus.uml.modelexplorer/resource/CustomizableUMLLabel.custom,platform\:/plugin/org.eclipse.papyrus.infra.gmfdiag.modelexplorer/resources/PapyrusDiagram.custom,platform\:/plugin/org.eclipse.papyrus.views.modelexplorer/resources/ReadOnlyElement.custom,platform\:/plugin/org.eclipse.papyrus.uml.modelexplorer/resource/StereotypeDisplay.custom,platform\:/plugin/org.eclipse.papyrus.infra.nattable.modelexplorer/resources/PapyrusTable.custom,platform\:/plugin/org.eclipse.papyrus.uml.modelexplorer/resource/SimpleUML.custom
+</source>
+<source lang="text">
+##Ensure we use the good type
+org.eclipse.papyrus.uml.modelexplorer/CustomizedTypes=label
+</source> \ No newline at end of file
diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/expandInModelExplorer-main-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/expandInModelExplorer-main-toc.xml
new file mode 100644
index 00000000000..f642dd37aca
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/expandInModelExplorer-main-toc.xml
@@ -0,0 +1,7 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc label="Papyrus Modeling Tools" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusTipsAndTricks">
+ <topic href="target/generated-eclipse-help/expandInModelExplorer.html" label="Expand in Model Explorer">
+ <link toc="target/generated-eclipse-help/expandInModelExplorer-toc.xml"/>
+ <anchor id="PapyrusExpandInModelExplorer"/>
+ </topic>
+</toc>
diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/expandInModelExplorer.mediawiki b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/expandInModelExplorer.mediawiki
new file mode 100644
index 00000000000..e1d4470f56a
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/expandInModelExplorer.mediawiki
@@ -0,0 +1,7 @@
+= Expand/Collapse in Model explorer =
+
+The model explorer menu will have 2 new menus:
+*+ : that will expand the tree inside the selected element (or everything if no selection)
+*- : that will collapse the tree inside the selected element (or everything if no selection)
+
+[[File:images/ExpandInModelExplorer.jpg]] \ No newline at end of file
diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ExpandInModelExplorer.jpg b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ExpandInModelExplorer.jpg
new file mode 100644
index 00000000000..ebdae6c4c53
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ExpandInModelExplorer.jpg
Binary files differ
diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/FilterInModelExplorer.png b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/FilterInModelExplorer.png
new file mode 100644
index 00000000000..e68cf0d66ec
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/FilterInModelExplorer.png
Binary files differ
diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/LabelUMLCusto.png b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/LabelUMLCusto.png
new file mode 100644
index 00000000000..c0facedfc95
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/LabelUMLCusto.png
Binary files differ
diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/SearchInModelExplorerPreferences.png b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/SearchInModelExplorerPreferences.png
new file mode 100644
index 00000000000..e2d8817a3d9
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/SearchInModelExplorerPreferences.png
Binary files differ
diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/searchModelExplorer-main-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/searchModelExplorer-main-toc.xml
new file mode 100644
index 00000000000..4dcd4e7abb3
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/searchModelExplorer-main-toc.xml
@@ -0,0 +1,7 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc label="Papyrus Modeling Tools" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusTipsAndTricks">
+ <topic href="target/generated-eclipse-help/searchModelExplorer.html" label="Search in Model Explorer">
+ <link toc="target/generated-eclipse-help/searchModelExplorer-toc.xml"/>
+ <anchor id="PapyrusSearchModelExplorer"/>
+ </topic>
+</toc>
diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/searchModelExplorer.mediawiki b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/searchModelExplorer.mediawiki
new file mode 100644
index 00000000000..cb301b59ec7
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/searchModelExplorer.mediawiki
@@ -0,0 +1,28 @@
+= Search field in Model Explorer =
+
+[[File:images/FilterInModelExplorer.png]]
+
+You can use:<br>
+<code>?</code> for any character<br>
+<code>*</code> for any string<br>
+<code>;</code> is used as OR<br>
+<code>^</code> is used as start key<br>
+<code>$</code> is used as end key<br>
+
+A case sensitive option is available (use Aa checkbox)
+
+= Preferences =
+The search is executed live (with a delay) by default and on the "enter" key.
+It can be changed in the preferences, here are the options
+ - disable the live validation
+ - change the delay (in millisecond)
+
+[[File:images/SearchInModelExplorerPreferences.png]]
+
+= Stereotype Information =
+
+Stereotype are displayed using special char that may them difficult to filter.
+
+Here is the an extract of UML 2.4.1: <br>
+Annex B: Keywords (normative) page 697
+Keywords are always enclosed in guillemets («keyword»), which serve as visual cues to more readily distinguish when a keyword is being used. (Note that guillemets are a special kind of quotation marks and should not be confused with or replaced by duplicated “greater than” (») or “less than” («) symbols, except in situations where the available character set may not include guillemets.) In addition to identifying keywords, guillemets are also used to distinguish the usage of stereotypes defined in user profiles. This means that: 1. Not all words appearing between guillemets are necessarily keywords (i.e., reserved words), and 2. words appearing in guillemets do not necessarily represent stereotypes. If multiple keywords and/or stereotype names apply to the same model element, each stereotype may be enclosed in a separate pair of guillemets and listed one after the other. Alternatively they all appear between the same pair of guillemets, separated by commas: “«” <label> [“,” <label>]* “»” where: <label> ::= <keyword> | <stereotype-label>

Back to the top