Home » Archived » M2M (model-to-model transformation) » [ATL] New documentation strategy
| [ATL] New documentation strategy [message #97744] |
Fri, 16 January 2009 13:08  |
Eclipse User |
|
|
|
Hello,
We have a new strategy for ATL documentation: you may have seen that it
was sometimes hard to find an up-to-date and complete version of ATL docs...
Now all informations have been merged into the ATL wiki, on three main
pages:
- http://wiki.eclipse.org/ATL/Concepts
- http://wiki.eclipse.org/ATL/User_Guide
- http://wiki.eclipse.org/ATL/Developer_Guide
Integrating/updating pdfs and existing wiki pages was quite a big work,
so there is still a lot of "TODOs" on those pages... that will be fixed
ASAP. :-)
Those page will also be available offline, into the eclipse.help ATL doc
plugin (available into ATL SDK builds), thanks to WikiText
(http://wiki.eclipse.org/Mylyn/FAQ#WikiText): this great tool provides a
very stable way to convert wiki pages into eclipse.help html pages.
So users (and contributors) are now allowed to modify, update ATL
documentation: then relevant corrections will be simply applied on each
new ATL build, using WikiText.
Best Regards,
William
|
|
|
| Re: [ATL] New documentation strategy [message #97759 is a reply to message #97744] |
Sat, 17 January 2009 08:43  |
| Eclipse User |
|
|
|
Hi William & co,
Great work, I think allot of people can benefit from it.
So will you publicize the pdf2wiki transformation? ;)
Regards,
Alfons
"William Piers" <william.piers@obeo.fr> schreef in bericht
news:gkqig2$9l7$1@build.eclipse.org...
> Hello,
>
> We have a new strategy for ATL documentation: you may have seen that it
> was sometimes hard to find an up-to-date and complete version of ATL
> docs...
>
> Now all informations have been merged into the ATL wiki, on three main
> pages:
> - http://wiki.eclipse.org/ATL/Concepts
> - http://wiki.eclipse.org/ATL/User_Guide
> - http://wiki.eclipse.org/ATL/Developer_Guide
> Integrating/updating pdfs and existing wiki pages was quite a big work, so
> there is still a lot of "TODOs" on those pages... that will be fixed ASAP.
> :-)
>
> Those page will also be available offline, into the eclipse.help ATL doc
> plugin (available into ATL SDK builds), thanks to WikiText
> (http://wiki.eclipse.org/Mylyn/FAQ#WikiText): this great tool provides a
> very stable way to convert wiki pages into eclipse.help html pages.
>
> So users (and contributors) are now allowed to modify, update ATL
> documentation: then relevant corrections will be simply applied on each
> new ATL build, using WikiText.
>
> Best Regards,
>
> William
|
|
|
| Re: [ATL] New documentation strategy [message #97774 is a reply to message #97759] |
Mon, 19 January 2009 03:46 |
| Eclipse User |
|
|
|
Hi Alfons,
To launch the wikitext pdf2wiki transformation we use that ant file:
http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.m2m/org .eclipse.m2m.atl/doc/org.eclipse.m2m.atl.doc/build-helper.xm l?root=Modeling_Project&view=markup
Which is based on the org.eclipse org.eclipse.mylyn.help.ui plugin:
Mylyn ever use that technique for their user guide.
Regards,
William
Alfons Laarman a écrit :
> Hi William & co,
>
> Great work, I think allot of people can benefit from it.
> So will you publicize the pdf2wiki transformation? ;)
>
>
> Regards,
>
> Alfons
>
> "William Piers" <william.piers@obeo.fr> schreef in bericht
> news:gkqig2$9l7$1@build.eclipse.org...
>> Hello,
>>
>> We have a new strategy for ATL documentation: you may have seen that it
>> was sometimes hard to find an up-to-date and complete version of ATL
>> docs...
>>
>> Now all informations have been merged into the ATL wiki, on three main
>> pages:
>> - http://wiki.eclipse.org/ATL/Concepts
>> - http://wiki.eclipse.org/ATL/User_Guide
>> - http://wiki.eclipse.org/ATL/Developer_Guide
>> Integrating/updating pdfs and existing wiki pages was quite a big work, so
>> there is still a lot of "TODOs" on those pages... that will be fixed ASAP.
>> :-)
>>
>> Those page will also be available offline, into the eclipse.help ATL doc
>> plugin (available into ATL SDK builds), thanks to WikiText
>> (http://wiki.eclipse.org/Mylyn/FAQ#WikiText): this great tool provides a
>> very stable way to convert wiki pages into eclipse.help html pages.
>>
>> So users (and contributors) are now allowed to modify, update ATL
>> documentation: then relevant corrections will be simply applied on each
>> new ATL build, using WikiText.
>>
>> Best Regards,
>>
>> William
>
>
|
|
|
Goto Forum:
Current Time: Wed May 21 13:41:12 EDT 2025
Powered by FUDForum. Page generated in 0.02649 seconds |
Home