Changes between Version 9 and Version 10 of CkEditorPlugin


Ignore:
Timestamp:
Oct 9, 2012 10:07:39 AM (2 years ago)
Author:
framay
Comment:

Improved documentation of Options based on python doc

Legend:

Unmodified
Added
Removed
Modified
  • CkEditorPlugin

    v9 v10  
    8484}}} 
    8585 
     86=== Options === 
     87 
    8688The following options can be specified in the `[ckeditor]` section of your `trac.ini`: 
    8789 
    88 || '''option''' || '''description''' || '''possible values''' || 
    89 || 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]'' || 
    90 || editor_type || Type of integrated editor || full_integration, only_ticket, only_wiki, html_wrapper, none || 
    91 || editor_source || Path to CKEditor 3.6.x javascript source. || ''valid path'' || 
     90'''code_styles''' 
     91List 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]''. 
     92 
     93''default values:'' cpp, csharp, java, js, python, sql, default, xml 
     94 
     95'''editor_type''' 
     96Type of integrated editor. Possible types are:  
     97 - `full_integration`: CKEditor with TracWiki output ('''experimental'''),  
     98 - `only_ticket`: CKEditor with TracWiki output for ticket fields ('''experimental'''); ''leaves wiki editing as in Trac standard'',  
     99 - `only_wiki`: CKEditor with TracWiki output for wiki pages ('''experimental'''); ''leaves ticket editing as in Trac standard'', 
     100 - `html_wrapper`: CKEditor with HTML output wrapped in html-processor,   
     101 - `none`: No integration - ''leaves editing as in Trac standard'' 
     102''default value:'' full_integration 
     103 
     104'''editor_source''' 
     105Path 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`. 
     106 
     107''default value:'' `site/js/ckeditor/ckeditor.js` 
    92108 
    93109You 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.