Bug 582486 Improve help for queries

Add more alt text. Task-Url: https://bugs.eclipse.org/bugs/show_bug.cgi?id=582486 Change-Id: I1288765a4135c03305fea0127ec503a0414a15db
eclipse-mat · Nov 9, 2023 · 3992983 · 3992983
1 parent 815ab46
commit 3992983
Show file tree

Hide file tree

Showing 28 changed files with 248 additions and 192 deletions.
diff --git a/plugins/org.eclipse.mat.ui.help/concepts/dominatortree.dita b/plugins/org.eclipse.mat.ui.help/concepts/dominatortree.dita
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-    Copyright (c) 2008, 2012 SAP AG and others.
+    Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others.
     All rights reserved. This program and the accompanying materials
     are made available under the terms of the Eclipse Public License 2.0
     which accompanies this distribution, and is available at
@@ -10,15 +10,16 @@
    
     Contributors:
         SAP AG - initial API and implementation
+        IBM Corporation - updates for validation
  -->
-<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd" >
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA 1.1 Concept//EN" "concept.dtd">
 <concept id="concept_dominatortree" xml:lang="en-us">
 	<title>Dominator Tree</title>
 	<prolog>
 		<copyright>
 			<copyryear year=""></copyryear>
 			<copyrholder>
-				Copyright (c) 2008, 2010 SAP AG and others.
+				Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others.
 			    All rights reserved. This program and the accompanying materials
 			    are made available under the terms of the Eclipse Public License 2.0
 			    which accompanies this distribution, and is available at
@@ -32,7 +33,7 @@
 		    The transformation of the object reference graph into a
 			dominator tree allows you to easily identify the biggest chunks of
 			retained memory and the keep-alive dependencies among objects. 
-			Bellow is an informal definition of the terms.</p>
+			Below is an informal definition of the terms.</p>
 		<p>
 			An object x
 			<b>dominates</b>

diff --git a/plugins/org.eclipse.mat.ui.help/concepts/dominatortree.html b/plugins/org.eclipse.mat.ui.help/concepts/dominatortree.html
@@ -7,8 +7,8 @@
 <meta name="generator" content="DITA-OT" /><meta name="DC.type" content="concept" />
 <meta name="DC.title" content="Dominator Tree" />
 <meta name="DC.relation" scheme="URI" content="shallowretainedheap.html" />
-<meta name="copyright" content="Copyright (c) 2008, 2010 SAP AG and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
-<meta name="DC.rights.owner" content="Copyright (c) 2008, 2010 SAP AG and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
+<meta name="copyright" content="Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
+<meta name="DC.rights.owner" content="Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
 <meta name="DC.format" content="XHTML" />
 <meta name="DC.identifier" content="concept_dominatortree" />
 <meta name="DC.language" content="en-us" />
@@ -26,7 +26,7 @@ <h1 class="title topictitle1" id="ariaid-title1">Dominator Tree</h1>
 		    The transformation of the object reference graph into a
 			dominator tree allows you to easily identify the biggest chunks of
 			retained memory and the keep-alive dependencies among objects. 
-			Bellow is an informal definition of the terms.</p>
+			Below is an informal definition of the terms.</p>
 
 		<p class="p">
 			An object x

diff --git a/plugins/org.eclipse.mat.ui.help/concepts/gcroots.dita b/plugins/org.eclipse.mat.ui.help/concepts/gcroots.dita
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-    Copyright (c) 2008, 2010 SAP AG and others.
+    Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others.
     All rights reserved. This program and the accompanying materials
     are made available under the terms of the Eclipse Public License 2.0
     which accompanies this distribution, and is available at
@@ -10,15 +10,16 @@
    
     Contributors:
         SAP AG - initial API and implementation
+        IBM Corporation - updates for validation
  -->
-<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd" >
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA 1.1 Concept//EN" "concept.dtd" >
 <concept id="concept_gcroots" xml:lang="en-us">
 	<title>Garbage Collection Roots</title>
 	<prolog>
 		<copyright>
 			<copyryear year=""></copyryear>
 			<copyrholder>
-				Copyright (c) 2008, 2010 SAP AG and others.
+				Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others.
 			    All rights reserved. This program and the accompanying materials
 			    are made available under the terms of the Eclipse Public License 2.0
 			    which accompanies this distribution, and is available at

diff --git a/plugins/org.eclipse.mat.ui.help/concepts/gcroots.html b/plugins/org.eclipse.mat.ui.help/concepts/gcroots.html
@@ -6,8 +6,8 @@
 
 <meta name="generator" content="DITA-OT" /><meta name="DC.type" content="concept" />
 <meta name="DC.title" content="Garbage Collection Roots" />
-<meta name="copyright" content="Copyright (c) 2008, 2010 SAP AG and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
-<meta name="DC.rights.owner" content="Copyright (c) 2008, 2010 SAP AG and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
+<meta name="copyright" content="Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
+<meta name="DC.rights.owner" content="Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
 <meta name="DC.format" content="XHTML" />
 <meta name="DC.identifier" content="concept_gcroots" />
 <meta name="DC.language" content="en-us" />

diff --git a/plugins/org.eclipse.mat.ui.help/concepts/heapdump.dita b/plugins/org.eclipse.mat.ui.help/concepts/heapdump.dita
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-    Copyright (c) 2008, 2012 SAP AG and others.
+    Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others.
     All rights reserved. This program and the accompanying materials
     are made available under the terms of the Eclipse Public License 2.0
     which accompanies this distribution, and is available at
@@ -11,14 +11,14 @@
     Contributors:
         SAP AG - initial API and implementation
  -->
-<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd" >
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA 1.1 Concept//EN" "concept.dtd" >
 <concept id="concept_heapdump" xml:lang="en-us">
 	<title>Heap Dump</title>
 	<prolog>
 		<copyright>
 			<copyryear year=""></copyryear>
 			<copyrholder>
-				Copyright (c) 2008, 2010 SAP AG and others.
+				Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others.
 			    All rights reserved. This program and the accompanying materials
 			    are made available under the terms of the Eclipse Public License 2.0
 			    which accompanies this distribution, and is available at

diff --git a/plugins/org.eclipse.mat.ui.help/concepts/heapdump.html b/plugins/org.eclipse.mat.ui.help/concepts/heapdump.html
@@ -7,8 +7,8 @@
 <meta name="generator" content="DITA-OT" /><meta name="DC.type" content="concept" />
 <meta name="DC.title" content="Heap Dump" />
 <meta name="DC.relation" scheme="URI" content="../tasks/acquiringheapdump.html" />
-<meta name="copyright" content="Copyright (c) 2008, 2010 SAP AG and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
-<meta name="DC.rights.owner" content="Copyright (c) 2008, 2010 SAP AG and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
+<meta name="copyright" content="Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
+<meta name="DC.rights.owner" content="Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
 <meta name="DC.format" content="XHTML" />
 <meta name="DC.identifier" content="concept_heapdump" />
 <meta name="DC.language" content="en-us" />

diff --git a/plugins/org.eclipse.mat.ui.help/concepts/reachability.dita b/plugins/org.eclipse.mat.ui.help/concepts/reachability.dita
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-    Copyright (c) 2018 IBM Corporation.
+    Copyright (c) 2018, 2023 IBM Corporation.
     All rights reserved. This program and the accompanying materials
     are made available under the terms of the Eclipse Public License 2.0
     which accompanies this distribution, and is available at
@@ -11,14 +11,14 @@
     Contributors:
         Andrew Johnson/IBM Corporation - initial API and implementation
  -->
-<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd" >
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA 1.1 Concept//EN" "concept.dtd" >
 <concept id="concept_reachability" xml:lang="en-us">
 	<title>Reachability</title>
 	<prolog>
 		<copyright>
 			<copyryear year=""></copyryear>
 			<copyrholder>
-				Copyright (c) 2018 IBM Corporation.
+				Copyright (c) 2018, 2023 IBM Corporation.
 			    All rights reserved. This program and the accompanying materials
 			    are made available under the terms of the Eclipse Public License 2.0
 			    which accompanies this distribution, and is available at

diff --git a/plugins/org.eclipse.mat.ui.help/concepts/reachability.html b/plugins/org.eclipse.mat.ui.help/concepts/reachability.html
@@ -7,8 +7,8 @@
 <meta name="generator" content="DITA-OT" /><meta name="DC.type" content="concept" />
 <meta name="DC.title" content="Reachability" />
 <meta name="DC.relation" scheme="URI" content="gcroots.html" />
-<meta name="copyright" content="Copyright (c) 2018 IBM Corporation. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
-<meta name="DC.rights.owner" content="Copyright (c) 2018 IBM Corporation. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
+<meta name="copyright" content="Copyright (c) 2018, 2023 IBM Corporation. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
+<meta name="DC.rights.owner" content="Copyright (c) 2018, 2023 IBM Corporation. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
 <meta name="DC.format" content="XHTML" />
 <meta name="DC.identifier" content="concept_reachability" />
 <meta name="DC.language" content="en-us" />

diff --git a/plugins/org.eclipse.mat.ui.help/concepts/shallowretainedheap.dita b/plugins/org.eclipse.mat.ui.help/concepts/shallowretainedheap.dita
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-    Copyright (c) 2008, 2010 SAP AG and others.
+    Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others.
     All rights reserved. This program and the accompanying materials
     are made available under the terms of the Eclipse Public License 2.0
     which accompanies this distribution, and is available at
@@ -10,15 +10,16 @@
    
     Contributors:
         SAP AG - initial API and implementation
+        IBM Corporation - updates for validation
  -->
-<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd" >
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA 1.1 Concept//EN" "concept.dtd" >
 <concept id="concept_shallowretainedsize" xml:lang="en-us">
 	<title>Shallow vs. Retained Heap</title>
 	<prolog>
 		<copyright>
 			<copyryear year=""></copyryear>
 			<copyrholder>
-				Copyright (c) 2008, 2010 SAP AG and others.
+				Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others.
 			    All rights reserved. This program and the accompanying materials
 			    are made available under the terms of the Eclipse Public License 2.0
 			    which accompanies this distribution, and is available at

diff --git a/plugins/org.eclipse.mat.ui.help/concepts/shallowretainedheap.html b/plugins/org.eclipse.mat.ui.help/concepts/shallowretainedheap.html
@@ -6,8 +6,8 @@
 
 <meta name="generator" content="DITA-OT" /><meta name="DC.type" content="concept" />
 <meta name="DC.title" content="Shallow vs. Retained Heap" />
-<meta name="copyright" content="Copyright (c) 2008, 2010 SAP AG and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
-<meta name="DC.rights.owner" content="Copyright (c) 2008, 2010 SAP AG and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
+<meta name="copyright" content="Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
+<meta name="DC.rights.owner" content="Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ " type="primary" />
 <meta name="DC.format" content="XHTML" />
 <meta name="DC.identifier" content="concept_shallowretainedsize" />
 <meta name="DC.language" content="en-us" />

diff --git a/plugins/org.eclipse.mat.ui.help/reference/selectingqueries.dita b/plugins/org.eclipse.mat.ui.help/reference/selectingqueries.dita
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-    Copyright (c) 2008, 2022 SAP AG, IBM Corporation and others.
+    Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others.
     All rights reserved. This program and the accompanying materials
     are made available under the terms of the Eclipse Public License 2.0
     which accompanies this distribution, and is available at
@@ -10,6 +10,7 @@
    
     Contributors:
         SAP AG - initial API and implementation
+        IBM Corporation - more updates including alternate text
  -->
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd" >
 <reference id="ref_queryarguments" xml:lang="en-us">
@@ -20,7 +21,7 @@
 		<copyright>
 			<copyryear year=""></copyryear>
 			<copyrholder>
-				Copyright (c) 2008, 2022 SAP AG, IBM Corporation and others.
+				Copyright (c) 2008, 2023 SAP AG, IBM Corporation and others.
 				All rights reserved. This program and the accompanying materials
 				are made available under the terms of the Eclipse Public License 2.0
 				which accompanies this distribution, and is available at
@@ -35,14 +36,18 @@
 			<p> Memory Analyzer provides a set of queries to analyze a heap dump. These
 				queries are grouped into several categories. </p>
 			<p> You can select a query out of the drop-down toolbar menu. </p>
-			<image href="../mimes/189608b9.png" align="left" placement="break"/>
+			<image href="../mimes/189608b9.png" align="left" placement="break">
+				<alt>Screen shot selecting Leak Identification > Top Consumers query</alt>
+			</image>
 			<p> In the menu you can also access the list of already executed queries via the
 				<menucascade><uicontrol>History</uicontrol></menucascade> entry. 
 				The Query Selector which can be
 				quickly accessed with the
 				<uicontrol>ctrl+Q</uicontrol> or <uicontrol platform="macOS">command+Q</uicontrol> 
 				key combination.</p>
-			<image href="../mimes/select_queries.png" align="left" placement="break"/>
+			<image href="../mimes/select_queries.png" align="left" placement="break">
+				<alt>Query selection pop-up showing history and other queries</alt>
+			</image>
 			<p> The Query Selector consists of an input field, where you can search for
 				queries, below the input field you can find the history of already executed
 				queries and below the history the list of all available queries grouped by
@@ -95,7 +100,9 @@
 				the message area at the top information is displayed about the mandatory
 				arguments. At the bottom the detailed description is displayed like in the
 				query selector. </p>
-			<image href="../mimes/36c94924.png" align="left" placement="break"/>
+			<image href="../mimes/36c94924.png" align="left" placement="break">
+				<alt>Argument wizard for Collection Fill Ratio query, showing help information</alt>
+			</image>
 
 			<p id="arguments">
 				<b>Providing Query Arguments</b>