eclipse-uml2 / uml2

An EMF-based implementation of the UML 2.x metamodel for the Eclipse platform.
Eclipse Public License 2.0
5 stars 4 forks source link

Documentation should be indexed #72

Open eclipse-uml2-bot opened 8 hours ago

eclipse-uml2-bot commented 8 hours ago

| --- | --- | | Bugzilla Link | 467617 | | Status | NEW | | Importance | P3 enhancement | | Reported | May 19, 2015 16:57 EDT | | Modified | May 21, 2015 09:29 EDT | | Reporter | Ed Willink |

Description

Searching the UML documentation for "profile" yields no hits.

The Help index is empty.

This is because the documentation is redirected to the Wiki.

If documentation is prepared with e.g. Wikitext, HTML, PDF, Eclipse representations can be derived from one source enabling proper Eclipse documentation

eclipse-uml2-bot commented 8 hours ago

By Kenn Hussey on May 19, 2015 21:46

Is there a way to generate an index from the online content? A decision was made some time ago to no longer embed the documentation content in the UML2 jars and adding them back would be a non-starter at this point...

eclipse-uml2-bot commented 8 hours ago

By Ed Willink on May 20, 2015 01:43

(In reply to Kenn Hussey from comment #1)

Is there a way to generate an index from the online content?

No idea. (When would the index refresh? How deep should it index?)

A decision was made some time ago to no longer embed the documentation content in the UML2 jars

That seems like a rather poor decision now. It also denies offline users any assistance. I feel that primary assistance should be in-tool.

and adding them back would be a non-starter at this point...

Obviously too late for Mars, but surely a consideration for Neon.

eclipse-uml2-bot commented 8 hours ago

By Kenn Hussey on May 21, 2015 09:29

OK, will leave this for consideration as a potential future enhancement.