Eclipse "New and Noteworthy" Template

Last revised October 29, 2007

This is the template for the "New and Noteworthy" document that accompanies each Eclipse project milestone build.

Note: This template document is XHTML 1.0 Transitional. Please use the W3C XHTML Markup Validation Service to check your document's markup before submitting. This will detect screwed up HTML tags, images without an "alt" attrribute, and other tedious little details.

Eclipse component
Item title, in bold, no trailing punctuation, with unique id attribute on <tr> A blurb pitched to the Eclipse community (not just to members of the Eclipse Platform development team). Tell end users about changes they'll see at the UI. Tell component writers about changes they'll see at the client- and server-side APIs. Try to generate some excitement; save the boring details for the manual. The description should be complete sentences, with trailing punctuation. Stick to the default font and size.

If a small image sheds light, place it below the description, in a separate paragraph. Regular screen snapshots should be done on Windows XP. Crop out any extraneous stuff to focus the reader's attention on your new feature. The image should be no more than 466 pixels wide and in PNG-24 format (as opposed to GIF, TIF, BMP, or JPG).

Microsoft Paint actually saves to PNG on Windows XP and can easily be used to crop and save screenshots:

  • Arrange the windows for the shot
  • Use the Print Screen key (or Alt+Print Screen) to capture the screen
  • Open Paint (under All Programs > Accessories)
  • Ctrl+V to paste
  • Select the area you want to keep
  • Ctrl+C to copy it
  • Ctrl+N to create a new canvas (ok to discard old one)
  • Ctrl+V to paste selected portion
  • Save As PNG

Name the file is a way that is appropriate and specific to the item (e.g., key-bindings.png, rather than something generic like image.png). Use all lowercase letters in the image file name, including the ".png" file extension. As a separator, use hyphen "-" rather than underscore "_".

Put all the images in a sibling directory named "images". This gives HTML like <img src="images/foo.png" alt="The Foo View" />. Include a suitable alt property (which is mandatory in XHTML 1.0). Do not embed the width and height of the image.

The images should be left justified (as opposed to centered).

Use the W3C XHTML Markup Validation Service to check your document's markup before submitting.
Another item Another blurb
Another item Another blurb