Changeset 464 for trunk/EditSyntaxPlugin/data/TWiki/EditSyntaxPlugin.txt
- Timestamp:
- 11/08/08 14:34:13 (4 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/EditSyntaxPlugin/data/TWiki/EditSyntaxPlugin.txt
r100 r464 13 13 Currently available converters: 14 14 | *Syntax* | *To Activate* | *Syntax Summary and Help* | *Converter topic* | 15 | =TWiki= | =<nop> * Set EDITSYNTAX = <nop>= | [[% TWIKIWEB%.WikiSyntaxSummary][Summary]], [[%TWIKIWEB%.TextFormattingRules][Help]] | N/A |15 | =TWiki= | =<nop> * Set EDITSYNTAX = <nop>= | [[%SYSTEMWEB%.WikiSyntaxSummary][Summary]], [[%SYSTEMWEB%.TextFormattingRules][Help]] | N/A | 16 16 %SEARCH{ "EditSyntaxRegex" scope="topic" topic="*EditSyntaxRegex" nonoise="on" format="| =$percntCALC{$SET(name, $SUBSTITUTE($topic, EditSyntaxRegex))$GET(name)}$percnt= | =<nop> * Set EDITSYNTAX = <nop>$percntCALC{$GET(name)}$percnt= | [[$percntCALC{$GET(name)}$percntWikiSyntaxSummary][Summary]], [[$percntCALC{$GET(name)}$percntTextFormattingRules][Help]] | [[$topic][$percntCALC{$GET(name)}$percnt converter]] |" }% 17 17 … … 19 19 20 20 <pre> 21 * Activate preferred edit syntax (see available edit syntax converters at % TWIKIWEB%.EditSyntaxPlugin) :21 * Activate preferred edit syntax (see available edit syntax converters at %SYSTEMWEB%.EditSyntaxPlugin) : 22 22 * Set <nop>EDITSYNTAX = Mediawiki 23 23 </pre> … … 30 30 Steps to create a new edit syntax converter, using the !FooWiki syntax as an example: 31 31 1. Decide on the base name, =Foowiki=. Base name must not be a !WikiWord, e.g. not =FooWiki=. 32 1. Create a =FoowikiEditSyntaxRegex= topic in the % TWIKIWEB% web, taking MediawikiEditSyntaxRegex as a template.32 1. Create a =FoowikiEditSyntaxRegex= topic in the %SYSTEMWEB% web, taking MediawikiEditSyntaxRegex as a template. 33 33 * List regular expressions to convert the syntax from the TWiki to the Foowiki format, and vice versa. 34 34 * The converter format is indicated below. 35 35 * All topics ending in =*EditSyntaxRegex= are listed automatically in the converter topic. 36 1. Create a =FoowikiWikiSyntaxSummary= syntax summary topic in the % TWIKIWEB% web, taking MediawikiWikiSyntaxSummary as a template.36 1. Create a =FoowikiWikiSyntaxSummary= syntax summary topic in the %SYSTEMWEB% web, taking MediawikiWikiSyntaxSummary as a template. 37 37 * This is the short help text shown in the edit screen. 38 38 * Replace =/MediawikiTextFormattingRules= in the "more formatting help" link with =/FoowikiTextFormattingRules=. 39 1. Create a =FoowikiTextFormattingRules= syntax help topic in the % TWIKIWEB% web, taking MediawikiTextFormattingRules and/or Foowiki's edit syntax help text as a template.39 1. Create a =FoowikiTextFormattingRules= syntax help topic in the %SYSTEMWEB% web, taking MediawikiTextFormattingRules and/or Foowiki's edit syntax help text as a template. 40 40 * This is the extensive help text shown when the users clicks on the "more formatting help" link. 41 41 … … 58 58 Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop><plugin>_<setting>%==, i.e. ==%<nop>EDITSYNTAXPLUGIN_SHORTDESCRIPTION%== 59 59 60 * One line description, is shown in the % TWIKIWEB%.TextFormattingRules topic:60 * One line description, is shown in the %SYSTEMWEB%.TextFormattingRules topic: 61 61 * Set SHORTDESCRIPTION = Edit TWiki content using your preferred wiki syntax 62 62 … … 92 92 * Show proper edit syntax summary in edit screen: 93 93 * Create an =EDITSYNTAX= setting in your =%MAINWEB%.TWikiPreferences= and set it to an empty value 94 * Edit =twiki/templates/edit.pattern.tmpl= and change ="%<nop> TWIKIWEB%.WikiSyntaxSummary"= to ="%<nop>TWIKIWEB%.%EDITSYNTAX%WikiSyntaxSummary"=94 * Edit =twiki/templates/edit.pattern.tmpl= and change ="%<nop>SYSTEMWEB%.WikiSyntaxSummary"= to ="%<nop>SYSTEMWEB%.%EDITSYNTAX%WikiSyntaxSummary"= 95 95 * Change other =twiki/templates/edit.*.tmpl= template files as needed 96 96 * Secure the =*EditSyntaxRegex= converter topics so that only %MAINWEB%.TWikiAdminGroup members can edit the topics. … … 114 114 | Other Dependencies: | none | 115 115 | Perl Version: | 5.005 | 116 | [[TWiki:Plugins/Benchmark][Benchmarks]]: | % TWIKIWEB%.GoodStyle nn%, %TWIKIWEB%.FormattedSearch nn%, %TOPIC% nn% |116 | [[TWiki:Plugins/Benchmark][Benchmarks]]: | %SYSTEMWEB%.GoodStyle nn%, %SYSTEMWEB%.FormattedSearch nn%, %TOPIC% nn% | 117 117 | Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% | 118 118 | Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev | 119 119 | Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal | 120 120 121 __Related Topics:__ % TWIKIWEB%.TWikiPlugins, %TWIKIWEB%.DeveloperDocumentationCategory, %TWIKIWEB%.AdminDocumentationCategory, %TWIKIWEB%.TWikiPreferences121 __Related Topics:__ %SYSTEMWEB%.TWikiPlugins, %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %SYSTEMWEB%.TWikiPreferences 122 122 123 123 -- TWiki:Main.PeterThoeny - 09 Jul 2006
Note: See TracChangeset
for help on using the changeset viewer.
