Eclipse "New and Noteworthy" Template

The title should be short and snappy, written in sentence case, and using "headlinese" (compressed style). The title should not use trailing punctuation, and the <tr> XHTML element needs a unique id attribute (value is all-lowercase and hyphen-separated).

In the news description, tell users about changes they'll see in 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; be short and don't repeat yourself. The description should be complete sentences, with trailing punctuation.

Make the entry self-contained and mention API classes. Do not link to bugs and don't promote individuals or third-party products.

Use active voice (say "you", not "the user"), and follow other advice in the Topic Content section of the Eclipse Doc Style Guidelines.

Stick to the default font and size. Make command names (Quick Fix), keyboard shortcuts (Ctrl+1), and preference page paths (Preferences > General > Keys) bold (using <b>). Avoid other emphasis markup, but prefer <b> over <em> if you have to use one.

Do not enclose the first paragraph of an item in <p></p> tags. Later in the entry, prefer <p> over <br/>.

To break up very long <code> tags that don't contain whitespace for automatic word-wrap, consider inserting <span style="visibility:hidden">&shy;</span> at strategic positions.

See entries in published news documents for correct examples. These published news entries have been already reviewed, while entries in the evolving document may still contain errors.

The Windows Snipping Tool actually saves to PNG on Windows 7 and can easily be used to crop and save screenshots:

• Arrange the windows for the shot
• Use the Windows Snipping Tool to capture part of the screen
• Use File > Save As to save the screenshot as a PNG
• Overlays such as red circles or boxes to call out details can be done using Microsoft Paint

Name the file in 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, space, or whatnot. The item's id is often a good choice for an image name.

Put all the images in a sibling directory named "images". This gives XHTML like:
<img src="images/foo-view.png" alt=""/>
Include a suitable alt attribute. The alt text should be empty ("") if the image just illustrates the text. Only use the alt text to add information that is not accessible if the page is rendered without images. Don't write alt="Screenshot of the XY dialog". Blind users shouldn't have to skip useless repetitions, but e.g. a field label can be interesting unless it's already part of the description.

If the alt attribute text cannot sufficiently replace the image contents (e.g. for a screenshot that shows source code), then enclose the img element in a link to a plain ".txt" file with the same name as the image:
<a href="images/foo-view.txt"><img ...

The images should be left-justified (as opposed to centered). Do not embed the width and height of the image.

Reading the source code is the task developers perform the most during coding. So text editors must assist the user as good as possible with that.

Up to now Eclipse running on macOS used the font "Monaco" as the default text editor font. This font does not contain a bold font face. But a lot of source code editors render keywords in the bold font face. With "Monaco" this feature was not available:

On macOS Eclipse Photon now uses the "Menlo" font as the default text font, which does also contain bold font faces. This increases readability in source code editors using bold font faces:

<extension point="org.eclipse.ui.genericeditor.autoEditStrategies">
    <autoEditStrategy
          class="org.eclipse.ui.genericeditor.demo.CloseTagAutoEditStrategy"
          contentType="org.eclipse.core.runtime.xml"/>
</extension>
      

<extension point="org.eclipse.ui.genericeditor.reconcilers">
    <reconciler
          class="org.eclipse.ui.genericeditor.demo.TagFoldingReconciler"
          contentType="org.eclipse.core.runtime.xml"/>
</extension>