blob: e32f192df91ededd47f3a490c0b699f5ca234471 [file] [log] [blame]
lmandelfe13d292005-07-11 19:53:21 +00001<?xml version="1.0" encoding="UTF-8"?>
2<html>
3 <!-- This file should be renamed to "package.xml" and placed within the API
4 package that you're summarizing.
5 -->
6 <head>
7 <!-- Escape to the root of your source folder -->
8 <meta
9 name="root"
10
11 content="../../../../../../" />
12 <title>title</title>
13 </head>
14
15 <body>
16 <abstract>
17 An overview sentence for the overview-summary page -- one sentence only.
18 </abstract>
19 <p>Insert text within this table template. The width is fixed
20 to prevent large images from stretching the text across
21 the entire screen.
22 </p>
23 <!--
24 REMOVE THIS COMMENT OR THE XSLT StyleSheet WILL FAIL!
25
26 The following template should be used for images. You must escape out
27 to the root directory of your packages, include the path "overview" and
28 then the name of your image. All images should be JPEG (*.jpg -- case is
29 important). The actual images should be located under [plugin]/javadoc-images.
30 If javadoc-images does not exist in your plugin, create one and update
31 org.eclipse.wst.doc.isv/javadoc.xml to copy the *.jpg into the correct
32 location. The "overview" directory must be in the link as below since
33 the *.jpg files from [plugin]/javadoc-images to [doc]/overview.
34
35 <img src="[escape out to source folder level]/overview/[your image].jpg" caption="Caption for the image"/>
36
37 -->
38 <codesnippet caption="Description text">
39int bobdole = 100;
40System.out.println("Bob Dole equals: " + bobdole);
41 </codesnippet>
42 </body>
43</html>