| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Language" content="en-us" /> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
| <style type="text/css"> |
| p, table, td, th { font-family: verdana, arial, helvetica, geneva; font-size: 10pt;} |
| pre { font-family: "Courier New", Courier, mono; font-size: 10pt;} |
| h2 { font-family: verdana, arial, helvetica, geneva; font-size: 18pt; font-weight: bold ; line-height: 14px;} |
| code { font-family: "Courier New", Courier, mono; font-size: 10pt;} |
| sup { font-family: verdana, arial, helvetica, geneva; font-size: 10px;} |
| h3 { font-family: verdana, arial, helvetica, geneva; font-size: 14pt; font-weight: bold;} |
| li { font-family: verdana, arial, helvetica, geneva; font-size: 10pt;} |
| h1 { font-family: verdana, arial, helvetica, geneva; font-size: 24pt; font-weight: bold;} |
| body { font-family: verdana, arial, helvetica, geneva; font-size: 10pt; margin-top: 5mm; margin-left: 3mm;} |
| .indextop { font-size: x-large; font-family: verdana, arial, helvetica, sans-serif; font-weight: bold;} |
| .indexsub { font-size: xx-small; font-family: verdana, arial, helvetica, sans-serif; color: #8080FF;} |
| a.bar:link { text-decoration: none; color: #FFFFFF;} |
| a.bar:visited { color: #FFFFFF; text-decoration: none;} |
| a.bar:hover { color: #FFFFFF; text-decoration: underline;} |
| a.bar { color: #FFFFFF;} |
| |
| .section {font-size: 20px; font-weight: bold;} |
| table.news td {border-top: solid thin black;} |
| table.news tr {vertical-align: top;} |
| table.news tr td.title {vertical-align: top; width: 30%; font-weight: bold;} |
| table.news tr td.content {vertical-align: top; width: 70%;} |
| </style> |
| <title>Eclipse "New and Noteworthy" Template</title> |
| </head> |
| |
| <body> |
| <h1>Eclipse "New and Noteworthy" Template</h1> |
| <p>Last revised 2012-11-02.</p> |
| <p>This is the template for the "New and Noteworthy" document that |
| accompanies each Eclipse project milestone build.</p> |
| <p>Note: This template document is XHTML 1.0 Transitional. Please use the W3C <a href="http://validator.w3.org/#validate_by_input">XHTML |
| Markup Validation Service</a> to check your document's markup before submitting. |
| This will detect screwed up HTML tags, images without an "alt" |
| attribute, and other tedious little details.</p> |
| |
| <ul> |
| <li><a href="#Platform">Platform</a></li> |
| <li><a href="#JDT">JDT</a></li> |
| <li><a href="#PDE">PDE</a></li> |
| <li><a href="#Equinox">Equinox</a></li> |
| </ul> |
| |
| <table class="news" border="0" cellpadding="10" cellspacing="0" width="80%" summary="news entries"> |
| |
| <tr> |
| <td id="Instructions" class="section" colspan="2"> |
| <h2>Instructions</h2> |
| </td> |
| </tr> |
| |
| <tr id="item-name"> |
| <td class="title">Item title, in sentence style, no trailing |
| punctuation, with unique id attribute on <tr></td> |
| <td class="content"> |
| 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 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. |
| <p>Use active voice (say "you", not "the user"), and follow other advice in the |
| <a href="http://wiki.eclipse.org/Eclipse_Doc_Style_Guide#topic-content">Topic Content</a> |
| section of the Eclipse Doc Style Guidelines. |
| </p> |
| <p>Stick to the default font and size. Make command names (<b>Quick Fix</b>), |
| keyboard shortcuts (<b>Ctrl+1</b>), and preference page paths |
| (<b>Preferences > General > Keys</b>) bold. |
| </p> |
| <p>Do <em>not</em> enclose the first paragraph of an item in <code><p></p></code> tags. |
| </p> |
| </td> |
| </tr> |
| |
| <tr id="screenshots"> |
| <td class="title">Screenshots</td> |
| <td class="content"> |
| If a small image sheds light, place it below the description, in a separate |
| paragraph. Regular screen snapshots should be done on Windows 7. Crop |
| out any extraneous stuff to focus the reader's attention on your new |
| feature. The image should be |
| <b>no more than 519 pixels wide</b> and in <b>PNG</b> format (as opposed |
| to GIF, TIF, BMP, or JPG). Use PNG-8 if your image doesn't have a lot of color, |
| or PNG-24 if the screen shot uses enough color to warrant additional color depth. |
| See also the |
| <a href="http://wiki.eclipse.org/Eclipse_Doc_Style_Guide#graphics">Graphics</a> |
| section of the Eclipse Doc Style Guidelines. |
| <p>The Windows <b>Snipping Tool</b> actually saves to PNG on Windows 7 and can easily be |
| used to crop and save screenshots:</p> |
| <ul> |
| <li>Arrange the windows for the shot</li> |
| <li>Use the Windows <b>Snipping Tool</b> to capture part of the screen</li> |
| <li>Use <b>File > Save As</b> to save the screenshot as a PNG</li> |
| <li>Overlays such as red circles or boxes to call out details can be done using Microsoft Paint</li> |
| </ul> |
| <p>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 <b>lowercase</b> letters in the image file name, including the "<b>.png</b>" |
| file extension. As a separator, use <b>hyphen</b> "-" rather than |
| underscore |
| "_". </p> |
| <p>Put all the images in a sibling directory named "images". |
| This gives XHTML like:<br/> |
| <code><img src="images/foo-view.png" alt=""/></code><br/> |
| Include a suitable <a href="http://www.w3.org/TR/html4/struct/objects.html#h-13.8"><code>alt</code></a> 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 <code>alt="Screenshot of <i>the XY dialog</i>"</code>. Blind users shouldn't have to skip useless repetitions.</p> |
| <p>If the <code>alt</code> 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:<br/> |
| <code><a href="images/foo-view.txt"><img ...</code></p> |
| <p>The images should be left-justified (as opposed to centered). Do not embed the width and height of the image.</p> |
| <p>Use the W3C <a href="http://validator.w3.org/#validate_by_input">XHTML |
| Markup Validation Service</a> to check your document's markup before |
| submitting.</p></td> |
| </tr> |
| |
| <tr> |
| <td id="Platform" class="section" colspan="2"> |
| <h2>Platform</h2> |
| </td> |
| </tr> |
| |
| <tr id="first-item"> |
| <td class="title">First item</td> |
| <td class="content"> |
| Item blurb. |
| </td> |
| </tr> |
| |
| <tr id="second-item"> |
| <td class="title">Second item</td> |
| <td class="content"> |
| Item blurb. |
| </td> |
| </tr> |
| |
| |
| <tr> |
| <td id="JDT" class="section" colspan="2"> |
| <h2>JDT</h2> |
| </td> |
| </tr> |
| |
| <tr id="first-jdt-item"> |
| <td class="title">First item</td> |
| <td class="content"> |
| Item blurb. |
| </td> |
| </tr> |
| |
| |
| <tr> |
| <td id="PDE" class="section" colspan="2"> |
| <h2>PDE</h2> |
| </td> |
| </tr> |
| |
| <tr id="first-pde-item"> |
| <td class="title">First item</td> |
| <td class="content"> |
| Item blurb. |
| </td> |
| </tr> |
| |
| |
| <tr> |
| <td id="Equinox" class="section" colspan="2"> |
| <h2>Equinox</h2> |
| </td> |
| </tr> |
| |
| <tr id="first-equinox-item"> |
| <td class="title">First item</td> |
| <td class="content"> |
| Item blurb. |
| </td> |
| </tr> |
| |
| |
| <tr> |
| <td colspan="2"></td> |
| </tr> |
| |
| </table> |
| </body> |
| </html> |
