Chris Aniszczyk's (zx) diatribe » ua

Eclipse Help System and non-Jetty web servers

Chris Aniszczyk — Tue, 11 Nov 2008 02:19:00 +0000

For those who are interested, there is work in the 3.5 stream to make the Eclipse help system pluggable (again!). I’ve come across quite a few people that have had use cases to use something other than Jetty so please comment if you do!

There’s also talk about moving the Help System to Lucene 2.4, if you have a vested interest in this for some reason, please comment here.

Context Help Editor

Chris Aniszczyk — Tue, 22 Jan 2008 00:47:00 +0000

The tool-smiths behind PDE are at it again. In 3.4M5, we will bringing the Eclipse community a Help Context editor:

There’s still some polishing to do, but it all should be good before the 3.4M5 release date. Don’t know what help contexts are? Well that’s a shame, they are the magic behind the ‘context-sensitiveness’ of the Eclipse help system. If you’re writing some tooling or an RCP-based application that includes help, I highly recommend writing contexts to assist your end-users.

Many thanks to Curtis Windatt of Debug fame who got this contribution off the ground in time before feature freeze.

Kind Words About Eclipse Help

Chris Aniszczyk — Tue, 15 Jan 2008 05:16:00 +0000

I always say that kind words are cheap so it’s nice to hear that the Eclipse help system got some praise from the DITA blogging community:

…Eclipse Help is nonetheless extremely interesting as a case study of how a fully-featured Help system can be delivered, and could be used as a model or benchmark for cross-platform Help.

It gives me warm fuzzies inside when I hear kind words about PDE so I hope the Eclipse UA team has some of those warm fuzzies now

FYI: Help Feature

Chris Aniszczyk — Fri, 11 Jan 2008 20:01:00 +0000

A feature was finally created for adding Help to your Eclipse RCP applications. The feature will make its debut in 3.4M5.

This should simplify the process of working with the help system as in the past, it was a bit painful playing the ‘which plug-in do I need to run the help system’ game.

Thank you User Assistance team for putting this together

Eclipse Help on Different Servers

Chris Aniszczyk — Wed, 05 Dec 2007 05:36:00 +0000

The ability to run the Eclipse Help System on different servers will becoming a reality in the 3.4 version of Eclipse. I’ve heard this request quite a few times from various people so it’s nice to finally get this taken care of. It looks like people have managed to get the help system running on WAS, WAS CE and Tomcat so far.

To stay informed, cc yourself on this bug.

Pushing Pixels

Chris Aniszczyk — Tue, 13 Nov 2007 04:53:00 +0000

Can you see what’s wrong with this picture? Most people can’t. Only a few people like Kevin McGuire who like to nitpick and subscribe to the religion of color can spot the problem quickly. I call these people pixel pushers. In my opinion, these are the people that make Eclipse look good due to their attention to detail.

Now getting back to what’s wrong, here’s a hint:

Oh my eyes! When I saw this it hit me like a ton of bricks and I had to fix it immediately.

Why does this happen? Well, there’s the unfortunate situation when Eclipse Forms sections are given text clients with things like toolbar managers to add cool icons. This results in text clients taller than their title text so things grow accordingly causing adjacent sections to possibly not align. If you would like to learn more about this problem, check out this unpublished article on some new things in Eclipse Forms 3.3 by one of my favorite people in Toronto, Adam Archer.

Here’s how it should look like:

Ah, much better!

What’s the fix? Align adjacent sections using the text client height difference:
section2.descriptionVerticalSpacing = section1.getTextClientHeightDifference();
Does this make me a pixel pusher too?

Suggestions for the Eclipse Welcome Experience?

Chris Aniszczyk — Thu, 08 Nov 2007 03:19:00 +0000

The Eclipse User Assistance (UA) team is looking for suggestions on how to improve the Welcome experience for the 3.4 version of Eclipse. I opened a bug to help facilitate the discussion.

If you ever had a problem with the Welcome experience within Eclipse, here’s your chance to be heard and have your thoughts considered for the 3.4 release.

User Assistance Article

Chris Aniszczyk — Mon, 10 Sep 2007 20:00:00 +0000

My favorite IBM new hire Adam Archer and user assistance guru Chris Goldthorpe have a new article out on Eclipse Corner. It’s entitled, Adding Help Support to a Rich Client Platform (RCP) Application and is full of goodies like adding context-related help to your RCP applications.

Give it a read!

A Help-ful feature?

Chris Aniszczyk — Sat, 08 Sep 2007 23:14:00 +0000

If you ever were in a situation that you needed to get Eclipse’s standalone Help working for a client or your company, you probably felt the pain of trying to figure out what the minimum dependencies were. This is even tricker in 3.3 now due to the Jetty move. If you support creating a feature just for Help, voice your opinions on this feature request.

The Awesome Button

Chris Aniszczyk — Mon, 16 Jul 2007 04:08:00 +0000

I don’t know if people had this experience, but searching on help.eclipse.org was painful for me (by painful, I mean I couldn’t find anything I wanted quickly). I recall requesting the UA team implement a feature in the 3.3 cycle that involved grouping search results. Lo and behold, the team just did that:

Thank you UA team!