[[PageOutline(2-5,Contents,pullout)]]

= Underscore_Wiki_Page automatic linking

== Description

A tiny one-file plugin that transforms the !MediaWiki styled `Underscore_Wiki_Page` to a link automatically, as it does with `CamelCaseWikiPage`. The wiki page name must have at least two words and each word must start with an upper case letter (like `Foo_Bar_Baz`).

We originally created it to make class names (like Controller_Frontend_Foobar) link to a corresponding wiki page automatically. We do think that !CamelCaseStyle is prettier and still use it for most wiki pages.

== Bugs/Feature Requests

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

If you have any issues, create a 
[/newticket?component=UnderscoreWikiPlugin new ticket] or email to nadav \\at\\ humaninternals <dot> com. I'm also at #trac, usually with the nickname shsek, shesek or execute.

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

== Download

Download the zipped source from [download:underscorewikiplugin here].

== Source

You can check out UnderscoreWikiPlugin from [http://trac-hacks.org/svn/underscorewikiplugin here] using Subversion, or [source:underscorewikiplugin browse the source] with Trac.

== Installation

This plugin consists of a single file. You can simply put the [http://trac-hacks.org/svn/underscorewikiplugin/0.12/UnderscoreWiki.py UnderscoreWiki.py] file directly in your plugins directory.

You can download it using wget:
{{{#!sh
$ wget -O /path/to/trac/env/plugins/UnderscoreWiki.py http://trac-hacks.org/svn/underscorewikiplugin/0.12/UnderscoreWiki.py
}}}

Make sure its readable by the user running Trac.

== Configuration

This plugin has two configuration options that can be set under a `[underscore-wiki]` section in TracIni.

 * '''ignore_missing_pages''' - Enable/disable highlighting `Underscore_Wiki_Page` links to missing pages. Defaults to false (not ignoring them, they'll be shown in grey with a question mark).
 * '''uppercase_in_words''' - Enable/disable using upper case letters in places other than first character of every word. Only `Foo_Bar` is supported by default, setting this to true adds support for `Foo_BAR`, `Foo_BaR`, `FOO_Bar`, etc. Defaults to false.

This should look like:
{{{#!ini
[underscore-wiki]
ignore_missing_pages = true
uppercase_in_words = false
}}}

== Recent Changes

[[ChangeLog(underscorewikiplugin, 3)]]

== Author/Contributors

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