TypographyPlugin

This plugin can be used to improve the typography of TWiki-generated text.

NOTE: You'll want to avoid this plugin if your users use --- to generate <hr> tags

Syntax Rules and Examples

Quotation marks (") and apostrophes (') are also converted to rounded quotes.

(Em/en-dash and rounded quotation/apostrophes are only done if client browser is known to handle Unicode characters appropriately.)

TypographyPlugin Global Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %INTERWIKIPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Improves the typography of TWiki-generated text.

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

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

• Download the ZIP file from the Plugin web (see below)
• Unzip TypographyPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/TypographyPlugin.txt	Plugin topic
  data/TWiki/TypographyPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/TypographyPlugin.pm	Plugin Perl module

• Test if the installation was successful:
  • enter samples here

• Optional: Add the following lines to TWiki.pm inside sub getRenderedVersion, in front of "# Wiki Plugin Hook", line 1893 in the 01 Dec 2001 distribution
  • # [scouten 12/07/02]: Terrible hack to get <expand> to work inside <title>.
  • &TWiki::Plugins::endRenderingHandler( $head );

Plugin Info

Plugin Author:	TWiki:Main/EricScouten
Plugin Version:	07 Jan 2003 (V1.000)
Change History:
07 Jan 2003:	Initial version
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/TypographyPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/TypographyPluginDev

Related Topics: TWikiPreferences, TWikiPlugins, TWiki:TWiki.SpecialCharacters

-- TWiki:Main/EricScouten - 07 Jan 2003