Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 317587

Summary:	[General] Papyrus shall embed a user documentation
Product:	[Modeling] Papyrus	Reporter:	Tatiana Fesenko <tatiana.fesenko>
Component:	Core	Assignee:	Tatiana Fesenko <tatiana.fesenko>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	P3	CC:	sebastien.gerard
Version:	0.7.0
Target Milestone:	---
Hardware:	PC
OS:	Windows XP
Whiteboard:
Bug Depends on:	312236
Bug Blocks:

Description Tatiana Fesenko

2010-06-22 10:36:59 EDT

Papyrus shall provide documentation in a standard Eclipse Help format. It should include tutorials and developers guides.

Comment 1 Tatiana Fesenko

2010-06-22 11:04:30 EDT

I created three categories:
-Developer Guide
-User Guide
-Customizer Guide

I converted the existing tutorials into HTML and put it there. Namely it was tutorials on 
-Creating and Adding New Plugins in Papyrus (from Open Office presentation)
-Papyrus Integration with xText(from Open Office presentation)
-Sash Editor Architecture(from MS Word document)
-Palette Customization(from Open Office presentation)

Since default convertor from Open Office presentation to HTML doesn't layout and ressize pictures well enough everybody is welcome to participate in improvement of appearance of our tutorials.

Comment 2 Tatiana Fesenko

2010-06-22 11:36:47 EDT

org.eclipse.papyrus.doc plugin was added to the build

Comment 3 Tatiana Fesenko

2010-06-24 09:17:01 EDT

I moved all docs which are not included into User Doc from org.eclipse.papyrus.doc plugin
to doc/DevelopperDocuments folder of SVN. Wiki references to thr code templates have been updated.

Comment 4 Tatiana Fesenko

2010-06-24 09:17:41 EDT

Stub FAQ page was created on http://wiki.eclipse.org/Papyrus-FAQ .

Comment 5 Tatiana Fesenko

2011-01-03 03:29:50 EST

Fixed in Helios

Comment 6 Vincent Lorenzo

2011-01-10 09:41:19 EST

In R3658 : update XText documentation to explain how to use the new plugins  
oep.common.editor.xtext and oep.common.editor.xtext.ui