Edgewall Software
Modify

Opened 14 years ago

Closed 14 years ago

#6220 closed defect (fixed)

TracIni macro on trac.edgewall.org shows plugin options

Reported by: Emmanuel Blot Owned by: Christian Boos
Priority: normal Milestone: 0.11
Component: wiki system Version: 0.10.4
Severity: normal Keywords: documentation
Cc: Branch:
Release Notes:
API Changes:
Internal Changes:

Description

Documentation on trac.edgewall.org should reflect Trac documentation, as a user guide reference.

The [[TracIni]] macro used in TracIni page displays options for Bitten, as Bitten is used on http://trac.edgewall.org
However this is unrelated to the Trac project and should not appear in TracIni page.

Attachments (0)

Change History (9)

comment:1 by Emmanuel Blot, 14 years ago

Version: 0.10.4

comment:2 by Emmanuel Blot, 14 years ago

It might be useful that the [[TracIni]] macro takes an extra argument, to enable or disable display of plugin options. Not sure how to implement this feature though ;-)

comment:3 by Noah Kantrowitz, 14 years ago

I thought we had agreed a while ago to not use the macro version on here so that users could actually edit the documentation and whatnot. For example, we should start to add documentation for new 0.11 options ahead of time.

in reply to:  3 ; comment:4 by Emmanuel Blot, 14 years ago

Replying to nkantrowitz:

I thought we had agreed a while ago to not use the macro version on here so that users could actually edit the documentation and whatnot. For example, we should start to add documentation for new 0.11 options ahead of time.

Dunno but both current and 0.11 TracIni pages are using this macro at the moment.

comment:5 by sid, 14 years ago

Keywords: documentation added

comment:6 by Christian Boos, 14 years ago

Milestone: 0.11

Well, we could simply warn in the TracIni page here that the [bitten] and [spam-filter] sections are only meant for use by those plugins.

Also, copying the content of the macro documentation from the source code to the TracIni page seems quite error prone. Better suggest to contribute enhancement to the documentation as patches or in a discussion section.

in reply to:  4 comment:7 by Christopher Lenz, 14 years ago

Replying to eblot:

Replying to nkantrowitz:

I thought we had agreed a while ago to not use the macro version on here so that users could actually edit the documentation and whatnot.

Yeah, I thought so too. Otherwise, how would we do proper versioning of the page?

Anyway, now that we have a bazillion options it's probably too cumbersome indeed :/

comment:8 by Christian Boos, 14 years ago

An alternative would be to embed the output of the TracIni macro as produced for a given version in an #!html block.

comment:9 by Christian Boos, 14 years ago

Cc: documentation removed
Resolution: fixed
Status: newclosed

Version dependent output saved in 0.10/TracIni@2 and TracIni@110.

This takes care of the only special case needed, i.e. here on t.e.o. The shipped TracIni page should continue to contain a simple call to [[TracIni]].

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.