Integration promoting web site for 3.3.1. (46fec3e)

ObeoNetwork · Sep 19, 2023 · fec6ad5 · fec6ad5
1 parent ca77aca
commit fec6ad5
Show file tree

Hide file tree

Showing 69 changed files with 7,483 additions and 0 deletions.
diff --git a/_data/pages.yml b/_data/pages.yml
@@ -34,6 +34,8 @@
   - title: Nightly
     file: ref-doc/nightly/index
 #---TAG---
+  - title: 3.3.1
+    file: ref-doc/3.3.1/index
   - title: 3.3.0
     file: ref-doc/3.3.0/index
   - title: 3.2.2

diff --git a/ref-doc/3.3.1/images/DBResult.png b/ref-doc/3.3.1/images/DBResult.png
diff --git a/ref-doc/3.3.1/images/DBTemplate.png b/ref-doc/3.3.1/images/DBTemplate.png
diff --git a/ref-doc/3.3.1/images/Edit Documentation Configuration menu.png b/ref-doc/3.3.1/images/Edit Documentation Configuration menu.png
diff --git a/ref-doc/3.3.1/images/Edit Template Properties menu.png b/ref-doc/3.3.1/images/Edit Template Properties menu.png
diff --git a/ref-doc/3.3.1/images/Extracting information.png b/ref-doc/3.3.1/images/Extracting information.png
diff --git a/ref-doc/3.3.1/images/Field edition.png b/ref-doc/3.3.1/images/Field edition.png
diff --git a/ref-doc/3.3.1/images/Field visualization edition (copie).png b/ref-doc/3.3.1/images/Field visualization edition (copie).png
diff --git a/ref-doc/3.3.1/images/Field visualization.png b/ref-doc/3.3.1/images/Field visualization.png
diff --git a/ref-doc/3.3.1/images/Formatting template.png b/ref-doc/3.3.1/images/Formatting template.png
diff --git a/ref-doc/3.3.1/images/Generate Documentation menu.png b/ref-doc/3.3.1/images/Generate Documentation menu.png
diff --git a/ref-doc/3.3.1/images/Generation Configuration Wizard1.png b/ref-doc/3.3.1/images/Generation Configuration Wizard1.png
diff --git a/ref-doc/3.3.1/images/Generation Configuration Wizard2.png b/ref-doc/3.3.1/images/Generation Configuration Wizard2.png
diff --git a/ref-doc/3.3.1/images/Import Wizard Selection.png b/ref-doc/3.3.1/images/Import Wizard Selection.png
diff --git a/ref-doc/3.3.1/images/Import menu.png b/ref-doc/3.3.1/images/Import menu.png
diff --git a/ref-doc/3.3.1/images/Initialize Documentation Configuration menu.png b/ref-doc/3.3.1/images/Initialize Documentation Configuration menu.png
diff --git a/ref-doc/3.3.1/images/Interpreter view1.png b/ref-doc/3.3.1/images/Interpreter view1.png
diff --git a/ref-doc/3.3.1/images/Interpreter view2.png b/ref-doc/3.3.1/images/Interpreter view2.png
diff --git a/ref-doc/3.3.1/images/Interpreter view3.png b/ref-doc/3.3.1/images/Interpreter view3.png
diff --git a/ref-doc/3.3.1/images/Interpreter view4.png b/ref-doc/3.3.1/images/Interpreter view4.png
diff --git a/ref-doc/3.3.1/images/Interpreter view5.png b/ref-doc/3.3.1/images/Interpreter view5.png
diff --git a/ref-doc/3.3.1/images/Interpreter view6.png b/ref-doc/3.3.1/images/Interpreter view6.png
diff --git a/ref-doc/3.3.1/images/Interpreter view7.png b/ref-doc/3.3.1/images/Interpreter view7.png
diff --git a/ref-doc/3.3.1/images/M2Doc Generate Template menu.png b/ref-doc/3.3.1/images/M2Doc Generate Template menu.png
diff --git a/ref-doc/3.3.1/images/M2Doc Update Document menu.png b/ref-doc/3.3.1/images/M2Doc Update Document menu.png
diff --git a/ref-doc/3.3.1/images/M2DocWorkflow.png b/ref-doc/3.3.1/images/M2DocWorkflow.png
diff --git a/ref-doc/3.3.1/images/Main steps.png b/ref-doc/3.3.1/images/Main steps.png
diff --git a/ref-doc/3.3.1/images/New Project Wizard1.png b/ref-doc/3.3.1/images/New Project Wizard1.png
diff --git a/ref-doc/3.3.1/images/New Project Wizard2.png b/ref-doc/3.3.1/images/New Project Wizard2.png
diff --git a/ref-doc/3.3.1/images/New Project Wizard3.png b/ref-doc/3.3.1/images/New Project Wizard3.png
diff --git a/ref-doc/3.3.1/images/New Project Wizard4.png b/ref-doc/3.3.1/images/New Project Wizard4.png
diff --git a/ref-doc/3.3.1/images/New Project Wizard5.png b/ref-doc/3.3.1/images/New Project Wizard5.png
diff --git a/ref-doc/3.3.1/images/New Project Wizard6.png b/ref-doc/3.3.1/images/New Project Wizard6.png
diff --git a/ref-doc/3.3.1/images/New Project Wizard7.png b/ref-doc/3.3.1/images/New Project Wizard7.png
diff --git a/ref-doc/3.3.1/images/New Project Wizard8.png b/ref-doc/3.3.1/images/New Project Wizard8.png
diff --git a/ref-doc/3.3.1/images/New Template Wizard1.png b/ref-doc/3.3.1/images/New Template Wizard1.png
diff --git a/ref-doc/3.3.1/images/New Template Wizard2.png b/ref-doc/3.3.1/images/New Template Wizard2.png
diff --git a/ref-doc/3.3.1/images/New Template Wizard3.png b/ref-doc/3.3.1/images/New Template Wizard3.png
diff --git a/ref-doc/3.3.1/images/New Template Wizard4.png b/ref-doc/3.3.1/images/New Template Wizard4.png
diff --git a/ref-doc/3.3.1/images/New Template Wizard5.png b/ref-doc/3.3.1/images/New Template Wizard5.png
diff --git a/ref-doc/3.3.1/images/New Template Wizard6.png b/ref-doc/3.3.1/images/New Template Wizard6.png
diff --git a/ref-doc/3.3.1/images/Open with menu.png b/ref-doc/3.3.1/images/Open with menu.png
diff --git a/ref-doc/3.3.1/images/Package selection dialog.png b/ref-doc/3.3.1/images/Package selection dialog.png
diff --git a/ref-doc/3.3.1/images/Service selection dialog.png b/ref-doc/3.3.1/images/Service selection dialog.png
diff --git a/ref-doc/3.3.1/images/Service token selection dialog.png b/ref-doc/3.3.1/images/Service token selection dialog.png
diff --git a/ref-doc/3.3.1/images/TechnicalArchitecture.png b/ref-doc/3.3.1/images/TechnicalArchitecture.png
diff --git a/ref-doc/3.3.1/images/Template Import Wizard1.png b/ref-doc/3.3.1/images/Template Import Wizard1.png
diff --git a/ref-doc/3.3.1/images/Template Import Wizard2.png b/ref-doc/3.3.1/images/Template Import Wizard2.png
diff --git a/ref-doc/3.3.1/images/Template Properties Wizard1 with included tokens.png b/ref-doc/3.3.1/images/Template Properties Wizard1 with included tokens.png
diff --git a/ref-doc/3.3.1/images/Template Properties Wizard1.png b/ref-doc/3.3.1/images/Template Properties Wizard1.png
diff --git a/ref-doc/3.3.1/images/Template Properties Wizard2.png b/ref-doc/3.3.1/images/Template Properties Wizard2.png
diff --git a/ref-doc/3.3.1/images/Validate Documentation menu.png b/ref-doc/3.3.1/images/Validate Documentation menu.png
diff --git a/ref-doc/3.3.1/images/Variable definition.png b/ref-doc/3.3.1/images/Variable definition.png
diff --git a/ref-doc/3.3.1/images/m2doc-overview.png b/ref-doc/3.3.1/images/m2doc-overview.png
diff --git a/ref-doc/3.3.1/index.md b/ref-doc/3.3.1/index.md
diff --git a/ref-doc/3.3.1/m2doc_service_booleanservices.md b/ref-doc/3.3.1/m2doc_service_booleanservices.md
@@ -0,0 +1,59 @@
+---
+layout: article-services
+title: BooleanServices
+subtitle: 3.3.1
+relativePath: ../..
+---
+
+<!--
+/********************************************************************************
+** Copyright (c) 2015 Obeo.
+** All rights reserved. This program and the accompanying materials
+** are made available under the terms of the Eclipse Public License v2.0
+** which accompanies this distribution, and is available at
+** http://www.eclipse.org/legal/epl-v20.html
+**
+** Contributors:
+**    Stephane Begaudeau (Obeo) - initial API and implementation
+*********************************************************************************/
+-->
+
+# BooleanServices
+
+Services available for Booleans. See [document examples](https://github.com/ObeoNetwork/M2Doc/tree/3.3.1/tests/org.obeonetwork.m2doc.tests/resources/booleanServices).
+
+* TOC
+{:toc}
+
+## boolean.check() : String
+
+Returns "X" for boolean true.
+
+### Parameter
+
+* **value**: The boolean value
+
+### Example
+
+* true.check()
+  * X
+* false.check()
+  * 
+
+## boolean.yesNo() : String
+
+Returns "Yes" for boolean true, "No" otherwise.
+
+### Parameter
+
+* **value**: The boolean value
+
+### Example
+
+* true.yesNo()
+  * Yes
+* false.yesNo()
+  * No
+
+
+
diff --git a/ref-doc/3.3.1/m2doc_service_excelservices.md b/ref-doc/3.3.1/m2doc_service_excelservices.md
@@ -0,0 +1,62 @@
+---
+layout: article-services
+title: ExcelServices
+subtitle: 3.3.1
+relativePath: ../..
+---
+
+<!--
+/********************************************************************************
+** Copyright (c) 2015 Obeo.
+** All rights reserved. This program and the accompanying materials
+** are made available under the terms of the Eclipse Public License v2.0
+** which accompanies this distribution, and is available at
+** http://www.eclipse.org/legal/epl-v20.html
+**
+** Contributors:
+**    Stephane Begaudeau (Obeo) - initial API and implementation
+*********************************************************************************/
+-->
+
+# ExcelServices
+
+Services available for Excel. See [document examples](https://github.com/ObeoNetwork/M2Doc/tree/3.3.1/tests/org.obeonetwork.m2doc.tests/resources/excelServices).
+
+* TOC
+{:toc}
+
+## String.asTable(String, String, String) : org.obeonetwork.m2doc.element.MTable
+
+Insert a table from an Excel .xlsx file.
+
+### Parameter
+
+* **uri**: The Excel .xlsx file uri, it can be relative to the template
+* **sheetName**: The sheet name
+* **topLeftCellAdress**: The top left cell address
+* **bottomRightCellAdress**: The bottom right cell address
+
+### Example
+
+* 'excel.xlsx'.asTable('Feuil1', 'C3', 'F7')
+  * insert the table from 'excel.xlsx'
+
+## String.asTable(String, String, String, String) : org.obeonetwork.m2doc.element.MTable
+
+Insert a table from an Excel .xlsx file.
+
+### Parameter
+
+* **uri**: The Excel .xlsx file uri, it can be relative to the template
+* **sheetName**: The sheet name
+* **topLeftCellAdress**: The top left cell address
+* **bottomRightCellAdress**: The bottom right cell address
+* **languageTag**: The language tag for the locale
+
+### Example
+
+* 'excel.xlsx'.asTable('Feuil1', 'C3', 'F7', 'fr-FR')
+  * insert the table from 'excel.xlsx'
+
+
+
diff --git a/ref-doc/3.3.1/m2doc_service_imageservices.md b/ref-doc/3.3.1/m2doc_service_imageservices.md
@@ -0,0 +1,182 @@
+---
+layout: article-services
+title: ImageServices
+subtitle: 3.3.1
+relativePath: ../..
+---
+
+<!--
+/********************************************************************************
+** Copyright (c) 2015 Obeo.
+** All rights reserved. This program and the accompanying materials
+** are made available under the terms of the Eclipse Public License v2.0
+** which accompanies this distribution, and is available at
+** http://www.eclipse.org/legal/epl-v20.html
+**
+** Contributors:
+**    Stephane Begaudeau (Obeo) - initial API and implementation
+*********************************************************************************/
+-->
+
+# ImageServices
+
+Services available for Images. See [document examples](https://github.com/ObeoNetwork/M2Doc/tree/3.3.1/tests/org.obeonetwork.m2doc.tests/resources/imageServices).
+
+* TOC
+{:toc}
+
+## String.asImage() : org.obeonetwork.m2doc.element.MImage
+
+Convert a String representing an URI to an Image.
+
+### Parameter
+
+* **uri**: The Image uri, it can be relative to the template
+
+### Example
+
+* 'image.png'.asImage()
+  * insert the image 'image.png'
+
+## String.asImage(String) : org.obeonetwork.m2doc.element.MImage
+
+Convert a String representing an URI to an Image and serialize it in the given format.
+
+### Parameter
+
+* **uri**: The Image uri, it can be relative to the template
+
+### Example
+
+* 'image.png'.asImage('jpg')
+  * insert the image 'image.jpg'
+
+## org.obeonetwork.m2doc.element.MImage.fit(Integer, Integer) : org.obeonetwork.m2doc.element.MImage
+
+Fits the Image in the given rectangle width and height. same as myImage.fit(width, height, true)
+
+### Parameter
+
+* **image**: The Image
+* **width**: The width to fit
+* **height**: The height to fit
+
+### Example
+
+* myImage.fit(200, 300)
+  * will fit the image in a rectangle (width=200, height=300)
+
+## org.obeonetwork.m2doc.element.MImage.fit(Integer, Integer, boolean) : org.obeonetwork.m2doc.element.MImage
+
+Fits the Image in the given rectangle width and height.
+
+### Parameter
+
+* **image**: The Image
+* **width**: The width to fit
+* **height**: The height to fit
+* **zoomIn**: The image will be zoomed in if smaller
+
+### Example
+
+* myImage.fit(200, 300, false)
+  * will fit the image in a rectangle (width=200, height=300) if the original image size is smaller it will not be zoomed in
+
+## org.obeonetwork.m2doc.element.MImage.getHeight() : Integer
+
+Gets the height of the image.
+
+### Parameter
+
+* **image**: The Image
+
+### Example
+
+* myImage.getHeight()
+  * 300
+
+## org.obeonetwork.m2doc.element.MImage.getWidth() : Integer
+
+Gets the width of the image.
+
+### Parameter
+
+* **image**: The Image
+
+### Example
+
+* myImage.getWidth()
+  * 300
+
+## org.obeonetwork.m2doc.element.MImage.resize(Double) : org.obeonetwork.m2doc.element.MImage
+
+Resizes the Image by the given factor.
+
+### Parameter
+
+* **image**: The Image
+* **factor**: The resize factor
+
+### Example
+
+* myImage.resize(0.5)
+  * will resize the image by a factor 0.5
+
+## org.obeonetwork.m2doc.element.MImage.rotate(Integer) : org.obeonetwork.m2doc.element.MImage
+
+Rotates the Image by the given angle in degres.
+
+### Parameter
+
+* **image**: The Image
+* **angle**: The angle in degres
+
+### Example
+
+* myImage.rotate(90)
+  * will rotate the image by an angle of 90 degres
+
+## org.obeonetwork.m2doc.element.MImage.setConserveRatio(Boolean) : org.obeonetwork.m2doc.element.MImage
+
+Sets the conserve ratio of the image.
+
+### Parameter
+
+* **image**: The Image
+* **conserve**: A Boolean
+
+### Example
+
+* myImage.setConserveRatio(false)
+  * set the conserve ratio to false
+
+## org.obeonetwork.m2doc.element.MImage.setHeight(Integer) : org.obeonetwork.m2doc.element.MImage
+
+Sets the height of the image.
+
+### Parameter
+
+* **image**: The Image
+* **height**: The height
+
+### Example
+
+* myImage.setHeight(300)
+  * set the height to 300
+
+## org.obeonetwork.m2doc.element.MImage.setWidth(Integer) : org.obeonetwork.m2doc.element.MImage
+
+Sets the width of the image.
+
+### Parameter
+
+* **image**: The Image
+* **width**: The width
+
+### Example
+
+* myImage.setWidth(300)
+  * set the witdh to 300
+
+
+
diff --git a/ref-doc/3.3.1/m2doc_service_linkservices.md b/ref-doc/3.3.1/m2doc_service_linkservices.md
@@ -0,0 +1,71 @@
+---
+layout: article-services
+title: LinkServices
+subtitle: 3.3.1
+relativePath: ../..
+---
+
+<!--
+/********************************************************************************
+** Copyright (c) 2015 Obeo.
+** All rights reserved. This program and the accompanying materials
+** are made available under the terms of the Eclipse Public License v2.0
+** which accompanies this distribution, and is available at
+** http://www.eclipse.org/legal/epl-v20.html
+**
+** Contributors:
+**    Stephane Begaudeau (Obeo) - initial API and implementation
+*********************************************************************************/
+-->
+
+# LinkServices
+
+Services available for links. See [document examples](https://github.com/ObeoNetwork/M2Doc/tree/3.3.1/tests/org.obeonetwork.m2doc.tests/resources/linkServices).
+
+* TOC
+{:toc}
+
+## String.asBookmarkRef(String) : org.obeonetwork.m2doc.element.MBookmark
+
+Converts a String to a bookmark reference
+
+### Parameter
+
+* **text**: The label of the bookmark reference
+* **id**: The ID of the bookmark reference
+
+### Example
+
+* 'Artifact1'.asBookmarkRef('Art1')
+  * a bookmark reference with the ID 'Art1' the label 'Artifact1'
+
+## String.asBookmark(String) : org.obeonetwork.m2doc.element.MBookmark
+
+Converts a String to a bookmark declaration
+
+### Parameter
+
+* **text**: The label of the bookmark declaration
+* **id**: The ID of the bookmark declaration
+
+### Example
+
+* 'Definition of Artifact1'.asBookmark('Art1')
+  * a bookmark with the ID 'Art1' the label 'Definition of Artifact1'
+
+## String.asLink(String) : org.obeonetwork.m2doc.element.MHyperLink
+
+Converts a String to an hyperlink
+
+### Parameter
+
+* **text**: The label of the link
+* **url**: The destination of the link
+
+### Example
+
+* 'My website'.asLink('https://www.example.org')
+  * a link to https://www.example.org with the label My website
+
+
+