Edgewall Software

Ticket #6220 (closed defect: fixed)

Opened 15 months ago

Last modified 13 months ago

TracIni macro on trac.edgewall.org shows plugin options

Reported by: eblot Owned by: cboos
Priority: normal Milestone: 0.11
Component: wiki system Version: 0.10.4
Severity: normal Keywords: documentation
Cc:

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

Change History

  Changed 15 months ago by eblot

  • version set to 0.10.4

  Changed 15 months ago by eblot

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 ;-)

follow-up: ↓ 4   Changed 15 months ago by 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.

in reply to: ↑ 3 ; follow-up: ↓ 7   Changed 15 months ago by 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. 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.

  Changed 14 months ago by sid

  • keywords documentation added

  Changed 13 months ago by cboos

  • milestone set to 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   Changed 13 months ago by cmlenz

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 :/

  Changed 13 months ago by cboos

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

  Changed 13 months ago by cboos

  • cc documentation removed
  • status changed from new to closed
  • resolution set to fixed

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]].

Add/Change #6220 (TracIni macro on trac.edgewall.org shows plugin options)

Author



Change Properties
<Author field>
Action
as closed
Next status will be 'reopened'
to The owner will change from cboos. Next status will be 'closed'
 
Note: See TracTickets for help on using tickets.