Plugin Overview

The Source Editor for Confluence Server allows the user to edit Confluence page XHTML using a browser based editor.

It has a plethora of features:

  • Syntax highlighting

  • Code/tag folding

  • Find/replace with regex support

  • Markup validation prior to apply

  • Access groups restrictions

Accessing The Source Editor

Open the Source Editor by clicking the  <> icon in the upper right corner of the Editor view.

You can access the source editor when editing pages, blog posts, and even comments.

You must be logged in and have editing privileges to edit the Confluence page source. You also cannot edit the source of a page that has not been created yet.

Compatibility with Confluence Source Editor:

It is recommended to disable or uninstall the native Confluence Source Editor app (if you are using it along with this app) to avoid performance issues.

Editing Confluence Source

The source editor provides direct access to Confluence page source. Confluence pages are stored in an XML based format called Confluence Storage Format.

Confluence Storage Format is a subset of HTML. It does not support all features of HTML. Please see here for more details.

Code Editing

The source editor is designed to be lightweight but contains a set of features to allow easy and intuitive editing of the Confluence page source.

  • Automatic indentation and syntax highlighting are available and enabled. 

  • Code folding: Use the markers next to the line numbers to fold XHTML tags.

  • Find/Replace: Easily search for and replace code in the editor. Use the Regex button to allow a regex string input.

Source Validation

To apply any edits made to a Confluence page, the XHTML source must be valid. To confirm the validity of your source, simply click Apply and the editor performs the verification. If your source is valid, the edits you made to the page in the source editor are applied and you are returned to the standard Confluence rich text editor. If your source contains an error, a message is displayed indicating the nature of the error and the location in the code where it was discovered.

Access Groups Configuration

Access to source editor can be controlled by restricting it to particular groups of users. This can be achieved in Source editor configuration page inside the administration menu.