HelpConstants


1   /*
2    * The contents of this file are subject to the terms of the Common Development
3    * and Distribution License (the License). You may not use this file except in
4    * compliance with the License.
5    *
6    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7    * or http://www.netbeans.org/cddl.txt.
8    *
9    * When distributing Covered Code, include this CDDL Header Notice in each file
10   * and include the License file at http://www.netbeans.org/cddl.txt.
11   * If applicable, add the following below the CDDL Header, with the fields
12   * enclosed by brackets [] replaced by your own identifying information:
13   * "Portions Copyrighted [year] [name of copyright owner]"
14   *
15   * The Original Software is NetBeans. The Initial Developer of the Original
16   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  
20  package org.netbeans.modules.javahelp;
21  
22  
23  
24  
25  /** Useful constants pertaining to the help system.
26  * @author Jesse Glick
27  */
28  public interface HelpConstants {
29  
30      /** public ID for standard helpset DTD
31       */
32      String   PUBLIC_ID_HELPSET = "-//Sun Microsystems Inc.//DTD JavaHelp HelpSet Version 1.0//EN"; // NOI18N
33      /** public ID for NetBeans reference to a helpset
34       */
35      String   PUBLIC_ID_HELPSETREF = "-//NetBeans//DTD JavaHelp Help Set Reference 1.0//EN"; // NOI18N
36      /** public URL for NetBeans reference to a helpset
37       */
38      String   PUBLIC_URL_HELPSETREF = "http://www.netbeans.org/dtds/helpsetref-1_0.dtd"; // NOI18N
39      /** public ID for a help context link
40       */    
41      String   PUBLIC_ID_HELPCTX = "-//NetBeans//DTD Help Context 1.0//EN"; // NOI18N
42      /** public URL for a help context link DTD
43       */    
44      String   PUBLIC_URL_HELPCTX = "http://www.netbeans.org/dtds/helpcontext-1_0.dtd"; // NOI18N
45      /** "context" for merge attribute on helpsets
46       */    
47      String   HELPSET_MERGE_CONTEXT = "OpenIDE"; // NOI18N
48      /** attribute (type Boolean) on helpsets indicating
49       * whether they should be merged into the master or
50       * not; by default, true
51       */    
52      String   HELPSET_MERGE_ATTR = "mergeIntoMaster"; // NOI18N
53      /** A helpID present only in the master help set;
54       *however, when displayed by {@link #showHelp} as the helpID in a context,
55       *the master help set (with merged-in children) will be shown instead,
56       *with no change made to the content pane.
57       *Also, this is the help ID mapped to the "default" page in the master help viewer.
58       */
59      String   MASTER_ID = "org.netbeans.api.javahelp.MASTER_ID"; // NOI18N
60  
61  }
62
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags