Changes between Version 9 and Version 10 of CkEditorPlugin

Timestamp:

Oct 9, 2012 10:07:39 AM (8 months ago)

Author:

framay

Comment:

Improved documentation of Options based on python doc

CkEditorPlugin

@@ -84 +84 @@
 }}}
 
+=== Options ===
+
 The following options can be specified in the `[ckeditor]` section of your `trac.ini`:
 
-|| '''option''' || '''description''' || '''possible values''' ||
-|| code_styles || List of code styles, which should be processed by CKEditor and displayed in CKEditor dialog 'insert code'. || ''list of [http://pygments.org/ pygments-styles]'' ||
-|| editor_type || Type of integrated editor || full_integration, only_ticket, only_wiki, html_wrapper, none ||
-|| editor_source || Path to CKEditor 3.6.x javascript source. || ''valid path'' ||
+'''code_styles'''
+List of code styles, which should be processed by CKEditor and displayed in CKEditor dialog 'insert code'. Possible types are one of ''[http://pygments.org/ pygments-styles]''.
+
+''default values:'' cpp, csharp, java, js, python, sql, default, xml
+
+'''editor_type'''
+Type of integrated editor. Possible types are: 
+ - `full_integration`: CKEditor with TracWiki output ('''experimental'''), 
+ - `only_ticket`: CKEditor with TracWiki output for ticket fields ('''experimental'''); ''leaves wiki editing as in Trac standard'', 
+ - `only_wiki`: CKEditor with TracWiki output for wiki pages ('''experimental'''); ''leaves ticket editing as in Trac standard'',
+ - `html_wrapper`: CKEditor with HTML output wrapped in html-processor,  
+ - `none`: No integration - ''leaves editing as in Trac standard''
+''default value:'' full_integration
+
+'''editor_source'''
+Path to CKEditor 3.6.x javascript source. The path should be specified as viewed by the client, and must be accessible by the client-browser. A recommended setup involves installing CKEditor in the htdocs/js directory of the Trac environment, and setting this option to `site/js/ckeditor/ckeditor.js`.
+
+''default value:'' `site/js/ckeditor/ckeditor.js`
 
 You can also type `[[TracIni(ckedior)]]` in any Wiki-Page to get a list of possible options and their descriptions; see also description in plugins-panel.