Edgewall Software
Modify

Opened 15 years ago

Closed 15 years ago

#8600 closed enhancement (fixed)

Better documentation for TracIni macro

Reported by: Ryan Ollos <ryano@…> Owned by: Christian Boos
Priority: normal Milestone: 0.11.6
Component: wiki system Version: 0.11.4
Severity: normal Keywords:
Cc: Branch:
Release Notes:
API Changes:
Internal Changes:

Description

My request is for some better documentation for the TracIni macro. The TracIni macro documentation on the WikiMacros page is brief and does not contain examples.

I don't understand how the option argument is specified, as you can see from my Example 2, which gives no output.

Example 1

[[TracIni(wiki)]]

[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

Example 2

[[TracIni(wiki, max_size)]]

[wiki]

max_size

Maximum allowed wiki page size in characters.

262144

Attachments (0)

Change History (2)

comment:1 by Christian Boos, 15 years ago

Component: generalwiki system
Milestone: 0.11.6
Owner: set to Christian Boos

Very interesting, in addition to not working as expected, the second form breaks the For non-empty elements, end tags are required rule, which result in the visual mess one can see here…

This shouldn't have happened, the wiki formatter is supposed to serialize Element output from macros to 'xhtml'.

comment:2 by Christian Boos, 15 years ago

Resolution: fixed
Status: newclosed

[8511] fixes the TracIni macro (the documentation was correct).

[8512] fixes the wiki formatter issue.

Modify Ticket

Change Properties
Set your email in Preferences
Action
as closed The owner will remain Christian Boos.
The resolution will be deleted. Next status will be 'reopened'.
to The owner will be changed from Christian Boos to the specified user.

Add Comment


E-mail address and name can be saved in the Preferences .
 
Note: See TracTickets for help on using tickets.