M2Doc. Document Generation with. Yvan Lussaud. copyright 2017 Obeo

Transcription

1 Document Generation with M2Doc Yvan Lussaud 1

2 Why documents? Written Documents are still necessary Transmit information to people who will not use the modeling workbench directly Fulfil certain obligations The Model should be the reference Up to date documentation 2

3 Alexander W. Galbraith - This image is available from the City of Toronto Archives, listed under the archival citation Fonds 1568, Item 177. Actors Involved CASID/DGSIC (French Department of Defense) 3

4 Our Solution M2Doc 4

5 Our Solution Model to documentation 5

6 Basic Principles Model Template M2Doc Document 6

7 Basic Principles Model Template M2Doc A380 Technical specifications DDE-H35 Applicable Documents Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet lorem ipsum dolor sit amet dolorem ipsu m dolor sit am Document 7

8 Basic Principles Model Template Template B Template C M2Doc A380 Technical specifications DDE-H35 Applicable Documents Lorem ipsum dolor sit amet Lorem ipsum dolor sit amet Lorem ipsum dolora380 sit amet loremgeneral ipsum Overview DDE-H35 dolorapplicable sit amet Documents dolorem Lorem ipsuipsum dolor sit amet m dolor sit am A380 Structure Breakdown DDE-H35 Document Applicable Documents ipsum dolor sit amet meae quam Document B Document C 8

9 Roles Involved Metamodel Expert Creates, tests and debugs reusable AQL services Registers services Templatist Creates M2Doc templates Uses AQL services Tests and debugs templates These are just roles Can be 1, 2, or 3 persons depending on complexity and organization End-User Edit models Produces documents by running M2Doc templates Edit userdoc in generated documents 9

10 Writing Templates Plain MS Word document (.docx files) Use Alt+F9 to activate fields Use Ctrl+F9 to insert fields M2Doc syntax is very simple 10

11 { m:xxx } 11

12 Simple query { m:conf.name } is located in Ludwisburg EclipseCon Europe is located in Ludwigsburg 12

13 Loop { m:for track conf.tracks} Track: {m:track.name} { m:endfor } Track: IoT Day Track: Eclipse Technologies Track: OSGi 13

14 Loop { m:for track conf.tracks} {m:track.name} {m:track.description} { m:endfor } IoT Day Eclipse Technologies OSGi Internet of Things Eclipse-related technologies and eclipse community Talks about OSGi 14

15 Conditional { m:if conf.name.contains( Eclipse ) } { m:else if } { m:else } { m:endif } Optional 15

16 User Doc {m:userdoc <queryid>} {m:enduserdoc} Incremental generation 16

17 Bookmark and link {m:bookmark <queryid>} {m:endbookmark} {m:link <queryid> <querytext>} 17

18 Let {m:let cname = conf.name} { m:cname } is located in Ludwisburg {m:endlet} Define variables 18

19 Using Services {m:if conf.tracks.talks >select(t t.name.contains( Sirius )) >notempty()} 19

20 Using Services { m:if conf.hastalkabout( Sirius ) } public boolean hastalkabout(conference, String) 20

21 Using Services Services are Java methods Facilitate creation and maintenance of templates Can be reused Can insert images/tables/formated text/ 21

22 Validation { m:conf. } is located in Ludwisburg { m:conf. } <---Expression conf." is invalid: missing feature access or service call is located in Ludwisburg 22

23 M2Doc + Sirius = Diagrams and Tables can be inserted The existence of a diagram/table can be checked Dedicated services are provided isrepresentation(descriptionname) asimagebyrepresentation(descriptionname) astablebyrepresentation(descriptionname) 23

24 M2DOC DEMO 24

25 Architecture Overview M2Doc UI M2Doc IDE M2Doc core AQL Apache POI EMF M2Doc Sirius Integration Sirius 25

26 Architecture Overview M2Doc UI M2Doc IDE M2Doc core AQL Apache POI EMF M2Doc your product Integration Your product 26

27 Show me the code! 27

28 M2Doc Roadmap V1.0.0 has been released First maintained version Fully documented Next Gather feedback Keep improving + features from feedback Improve Apache POI integration 28

29 Keypoints Produces MS Word documents from EMF-compliant Models Can include Sirius Diagrams & Tables Easy to use: simple syntax, tooling helps Has Useful Error Reporting Supports Incremental Generation 29

30 30

31 31