Changes between Version 25 and Version 26 of TracWysiwygPlugin


Ignore:
Timestamp:
Jun 14, 2015, 1:15:26 PM (9 years ago)
Author:
figaro
Comment:

Rearranged paragraphs to maintain consistency, tagged with license

Legend:

Unmodified
Added
Removed
Modified
  • TracWysiwygPlugin

    v25 v26  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = TracWiki WYSIWYG Editor Plugin =
     3= TracWiki WYSIWYG Editor Plugin
    44
    5 == Description ==
     5== Description
    66
    7 Wysiwyg editor embedded into `textarea.wikitext`.
     7This plugin implements a Wysiwyg editor embedded into `textarea.wikitext`.
    88
    9 == Bugs/Feature Requests ==
     9Key features:
     10
     11 * Generation of "native" Trac wikitext.
     12 * Supports heading 1-6, code block, quote format (slightly buggy on quote format).
     13 * Bold/italics/underline, hotkeys are supported.
     14 * `teletype`, ^superscript^, ,,subscript,,, ~~strikethrough~~.
     15 * hyperlinks, and automatic Trac link highlighting for CamelCase as you type (optional).
     16 * List formatting, allows you to select and change list levels very easily, as in MS Word.
     17 * '''Table Editor''' -- the plugin is almost worth getting just for this point alone, the table editor allows add/remove columns, rows, etc as well as wiki format inside of the cells.
     18 * Trac macros shown as normal text but expand when saved and viewed in wiki.
     19 * Formatted code blocks.
     20 * I tested copy/paste in Firefox 2 and 3:
     21   * Paste into MS Word was tested and worked quite well (although links are not valid; instead of http whatever, you get hyperlinks that point to trac-links like wiki:TracWysiwygPlugin, which of course only Trac understands).
     22   * Paste into editor from MS Word worked somewhat, but I tested only styles that Trac wiki can support like headings, lists, bold/italics, etc. However, all special Word formatting (and even images) will appear (at least in Firefox 3), but when you save the page it will convert it down to the plain formatting that Trac supports.
     23
     24The only real problem is that sometimes the appearance is correct on the screen but the result generated is different; however, this almost always happens when pasting in from external programs, but usually not in other situations.
     25
     26== Bugs/Feature Requests
    1027
    1128Existing bugs and feature requests for TracWysiwygPlugin are
     
    1330
    1431If you have any issues, create a
    15 [/newticket?component=TracWysiwygPlugin&owner=jun66j5 new ticket].
     32[/newticket?component=TracWysiwygPlugin new ticket].
    1633
    17 == Installation ==
     34[[TicketQuery(component=TracWysiwygPlugin&group=type,format=progress)]]
     35
     36== Download and Source
     37
     38Download the [download:tracwysiwygplugin zipped source], check out from the [/svn/tracwysiwygplugin subversion repository], or [source:tracwysiwygplugin browse the source] with Trac.
     39
     40== Installation
     41
    1842 1. Install the plugin:
    1943    - For Trac 0.10[[br]]
     
    2347    - For Trac 0.12, 1.0 or later[[br]]
    2448      `easy_install http://trac-hacks.org/svn/tracwysiwygplugin/0.12`
    25  2. Enable the plugin in trac.ini:
    26 {{{
    27 #!ini
     49 2. Enable the plugin in your `trac.ini` file:
     50{{{#!ini
    2851[components]
    2952tracwysiwyg.* = enabled
     
    3255The configuration options can be viewed on the TracIni page after installing the plugin.
    3356
    34 == Download and Source ==
    35 Download the [download:tracwysiwygplugin  zipped source], check out from the [/svn/tracwysiwygplugin subversion repository], or [source:tracwysiwygplugin browse the source] with Trac.
    36 
    37 == Example ==
     57== Example
    3858
    3959[[Image(tracwysiwyg-firefox2.png,width=200)]]
     
    4161[[Image(tracwysiwyg-opera9.png,width=200)]]
    4262
    43 == Reviews ==
     63== Reviews
    4464
    4565By JasonWinnebeck:
     
    5575We're using r3092 with Trac 0.11b1, and it has so far worked very, very well for all the formatting we've used (headings, links, tables). Especially table editing is immensely helpful. We're using Firefox 2 exclusively on Ubuntu and WinXP. Warmly recommended!
    5676
    57 === Features ===
    58 
    59  * Generation of "native" Trac wikitext
    60  * Supports heading 1-6, code block, quote format (slightly buggy on quote format)
    61  * Bold/italics/underline, hotkeys are supported
    62  * `teletype`, ^superscript^, ,,subscript,,, ~~strikethrough~~
    63  * hyperlinks, and automatic Trac link highlighting for CamelCase as you type (optional)
    64  * List formatting, allows you to select and change list levels very easily, as in MS Word
    65  * '''Table Editor''' -- the plugin is almost worth getting just for this point alone, the table editor allows add/remove columns, rows, etc as well as wiki format inside of the cells.
    66  * Trac macros shown as normal text but expand when saved and viewed in wiki.
    67  * Formatted code blocks
    68  * I tested copy/paste in Firefox 2 and 3:
    69    * Paste into MS Word was tested and worked quite well (although links are not valid; instead of http whatever, you get hyperlinks that point to trac-links like wiki:TracWysiwygPlugin, which of course only Trac understands)
    70    * Paste into editor from MS Word worked somewhat, but I tested only styles that Trac wiki can support like headings, lists, bold/italics, etc. However, all special Word formatting (and even images) will appear (at least in Firefox 3), but when you save the page it will convert it down to the plain formatting that Trac supports.
    71 
    72 The only real problem is that sometimes the appearance is correct on the screen but the result generated is different; however, this almost always happens when pasting in from external programs, but usually not in other situations.
    73 
    74 === Summary ===
     77=== Summary
    7578
    7679For someone who is already a good Trac user, the quirks are easy enough to recognize and the tool is still quite helpful. For new users, the current state is a toss-up on whether to use it directly or train the users on wiki formatting. For almost all basic edits it works well, but quirks on atypical cases or handling of newlines can be surprising to new users.
    7780
    78 == Recent Changes ==
     81== Recent Changes
    7982
    8083[[ChangeLog(tracwysiwygplugin, 3)]]
    8184
    82 == Author/Contributors ==
     85== Author/Contributors
    8386
    8487'''Author:''' [wiki:jun66j5] [[BR]]