TypographyPlugin

This plugin can be used to improve the typography of TML text.

Syntax Rules and Examples

Syntax	Generates	Description
<<		Non-breaking space
>>	4	Little arrow
---	—	Em dash*
--	–	En dash*
<expand>WikiWord(s)</expand>	Wiki Words	Expands wiki words Hint: Use in navigation/title bars

Dashes

• For an ordinary hyphen use "-" (don't use the quotes).
• For a range of numbers use the en dash "--" as in 2--8 (named because it is as wide as n).
• To indicate a parenthetic expression use the em dash "---" (as wide as m).

see http://en.wikipedia.org/wiki/Dash for more details on the proper use of dashes

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 TML tex.

• 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 Foswiki is running.

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

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

• Visit configure in your Foswiki installation, and enable the plugin in the {Plugins} section.
• Test if the installation was successful:
  • This is a range of numbers from 1--10
  • Nice typography is pleasing to the eyes---wouldn't you agree?
  • "That's what he said!"
  • ``That's what he said!''

Plugin Info

Plugin Author:	TWiki:Main/EricScouten, Foswiki:Main.WillNorris
Plugin Version:	31 Jan 2009 (V1.001)
Change History:
31 Jan 2009:	Ported to Foswiki
07 Jan 2003:	Initial version
CPAN Dependencies:	none
Other Dependencies:	none
Plugin Home:	http://foswiki.org/Extensions/TypographyPlugin
Feedback:	http://foswiki.org/Extensions/TypographyPluginDev

Related Topics: DefaultPreferences, SitePreferences, Plugins