[[PageOutline(2-5,Contents,pullout)]]
= Wiki Goodies for Trac
{{{#!box warn
**Notice:** This plugin is deprecated. You're better off using WikiExtrasPlugin, which integrates most of the features of this plugin, and then some more.
}}}

== Description

This plugin extends the Trac wiki in several ways:
 * Simplified markup for single words: `*this* /is/ _important_`
   becomes '''this''' ''is'' __important__ [[comment(replace by *this* /is/ _important_)]]
 - now (i.e. in Trac version 0.13) obsolete features:
   - by the WikiExtrasPlugin:
     * Support for displaying smileys, as in [http://moinmo.in/HelpOnSmileys MoinMoin],
       with a few exceptions (no flags, "priority" smileys are renamed {p1}
       instead of {1} in order to be compatible with report: shorthand links)
     * HTML 4.0 entities (named entities and numerical entities)
     * Automatic replacement of common text idioms by their corresponding symbols (e.g. arrows, fractions, etc.)
     * Replace `\\...` UNC paths with `file:///` links  (0.11 only)
   - by Trac core:
     * Replace <name@domain> with "mailto:" links (obfuscated if needed) (0.11 only - though that's now in Trac core)

Each feature can be disabled individually if needed.

Alternatives:
 * EmoticonsPlugin: provides support for smileys, and is a little bit more lightweight than this plugin.
 * EntityMacro: returns HTML 4.01 numeric character entity references from their corresponding names.
 * WikiExtrasPlugin: supersedes most of the features of this plugin, except for the simplified markup for single words and Mozilla features. You can disable all but those two modules and use both plugins together.

== Bugs/Feature Requests

Existing bugs and feature requests for WikiGoodiesPlugin are 
[report:9?COMPONENT=WikiGoodiesPlugin here].

If you have any new issue of feature request, create a 
[/newticket?component=WikiGoodiesPlugin new ticket].

[[TicketQuery(component=WikiGoodiesPlugin&group=type,format=progress)]]

== Download

You can download the zipped source:

|| ''Trac Version''      || ''Zip''                           ||
|| 0.9.3 and above, 0.10 || [export:wikigoodiesplugin/0.9]  ||
||          0.11         || [export:wikigoodiesplugin/0.11] ||

== Source

You can check out the source using Subversion [/svn/wikigoodiesplugin here], or [source:wikigoodiesplugin browse the code] from within Trac.

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

If you need to enable the plugin in the `trac.ini` file, use:
{{{#!ini
[components]
goodies.* = enabled
}}}

== Usage

There are 3 new macros that can be used to conveniently display all the newly introduced markup.

Simply copy and paste the following wiki snippet somewhere into your Wiki (e.g. in WikiFormatting):

'''Note''': the argument below - between '( )' - is the number of columns to be used in the displayed table.

=== Smileys

{{{
[[ShowSmileys(5)]]
}}}

=== Entities

{{{
[[ShowEntities(4)]]
}}}

For the entities, only the named ones are shown.

For help on using the numerical entities, see for example those [http://home.tiscali.nl/t876506/entitiesTips.html tips].

=== Symbols

{{{
[[ShowSymbols(5)]]
}}}

== More about UNC path support

Turning off the UNC paths transformation might be seen as a [http://kb.mozillazine.org/Links_to_local_pages_don%27t_work security measure] and if someone can demonstrate that this feature presents a security risk, I'll disable it by default in future releases.
But here, the "file:" links are user-oriented and can't possibly be embedded in a <img> tag or Javascript code, so I don't really see what could be the risk, and I think it's OK to enable this feature by default.

Firefox doesn't do anything with the `file:` links, but users can use the [http://locallink.mozdev.org/ LocalLink] plugin
([https://addons.mozilla.org/en-US/firefox/addon/281 install]). 

Alternatively, I use the ''"Open Link in Ext.App."'' contextual menu entry provided by the [http://ietab.mozdev.org/ IETab] plugin 
([https://addons.mozilla.org/en-US/firefox/addon/1419 install]) and this works great. 

Chrome has also its own [https://chrome.google.com/webstore/detail/jllpkdkcdjndhggodimiphkghogcpida LocalLinks] plugin, which was modeled after the Firefox extension.

=== Local Paths

Using IETab within Firefox even allows you to use links local paths (say, `S:\Public\File.txt`) by using the equivalent UNC path `\\?\S:\Public\File.txt`, which is recognized as a link by the plugin and will be opened correctly by IETab ''"Open Link in Ext.App."''.
Note that S:\Public\File.txt itself isn't recognized as a link (and probably will never be, as that will conflict with one letter InterTrac prefixes) and that the `file:///?/` file link produced by the plugin are ''not'' understood by IE7 or IETab plugin ''"Open Link in IE Tab"'' (I haven't tested the !LocalLink plugin).

== Recent Changes

[[ChangeLog(wikigoodiesplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:cboos] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''