Tags:
rendering1Add my vote for this tag create new tag
, view all tags

RicherSyntaxPlugin

This pluging tries to make twiki syntax more similar to plain text style.

Syntax Rules

Titles
A <H1> title is specified by underlining it with equal signs, a <H2> with minus signs, and a <H3> with caret signs and <H4> tildes. The length of underlining has to be (almost) the same of the title one.

Description
===========

Syntax rules
------------

Example 1
^^^^^^^^^

Sub-example 1
~~~~~~~~~~~~~

Continuations: Sometimes one wants to split a line (for instance a table) and the backslash at the end is not usual. So the rule is:

  • Every two lines in which the second one has greater indentation (more white space at beginning) and does begins with a letter (in order to avoid clashes with nested lists) are glued together.
But sometimes you may want to add a blank line in the middle of an itemized list. So I added the special variable %BR% that inserts a <BR /> and the rule:
  • If a line has greater indentation than the previous one, but is composed only by blanks, it is replaced by %BR% % BR%. For ease of reading, it may contain some dots.

| first column header 
   | second column header 
        |
| 1 | 2 |

   * a list
     ...
     with a break

Description with spaces
one can insert a description heading with embedded spaces by surrounding it with colons. They are rendered in a compact way. If you want to split it over lines use the continuation method described above.

<tab>:Description with spaces: one can...

TESTS

Description =======

This pluging tries to make twiki syntax more similar to plain text style.

Syntax Rules


:Titles
A <H1> title is specified by underlining it with equal signs, a <H2> with minus signs, and a <H3> with tildes. The length of underlining has to be the same of the title one.

Example 1 ~~~~~~~~~

Description
===========

Syntax rules
------------

Example 1
~~~~~~~~~

:Continuations: Sometimes one wants to split a line (for instance a table) and the backslash at the end is not usual. So the rule is:

  • Every two lines in which the second one has greater indentation (more white space at beginning) and does begins with a letter (in order to avoid clashes with nested lists) are glued together.
But sometimes you may want to add a blank line in the middle of an itemized list. So I added the special variable %BR% that inserts a <BR /> and the rule:
  • If a line has greater indentation than the previous one, but is composed only by blanks, it is replaced by %BR% % BR%. For ease of reading, it may contain some dots.
Example 2 ~~~~~~~~~

| first column header 
   | second column header 
        |
| 1 | 2 |

becomes

| first column header | second column header |

1 2

and

   * a list
     ...
     with a break

becomes

  • a list ... with a break

:Description with spaces: one can insert a description heading with embedded spaces by surrounding it with colons. They are rendered in a compact way. If you want to split it over lines use the continuation method described above.

Example 3 ~~~~~~~~~

<tab>:Description with spaces: one can...

RicherSyntaxPlugin Settings

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = This plugin allows to write headers, description items and continuation lines in a way more similar to usual text rules.

  • Debug plugin: (See output in data/debug.txt)
    • Set DEBUG = 0

  • My own setting:
    • No settings

Plugin Installation Instructions

  • Download the ZIP file from the Plugin web (see below)
  • Unzip RicherSyntaxPlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/RicherSyntaxPlugin.txt Plugin topic
    data/TWiki/RicherSyntaxPlugin.txt,v Plugin topic repository
    lib/TWiki/Plugins/RicherSyntaxPlugin.pm Plugin Perl module
  • Check this topic here if the installation was successful
  • Test if the plugin is correctly installed:

Plugin Info

Plugin Author: FrancoBagnoli
Plugin Version: 25 Mar 2002
Change History: 25 Mar 2002: Initial version
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.0
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/RicherSyntaxPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/RicherSyntaxPluginDev

Related Topics: TWikiPreferences, TWikiPlugins

-- FrancoBagnoli - 25 Mar 2002

Topic attachments
I Attachment History Action Size Date Who Comment
Compressed Zip archivezip RicherSyntaxPlugin.zip r2 r1 manage 5.0 K 2002-05-14 - 09:38 FrancoBagnoli new version
Edit | Attach | Watch | Print version | History: r7 < r6 < r5 < r4 < r3 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r7 - 2005-03-17 - MeredithLesly
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.