This is version 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 . It is not the current version, and thus it cannot be edited.

Back to current version Restore this version

How to create a new markup #

KnowWE is designed for the easy introduction of new (e.g., project specific) markups. Therefore, an extra plugin extension point is provided. Further, a markup template is defined that allows to make benefit of existing implementations of parser and autocompletion functionality. We call this template DefaultMarkup. The implementation of a new markup based on the DefaultMarkup can be achieved at very low implementation workload. It is recommended to always make use of this template when creating a new markup (except for the very rare cases where it is not suitable).

Create a new markup derived from default markup#

The DefaultMarkup has a particular predefined syntactical structure that can be coined by a custom keyword and custom annotation.

public class HelloWorldMarkup extends DefaultMarkupType {

	private static final DefaultMarkup MARKUP;

	static {
		MARKUP = new DefaultMarkup("HelloWorld");
	}

	public HelloWorldMarkup() {
		super(MARKUP);
	}
}

! Extend Class DefaultMarkupType

To create a new markup based on DefaultMarkup, the class de.knowwe.kdom.defaultMarkup.DefaultMarkupType needs to be extended. The following code snipplet shows a Hello-World extension of DefaultMarkup.

Add Annotations#

public class HelloWorldMarkup extends DefaultMarkupType {

	public static final String IMAGE_KEY = "image";
	
	private static final DefaultMarkup MARKUP;

	static {
		MARKUP = new DefaultMarkup("HelloWorld");
		MARKUP.addAnnotation(Image_KEY, false);
	}

	public HelloWorldMarkup() {
		super(MARKUP);
	}
}

Create a renderer#

Create entry into the plugin.xml#

Create an new general markup#