plugins/doc/org.eclipse.papyrus.model2doc.doc/src/site/mediawiki/model2doc-userDoc.mediawiki - papyrus/org.eclipse.papyrus-model2doc - Git at Google

 =Introduction=
 Papyrus-Model2Doc is an EMF-based document generator for EMF models. To enhance the user experience compared to existing document generation frameworks, the proposed approach is fully model-based while separating the concerns of (1) how the source model is visited, and (2) what the content of the generated document is. Two EMF models are used to provide the description of these two concerns. A documentation-oriented metamodel allows the document-generator specifier to choose what to generate (titles, tables, lists, images for GMF Diagram, insertion of preexisting file...). The generation is done in two steps. The first one creates an EMF Tree View of the structure of the final document and the second one, is the generation in the expected document format (currently this generator only target the LibreOffice format (odt file), but other output format can easily be developed).

 [[Image:images/userDoc/userDoc_001_DocumentGenerationProcess.png]]

 This framework has mainly been developed for EMF, but as it is a subpart of the Papyrus project, several integration are already available:
 #GMF Diagram
 #UML
 #Papyrus
 ##Papyrus integration with Architecture Framework, creation menu, ...
 ##Papyrus GMF Diagram support (Papyrus extends GMF Diagram Framework)
 ##Papyrus Nattable support
 ##SysML 1.6 extension to support the document generation for Requirements.

 You will get all these parts if you installed all Model2Doc features.

 =Model2Doc installation=
 <span style="font-size:150%; line-height: 1.31em;">First and foremost, you will need install LibreOffice SDK 6.0 (or upper) on your computer.</span>

 The update site for Model2Doc's nightly build is [https://hudson.eclipse.org/papyrus/job/Papyrus-Model2Doc/lastSuccessfulBuild/artifact/repository/].

 The update site provides the following features:
 *'''Papyrus-Model2Doc''': the required plugins to generate a document from a EMF model. Papyrus won't be installed except some required plugins like the Papyrus Expressions Framework.
 *'''Papyrus-Model2Doc Developper Tools''': some additional toolings for Model2Doc developpers (see developers documentation for further information)
 *'''Papyrus-Model2Doc GMF Support''': provides elements to integrate GMF Diagram as images in your document
 *'''Papyrus-Model2Doc Papyrus Integration''':
 **integration of Model2Doc as Papyrus editor
 **contribution to Papyrus menus, Architecture Framework, pre-configured DocumentTemplate,...
 **Papyrus GMF Diagram support
 **Papyrus NatTable support
 *'''Papyrus-Model2Doc Papyrus IEEE Integration for SysML 1.6 (ODT format)''':
 **a profile based on an IEEE recommendation for the documentation of requirements,
 **this feature requires SysML 1.6.
 *'''Papyrus-Model2Doc UML Support''': extensions for UML, to support Profile, Stereotype and Stereotype's properties.


 =DocumentStructureTemplate metamodel elements' description=
 In the document template file:
 *you can create new element by ''Right-Click''->''New Child''
 *you can edit their properties in the property view (''Right-Click''->''Show Property View''.

 *'''TextDocumentTemplate''': The root of the DocumentTemplate. This element provides these fields:
 **'''Description''': a description of the current DocumentTemplate. This field is not used by the generation.
 **'''Document Template Prototype''': reference the prototype used to create this DocumentStructure
 **'''Graphical Context''': reference the model element under which the DocumentTemplate will be displayed (mainly for Papyrus ModselExplorer integration)
 **'''Kind Id''': a string defining the kind of the DocumentTemplate (mainly for Papyrus Architecture Framework integration)
 **'''Main Title''': the main title displayed in the generated document
 **'''Semantic Context''': the model element from which the documentation process will start

 Children of the '''TextDocumentTemplate''':
 *'''DocumentStructureGeneratorConfiguration''': enables the configuration of the generation process. This element provides these fields:
 **'''DocumentFolder''':the folder where the generated document will be stored. Supported paths are:
 ***''platform:/resource/aPluginName/aFolderName/...'' : the folder in an Eclipse project of the workspace
 ***''folder1/folder2/...'': interpreted as ''platform:/resource/currentPluginName/folder1/folder2/...'' : folders owned by the current Eclipse project
 **'''DocumentGeneratorId''':the id of the generator used to transform the DocumentStructure file into the final document.
 ***We provide the odt generator, its id is ''org.eclipse.papyrus.model2doc.document.generator.odt''
 **'''DocumentName''': The name of the generated document file
 **'''ImageFolder''': the folder where the generated image is stored. Supported path are
 ***''platform:/resource/aPluginName/aFolderName/...'' : the folder in an Eclipse project of the workspace
 ***''folder1/folder2/...'': interpreted as ''platform:/resource/currentPluginName/folder1/folder2/...'' : folders owned by the current Eclipse project
 **'''SaveDocumentStructure''':a boolean value indicating if the generated DocumentStructure must be kept at the end of the process
 **'''SaveImages''':a boolean value indicating if the generated DocumentStructure must be kept at the end of the process
 **'''StructureFolder''':the folder where we stored the generated DocumentStructure
 ***''platform:/resource/aPluginName/aFolderName/...'' : the folder in an Eclipse project of the workspace
 ***''folder1/folder2/...'': interpreted as ''platform:/resource/currentPluginName/folder1/folder2/...'' : folders owned by the current Eclipse project
 **'''StructureGeneratorId''':the id of the generator used to transform the DocumentTemplate into a DocumentStructure
 ***The id of the provided generator is ''TextDocumentStructureGenerator.default''
 **'''TemplateFile''': this file is used to initialize the generated document. It can contains the style definitions, headers, ... For LibreOffice generation, it is an ''ott'' file. This file can be used to define the cover page too. The supported path are:
 ***''platform:/resource/aPluginName/aFolderName/myTemplatefile'' : the template is located in an Eclipse project of the workspace
 ***''folder1/folder2/myTemplateFile'': interpreted as ''platform:/resource/currentPluginName/folder1/folder2/myTemplateFile'' : template owned by the current Eclipse project
 ***''platform:/plugin/aPluginName/aFolderName/myTemplatefile'' : the template is located in an installed Eclipse plugin
 *'''TableOfContents''': this element is used to declare that you want a Table Of Contents
 **'''TocTitle''': the title to use for the TableOfContents. If nothing is defined, the table of contents will be name ''Table Of Contents'' in the generated file
 *'''TableOfFigures''': this element is used to declare that you want a Table Of Fiures
 **'''TofTitle''': the title to use for the TableOfFigures. If nothing is defined, the table of figures will be name ''Table Of Figures'' in the generated file
 *'''Body''': The children of this element allows the definition of the document's content
 *'''Author''': allows to define the authors of the document

 ===Body's description===
 This element is the most important part of the '''TextDocumentTemplate''' file. It defines the contents of the generated document. Here we declare how to parse the model. Basically, we start referencing an EReference (first level) used to get the values from the semantic context of the document, then an EClass (second level), then an EReference again to get the value of the found elements at the previous level, and again EClass, ... Of course others elements are possible, but the goal is to declare a navigation alternating between EReference and EClass.

 The generation process will start by taking the semanticContext of the '''DocumentTemplate''' and asking it the values of the property represented by the '''EReference''' declared in the '''DocumentTemplate'''.
 These values will be consummed by the second level of '''DocumentTemplate''' elements to extract relevant ones. Then we take these results and use them as input of the third level which references features too. After this the process will continue by parsing the model using the DocumentTemplate.


 #First level element
 ##''pure EMF''
 ###'''EAttributeAsParagraph''': to create a paragraph in the final document from the value of an EAttribute.
 ###'''EReferencePartTemplate''': to choose which EReference to use. This element can have children.
 ###'''EReferenceTableView''': to create a table from a reference value (detail further in the documentation).
 ###'''TreeListView''': to create a list from EStructuralFeature values (detail further in the documentation).
 ###'''InsertFileTemplate''': to declare a path to a file to integrate into the generated document. It won't be a reference, but a copy of its contents into the generated file.
 ##''GMF''
 ###'''GMFDiagramView''': to define the type of the Diagram owned by the context element to include as image
 ##''Papyrus GMF''
 ###'''PapyrusGMFDiagramView''': used to import a Papyrus diagram as image. It allows to define:
 ###*the type of the Diagram to include as image
 ###*the kindId of the Diagram to include as image (Papyrus Architecture Framework information)
 ###*a context filtering rules to find diagram by semanticContext (called Root element in the Papyrus interface) or graphicalContext (called owner in the Papyrus interface) (Papyrus integration)
 ##''Papyrus NatTable''
 ###'''PapyrusTableView''': used to import a Papyrus table. It allows to define:
 ###*the type of the Table to include
 ###*the kindId of the Table to include (Papyrus Architecture Framework information)
 ###*a context filtering rule to find diagram by semanticContext (called Root element in the Papyrus interface) or graphicalContext (called owner in the Papyrus interface) (Papyrus integration)
 ###*the import method, to import the table as an Image, or as a table in the generated document
 ##''UML''
 ###'''StereotypePropertyReferencePartTemplate''': to choose a stereotype's property type with a reference to cross the model
 ###'''CommentAsParagraph''': to find owned comment and use their body to create paragraph in the final document
 ###'''StereotypePropertyReferenceTableView''': to create a table from a stereotype's property value (detail further in the documentation).
 #Second level element
 ##''pure EMF''
 ###'''EClassPartTemplate''': to reference an EClass, to filter element found in the feature referenced in the previous level
 ###'''InsertFileTemplate''': to declare a path to a file to integrate into the generated document. It won't be a reference, but a copy of its contents into the generated file.
 ##''UML''
 ###'''StereotypePartTemplate''': to reference a stereotype, to filter the elements found in the feature referenced in the previous level

 All the previous elements own these fields too:
 *''custom title'': a title to use instead of the default one (generally the name of the feature, or the name/label of the element model)
 *''generate title'': if <code>true</code>, a title will be generated
 *''generate'': if <code>true</code> we will generate something to this step, if <code>false</code>, we will generate nothing, but we will process its children. The 'View' elements have this field too, but this field is useless for them and should always be kept to <code>true</code>
 *''generateBranchCondition'': this field is not displayed in the property view. It is set when you create an Expression as child of the element. When such a condition is defined, the whole branch will be managed only when the condition will return <code>true</code> for the evaluated element. For more information about the Expression, please read the Papyrus Expression Framework.
 On the next snapshot the process to create a new expression.
 [[Image:images/userDoc/userDoc_002_CreateGenerateBranchCondition.png]]


 =How to create a TreeListView?=
 You can create a '''TreeListView''' as a child element of the '''Body''' of your '''TextDocumentTemplate''' itself, or as a child of an '''EClassPartTemplate''' or a '''StereotypePartTemplate'''.
 Under a '''TreeListView''', you can create, these elements:
 #''pure EMF''
 ##'''EReferenceListItemTemplate''': used to reference an EReference of the context model element of the list. The EReference value will be used to create the items in the document.
 ##'''EAttributeListItemtemplate''': used to reference an EAttribute of the context model element of the list. The EReference value will be used to create the items in the document.
 #'UML'
 ##'''StereotypePropertyReferenceListItemTemplate''': used to reference a Stereotype's property typed with a UML element of the context model element of the list. The property's value will be used to create the items in the document.
 ##'''StereotypePropertyAttributeListItemTemplate''': used to reference a Stereotype's property typed with a PrimitiveType of the context model element of the list. The property's value will be used to create the items in the document.

 '''EReferenceListItemTemplate''' and '''StereotypePropertyReferenceListItem''' can have children to create sub items.
 #''pure EMF''
 ##'''EClassListItemTemplate''': used to reference an '''EClass'''  to filter elements referenced by the feature from the previous level and create sub items.
 #''UML''
 ##'''StereotypeListItemTemplate''': used to reference a '''Stereotype''' to filter elements referenced by the feature from the previous level and create sub items.

 =How to create an EReferenceTableView or a StereotypePropertyReferenceTableView?=
 A '''TableView''' allows you to display elements of your model with some of their properties' values. Your elements will be displayed as rows : one row representing one element.
 You can create such '''TableView''' as child elements of the '''Body''' of your '''TextDocumentTemplate''' itself, or as child of an '''EClassPartTemplate''' or a '''StereotypePartTemplate'''.
 Once one of these '''TableView ''' is created, you must fill these fields:
 *for '''EReferenceTableView''', the field '''EReference''' must be set. The value of this '''EReference''' will be used to create the rows of the table.
 *for '''StereotypePropertyReferenceTableView''', the field '''propertyName''' and '''stereotypeQualifiedName''' must be set. The value of the '''propertyName''' will be used to create the rows of the table.

 Now that we know how to obtain the rows, we need to declare the column. In order to do that, you need to create new children for your '''TableView'''. Possible children are:
 #''pure EMF''
 ##'''EStructuralFeatureColumn''': you choose an EStructuralFeature
 #''UML''
 ##'''StereotypePropertyColumn''': you choose a stereotype's property
 For these 2 elements, you can define your own  Column Title. If not, we will use the name of the feature/property.

 That's all! The generator will ask the value of the column feature/property for each element represented in row to fill the the cell at the intersection of the row and the column.

 =Generation from the DocumentStructureTemplate=
 Model2Doc provides several generation menus, depending of what you want to do.
 All these menus are available in the ''Right-Click'' menu.

 [[Image:images/userDoc/userDoc_009_GenerationFromDocumentStructureTemplate_Menu.png]]


 * ''Generate Document Structure'': only the intermediate DocumentStructure ( '''*.pds''') file will be generated.
 * ''Generate All (Structure + xxx)'': the intermediate DocumentStructure ('''*.pds''') file and the final document. '''xxx''' is the name of the used generator. In the main case, it is '''ODT'''
 * ''Generate All + PDF'': here, the '''*.pds''' file, the document and a PDF version of this document are generated. Several menus exist for PDF generation, to support several PDF format. The used exporter in the LibreOffice one.

 =How to generate the DocumentStructure from the DocumentTemplate?=
 Once you finished the configuration of your '''DocumentTemplate''', you can generate your '''DocumentStructure'''. in the opened DocumentTemplate editor, ''Right-Click'' on the '''DocumentTemplate''', then ''Generate DocumentStructure''.

 [[Image:images/userDoc/userDoc_003_CreateDocumentStructureFromDocumentTemplate.png]]

 An input dialog asking you the version of the DocumentStructure to generate opens. You must fill a string value (with char allowed for a file name), then Press ''Enter''.
 At the end of the process, an dialog will open to inform you about the end of the process.
 The generated '''DocumentStructure''' has been created. This file should be visible in the ''Project Explorer'' View.

 [[Image:images/userDoc/userDoc_004_A_pds_file_appeas in the ProjectExplorer.png]]

 =How to generate the final Document from the DocumentStructure?=
 Open the generated '''*.pds''' file, then select the root element of the file (here, Text Document), then ''Right-Click''->''Generate ODT File''.
 A dialog opens at the end of the process and the generated document appears in the ''Project Explorer'' view. (If it does not, you might need to refresh the workspace manually, pressing F5).


 =How to create a new LibreOffice template?=
 Here, we will talk about the ''*.ott'' file and not about the ''DocumentTemplate'' provided by Papyrus-Model2Doc.
 Of course, we advise you to read the LibreOffice documentation as required.
 Your LibreOffice template can define styles, header and footer and more generally all features provided by LibreOffice.

 The goal of this documentation chapter is to present you the LibreOffice field used by Model2Doc.
 *native LibreOffice fields
 **''author'': to include the author of the document in your template. On the next snapshot, you see how to insert the author reference.
 [[Image:images/userDoc/userDoc_006_LibreOffice_InsertAuthor.png]]


 *custom LibreOffice fields: you must define these fields in your template. They will be used by our generator:
 **''Authors'': when you have several authors, you can display them in one string
 **''Version'': to define the version of your document
 To create these custom fields, go in the menu ''File->Properties->Custom Properties'' and create them.
 [[Image:images/userDoc/userDoc_007_LibreOffice_CreateNewVariables.png]]

 To insert them into the LibreOffice template, go into the menu ''Insert->Fields->More Fields''. A dialog opens, go into the tab ''Variables'', select ''User fields'' and you can insert these fieds clicking on ''Insert'', as described on the next snapshot.

 [[Image:images/userDoc/userDoc_008_LibreOffice_CustomVariableUsage.png]]
	=Introduction=
	Papyrus-Model2Doc is an EMF-based document generator for EMF models. To enhance the user experience compared to existing document generation frameworks, the proposed approach is fully model-based while separating the concerns of (1) how the source model is visited, and (2) what the content of the generated document is. Two EMF models are used to provide the description of these two concerns. A documentation-oriented metamodel allows the document-generator specifier to choose what to generate (titles, tables, lists, images for GMF Diagram, insertion of preexisting file...). The generation is done in two steps. The first one creates an EMF Tree View of the structure of the final document and the second one, is the generation in the expected document format (currently this generator only target the LibreOffice format (odt file), but other output format can easily be developed).

	[[Image:images/userDoc/userDoc_001_DocumentGenerationProcess.png]]

	This framework has mainly been developed for EMF, but as it is a subpart of the Papyrus project, several integration are already available:
	#GMF Diagram
	#UML
	#Papyrus
	##Papyrus integration with Architecture Framework, creation menu, ...
	##Papyrus GMF Diagram support (Papyrus extends GMF Diagram Framework)
	##Papyrus Nattable support
	##SysML 1.6 extension to support the document generation for Requirements.

	You will get all these parts if you installed all Model2Doc features.

	=Model2Doc installation=
	<span style="font-size:150%; line-height: 1.31em;">First and foremost, you will need install LibreOffice SDK 6.0 (or upper) on your computer.</span>

	The update site for Model2Doc's nightly build is [https://hudson.eclipse.org/papyrus/job/Papyrus-Model2Doc/lastSuccessfulBuild/artifact/repository/].

	The update site provides the following features:
	*'''Papyrus-Model2Doc''': the required plugins to generate a document from a EMF model. Papyrus won't be installed except some required plugins like the Papyrus Expressions Framework.
	*'''Papyrus-Model2Doc Developper Tools''': some additional toolings for Model2Doc developpers (see developers documentation for further information)
	*'''Papyrus-Model2Doc GMF Support''': provides elements to integrate GMF Diagram as images in your document
	*'''Papyrus-Model2Doc Papyrus Integration''':
	**integration of Model2Doc as Papyrus editor
	**contribution to Papyrus menus, Architecture Framework, pre-configured DocumentTemplate,...
	**Papyrus GMF Diagram support
	**Papyrus NatTable support
	*'''Papyrus-Model2Doc Papyrus IEEE Integration for SysML 1.6 (ODT format)''':
	**a profile based on an IEEE recommendation for the documentation of requirements,
	**this feature requires SysML 1.6.
	*'''Papyrus-Model2Doc UML Support''': extensions for UML, to support Profile, Stereotype and Stereotype's properties.


	=DocumentStructureTemplate metamodel elements' description=
	In the document template file:
	*you can create new element by ''Right-Click''->''New Child''
	*you can edit their properties in the property view (''Right-Click''->''Show Property View''.

	*'''TextDocumentTemplate''': The root of the DocumentTemplate. This element provides these fields:
	**'''Description''': a description of the current DocumentTemplate. This field is not used by the generation.
	**'''Document Template Prototype''': reference the prototype used to create this DocumentStructure
	**'''Graphical Context''': reference the model element under which the DocumentTemplate will be displayed (mainly for Papyrus ModselExplorer integration)
	**'''Kind Id''': a string defining the kind of the DocumentTemplate (mainly for Papyrus Architecture Framework integration)
	**'''Main Title''': the main title displayed in the generated document
	**'''Semantic Context''': the model element from which the documentation process will start

	Children of the '''TextDocumentTemplate''':
	*'''DocumentStructureGeneratorConfiguration''': enables the configuration of the generation process. This element provides these fields:
	**'''DocumentFolder''':the folder where the generated document will be stored. Supported paths are:
	***''platform:/resource/aPluginName/aFolderName/...'' : the folder in an Eclipse project of the workspace
	***''folder1/folder2/...'': interpreted as ''platform:/resource/currentPluginName/folder1/folder2/...'' : folders owned by the current Eclipse project
	**'''DocumentGeneratorId''':the id of the generator used to transform the DocumentStructure file into the final document.
	***We provide the odt generator, its id is ''org.eclipse.papyrus.model2doc.document.generator.odt''
	**'''DocumentName''': The name of the generated document file
	**'''ImageFolder''': the folder where the generated image is stored. Supported path are
	***''platform:/resource/aPluginName/aFolderName/...'' : the folder in an Eclipse project of the workspace
	***''folder1/folder2/...'': interpreted as ''platform:/resource/currentPluginName/folder1/folder2/...'' : folders owned by the current Eclipse project
	**'''SaveDocumentStructure''':a boolean value indicating if the generated DocumentStructure must be kept at the end of the process
	**'''SaveImages''':a boolean value indicating if the generated DocumentStructure must be kept at the end of the process
	**'''StructureFolder''':the folder where we stored the generated DocumentStructure
	***''platform:/resource/aPluginName/aFolderName/...'' : the folder in an Eclipse project of the workspace
	***''folder1/folder2/...'': interpreted as ''platform:/resource/currentPluginName/folder1/folder2/...'' : folders owned by the current Eclipse project
	**'''StructureGeneratorId''':the id of the generator used to transform the DocumentTemplate into a DocumentStructure
	***The id of the provided generator is ''TextDocumentStructureGenerator.default''
	**'''TemplateFile''': this file is used to initialize the generated document. It can contains the style definitions, headers, ... For LibreOffice generation, it is an ''ott'' file. This file can be used to define the cover page too. The supported path are:
	***''platform:/resource/aPluginName/aFolderName/myTemplatefile'' : the template is located in an Eclipse project of the workspace
	***''folder1/folder2/myTemplateFile'': interpreted as ''platform:/resource/currentPluginName/folder1/folder2/myTemplateFile'' : template owned by the current Eclipse project
	***''platform:/plugin/aPluginName/aFolderName/myTemplatefile'' : the template is located in an installed Eclipse plugin
	*'''TableOfContents''': this element is used to declare that you want a Table Of Contents
	**'''TocTitle''': the title to use for the TableOfContents. If nothing is defined, the table of contents will be name ''Table Of Contents'' in the generated file
	*'''TableOfFigures''': this element is used to declare that you want a Table Of Fiures
	**'''TofTitle''': the title to use for the TableOfFigures. If nothing is defined, the table of figures will be name ''Table Of Figures'' in the generated file
	*'''Body''': The children of this element allows the definition of the document's content
	*'''Author''': allows to define the authors of the document

	===Body's description===
	This element is the most important part of the '''TextDocumentTemplate''' file. It defines the contents of the generated document. Here we declare how to parse the model. Basically, we start referencing an EReference (first level) used to get the values from the semantic context of the document, then an EClass (second level), then an EReference again to get the value of the found elements at the previous level, and again EClass, ... Of course others elements are possible, but the goal is to declare a navigation alternating between EReference and EClass.

	The generation process will start by taking the semanticContext of the '''DocumentTemplate''' and asking it the values of the property represented by the '''EReference''' declared in the '''DocumentTemplate'''.
	These values will be consummed by the second level of '''DocumentTemplate''' elements to extract relevant ones. Then we take these results and use them as input of the third level which references features too. After this the process will continue by parsing the model using the DocumentTemplate.


	#First level element
	##''pure EMF''
	###'''EAttributeAsParagraph''': to create a paragraph in the final document from the value of an EAttribute.
	###'''EReferencePartTemplate''': to choose which EReference to use. This element can have children.
	###'''EReferenceTableView''': to create a table from a reference value (detail further in the documentation).
	###'''TreeListView''': to create a list from EStructuralFeature values (detail further in the documentation).
	###'''InsertFileTemplate''': to declare a path to a file to integrate into the generated document. It won't be a reference, but a copy of its contents into the generated file.
	##''GMF''
	###'''GMFDiagramView''': to define the type of the Diagram owned by the context element to include as image
	##''Papyrus GMF''
	###'''PapyrusGMFDiagramView''': used to import a Papyrus diagram as image. It allows to define:
	###*the type of the Diagram to include as image
	###*the kindId of the Diagram to include as image (Papyrus Architecture Framework information)
	###*a context filtering rules to find diagram by semanticContext (called Root element in the Papyrus interface) or graphicalContext (called owner in the Papyrus interface) (Papyrus integration)
	##''Papyrus NatTable''
	###'''PapyrusTableView''': used to import a Papyrus table. It allows to define:
	###*the type of the Table to include
	###*the kindId of the Table to include (Papyrus Architecture Framework information)
	###*a context filtering rule to find diagram by semanticContext (called Root element in the Papyrus interface) or graphicalContext (called owner in the Papyrus interface) (Papyrus integration)
	###*the import method, to import the table as an Image, or as a table in the generated document
	##''UML''
	###'''StereotypePropertyReferencePartTemplate''': to choose a stereotype's property type with a reference to cross the model
	###'''CommentAsParagraph''': to find owned comment and use their body to create paragraph in the final document
	###'''StereotypePropertyReferenceTableView''': to create a table from a stereotype's property value (detail further in the documentation).
	#Second level element
	##''pure EMF''
	###'''EClassPartTemplate''': to reference an EClass, to filter element found in the feature referenced in the previous level
	###'''InsertFileTemplate''': to declare a path to a file to integrate into the generated document. It won't be a reference, but a copy of its contents into the generated file.
	##''UML''
	###'''StereotypePartTemplate''': to reference a stereotype, to filter the elements found in the feature referenced in the previous level

	All the previous elements own these fields too:
	*''custom title'': a title to use instead of the default one (generally the name of the feature, or the name/label of the element model)
	*''generate title'': if <code>true</code>, a title will be generated
	*''generate'': if <code>true</code> we will generate something to this step, if <code>false</code>, we will generate nothing, but we will process its children. The 'View' elements have this field too, but this field is useless for them and should always be kept to <code>true</code>
	*''generateBranchCondition'': this field is not displayed in the property view. It is set when you create an Expression as child of the element. When such a condition is defined, the whole branch will be managed only when the condition will return <code>true</code> for the evaluated element. For more information about the Expression, please read the Papyrus Expression Framework.
	On the next snapshot the process to create a new expression.
	[[Image:images/userDoc/userDoc_002_CreateGenerateBranchCondition.png]]


	=How to create a TreeListView?=
	You can create a '''TreeListView''' as a child element of the '''Body''' of your '''TextDocumentTemplate''' itself, or as a child of an '''EClassPartTemplate''' or a '''StereotypePartTemplate'''.
	Under a '''TreeListView''', you can create, these elements:
	#''pure EMF''
	##'''EReferenceListItemTemplate''': used to reference an EReference of the context model element of the list. The EReference value will be used to create the items in the document.
	##'''EAttributeListItemtemplate''': used to reference an EAttribute of the context model element of the list. The EReference value will be used to create the items in the document.
	#'UML'
	##'''StereotypePropertyReferenceListItemTemplate''': used to reference a Stereotype's property typed with a UML element of the context model element of the list. The property's value will be used to create the items in the document.
	##'''StereotypePropertyAttributeListItemTemplate''': used to reference a Stereotype's property typed with a PrimitiveType of the context model element of the list. The property's value will be used to create the items in the document.

	'''EReferenceListItemTemplate''' and '''StereotypePropertyReferenceListItem''' can have children to create sub items.
	#''pure EMF''
	##'''EClassListItemTemplate''': used to reference an '''EClass''' to filter elements referenced by the feature from the previous level and create sub items.
	#''UML''
	##'''StereotypeListItemTemplate''': used to reference a '''Stereotype''' to filter elements referenced by the feature from the previous level and create sub items.

	=How to create an EReferenceTableView or a StereotypePropertyReferenceTableView?=
	A '''TableView''' allows you to display elements of your model with some of their properties' values. Your elements will be displayed as rows : one row representing one element.
	You can create such '''TableView''' as child elements of the '''Body''' of your '''TextDocumentTemplate''' itself, or as child of an '''EClassPartTemplate''' or a '''StereotypePartTemplate'''.
	Once one of these '''TableView ''' is created, you must fill these fields:
	*for '''EReferenceTableView''', the field '''EReference''' must be set. The value of this '''EReference''' will be used to create the rows of the table.
	*for '''StereotypePropertyReferenceTableView''', the field '''propertyName''' and '''stereotypeQualifiedName''' must be set. The value of the '''propertyName''' will be used to create the rows of the table.

	Now that we know how to obtain the rows, we need to declare the column. In order to do that, you need to create new children for your '''TableView'''. Possible children are:
	#''pure EMF''
	##'''EStructuralFeatureColumn''': you choose an EStructuralFeature
	#''UML''
	##'''StereotypePropertyColumn''': you choose a stereotype's property
	For these 2 elements, you can define your own Column Title. If not, we will use the name of the feature/property.

	That's all! The generator will ask the value of the column feature/property for each element represented in row to fill the the cell at the intersection of the row and the column.

	=Generation from the DocumentStructureTemplate=
	Model2Doc provides several generation menus, depending of what you want to do.
	All these menus are available in the ''Right-Click'' menu.

	[[Image:images/userDoc/userDoc_009_GenerationFromDocumentStructureTemplate_Menu.png]]


	* ''Generate Document Structure'': only the intermediate DocumentStructure ( '''*.pds''') file will be generated.
	* ''Generate All (Structure + xxx)'': the intermediate DocumentStructure ('''*.pds''') file and the final document. '''xxx''' is the name of the used generator. In the main case, it is '''ODT'''
	* ''Generate All + PDF'': here, the '''*.pds''' file, the document and a PDF version of this document are generated. Several menus exist for PDF generation, to support several PDF format. The used exporter in the LibreOffice one.

	=How to generate the DocumentStructure from the DocumentTemplate?=
	Once you finished the configuration of your '''DocumentTemplate''', you can generate your '''DocumentStructure'''. in the opened DocumentTemplate editor, ''Right-Click'' on the '''DocumentTemplate''', then ''Generate DocumentStructure''.

	[[Image:images/userDoc/userDoc_003_CreateDocumentStructureFromDocumentTemplate.png]]

	An input dialog asking you the version of the DocumentStructure to generate opens. You must fill a string value (with char allowed for a file name), then Press ''Enter''.
	At the end of the process, an dialog will open to inform you about the end of the process.
	The generated '''DocumentStructure''' has been created. This file should be visible in the ''Project Explorer'' View.

	[[Image:images/userDoc/userDoc_004_A_pds_file_appeas in the ProjectExplorer.png]]

	=How to generate the final Document from the DocumentStructure?=
	Open the generated '''*.pds''' file, then select the root element of the file (here, Text Document), then ''Right-Click''->''Generate ODT File''.
	A dialog opens at the end of the process and the generated document appears in the ''Project Explorer'' view. (If it does not, you might need to refresh the workspace manually, pressing F5).


	=How to create a new LibreOffice template?=
	Here, we will talk about the ''*.ott'' file and not about the ''DocumentTemplate'' provided by Papyrus-Model2Doc.
	Of course, we advise you to read the LibreOffice documentation as required.
	Your LibreOffice template can define styles, header and footer and more generally all features provided by LibreOffice.

	The goal of this documentation chapter is to present you the LibreOffice field used by Model2Doc.
	*native LibreOffice fields
	**''author'': to include the author of the document in your template. On the next snapshot, you see how to insert the author reference.
	[[Image:images/userDoc/userDoc_006_LibreOffice_InsertAuthor.png]]


	*custom LibreOffice fields: you must define these fields in your template. They will be used by our generator:
	**''Authors'': when you have several authors, you can display them in one string
	**''Version'': to define the version of your document
	To create these custom fields, go in the menu ''File->Properties->Custom Properties'' and create them.
	[[Image:images/userDoc/userDoc_007_LibreOffice_CreateNewVariables.png]]

	To insert them into the LibreOffice template, go into the menu ''Insert->Fields->More Fields''. A dialog opens, go into the tab ''Variables'', select ''User fields'' and you can insert these fieds clicking on ''Insert'', as described on the next snapshot.

	[[Image:images/userDoc/userDoc_008_LibreOffice_CustomVariableUsage.png]]