Markup Language Cheat Seet
Identifier:
org.eclipse.mylyn.wikitext.ui.cheatSheet
Since:
1.0
Description:
Plugin cheat-sheet content specific to a markup language.
Cheat-sheet content is help text that provides information about the syntax of a specific markup language. This help text is presented to the user within the markup editor.
Configuration Markup:
<!ELEMENT extension (content+)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED
>
<!ELEMENT content EMPTY>
<!ATTLIST content
markupLanguage CDATA #REQUIRED
resource CDATA #REQUIRED
contentLanguage CDATA #IMPLIED
>
a pointer to markup language-specific cheat sheet help content
- markupLanguage - the name of the markup language for which the cheat sheet content is relevant (eg: "Textile", "MediaWiki", etc)
- resource - A path to the resource that provides the content.
The provided resource path is the default resource, however additional resources may be located alongside the default resource in order to provide locale-specific content. This works in the same way as for resource bundles.
For example, the resource may be specified as help/cheatSheet.textile and for the locale 'no_NO_NY' the following resource paths would be searched in the following order:
help/cheatSheet_no_NO_NY.textile
help/cheatSheet_no_NO.textile
help/cheatSheet_no.textile
help/cheatSheet.textile
in this way the user is presented with the most locale-specific help resource.
- contentLanguage - The markup language of the help content. If unspecified, then HTML is assumed. Otherwise the contentLanguage may be specified as any registered markup language (eg: "Textile", "MediaWiki", etc).
Examples:
<extension
point="org.eclipse.mylyn.wikitext.ui.cheatSheet">
<content
contentLanguage="Textile"
markupLanguage="Textile"
resource="help/cheatSheet/Textile.textile">
</content>
</extension>
Copyright (c) 2007, 2009 David Green 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