[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
[platform-releng-dev] Additional Doc Fixes
|
The attached patch contains additional doc fixes: it removes unwanted image
sizes in all our doc plug-ins and adds missing ALT text to the JDT doc
plug-ins (there are still many missing ALT tags in the PDE and Platform doc
plug-ins).
This is nothing that should hold off RC7 but should be released in case of
a rebuild. I didn't commit any changes from the attached patch yet.
Dani
(See attached file: patch.txt)
### Eclipse Workspace Patch 1.0
#P org.eclipse.jdt.doc.isv
Index: guide/jdt_apt_getting_started.htm
===================================================================
RCS file: /home/eclipse/org.eclipse.jdt.doc.isv/guide/jdt_apt_getting_started.htm,v
retrieving revision 1.5
diff -u -r1.5 jdt_apt_getting_started.htm
--- guide/jdt_apt_getting_started.htm 1 Jun 2006 20:25:40 -0000 1.5
+++ guide/jdt_apt_getting_started.htm 2 Jun 2006 10:01:56 -0000
@@ -29,11 +29,11 @@
You must have your project's compiler configured to use Java 5.0-level compliance
in the preferences, under Java->Compiler:
<p>
-<img src="images/compiler_dialog.png"></p>
+<img src="images/compiler_dialog.png" alt="Screenshot of Compiler preference page"></p>
<p>
Next you need to enable annotation processing under Java->Compiler->Annotation Processing:</p>
<p>
-<img src="images/annotation_processing.png"></p>
+<img src="images/annotation_processing.png" alt="Screenshot of Annotation Processing properties page"></p>
<p>
In this dialog you can also specify the generated source directory if desired,
and provide any processor options that are necessary.</p>
@@ -45,7 +45,7 @@
You can add annotation processors to your project under Java->Compiler->Annotation Processing->Factory Path:
<p>
-<img src="images/factory_path.png"></p>
+<img src="images/factory_path.png" alt="Screenshot of Factory Path properties page"></p>
<p>
<h3>Factory Path and Source Control</h3>
#P org.eclipse.platform.doc.user
Index: tips/platform_tips.html
===================================================================
RCS file: /home/eclipse/org.eclipse.platform.doc.user/tips/platform_tips.html,v
retrieving revision 1.74
diff -u -r1.74 platform_tips.html
--- tips/platform_tips.html 30 May 2006 17:58:30 -0000 1.74
+++ tips/platform_tips.html 2 Jun 2006 10:01:57 -0000
@@ -496,7 +496,7 @@
</td>
<td valign="top" align="left"><p>Many operations can be optionally
run in the background so that you can continue working while they complete.</p>
- <p><img src="../images/res_build.png" alt="Progress dialog with Run in background button" width="450" height="198" ></p>
+ <p><img src="../images/res_build.png" alt="Progress dialog with Run in background button"></p>
<p>In the
<a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.ui.preferencePages.Workbench)")'>
@@ -522,7 +522,7 @@
preference page. By disabling capabilities you are able to hide views,
perspectives, preference pages and other assorted contributions.</p>
- <p align="left"><img src="../images/cap-pref.png" alt="Capabilities Preference Page" width="597" height="527"></p>
+ <p align="left"><img src="../images/cap-pref.png" alt="Capabilities Preference Page"></p>
</td>
</tr>
</table>
#P org.eclipse.pde.doc.user
Index: guide/intro/pde_overview.htm
===================================================================
RCS file: /home/eclipse/org.eclipse.pde.doc.user/guide/intro/pde_overview.htm,v
retrieving revision 1.8
diff -u -r1.8 pde_overview.htm
--- guide/intro/pde_overview.htm 22 Jun 2005 22:01:50 -0000 1.8
+++ guide/intro/pde_overview.htm 2 Jun 2006 10:01:58 -0000
@@ -66,11 +66,11 @@
combined list of workspace and external plug-ins. In it, you will be able to
browse the directory structure of external plug-ins, open files, etc.</p>
<p>
-<img border="0" src="../images/ngrelc.png" width="159" height="27" alt="Related concepts"><br>
+<img border="0" src="../images/ngrelc.png" alt="Related concepts"><br>
<a href="javaScript:openRelatedLink('guide/pde_setup.htm')">Preparing the workbench</a><br>
<a href="javaScript:openRelatedLink('guide/pde_configuring.htm')">PDE concepts</a></p>
<p>
-<img border="0" src="../images/ngrelt.png" width="159" height="27" alt="Related tasks"><br>
+<img border="0" src="../images/ngrelt.png" alt="Related tasks"><br>
<a href="javaScript:openRelatedLink('guide/pde_creating.htm')">Creating new plug-in project</a><br>
<a href="javaScript:openRelatedLink('guide/pde_manifest.htm')">Editing the manifest</a><br>
<a href="javaScript:openRelatedLink('guide/pde_running.htm')">Running</a><br>
Index: guide/tools/editors/manifest_editor/dependencies.htm
===================================================================
RCS file: /home/eclipse/org.eclipse.pde.doc.user/guide/tools/editors/manifest_editor/dependencies.htm,v
retrieving revision 1.3
diff -u -r1.3 dependencies.htm
--- guide/tools/editors/manifest_editor/dependencies.htm 2 Jun 2006 02:48:01 -0000 1.3
+++ guide/tools/editors/manifest_editor/dependencies.htm 2 Jun 2006 10:01:58 -0000
@@ -55,7 +55,7 @@
<p> </p>
<p class="style2">Dependency Analysis</p>
<p align="left">The <strong>Dependency Analysis</strong> section contains several useful features that help you examine and optimize your plug-in dependencies to make your plug-in run better. </p>
-<p><img src="../../../images/plugin_editor/dependencies_analysis.png" alt="Dependency Analysis" width="343" height="125"></p>
+<p><img src="../../../images/plugin_editor/dependencies_analysis.png" alt="Dependency Analysis"></p>
<p>Since JARs from all the plug-ins listed as dependencies will be on your plug-in runtime classpath, it is very important not to list dependencies that are not required. Otherwise, class loading performance will be detrimentally affected. If you click the <strong>Find unused dependencies</strong> hyperlink, PDE will find unused and redundant entries in the list of required plug-ins and imported packages and offer to remove them. </p>
<p> </p>
<p> </p>
Index: guide/tools/editors/manifest_editor/build.htm
===================================================================
RCS file: /home/eclipse/org.eclipse.pde.doc.user/guide/tools/editors/manifest_editor/build.htm,v
retrieving revision 1.3
diff -u -r1.3 build.htm
--- guide/tools/editors/manifest_editor/build.htm 2 Jun 2006 02:48:01 -0000 1.3
+++ guide/tools/editors/manifest_editor/build.htm 2 Jun 2006 10:01:58 -0000
@@ -30,7 +30,7 @@
<p>If your plug-in declares more than one library, order them correctly using the <strong>Up</strong> and <strong>Down</strong> button. This will ensure that they get compiled in the correct order.</p>
<p> </p>
<p class="style2">Binary and Source Builds </p>
-<p><img src="../../../images/plugin_editor/binary_source.png" alt="Binary and Source Builds" width="648" height="217"></p>
+<p><img src="../../../images/plugin_editor/binary_source.png" alt="Binary and Source Builds"></p>
<p> </p>
<p align="left">The <strong>Binary Build</strong> section is where you select all the files and folders that will make it into the packaged plug-in. </p>
<p align="left">The <strong>Source Build </strong>section has a specialized purpose and is not commonly used or needed by the general population. It is only needed when you need to ship source in separate plug-ins and features rather than in binary plug-ins. See the <A href="../reference/extension-points/org_eclipse_pde_core_source.html">org.eclipse.pde.core.source</A> extension point for details.</p>
Index: guide/tools/editors/feature_editor/information.htm
===================================================================
RCS file: /home/eclipse/org.eclipse.pde.doc.user/guide/tools/editors/feature_editor/information.htm,v
retrieving revision 1.3
diff -u -r1.3 information.htm
--- guide/tools/editors/feature_editor/information.htm 2 Jun 2006 02:48:01 -0000 1.3
+++ guide/tools/editors/feature_editor/information.htm 2 Jun 2006 10:01:58 -0000
@@ -26,24 +26,24 @@
<p> </p>
<p class="style2">Feature Description</p>
<p>A <strong>Feature Description</strong> is a brief component description. </p>
-<p><img src="../../../images/feature_editor/information_description.png" alt="Description" width="456" height="184"></p>
+<p><img src="../../../images/feature_editor/information_description.png" alt="Description"></p>
<p>Typically, a description is plain text and intended to be translated. Alternatively, you can provide the description in HTML format and point to it via a URL. The URL can be specified as absolute or relative. If a relative URL is specified, it is assumed to be relative to (and packaged in) the feature archive. </p>
<p> </p>
<p class="style2">Copyright Notice </p>
<p>The feature <strong>Copyright Notice</strong> is typically provided as plain text and is intended to be translated. </p>
-<p><img src="../../../images/feature_editor/information_copyright.png" alt="Copyright" width="460" height="183"></p>
+<p><img src="../../../images/feature_editor/information_copyright.png" alt="Copyright"></p>
<p>Alternatively, you can provide the copyright notice in HTML format and point to it via a URL. The URL can be specified as absolute or relative. If a relative URL is specified, it is assumed to be relative to (and packaged in) the feature archive. </p>
<p> </p>
<p class="style2">License Agreement</p>
<p>The <strong>License Agreement</strong> is a feature <em>click-through</em> license. It is typically simple text and is intended to be translated. </p>
<p>The license is displayed in a standard dialog with <strong>Accept</strong> and <strong>Reject</strong> actions during the download and installation process. </p>
-<p><img src="../../../images/feature_editor/information_license.png" alt="License" width="456" height="177"></p>
+<p><img src="../../../images/feature_editor/information_license.png" alt="License"></p>
<p>Note that a <em>click-through</em> license must be specified for any feature that will be selected for installation or update using the <em>Update Manager</em>. When using nested features, only the nesting parent (i.e. the feature selected for installation or update) must have <em>click-through</em> license <strong>Text</strong> defined. </p>
<p><em><strong>Please note that the license text is required even if the Optional URL attribute is specified. </strong></em></p>
<p> </p>
<p class="style2">Sites to Visit</p>
<p><strong>Sites to Visit</strong> specify the name and URL of sites to search for new features. </p>
-<p><img src="../../../images/feature_editor/information_sites.png" alt="Sites To Visit" width="459" height="175"></p>
+<p><img src="../../../images/feature_editor/information_sites.png" alt="Sites To Visit"></p>
<p>In general, a provider can use <strong>Sites to Visit</strong> to reference its own site(s), or partner site(s) that offer complementary features. </p>
<p>Eclipse uses this data simply as a way to distribute new site URLs to the clients. Sites that belong to root features (at the top of the hierarchy) typically appear as <strong>Sites to Visit</strong> in <em>Update Manager</em>. </p>
<p> </p>
Index: guide/tools/editors/feature_editor/included_features.htm
===================================================================
RCS file: /home/eclipse/org.eclipse.pde.doc.user/guide/tools/editors/feature_editor/included_features.htm,v
retrieving revision 1.3
diff -u -r1.3 included_features.htm
--- guide/tools/editors/feature_editor/included_features.htm 2 Jun 2006 02:48:01 -0000 1.3
+++ guide/tools/editors/feature_editor/included_features.htm 2 Jun 2006 10:01:58 -0000
@@ -26,11 +26,11 @@
<p> </p>
<p class="style2">Feature List</p>
<p>The <strong>Included Features</strong> list enumerates all the features that are directly nested in your feature. </p>
-<p><img src="../../../images/feature_editor/features_included.png" alt="Included Features" width="256" height="135"></p>
+<p><img src="../../../images/feature_editor/features_included.png" alt="Included Features"></p>
<p>When your feature is built, all of its included features are recursively built and packaged as well.</p>
<p> </p>
<p class="style2">Included Feature Details</p>
-<p><img src="../../../images/feature_editor/features_details.png" alt="Feature Details" hspace="30"></p>
+<p><img src="../../../images/feature_editor/features_details.png"></p>
<p>An included feature may be marked as <strong>optional</strong> using the <strong>The feature is optional</strong> option. Users may not choose to install optional features. However, if users do choose to install optional features, they may safely disable them later on. Please note that a missing optional feature is not treated as an error.</p>
<p>An included feature can be updated by patches. By default, <em>Update Manager</em> searches for updates to an included feature at <strong>the update site for the parent feature</strong>; but, this setting can be overridden. </p>
<p>If an included feature contains platform-specific code or resources, then environment conditions should be specified and associated with that feature.</p>
Index: guide/tools/editors/site_editor/archives.htm
===================================================================
RCS file: /home/eclipse/org.eclipse.pde.doc.user/guide/tools/editors/site_editor/archives.htm,v
retrieving revision 1.1
diff -u -r1.1 archives.htm
--- guide/tools/editors/site_editor/archives.htm 2 Jun 2006 02:48:02 -0000 1.1
+++ guide/tools/editors/site_editor/archives.htm 2 Jun 2006 10:01:58 -0000
@@ -21,11 +21,11 @@
<p> </p>
<p class="style2">Site Description </p>
<p>A site description may be as simple as a brief text description. Alternately, you may specify a URL pointing to an HTML file. The URL can be specified as absolute of relative. If relative, the URL is assumed to be relative to site.xml. </p>
-<p><img src="../../../images/site_editor/archives_description.png" alt="Description" width="559" height="214"></p>
+<p><img src="../../../images/site_editor/archives_description.png" alt="Description"></p>
<p> </p>
<p class="style2">Site Mirrors</p>
<p>An update site may point to the URL of a file listing update site mirror definitions. This URL can be absolute or relative to this site.</p>
-<p><img src="../../../images/site_editor/archives_mirrors.png" alt="Mirrors" width="559" height="84"></p>
+<p><img src="../../../images/site_editor/archives_mirrors.png" alt="Mirrors"></p>
<p> </p>
<p> </p>
</body>
#P org.eclipse.platform.doc.isv
Index: guide/ide_marker_support.htm
===================================================================
RCS file: /home/eclipse/org.eclipse.platform.doc.isv/guide/ide_marker_support.htm,v
retrieving revision 1.2
diff -u -r1.2 ide_marker_support.htm
--- guide/ide_marker_support.htm 30 May 2006 15:43:17 -0000 1.2
+++ guide/ide_marker_support.htm 2 Jun 2006 10:01:59 -0000
@@ -36,7 +36,7 @@
are instances of <a href="../reference/api/org/eclipse/ui/views/markers/WorkbenchMarkerResolution.html">WorkbenchMarkerResolution</a>
it is possible for users to add other matching <code>WorkbenchMarkerResolutions</code>
in the Quick Fix dialog.</p>
-<p><img src="images/quickfix.png" width="543" height="523"></p>
+<p><img src="images/quickfix.png"></p>
<p><strong>Quick Fix dialog with two missing externalizations</strong></p>
<p><strong>org.eclipse.ui.ide.markerSupport </strong></p>
<p><code>org.eclipse.ui.ide.markerSupport</code> is the extension for specifying
@@ -48,16 +48,16 @@
using the problemFilter extension element or manually by the user. Below is
the filters section of the Problems View showing user filters and filters added
via the extension point (system filters).</p>
-<p><img src="images/problems_view_filters.png" width="258" height="459"></p>
+<p><img src="images/problems_view_filters.png"></p>
<p><strong>Grouped</strong></p>
<p>Markers can be grouped into two ways. The first way is to group marker types
into groups using the <code>markerTypeCategory</code> extension. This is shown
when the user selects Group By - > Type. Below is an example showing Java
Problems and some using a test grouping.</p>
-<p><img src="images/problems_view_groupByType.png" width="497" height="178"></p>
+<p><img src="images/problems_view_groupByType.png"></p>
<p>When marker types are grouped together they will be shown in those groups in
the filters dialog.</p>
-<p><img src="images/problems_view_markerTypeCat.png" width="225" height="212"></p>
+<p><img src="images/problems_view_markerTypeCat.png"></p>
<p>It is also possible to create your own grouping using the <code>markerGrouping</code>
extension which will show up as an extra entry in the Group By->Menu of the
Problems view. The IDE provides a grouping based on severity (the default).
@@ -66,7 +66,7 @@
<code>markerAttributeMappings</code> are used to specify these mappings. Below
is the Group By menu with the extra <code>markerGroupings</code> that have been
added. The Problems view is currently grouped by severity.</p>
-<p><img src="images/problemsview_groups.png" width="498" height="180"></p>
+<p><img src="images/problemsview_groups.png"></p>
<p></p>
</body>
</html>
#P org.eclipse.jdt.doc.user
Index: reference/views/shared/ref-details.htm
===================================================================
RCS file: /home/eclipse/org.eclipse.jdt.doc.user/reference/views/shared/ref-details.htm,v
retrieving revision 1.1
diff -u -r1.1 ref-details.htm
--- reference/views/shared/ref-details.htm 30 May 2006 18:23:52 -0000 1.1
+++ reference/views/shared/ref-details.htm 2 Jun 2006 10:02:00 -0000
@@ -15,7 +15,7 @@
<p>
Select the <strong>Detail Pane... </strong> command to open a dialog that allows you to change the maximum number of characters that will be allowed to display in the <strong><a href="../../details_pane/ref-details_pane.htm">Details Pane</a></strong>.</p>
<p>The resulting dialog.</p>
- <p><img src="../../../reference/views/shared/images/ref-detailpane_dialog.PNG" alt="Detail Pane Dialog" width="399" height="158"> </p>
+ <p><img src="../../../reference/views/shared/images/ref-detailpane_dialog.PNG" alt="Detail Pane Dialog"> </p>
<p>This command applies to:</p>
<ul>
<li><a href="../../../reference/views/expressions/ref-expressions_view.htm"><strong>Expressions View</strong></a></li>
