The next sections will show the simplest way to embed an editor by using the orion/editor/edit function. Note if you want customize your editor (beyond the options provided by the edit function), you have access to the full editor in the build.

The following demos are going to start with the following html file then add in the built editor:

The following demos are going to start with the following html file then add in the built editor:

Line 39:

Line 41:

<pre>

<pre>

/*

/*

−

* This is a orion editor sample.

+

* This is an Orion editor sample.

*/

*/

function() {

function() {

Line 93:

Line 95:

<pre class="editor" data-editor-lang="js">

<pre class="editor" data-editor-lang="js">

/*

/*

−

* This is a orion editor sample.

+

* This is an Orion editor sample.

*/

*/

function() {

function() {

Line 124:

Line 126:

<pre class="editor" data-editor-lang="js">

<pre class="editor" data-editor-lang="js">

/*

/*

−

* This is a orion editor sample.

+

* This is an Orion editor sample.

*/

*/

function() {

function() {

Line 172:

Line 174:

... snip ...

... snip ...

</source>

</source>

−

* Add the '''className''' attribute to the code. Note you can also pass in other attributes that influence the editor configuration (see : [[#Editor Attributes|editor attributes]]):

+

* Add the '''className''' attribute to the code. Note you can also pass in other options that influence the editor configuration (see : [[#Editor Options|editor options]]):

<source lang="xml">

<source lang="xml">

... snip ...

... snip ...

Line 180:

Line 182:

<pre class="editor" data-editor-lang="js">

<pre class="editor" data-editor-lang="js">

/*

/*

−

* This is a orion editor sample.

+

* This is an Orion editor sample.

*/

*/

function() {

function() {

Line 211:

Line 213:

<pre class="editor" data-editor-lang="js">

<pre class="editor" data-editor-lang="js">

/*

/*

−

* This is a orion editor sample.

+

* This is an Orion editor sample.

*/

*/

function() {

function() {

Line 222:

Line 224:

</source>

</source>

−

== Editor Attributes ==

+

== Editor Options ==

−

Here is the current list of attributes supported by the build for the 2.0 release. Note that these are liable to change in future releases.

+

Below is the current list of options(along with their default values) supported in the 2.0 release. The options can be specified directly in HTML by adding data attributes prefixed with "data-editor". Since HTML attributes are case insensitive, camel case letters are prefixed by a dash. For example: fullSelection becomes full-selection.

Revision as of 13:46, 7 November 2013

Contents

Editor Builds

In order to make the Orion editor easier to consume, 2 new nightly builds have been introduced.

One build is targeted at users who already use the RequireJS module loader.

The other build is targeted at users who want to embed the editor without any other dependencies.

The builds are identical in functionality and are available both minified and non-minified.

Getting the Build

Users can grab the most recent editor code from the nightly builds or they can use the latest release available on the Orion editor web page.

Users need to download (or directly link to) one type of build (either the RequireJS or standalone) and the common CSS file.

Nightly builds & Releases

From the Orion build page, users can click on a nightly build or a release (starting with 2.0) and they will be presented with a page that now includes the built editor components:

build-editor-amd.min.js and built-editor-amd.js are the minified and non-minified versions of the RequireJS build.

built-editor.min.js and built-editor.js are the minified and non-minified versions of the standalone build.

built-editor.css is the built css file and is needed by both builds.

Orion Editor web page

The built editor files will also be available directly from the Orion editor web page releases section.

Using the Build

The next sections will show the simplest way to embed an editor by using the orion/editor/edit function. Note if you want customize your editor (beyond the options provided by the edit function), you have access to the full editor in the build.

The following demos are going to start with the following html file then add in the built editor:

Using the standalone build

These instructions are going to use the builds available on eclipse.org/orion.editor. If you have downloaded the built-editor.min.js and built-editor.css files to your local server, just update the corresponding paths.

Using the RequireJS build

These instructions are going to use the builds available on eclipse.org/orion.editor. If you have downloaded the built-editor-amd.min.js and built-editor.css files to your local server, just update the corresponding paths.

Editor Options

Below is the current list of options(along with their default values) supported in the 2.0 release. The options can be specified directly in HTML by adding data attributes prefixed with "data-editor". Since HTML attributes are case insensitive, camel case letters are prefixed by a dash. For example: fullSelection becomes full-selection.

/**
* @class This object describes the options for <code>edit</code>.
* @name orion.editor.EditOptions
*
* @property {String|DOMElement} parent the parent element for the view, it can be either a DOM element or an ID for a DOM element.
* @property {Boolean} [readonly=false] whether or not the view is read-only.
* @property {Boolean} [fullSelection=true] whether or not the view is in full selection mode.
* @property {Boolean} [tabMode=true] whether or not the tab keypress is consumed by the view or is used for focus traversal.
* @property {Boolean} [expandTab=false] whether or not the tab key inserts white spaces.
* @property {String} [themeClass] the CSS class for the view theming.
* @property {Number} [tabSize=4] The number of spaces in a tab.
* @property {Boolean} [wrapMode=false] whether or not the view wraps lines.
* @property {Function} [statusReporter] a status reporter.
* @property {String} [title=""] the editor title.
* @property {String} [contents=""] the editor contents.
* @property {String} [lang] the styler language. Plain text by default.
* @property {Boolean} [showLinesRuler=true] whether or not the lines ruler is shown.
* @property {Boolean} [showAnnotationRuler=true] whether or not the annotation ruler is shown.
* @property {Boolean} [showOverviewRuler=true] whether or not the overview ruler is shown.
* @property {Boolean} [showFoldingRuler=true] whether or not the folding ruler is shown.
*/