Craig Petchell avatar Craig Petchell committed 4c34584

Update readme, and link to marketplace

Comments (0)

Files changed (1)

 # Confluence Source Editor Plugin
 
-This plugin provides the ability to edit a Confluence pages storage source while in the RTE.
+The Confluence Source Editor plugin allows users to view and edit the underlying storage format for a Confluence page. The source editor is ideal for:
 
-An icon (<>) is added to the right-hand side of the toolbar that provides access to the editor.
+* Copy/pasting back and forth between Confluence and your preferred desktop editor
+* Quickly viewing and editing macro parameters, link URLs, image names and more.
+* Quickly fixing editor formatting errors
+* Search and replace macro parameters and link urls.
 
-While there is some limited validation, it is still possible to manipulate and save the source such that a page cannot be
-rendered correctly.
+When the plugin is installed and enabled on your Confluence site, users will see the new source editor button <> in the editor toolbar. Features include:
 
-If this occurs, the changes may be reverted via a opening the pages history and reverting to an earlier version.
+* XML syntax highlighting and line numbers to make the source easy to read.
+* Simple validation ensures that your XHTML is well formed before you apply the changes to the page.
+
+Access to the Source Editor may be restricted to specific groups by the system administrator.
+
+Documentation for the Confluence Storage Format is available [here](http://confluence.atlassian.com/display/DOC/Confluence+Storage+Format).
+
+This plugin is available on the [Atlassian Marketplace](https://marketplace.atlassian.com/plugins/com.atlassian.confluence.plugins.editor.confluence-source-editor).
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.