wiki:CamelCase

The TracGuide is not editable on this site. Changes should instead be made on the Trac Development site.

CamelCase

New wiki links are automatically created when concatenating capitalized words, such that for example the words 'Camel' and 'Case' concatenated form a link to this CamelCase page.

CamelCase is the original wiki convention for creating hyperlinks, with the additional requirement that the capital letters are followed by a lower-case letter; hence "AlabamA" and "ABc" will not be links.

Customizing the Wiki behavior

While Trac remains faithful to the original Wiki style, it also provides a number of ways to accommodate users with different preferences:

  • To prevent the creation of a link for the CamelCase word, prefix the word with an exclamation mark (!): !CamelCase.
  • By default a CamelCase word with no corresponding Wiki page will be rendered as a gray link followed by a question mark. This is useful for example when the CamelCase style is used to name code artefacts like class names, and a Wiki page is expected to exist to document each class. The behavior can be configured through the [wiki] ignore_missing_pages option in TracIni.
  • To automatically insert space characters between the words of a CamelCase link when rendering the link, enable [wiki] split_page_names of TracIni.
  • Creation of explicit Wiki links is also easy, see WikiPageNames for details.
  • Wiki formatting can be disabled completely in some places, for example when rendering commit log messages. See the [wiki] wiki_format_messages option in TracIni.

See TracIni for more information on the available options.

More information on CamelCase


See also: WikiPageNames, WikiNewPage, WikiFormatting, TracWiki

Last modified 8 weeks ago Last modified on Jun 30, 2017, 6:17:50 PM