SCEditor Documentation

XHTML

This format will convert the output of SCEditor into valid XHTML.

Initialise

To enable the XHTML format, set the format option to xhtml. e.g.

<script>
var textarea = ...;
sceditor.create(textarea, {
	format: 'xhtml',
	style: 'minified/themes/content/default.min.css'
});
</script>

Options

All of the options below should be set before creating an instance of the editor. If they are set after they will not take effect until source mode is toggled.

converters

sceditor.formats.xhtml.converters Array

An array of converter objects used to convert HTML into valid XHTML or HTML5.

A converter object must be in the following format:

{
	// Object with all the tags to match
	tags: {
		// Matches any <tagname> that has the following attributes
		'tagname': {
			// Will match if tagname has the attribute attributename with
			// one of the specified values from the array
			attributename: [
				'an array', 'of values or', 'null to match', 'all values'
			],

			// Will match if it has the attribute anotherattribute regardless
			// of the attributes value
			anotherattribute: null
		},

		// Matches any <anothertagname> tag
		'anothertagname': null
		
	},
	conv: function(node) {
		// convert node here
	}
}

To match any tag use * for the name.

For example:

// Push this converter onto the end of the converters array
sceditor.formats.xhtml.converters.push({
	tags: {
		// Match any tag with the attribute border
		'*': {
			border: null
		}
		
	},
	conv: function(node) {
		var $node = $(node);

		// Change border attribute to CSS
		$node.css('border-size', $node.attr('border')).removeAttr('border');
	}
});

The above will match any tag with the attibute border and convert the border attribute into border-size CSS.

allowedAttribs

sceditor.formats.xhtml.allowedAttribs Object

Acts as a whitelist of allowed attributes. If this is null or empty then all attributes will be allowed unless blacklisted.

The allowed attributes can be specified on a tag by tag basis or for all tags by using * as the tag name.

allowedAttribs should be in the following format format:

sceditor.formats.xhtml.disallowedAttribs['tagname']['attributename'] = [
	'array', 'of', 'valid', 'values', 'or', 'null', 'to', 'allow', 'all', 'values'
];

For example:

sceditor.formats.xhtml.disallowedAttribs = {
	// The * sign matches every tags so this will allow the id
	// and class attributes on all tags
	'*': {
		id: null,
		'class': null
	},
	// This will allow the href attribute on the a tag
	a: {
		href: null
	},
	// This will allow the face attribute on the font tag
	// with a value of 'Arial' or 'Times New Roman'
	font: {
		face: ['Arial', 'Times New Roman']
	}
};

Acts as a blacklist of disallowed tags. If null or empty then all tags will be allowed.

disallowedAttribs

sceditor.formats.xhtml.disallowedAttribs Object

This will only be used if allowedAttribs is empty.

Acts as a blacklist of disallowed attributes. If null or empty then all attributes will be allowed.

The format of disallowedAttribs is the same as allowedAttribs above except instead of allowing attributes, this will blacklist them.

allowedTags

sceditor.formats.xhtml.allowedTags Array

Acts as a whitelist of allowed tags. If null or empty then all tags will be allowed unless blacklisted.

sceditor.formats.xhtml.allowedTags = ['a', 'strong', 'p', 'span', 'div'];

disallowedTags

sceditor.formats.xhtml.disallowedTags Array

This will only be used if allowedTags is empty.

Acts as a blacklist of disallowed tags. If null or empty then all tags will be allowed.

sceditor.formats.xhtml.disallowedTags = ['a', 'strong', 'p', 'span', 'div'];