KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > pde > internal > core > ischema > IDocumentSection


1 /*******************************************************************************
2  * Copyright (c) 2000, 2003 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.pde.internal.core.ischema;
12
13 /**
14  * Document section is portion of the extension point schema
15  * definition that will be taken and built into the final reference
16  * HTML document. There are several predefined document sections
17  * that PDE recognizes:
18  * <ul>
19  * <li>MARKUP - will be used for "Markup" section</li>
20  * <li>EXAMPLES - will be used for "Examples" section</li>
21  * <li>API_INFO - will be used for "API information" section</li>
22  * <li>IMPLEMENTATION - will be used for "Supplied Implementation" section</li>
23  * </ul>
24  * Text that objects of this class carry can contain HTML tags that
25  * will be copied into the target document as-is.
26  */
27 public interface IDocumentSection extends ISchemaObject {
28     /**
29      * Section Id for the "Markup" section of the target reference document
30      */
31     String JavaDoc MARKUP = "markup"; //$NON-NLS-1$
32 /**
33      * Section Id for the "Examples" section of the target reference document
34      */
35     String JavaDoc EXAMPLES = "examples"; //$NON-NLS-1$
36 /**
37      * Section Id for the "Supplied Implementation" section of the target reference document
38      */
39     String JavaDoc IMPLEMENTATION = "implementation"; //$NON-NLS-1$
40 /**
41      * Section Id for the "API Information" section of the target reference document
42      */
43     String JavaDoc API_INFO = "apiInfo"; //$NON-NLS-1$
44 /**
45      * Section Id for the copyright statement section of the target reference document
46      */
47     String JavaDoc COPYRIGHT = "copyright"; //$NON-NLS-1$
48
49     /**
50      * Section Id for the first version in which the extension point appears.
51      */
52     String JavaDoc SINCE = "since"; //$NON-NLS-1$
53 /**
54  * Returns the Id of this section.
55  */
56 public String JavaDoc getSectionId();
57 }
58
Popular Tags