Eclipse Community Forums: Oomph » Oomph documentation

Help

Home

Home » Eclipse Projects » Oomph » Oomph documentation(missing documentation)

Show: Today's Messages :: Show Polls :: Message Navigator

Oomph documentation [message #1847212]

Tue, 19 October 2021 13:03

Zdeněk Ziegler

Messages: 22
Registered: November 2019

Junior Member

Hey everyone!

I just have started with Oopmh in Eclipse and I am really excited. I would like to create our company custom Eclipse installer. Because I setup whole Eclipse (preferences/projects/etc) manually with every new version.

But unfortunately there is a very small amout of tutorials and documents about it.

I would like to ask you whether there is any kind of documentation about all possible nodes/elements within .setup file. For example: P2 Director, Copy resources etc.
In which I can find element purpose and all it possible settings.

Also I am looking for list of all potential variables which can be used in setup file. For example installer path.

I tried Eclipse wiki (there is a documentation but not to general as I would like to need) I also tried Eclipse documentation but it is not complete there.

I will be glad for every tip and trick in this topic.
Thanks in advance.

Report message to a moderator

Re: Oomph documentation [message #1847228 is a reply to message #1847212]

Wed, 20 October 2021 05:45

Ed Merks

Messages: 33140
Registered: July 2009

Senior Member

The documentation is very much lacking. I assume you found https://wiki.eclipse.org/Eclipse_Oomph_Authoring but that's certainly not exhaustive.

It will probably be helpful to set up an Oomph development environment so you can easily search the source code and can debug easily.

https://www.eclipse.org/setups/installer/?url=http://git.eclipse.org/c/oomph/org.eclipse.oomph.git/plain/setups/configurations/OomphConfiguration.setup&show=true

On the plus side, there are lots of examples which you can view using Navigate -> Open Setup -> Parent Models -> Catalog Index. From this you can see everything, including all the setups that various projects have contributed.

When authoring anything, make sure Setup Editor -> Live Validation is enabled so that you see problems early. Also keep an eye on the Outline which is kind of a preview for what you will see in the wizard, I.e., the Unresolved Variables section will be those that will be prompted, the Resolved Variables are those that have a fully specified value. If you see Undeclared variables, then you have a typo or forgot to define a variable that's needed. In org.eclipse.oomph.internal.setup.SetupProperties you'll find most of the system properties you might want to use.

You might also consider professional support...

Ed Merks
Professional Support: https://www.macromodeling.com/

Report message to a moderator