Edgewall Software

Version 4 (modified by Christian Boos, 16 years ago) ( diff )

Added informations about how to better live with CamelCase links

This page documents the 1.4 (latest stable) release. Documentation for other releases can be found here.

CamelCase

New words created by smashing together capitalized words.

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

Customizing the Wiki behavior

Some people dislike linking by CamelCase. While Trac remains faithful to the original Wiki style, it provides a number of ways for making life easier to these people.

  • There's an option to simply ignore links to missing pages when the link is written using the CamelCase style, instead of that word being replaced by grey links followed by a question mark. That's quite useful when CamelCase style is used to name code artifacts like class names and there's no corresponding page for them.
  • There's an option to automatically insert space characters between words constitutive of a CamelCase link, when rendering the link.
    e.g. Camel Case
  • Creation of explicit Wiki links is also easy, see WikiPageNames for details.
  • Lastly, wiki formatting can be disabled completely in some places (e.g. when rendering commit log messages)

See relevant configuration settings:

[wiki]

default_edit_area_height

Default height of the textarea on the wiki edit page. (Since 1.1.5)

20
ignore_missing_pages

Enable/disable highlighting CamelCase links to missing pages.

disabled
max_size

Maximum allowed wiki page size in characters.

262144
render_unsafe_content

Enable/disable the use of unsafe HTML tags such as <script> or <embed> with the HTML WikiProcessor.

For public sites where anonymous users can edit the wiki it is recommended to leave this option disabled.

disabled
safe_origins

List of URIs considered "safe cross-origin", that will be rendered as img element without crossorigin="anonymous" attribute or used in url() of inline style attribute even if [wiki] render_unsafe_content is false (since 1.0.15).

To make any origins safe, specify "*" in the list.

data:
safe_schemes

List of URI schemes considered "safe", that will be rendered as external links even if [wiki] render_unsafe_content is false.

cvs,file,ftp,git,irc,http,https,news,sftp,smb,ssh,svn,svn+ssh
split_page_names

Enable/disable splitting the WikiPageNames with space characters.

disabled

[wikiextras]

done_phrases

Analogous to FIXME-phrases, but presentation is less eye-catching.

DONE,DEBUGGED,FIXED,REVIEWED
fixme_phrases

A list of attentional phrases or single words, separated by comma (,) that will be highlighted to catch attention. Any delimiter ():<> adjacent to a phrase will not be presented. (i.e. do not include any of these delimiters in this list). This makes it possible to naturally write, for example, FIXME: in a wiki text, but view the phrase highlighted without the colon (:) which would not look natural. Use the ShowPhrases macro to show a list of currently defined phrases.

BUG,FIXME
lbox_width

Width of left aligned boxes (defaults to rbox_width).

300
rbox_width

Width of right aligned boxes.

300
shadowless_boxes

Use shadowless boxes.

disabled
todo_phrases

Analogous to FIXME-phrases, but presentation is less eye-catching.

REVIEW,TODO
wide_toc

Right aligned boxes with table of contents, produced by the PageOutline macro, are either as wide as ordinary right aligned boxes (true) or narrow (false).

disabled

[wikiextras-custom-phrases]

Custom phrases are configurable by providing associations between a CSS class and the list of phrases separated by comma.

Example:

[wikiextras-custom-phrases]
nice = NICE, COOL

[wikiextras-symbols]

The set of symbols is configurable by providing associations between symbols and wiki keywords. A default set of symbols and keywords is defined, which can be revoked one-by-one (_remove) or all at once (_remove_defaults).

Example:

[wikiextras-symbols]
_remove_defaults = true
_remove = <- ->
&laquo; = <<
&raquo; = >>
&sum; = (SUM)
&hearts; = <3

Keywords are space-separated!

A symbol can also be removed by associating it with no keyword:

&larr; =

Use the ShowSymbols macro to find out the current set of symbols and keywords.

_remove

Space-separated(!) list of keywords that shall not be interpreted as symbols (even if defined in this section).

(no default)
_remove_defaults

Set to true to remove all default symbols.

disabled

More information on CamelCase


See also: WikiPageNames, WikiNewPage, WikiFormatting, TracWiki

Note: See TracWiki for help on using the wiki.