wiki:WikiGoodiesPlugin

Version 25 (modified by cboos, 4 years ago) (diff)

a note about features which are now better implemented elsewhere

Wiki Goodies for Trac

Description

This plugin extends the Trac Wiki in several ways:

  • Simplified markup for single words: *this* /is/ _important_ becomes this is important
  • Replace
    ... UNC paths with "file:///" links (0.11 only)
  • now obsolete features:
    • by the WikiExtrasPlugin:
      • Support for displaying smileys, as in 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.)
    • 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.

Install

See generic instructions in Trac:TracPlugins#InstallingaTracPlugin.

Enable

If you need to enable the plugin in the trac.ini, use:

[components]
goodies.* = enabled

Usage

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

Simply copy&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 tips.

Symbols

[[ShowSymbols(5)]]

Bugs/Feature Requests

Existing bugs and feature requests for WikiGoodiesPlugin are here.

Known Issues

#1799
[Patch] {p1} doesn't work as expected and :\ is not a good smiley IMHO
#2257
mailto links not linking correctly with hyphenated addresses/domains
#4405
underscore in front of a goodie escapes symbols from beeing converted.
#4840
All icon background should be transparent
#4841
[Patch] {i} is not handled, even though there is an icon for it.

If you have any new issue of feature request, create a new ticket.

More about UNC path support

Turning off the UNC paths transformation might be seen as a 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 LocalLink plugin (install).

Alternatively, I use the "Open Link in Ext.App." contextual menu entry provided by the IETab plugin (install), and this works great.

Chrome has also its own 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).

Source code & Download

  1. You can download the zipped source:
Trac Version Zip
0.9.3 and above, 0.10 wikigoodiesplugin/0.9
0.11 wikigoodiesplugin/0.11
  1. or You can check out the source from Subversion at http://trac-hacks.org/svn/wikigoodiesplugin
  1. or also browse the code from within Trac (recommended!).

Recent Changes

[11709] by rjollos on 2012-07-04 11:16:00
Fixes #9799: Added Skype syntax for "Thumbs Up".
[10301] by cboos on 2011-06-16 21:35:11
WikiGoodiesPlugin: oops, five slashes were really needed for UNC path to work with Firefox's LocalLink plugin... \

I only tested the previous changesets (four slashes) with Chrome's LocalLinks one.

Now it works for both browsers with those plugins (and also for IE9 without plugins!)

[10300] by cboos on 2011-06-16 21:08:03
WikiGoodiesPlugin: UNC path syntax extended to support [unc_path label] forms.

In more details, the following two new syntaxes are now supported:

[\\svr1\work\sixtrak\gateway\ipm_firmware\xvers\etms4_7_1000.fwb Current release firmware]

and:

[unc:\\svr1\work\sixtrak\gateway\ipm_firmware\xvers\etms4_7_1000.fwb Current release firmware]
[unc:"\\svr1\work\sixtrak\gateway\ipm firmware\xvers\etms4_7_1000.fwb" Current release firmware]

Closes #6656.

See Also

The EmoticonsPlugin also provides support for smileys, and is a little bit more lightweight than this plugin.

The EntityMacro package returns HTML 4.01 numeric character entity references from their corresponding names.

The WikiExtrasPlugin supersedes most of the features of this plugin, except for the UNC paths and mozilla features. You can disable all but those two modules and uses both plugins together.

Author/Contributors

Author: cboos
Maintainer: mrelbe
Contributors: