If you think a bug might affect users in the 57 release, please set the correct tracking and status flags for Release Management.

Template Customisation Section Issues

RESOLVED FIXED in Bugzilla 2.16

Status

()

Bugzilla
Documentation
P2
normal
RESOLVED FIXED
16 years ago
5 years ago

People

(Reporter: CodeMachine, Assigned: Matthew Barnson)

Tracking

2.15
Bugzilla 2.16

Details

(Reporter)

Description

16 years ago
The following appears to possibly need doing, looking through the template
customisation section:

Say that what you edit depends on how you upgrade.  If you purely use cp (ie you
download tarballs), then custom is always the right option.

Add a comment to say if you are making changes that will be submitted back to
Bugzilla, please read the Developers' Guide first.

How does the enter_bug format template know which post_bug template to call? 
Didn't we include formats for post_bug?  These aren't documented.

Add a comment mentioning that custom will always work unless there are
incompatible template interface changes.  Mention if this occurs it will be
mentioned in the release notes (and we should probably talk about versions too
for people who pull from CVS which doesn't have the release notes), and there
may also have a transition period where the feature is mentioned in the
deprecations section in the release notes.

> Underneath that, there are two directories - default and custom.

No there aren't custom isn't in CVS and isn't created by checksetup.pl, although
I consider that a bug which I will raise elsewhere.
(Reporter)

Updated

16 years ago
Priority: -- → P2
Target Milestone: --- → Bugzilla 2.16

Comment 1

16 years ago
If you purely use cp, then using custom is the right thing to do. Note however
that you are not required to use cp, even if you can't use cvs: 
* One way is to download the original old tarball and the original new tarball
and run a recursive diff -urN or something like that between the two
template/en/default directories. bugzilla.org could even offer such a diff for
each new release that upgrades you from the previous one. Then you can patch
your installations with this diff. 
* Alternatively, you can create a diff between your local installation and the
original old tarball, and then try to apply that diff to the new tarball. But
make sure that you are comparing only the template directories, or else you need
to be careful with special files like localconfig.

In both cases, you can get away without using custom templates and let the patch
program do most of the work for you. (Of course, using CVS is even more
convenient.) On the other hand, since I'm using CVS I have no need for manual
patches, so this is only theory. In my own installation, index.html.tmpl is my
only custom template; all the others are modifications in default. So far, this
has been working very well.
(Reporter)

Comment 2

16 years ago
This also needs to mention the template versioning system from the perspective
of developers.
(Reporter)

Comment 3

16 years ago
We also need a section on HTML and URL filtering, especially the former due to
security issues.  You could rip the section on this from the Developer's Guide
if you like.
(Assignee)

Updated

16 years ago
Status: NEW → ASSIGNED
Fixed in my local copy, to be checked in today.

Gerv
Status: ASSIGNED → RESOLVED
Last Resolved: 15 years ago
Resolution: --- → FIXED

Comment 5

11 years ago
I am new to bugzilla and hence would require some help from you all here.

Could anyone let me know if this enhancement will be available for the current release if I download bugzilla now? If no, how to get the current updates / patches for bugzilla 2.20? In such a case will all the new customization [custom field] etc get merged with bugzilla 2.20 release?

The customizations mentioned here would really come handy for us too. Please
check BUG #344086 about the same. Looking forward to your replies on the same.

Thanks,
QA Contact: matty_is_a_geek → default-qa
You need to log in before you can comment on or make changes to this bug.