[haiku-bugs] Re: [Haiku] #4956: Previewing a ticket shows empty Description box
- From: "nielx" <trac@xxxxxxxxxxxxxxxx>
- Date: Sun, 15 Nov 2009 17:22:22 -0000
#4956: Previewing a ticket shows empty Description box
---------------------------+------------------------------------------------
Reporter: humdinger | Owner: nielx
Type: bug | Status: new
Priority: high | Milestone: R1
Component: Website/Trac | Version: R1/alpha1
Resolution: | Keywords:
Blockedby: | Platform: All
Blocking: |
---------------------------+------------------------------------------------
Comment(by nielx):
Replying to [comment:12 zooey]:
> > > The result of the bug was pretty severe, so something had to be
done. And, honestly, whether or not changing the original template file
within the trac package is worse than patching the same template file on
the go via site.html, is at least debatable. My personal view on this is
that trac's template-patching mechanism is neither easy to grok nor will
it scale well with many changes, so I actually prefer adjusting the
template files themselves to our needs. But that's just my view - I may be
wrong ...
> >
> > Well, my view is different (see message on haiku-sysadmin). The
summary (for those not following the list): I suggest separating the hack
logic from the Trac logic (through plugins and template customization)
wherever possible.
>
> But separation has to be weighed against reliability: if keeping things
separate gives a less reliable result, maybe it's not worth it.
That would be a good argument, but I am not quite sure wheter it applies
here. There was a bug in the modification in site.html, now it is fixed.
The syntax of the modification is not that complex and reasonably easy to
understand if you know some XPath and Genshi.
> > > But, anyway, since you are the trac-admin, I will move the patch out
of the package back into site.html.
> >
> > Thanks, but I hope you are not just doing this because I am the trac-
admin.
>
> What other reason would there be? I have not heard of any evidence that
doing it your way is better than doing it mine. You keep stating it, but
that hasn't convinced me yet.
>
> I have now removed the patch from the package again and restored
site.html and adjusted it according to your patch. It works, but due to
how the matching in site.html is done, the note is shown only for new
tickets, it is not being shown when you're editing or previewing an
existing ticket.
This was a conscious choice. The original request was in #4121 and it only
refered to the new ticket form. I did not think about extending this to
the normal ticket pages.
> This wasn't the case before (i.e. the note was always shown). I know
this can be fixed in site.html, but I guess this just goes to show that
the whole on-the-fly-template-patching approach is somewhat complicated
and hard to get right.
>
> Niels: if you think the note should be visible in all contexts of the
editable ticket view, please adjust site.html accordingly (or just close
the ticket if it's ok as it is now).
I'm okay with it either way. I ''think'' the rationale behind the original
bug report was that the only ones who can change the description are
developers, and they should be aware of the WikiFormatting, however new
tickets can be created by everyone. Nonetheless, why not put it there at
any time...
> > Final note: in case of future template modification that does not go
through site.html, it is also possible to copy the original template to
the env's template dir and make the changes there. It will be picked up
then as well.
>
> I personally consider that the worst of the three approaches, as during
an upgrade, it would be very easy to forget updating these templates and
they'd silently override any changes in the newer trac version.
Well, it does not really matter, in any upgrade we have to check whether
the functionality of ''all'' modifications remain operational. As such we
can store the diff of any modification in the patches in the trac-
customizations module. The diff needs to be tested manually anyway, so
whether it goes into the installed package itself, or the local templates
dir does not really matter IMO.
Overall, you have to know that the Trac guys do not consider their
internal classes (Ticket, Attachment, etc.) and their template data
interfaces as stable APIs, rather they feel free to make modifications.
This means that it is wise not only to test changes between major versions
(0.11.x, 0.12.x) but also between minor versions (0.11.5, 0.11.6).
--
Ticket URL: <http://dev.haiku-os.org/ticket/4956#comment:13>
Haiku <http://dev.haiku-os.org>
Haiku - the operating system.
Other related posts:
