[260230] Documentation for Visualization components
diff --git a/plugins/org.eclipse.actf.visualization.doc.isv/html/actf.html b/plugins/org.eclipse.actf.visualization.doc.isv/html/actf.html index e4eee68..6e4d261 100644 --- a/plugins/org.eclipse.actf.visualization.doc.isv/html/actf.html +++ b/plugins/org.eclipse.actf.visualization.doc.isv/html/actf.html
@@ -6,7 +6,7 @@ http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <title>ACTF Visualization SDK Developer Guide</title> -<link rel="stylesheet" type="text/css" href="book.css"> +<link rel="stylesheet" type="text/css" href="base.css"> </head> <body>
diff --git a/plugins/org.eclipse.actf.visualization.doc.isv/html/base.css b/plugins/org.eclipse.actf.visualization.doc.isv/html/base.css new file mode 100644 index 0000000..5838ef9 --- /dev/null +++ b/plugins/org.eclipse.actf.visualization.doc.isv/html/base.css
@@ -0,0 +1,156 @@ +/******************************************************************************* + * Copyright (c) 2004, 2008 IBM Corporation and Others + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * IBM Corporation - initial API and implementation + *******************************************************************************/ + +body { + font-family: sans-serif; + color: black; + background: white; + background-position: top left; + background-attachment: fixed; + background-repeat: no-repeat; +} + +th, td { /* ns 4 */ + font-family: sans-serif; +} + +h1, h2, h3, h4, h5, h6 { text-align: left } +h1 { font: bold 170% arial } +h2 { font: bold 140% arial } +h3 { font: bold 120% sans-serif } +h3.bullet { font: normal 100% sans-serif; margin-top: 0; margin-bottom: 3px; margin-left: 1em; } +h3.menudesc { font: bold 100% sans-serif } +h4 { font: bold 100% sans-serif } +h5 { font: italic 100% sans-serif } +h6 { font: small-caps 100% sans-serif } + +pre { margin-left: 2em } + +dt, dd { margin-top: 0; margin-bottom: 0 } /* opera 3.50 */ +dt { + font-weight: bold; + margin-top: 12px; +} + +pre, code { + font-family: monospace; +} /* navigator 4 requires this */ + +ul.bullet { + margin-top: 0; + margin-bottom: 3px; +} + +ul.toc { + list-style: disc; /* Mac NS has problem with 'none' */ + list-style: none; +} + +ul.related { + list-style: disc; /* Mac NS has problem with 'none' */ + list-style: none; + margin-left: 1em; +} + +ul.left { + list-style: disc; + list-style: none; + margin-left: 0; +} +ul.left li{ + margin-left: 0; + margin-bottom: 1em; +} + +ul.space li{ + margin-bottom: 1em; +} + +ul.nospace li{ + margin-bottom: 0em; +} + +ol ul.nospace li{ + margin-bottom: 0em; +} + +ol.space li{ + margin-bottom: 1em; +} + +DIV.figure{ + text-align: center; + margin: 10px; +} +DIV.figure SPAN{ + font-weight: bold; +} + +UL.icons{ + list-style-type: none; +} + +DIV.logo{ + text-align: right; +} + +DIV.footnote{ + margin-left: 10px; + font-size: small; +} + +H1.related { + font-size: medium; + border-top-style: solid; + border-top-width: thin; +} + + + +@media aural { + h1, h2, h3 { stress: 20; richness: 90 } + .hide { speak: none } + p.copyright { volume: x-soft; speech-rate: x-fast } + dt { pause-before: 20% } + pre { speak-punctuation: code } +} + +img { margin-bottom: 3px; } + +img.border { + border-style: solid; + border-width: 1px; + padding: 3px; + } + +img.border-nopad { + border-style: solid; + border-width: 1px; + padding: 0; + } + +p.trademark { + font-size: small; +} + +p.footer{ + border-top: 1px solid #2f4e6f; + font-family: arial; + font-size:small; + font-weight: bold; + margin: 15px 5px 5px 5px; + padding: 5px 20px 5px 5px; + text-align:right; +} + +.license { + font-size: small; +} \ No newline at end of file
diff --git a/plugins/org.eclipse.actf.visualization.doc.isv/html/book.css b/plugins/org.eclipse.actf.visualization.doc.isv/html/book.css deleted file mode 100644 index 565625c..0000000 --- a/plugins/org.eclipse.actf.visualization.doc.isv/html/book.css +++ /dev/null
@@ -1,23 +0,0 @@ -<STYLE> -SPAN.control -{ - FONT-WEIGHT: bold -} -SPAN.name -{ - FONT-STYLE: italic -} -SPAN.code -{ - FONT-FAMILY: monospace -} -P.nav_footer -{ - FONT-WEIGHT: bold -} -P.nav_footer A -{ - FONT-WEIGHT: bold; - FONT-STYLE: italic -} -</STYLE> \ No newline at end of file
diff --git a/plugins/org.eclipse.actf.visualization.doc.isv/html/checker/customize.html b/plugins/org.eclipse.actf.visualization.doc.isv/html/checker/customize.html new file mode 100644 index 0000000..b7169b8 --- /dev/null +++ b/plugins/org.eclipse.actf.visualization.doc.isv/html/checker/customize.html
@@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" +"http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta + http-equiv="Content-Type" + content="text/html; charset=iso-8859-1"> +<title>How to extend/customize HTML checker</title> +<link rel="stylesheet" type="text/css" href="../base.css"> +</head> +<body> + +<h1>How to extend/customize HTML checker</h1> + <p> + </p> +</body> +</html>
diff --git a/plugins/org.eclipse.actf.visualization.doc.isv/html/img/parser_dep_tab.gif b/plugins/org.eclipse.actf.visualization.doc.isv/html/img/parser_dep_tab.gif new file mode 100644 index 0000000..09a9b52 --- /dev/null +++ b/plugins/org.eclipse.actf.visualization.doc.isv/html/img/parser_dep_tab.gif Binary files differ
diff --git a/plugins/org.eclipse.actf.visualization.doc.isv/html/img/parser_mf.gif b/plugins/org.eclipse.actf.visualization.doc.isv/html/img/parser_mf.gif new file mode 100644 index 0000000..bb270bb --- /dev/null +++ b/plugins/org.eclipse.actf.visualization.doc.isv/html/img/parser_mf.gif Binary files differ
diff --git a/plugins/org.eclipse.actf.visualization.doc.isv/html/img/parser_path.gif b/plugins/org.eclipse.actf.visualization.doc.isv/html/img/parser_path.gif new file mode 100644 index 0000000..f53c14b --- /dev/null +++ b/plugins/org.eclipse.actf.visualization.doc.isv/html/img/parser_path.gif Binary files differ
diff --git a/plugins/org.eclipse.actf.visualization.doc.isv/html/model/dom_live.html b/plugins/org.eclipse.actf.visualization.doc.isv/html/model/dom_live.html new file mode 100644 index 0000000..5204794 --- /dev/null +++ b/plugins/org.eclipse.actf.visualization.doc.isv/html/model/dom_live.html
@@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" +"http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta + http-equiv="Content-Type" + content="text/html; charset=iso-8859-1"> +<title>Difference between LiveDocument and Document</title> +<link rel="stylesheet" type="text/css" href="../base.css"> +</head> +<body> + +<h1>Difference between LiveDocument and Document</h1> + <p> + </p> +</body> +</html>
diff --git a/plugins/org.eclipse.actf.visualization.doc.isv/html/model/htmlparser/parser.html b/plugins/org.eclipse.actf.visualization.doc.isv/html/model/htmlparser/parser.html new file mode 100644 index 0000000..fe37f40 --- /dev/null +++ b/plugins/org.eclipse.actf.visualization.doc.isv/html/model/htmlparser/parser.html
@@ -0,0 +1,63 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" +"http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta + http-equiv="Content-Type" + content="text/html; charset=iso-8859-1"> +<title>ACTF HTML Parser Guide</title> +<link rel="stylesheet" type="text/css" href="../../base.css"> +</head> +<body> + +<h1>How to use ACTF HTML Parser</h1> +<h2>1. Preparation</h2> + <ul> + <li>Add org.eclipse.actf.mode.dom.html as required plug-in<br> + <div class="figure"><img src="../../img/parser_dep_tab.gif" alt=""/><br>by using Dependencies tab</div> + <div class="figure"><img src="../../img/parser_mf.gif" alt=""/><br>by editing MANIFEST.MF directory</div> + </li> + <li>In the case of usual Java project, add jar file (org.eclipse.actf.model.dom.html_*.jar) into build path. + <div class="figure"><img src="../../img/parser_path.gif" alt=""/></div> + </li> + </ul> +<h2>2. Usage</h2> + <ol> + <li>Create HTML Parser<br> + <pre>IHTMLParser parser = HTMLParserFactory.createHTMLParser();</pre> + </li> + <li>Parse target HTML as InputStream + <p/> + <ul> + <li>Parse HTML by using default encoding + <pre>parser.parse(InputStream is);</pre> + </li> + <li>Parse HTML by using specified encoding + <pre>parser.parse(InputStream is, String encoding);</pre> + </li> + <li>Parse HTML by using charset information in META tag + <pre>parser.parseSwitchEnc(*);</pre> + </li> + </ul> + </li> + <li>Obtain resulting HTML Document + <pre>Document doc = parser.getDocument();</pre> + </li> + </ol> + <p> + The resulting HTML Document implements org.w3c.dom.html Interface.<br> + (See <a href="../../../reference/api/org/eclipse/actf/model/dom/html/package-summary.html">API document</a> for more details.) + </p> + +<h1>Additional resources</h1> +<p> In org.eclipse.actf.core plugin, several DOM utilities are available +<br> +<table border="1"> +<tr><td>org.eclipse.actf.util.dom.DomPrintUtil</td><td>Utility to convert DOM into String</td></tr> +<tr><td>org.eclipse.actf.util.dom.NodeIteratorImpl</td><td>DOM NodeIterator implementation</td></tr> +<tr><td>org.eclipse.actf.util.dom.TreeWalkerImpl</td><td>DOM TreeWalker implementation</td></tr> +<tr><td>org.eclipse.actf.util.xpath.XPathService</td><td>Utility for XPath evaluation<br>(Instance can be obtained from XPathServiceFactory)</td></tr> +</table> +</p> +</body> +</html>
diff --git a/plugins/org.eclipse.actf.visualization.doc.isv/html/model/modelservice.html b/plugins/org.eclipse.actf.visualization.doc.isv/html/model/modelservice.html new file mode 100644 index 0000000..bf996d1 --- /dev/null +++ b/plugins/org.eclipse.actf.visualization.doc.isv/html/model/modelservice.html
@@ -0,0 +1,17 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" +"http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta + http-equiv="Content-Type" + content="text/html; charset=iso-8859-1"> +<title>ACTF Model Service</title> +<link rel="stylesheet" type="text/css" href="../base.css"> +</head> +<body> + +<h1>How to access IModelService</h1> + <p> + </p> +</body> +</html>
diff --git a/plugins/org.eclipse.actf.visualization.doc.isv/toc_ACTF.xml b/plugins/org.eclipse.actf.visualization.doc.isv/toc_ACTF.xml index 5ba75a0..0236872 100644 --- a/plugins/org.eclipse.actf.visualization.doc.isv/toc_ACTF.xml +++ b/plugins/org.eclipse.actf.visualization.doc.isv/toc_ACTF.xml
@@ -2,4 +2,12 @@ <?NLS TYPE="org.eclipse.help.toc"?> <toc label="Programmer's Guide" href="html/actf.html"> -</toc> \ No newline at end of file + <topic href="html/model/modelservice.html" label="How to access IModelService"> + <topic href="html/model/dom_live.html" label="Difference between LiveDocument and Document"> + </topic> + </topic> + <topic href="html/model/htmlparser/parser.html" label="How to use ACTF HTML Parser"> + </topic> + <topic href="html/checker/customize.html" label="How to extend/customize HTML checker"> + </topic> +</toc>
