prepare for uploading, http://foswiki.org/Development/TopicStructureForFoswikiExtensions default tip
authorColas Nahaboo <colas@nahaboo.net>
Thu, 16 Apr 2009 00:06:32 +0200
changeset 19fda6c21fdccf
parent 18 2ef558cae438
prepare for uploading, http://foswiki.org/Development/TopicStructureForFoswikiExtensions
data/System/SmartEditContrib.txt
     1.1 --- a/data/System/SmartEditContrib.txt	Wed Apr 15 23:44:37 2009 +0200
     1.2 +++ b/data/System/SmartEditContrib.txt	Thu Apr 16 00:06:32 2009 +0200
     1.3 @@ -1,27 +1,30 @@
     1.4  ---+!! <nop>Smart Edit Contrib
     1.5  
     1.6 -Smart Edit is a !JavaScript editor "&agrave; la wikipedia" for Foswiki.
     1.7 +Smart Edit is a !JavaScript editor "&agrave; la wikipedia" for Foswiki. It is
     1.8 +a WYSIWISAD (What You See Is What Is Saved On Disk :-) editor.
     1.9  
    1.10 -It takes an alternate approach to the WYSIWYG one, as its goals are
    1.11 -   * be useful, even for experienced wiki users
    1.12 -   * predictability: What you see is what will be saved
    1.13 -   * reliability: use only the standard TEXTAREA of the browsers
    1.14 -   * be unobstrusive: as long as you do not use the toolbar, you are still
    1.15 +It takes an alternate approach to the WYSIWYG one, as its goals are to be
    1.16 +   * useful, even for experienced wiki users
    1.17 +   * predictable: What you see is what will be saved
    1.18 +   * reliable: use only the standard plain text edit mode (textarea) of the browsers to avoid bugs of their rich text (dom) mode
    1.19 +   * unobstrusive: as long as you do not use the toolbar, you are still
    1.20       using the traditional raw wiki editor
    1.21  
    1.22 -The aim is to assist System.WikiSyntax editing by providing the following features as !JavaScript code:
    1.23 +For this, it assists editing System.WikiSyntax by providing the following features as !JavaScript code:
    1.24 +   * Foswiki syntax insertion (click the B button to make bold text)
    1.25 +   * Keyboard shortcuts: hit TAB to ident and shift-TAB to outdent
    1.26 +   * Configurable menus to insert icons and useful constructs, like various !CommentPlugin types
    1.27 +   * A dynamic Foswiki link selection, to insert links to topics with an incremental ("search-as-you-type") menus
    1.28 +   * An interactive search 
    1.29  
    1.30 -   * Foswiki syntax insertion
    1.31 -   * Keyboard shortcuts
    1.32 -   * Configurable menus
    1.33 -   * A dynamic Foswiki link selection
    1.34 -   * A search bar
    1.35 +Smart Edit is a !JavaScript application, working on *Firefox* , *Internet
    1.36 +Explorer 8+* and *Mozilla 7.1+* . The code is clearly ugly (it was my first
    1.37 +real javascript program), and should be rewritten as it can be too slow on big
    1.38 +topics. It is however much faster on firefox, meaning that you will be able to
    1.39 +edit comfortably 15k topics with IE and 80k topics on Firefox. However, we use
    1.40 +it as our default editor daily since 2006 on our intranet.
    1.41  
    1.42 -Smart Edit is a !JavaScript application, working on *Firefox* , *Internet Explorer* and *Mozilla* . The code is clearly sub-optimal, and should be rewritten as it can be too slow on big topics. It is however much faster on firefox, meaning that you will be able to edit comfortably 15k topics with IE and 80k topics on Firefox. However, we use it as our default editor on our intranet.
    1.43 -
    1.44 -*You can see a demo here* : http://twbw-test.luddeni.net/bin/view/Sandbox (<nop>DemoDemo/demo)
    1.45 -
    1.46 -<img src="%ATTACHURLPATH%/screenShotSmartEditor.JPG" alt="screenShotSmartEditor.JPG" width='766' height='67' />
    1.47 +http://colaz.net/files/smartedit/screenShotSmartEditor.JPG
    1.48  
    1.49  %TOC%
    1.50  
    1.51 @@ -118,13 +121,19 @@
    1.52       e.g. =Set SKIN = smarteditor, editdefault, pattern=
    1.53     * Add the following declarations to the same <nop>Main.SitePreferences topic. You can expand and/or modify these at will
    1.54  <verbatim>
    1.55 +
    1.56 +   * Due to bugs on other browsers, Smartedit will refuse to run on browsers
    1.57 +     other than Gecko-based ones (firefox) and Internet Explorer 8 or more. To
    1.58 +     force it to run anyways, set the variable in your preferences:
    1.59 +      * Set SMARTEDITFORCE = on
    1.60 +
    1.61  ---++ Smartedit
    1.62  Warning: only use simple quotes ', not double quotes " in the following 3 vars:
    1.63     * Set SMARTEDITSTRINGSITE = <tselement><tsname>Today's Date</tsname><tsstring>%GMTIME{$year-$mo-$day}%</tsstring></tselement><tselement><tsname>User name</tsname><tsstring>%WIKIUSERNAME%</tsstring></tselement><tselement><tsname>Signature</tsname><tsstring>--&nbsp;%WIKIUSERNAME% - %DATE%</tsstring></tselement><tselement><tsname>Comments, signed and dated, added at top</tsname><tsstring>%<nop>COMMENT{type='top'}%</tsstring></tselement><tselement><tsname>Comments, signed and dated, added at end</tsname><tsstring>%<nop>COMMENT{type='bottom'}%</tsstring></tselement><tselement><tsname>Comments, signed and dated, added immediately before</tsname><tsstring>%<nop>COMMENT{type='above'}%</tsstring></tselement><tselement><tsname>Bullet item added immediately before</tsname><tsstring>%<nop>COMMENT{type='bulletabove'}%</tsstring></tselement><tselement><tsname>Wiki thread mode comment, signed and dated</tsname><tsstring>%<nop>COMMENT{type='threadmode'}%</tsstring></tselement><tselement><tsname>Comments, signed and dated, added recurse after comment box</tsname><tsstring>%<nop>COMMENT{type='belowthreadmode'}%</tsstring></tselement><tselement><tsname>Comments, signed and dated, added immediately below</tsname><tsstring>%<nop>COMMENT{type='below'}%</tsstring></tselement><tselement><tsname>Comments, signed and dated, added at top of table below</tsname><tsstring>%<nop>COMMENT{type='tableprepend'}%</tsstring></tselement><tselement><tsname>Comments, signed and dated, added at end of table above</tsname><tsstring>%<nop>COMMENT{type='tableappend'}%</tsstring></tselement><tselement><tsname>Add before the comment box, after the last comment</tsname><tsstring>%<nop>COMMENT{type='after'}%</tsstring></tselement><tselement><tsname>Action of Action Tracker added to action table directly above</tsname><tsstring>%<nop>COMMENT{type='action'}%</tsstring></tselement><tselement><tsname>Tablerows adding on end</tsname><tsstring>%<nop>COMMENT{type='table'}%</tsstring></tselement><tselement><tsname>Talk using TOC adding on end</tsname><tsstring>%<nop>COMMENT{type='toctalk'}%</tsstring></tselement><tselement><tsname>Create a list of annotated bookmarks</tsname><tsstring>%<nop>COMMENT{type='bookmark'}%</tsstring></tselement><tselement><tsname>Post to a different topic and return to here</tsname><tsstring>%<nop>COMMENT{type='return'}%</tsstring></tselement>
    1.64     * Set SMARTEDITSTRINGWEB = 
    1.65     * Set SMARTEDITSTRINGUSER =
    1.66     
    1.67 -Warning: only use double quotes ", not single quotes ' in the following 3 vars:
    1.68 +Warning: only use single quotes ', not double quotes " in the following 3 vars:
    1.69     * Set SMARTEDITICONSITE = <tselement><tsname> %ICON{info}%</tsname><tsstring>%<nop>ICON{info}%</tsstring></tselement><tselement><tsname> %ICON{more}%</tsname><tsstring>%<nop>ICON{more}%</tsstring></tselement><tselement><tsname> %ICON{note}%</tsname><tsstring>%<nop>ICON{note}%</tsstring></tselement><tselement><tsname> %ICON{pencil}%</tsname><tsstring>%<nop>ICON{pencil}%</tsstring></tselement><tselement><tsname> %ICON{question}%</tsname><tsstring>%<nop>ICON{question}%</tsstring></tselement><tselement><tsname> %ICON{stargold}%</tsname><tsstring>%<nop>ICON{stargold}%</tsstring></tselement><tselement><tsname> %ICON{starred}%</tsname><tsstring>%<nop>ICON{starred}%</tsstring></tselement><tselement><tsname> %ICON{stop}%</tsname><tsstring>%<nop>ICON{stop}%</tsstring></tselement><tselement><tsname> %ICON{target}%</tsname><tsstring>%<nop>ICON{target}%</tsstring></tselement><tselement><tsname> %ICON{tip}%</tsname><tsstring>%<nop>ICON{tip}%</tsstring></tselement><tselement><tsname> %ICON{warning}%</tsname><tsstring>%<nop>ICON{warning}%</tsstring></tselement><tselement><tsname> %ICON{wip}%</tsname><tsstring>%<nop>ICON{wip}%</tsstring></tselement><tselement><tsname> %ICON{watch}%</tsname><tsstring>%<nop>ICON{watch}%</tsstring></tselement><tselement><tsname> %ICON{wrench}%</tsname><tsstring>%<nop>ICON{wrench}%</tsstring></tselement><tselement><tsname> %ICON{person}%</tsname><tsstring>%<nop>ICON{person}%</tsstring></tselement><tselement><tsname> %ICON{group}%</tsname><tsstring>%<nop>ICON{group}%</tsstring></tselement><tselement><tsname> %ICON{key}%</tsname><tsstring>%<nop>ICON{key}%</tsstring></tselement><tselement><tsname> %ICON{lock}%</tsname><tsstring>%<nop>ICON{lock}%</tsstring></tselement><tselement><tsname> %ICON{new}%</tsname><tsstring>%<nop>ICON{new}%</tsstring></tselement><tselement><tsname> %ICON{todo}%</tsname><tsstring>%<nop>ICON{todo}%</tsstring></tselement><tselement><tsname> %ICON{updated}%</tsname><tsstring>%<nop>ICON{updated}%</tsstring></tselement><tselement><tsname> %ICON{done}%</tsname><tsstring>%<nop>ICON{done}%</tsstring></tselement><tselement><tsname> %ICON{closed}%</tsname><tsstring>%<nop>ICON{closed}%</tsstring></tselement><tselement><tsname> %ICON{choice-yes}%</tsname><tsstring>%<nop>ICON{choice-yes}%</tsstring></tselement><tselement><tsname> %ICON{choice-no}%</tsname><tsstring>%<nop>ICON{choice-no}%</tsstring></tselement><tselement><tsname> %ICON{choice-cancel}%</tsname><tsstring>%<nop>ICON{choice-cancel}%</tsstring></tselement><tselement><tsname> %ICON{minus}%</tsname><tsstring>%<nop>ICON{minus}%</tsstring></tselement><tselement><tsname> %ICON{plus}%</tsname><tsstring>%<nop>ICON{plus}%</tsstring></tselement><tselement><tsname> %ICON{home}%</tsname><tsstring>%<nop>ICON{home}%</tsstring></tselement><tselement><tsname> %ICON{left}%</tsname><tsstring>%<nop>ICON{left}%</tsstring></tselement><tselement><tsname> %ICON{right}%</tsname><tsstring>%<nop>ICON{right}%</tsstring></tselement><tselement><tsname> %ICON{up}%</tsname><tsstring>%<nop>ICON{up}%</tsstring></tselement><tselement><tsname> %ICON{down}%</tsname><tsstring>%<nop>ICON{down}%</tsstring></tselement>
    1.70     * Set SMARTEDITICONWEB =
    1.71     * Set SMARTEDITICONUSER =
    1.72 @@ -140,9 +149,9 @@
    1.73     * Set SHORTDESCRIPTION = Toolbar to help edit Foswiki content
    1.74  
    1.75  |  Add-on Author: | Gael Crova (Special thanks to Colas Nahaboo and Frederic Luddeni for their help and feedback)|
    1.76 -|  Add-on Version: | 14 Apr 2009 (v3) |
    1.77 +|  Add-on Version: | 15 Apr 2009 (v3) |
    1.78  |  Change History: | <!-- versions below in reverse order -->&nbsp; |
    1.79 -| 14 Apr 2009: | v3: Version for Foswiki 1.0.4 |
    1.80 +| 15 Apr 2009: | v3: Version for Foswiki 1.0.4 (Colas Nahaboo), bug where smartedit was running at the same time as the wysiwyg editor fixed, new variable SMARTEDITFORCE, disabled on IE 6 and 7 because of bugs, text coloring is now using the same conventions as the wysiwyg editor |
    1.81  | 23 Jan 2008: | v2: Version for TWiki Freetown, 4.2.0 |
    1.82  |  18 Aug 2006: | IE Toolbar width fixed |
    1.83  |  16 Aug 2006: | Tab and SHIFT-TAB events disabled in Opera - Help in a specific topic with the viewprint template |
    1.84 @@ -157,7 +166,7 @@
    1.85  |  Other Dependencies: | none |
    1.86  |  Perl Version: | 5.005 |
    1.87  |  License: | GPL |
    1.88 -|  Add-on Home: | http://foswiki.org/Extensions/%TOPIC% |
    1.89 -|  Feedback: | http://foswiki.org/Extensions/%TOPIC%Dev |
    1.90 +|  Contrib Home: | http://foswiki.org/Extensions/%TOPIC% |
    1.91 +|  Support: | http://foswiki.org/Support/%TOPIC% |
    1.92  
    1.93 --- TWiki:Main/GaelCrova - 07 Aug 2006
    1.94 +-- Gael Crova - 07 Aug 2006