001: /*******************************************************************************
002: * Copyright (c) 2002, 2007 IBM Corporation and others.
003: * All rights reserved. This program and the accompanying materials
004: * are made available under the terms of the Eclipse Public License v1.0
005: * which accompanies this distribution, and is available at
006: * http://www.eclipse.org/legal/epl-v10.html
007: *
008: * Contributors:
009: * IBM Corporation - initial API and implementation
010: *******************************************************************************/package org.eclipse.ui.internal.cheatsheets.data;
011:
012: /**
013: * Interface containing the constants used by the cheatsheet parser
014: * to identify the tags used in the cheatsheet file.
015: */
016: public interface IParserTags {
017:
018: /*
019: * <!ELEMENT cheatsheet (intro, item+)>
020: * <!ATTLIST cheatsheet
021: * title CDATA #REQUIRED
022: * >
023: */
024: public static final String CHEATSHEET = "cheatsheet"; //$NON-NLS-1$
025: public static final String TITLE = "title"; //$NON-NLS-1$
026:
027: /*
028: * <!ELEMENT intro (description)>
029: * <!ATTLIST intro
030: * contextId CDATA #IMPLIED
031: * href CDATA #IMPLIED
032: * >
033: */
034: public static final String INTRO = "intro"; //$NON-NLS-1$
035: public static final String CONTEXTID = "contextId"; //$NON-NLS-1$
036: public static final String HREF = "href"; //$NON-NLS-1$
037:
038: /*
039: * <!ELEMENT description ()>
040: * <!ATTLIST description
041: * >
042: */
043: public static final String DESCRIPTION = "description"; //$NON-NLS-1$
044: public static final String BOLD = "b"; //$NON-NLS-1$
045: public static final String BREAK = "br"; //$NON-NLS-1$
046: public static final String BOLD_START_TAG = "<b>"; //$NON-NLS-1$
047: public static final String BOLD_END_TAG = "</b>"; //$NON-NLS-1$
048: public static final String BREAK_TAG = "<br/>"; //$NON-NLS-1$
049: public static final String FORM_START_TAG = "<form><p>"; //$NON-NLS-1$
050: public static final String FORM_END_TAG = "</p></form>"; //$NON-NLS-1$
051:
052: /*
053: * <!ELEMENT item (description [action|perform-when] | (subitem|repeated-subitem|conditional-subitem)*)>
054: * <!ATTLIST item
055: * title CDATA #REQUIRED
056: * dialog ("true" | "false") "false"
057: * skip ("true" | "false") "false"
058: * contextId CDATA #IMPLIED
059: * href CDATA #IMPLIED
060: * >
061: */
062: public static final String ITEM = "item"; //$NON-NLS-1$
063: public static final String DIALOG = "dialog"; //$NON-NLS-1$
064: public static final String SKIP = "skip"; //$NON-NLS-1$
065:
066: /*
067: * <!ELEMENT subitem ( [action|perform-when] )>
068: * <!ATTLIST subitem
069: * label CDATA #REQUIRED
070: * skip ("true" | "false") "false"
071: * when CDATA #IMPLIED
072: * >
073: */
074: public static final String SUBITEM = "subitem"; //$NON-NLS-1$
075: public static final String LABEL = "label"; //$NON-NLS-1$
076: public static final String WHEN = "when"; //$NON-NLS-1$
077:
078: /*
079: * <!ELEMENT conditional-subitem (subitem+)>
080: * <!ATTLIST conditional-subitem
081: * condition CDATA #REQUIRED
082: * >
083: */
084: public static final String CONDITIONALSUBITEM = "conditional-subitem"; //$NON-NLS-1$
085: public static final String CONDITION = "condition"; //$NON-NLS-1$
086:
087: /*
088: * <!ELEMENT repeated-subitem (subitem)>
089: * <!ATTLIST repeated-subitem
090: * values CDATA #REQUIRED
091: * >
092: */
093: public static final String REPEATEDSUBITM = "repeated-subitem"; //$NON-NLS-1$
094: public static final String VALUES = "values"; //$NON-NLS-1$
095:
096: /*
097: * <!ELEMENT action EMPTY>
098: * <!ATTLIST action
099: * class CDATA #REQUIRED
100: * pluginId CDATA #REQUIRED
101: * param1 CDATA #IMPLIED
102: * ...
103: * param9 CDATA #IMPLIED
104: * confirm ("true" | "false") "false"
105: * when CDATA #IMPLIED
106: * >
107: */
108: public static final String ACTION = "action"; //$NON-NLS-1$
109: public static final String CLASS = "class"; //$NON-NLS-1$
110: public static final String PLUGINID = "pluginId"; //$NON-NLS-1$
111: public static final String PARAM = "param"; //$NON-NLS-1$
112: public static final String CONFIRM = "confirm"; //$NON-NLS-1$
113:
114: /*
115: * <!ELEMENT perform-when (action+)>
116: * <!ATTLIST perform-when
117: * condition CDATA #REQUIRED
118: * >
119: */
120: public static final String PERFORMWHEN = "perform-when"; //$NON-NLS-1$
121:
122: // Miscellaneous tags
123: public static final String COMMAND = "command"; //$NON-NLS-1$
124: public static final String SERIALIZATION = "serialization"; //$NON-NLS-1$
125: public static final String RETURNS = "returns"; //$NON-NLS-1$
126: public static final String ON_COMPLETION = "onCompletion"; //$NON-NLS-1$
127: public static final String CONTENT_URL = "contentURL"; //$NON-NLS-1$
128: public static final String REQUIRED = "required"; //$NON-NLS-1$
129: public static final String TRANSLATE = "translate"; //$NON-NLS-1$
130:
131: // Constants for re-escaping XML characters
132: public static final String LESS_THAN = "<"; //$NON-NLS-1$
133: public static final String GREATER_THAN = ">"; //$NON-NLS-1$
134: public static final String AMPERSAND = "&"; //$NON-NLS-1$
135: public static final String APOSTROPHE = "'"; //$NON-NLS-1$
136: public static final String QUOTE = """; //$NON-NLS-1$
137:
138: // Cheat Sheet state data key
139: public static final String ID = "id";//$NON-NLS-1$
140: public static final String MANAGERDATA = "CSMData";//$NON-NLS-1$
141: public static final String MANAGERDATAKEY = "key"; //$NON-NLS-1$
142: public static final String MANAGERDATAVALUE = "value"; //$NON-NLS-1$
143: public static final String COMPLETED = "completed"; //$NON-NLS-1$
144: public static final String CURRENT = "current"; //$NON-NLS-1$
145: public static final String SUBITEMCOMPLETED = "subitemcompleted"; //$NON-NLS-1$
146: public static final String SUBITEMSKIPPED = "subitemskipped"; //$NON-NLS-1$
147: public static final String EXPANDED = "expanded"; //$NON-NLS-1$
148: public static final String EXPANDRESTORE = "expandRestore"; //$NON-NLS-1$
149: public static final String BUTTON = "button"; //$NON-NLS-1$
150: public static final String BUTTONSTATE = "buttonstate"; //$NON-NLS-1$
151: public static final String PATH = "path"; //$NON-NLS-1$
152: public static final String CHEATSHEET_STATE_REFERENCE = "CHEATSHEET_STATE_REFERENCE"; //$NON-NLS-1$
153: public static final String CHEATSHEET_STATE = "cheatsheetState"; //$NON-NLS-1$
154:
155: }
|