256208 - make checksetup.pl create .cvsignored skins/custom/ and children

Status: RESOLVED FIXED

(Bugzilla :: User Interface, defect)

Description

[Myk Melez [:myk] [@mykmelez]]

Per the Bugzilla CSS plan, checksetup.pl should create skins/custom/ and a set
of empty stylesheets equivalent to the files in skins/standard/. 
skins/.cvsignore should tell CVS to ignore skins/custom/.

Comment 1

[Myk Melez [:myk] [@mykmelez]]

Attachment: patch v1: implements feature

Comment 2

[Myk Melez [:myk] [@mykmelez]]

Comment on attachment 156553 [details] [diff] [review]
patch v1: implements feature

Gerv, can you take a look at this?

Comment 3

[Gervase Markham [:gerv]]

Comment on attachment 156553 [details] [diff] [review]
patch v1: implements feature

Can we not just check in the .cvsignore file? Or is that considered bad
practice?

Having read both bugs: did we give up on the multiple selectable skins thing?
If so, fair enough. How does custom override standard? Surely, to make that
work, you'd need to @include standard at the top of custom, and then reference
_custom_ in the templates?

I'm confused...

Gerv

Comment 4

[Myk Melez [:myk] [@mykmelez]]

>Can we not just check in the .cvsignore file? Or is that considered bad
>practice?

It's not bad practice, but it does mean changes to the file will show up in
diffs, and admins who install custom skins may well change the file, add those
skins to it so they don't show up as unrecognized files in diffs.  But perhaps
this matters less than the simplicity of just checking it in, or perhaps it (or
the equivalent one directory up) can tell CVS to ignore it.

>Having read both bugs: did we give up on the multiple selectable skins thing?

Nope, we're just not doing that in the first stage.  From the CSS plan:

"Implementation of this proposal will happen in stages.  In the first stage, we
move existing files to their new locations, make checksetup.pl create the custom
directory/file hierarchy, make header.html.tmpl include custom stylesheets, and
classify pages by installation and CGI."

moving existing files to their new locations is bug 256207;
making checksetup.pl create the hierarchy is this bug;
making header.html.tmpl include custom stylesheets hasn't been filed yet;
classifying pages by installation and CGI is bug 253480;

>How does custom override standard? Surely, to make that work, you'd need to 
>@include standard at the top of custom, and then reference _custom_ in the 
>templates?

Actually we're going to use persistent stylesheet tags for customizations and
preferred stylesheet tags for the default skin to ensure the appropriate
cascading order.  Per the CSS plan:

"header.html.tmpl generates persistent stylesheet tags for customizations,
preferred stylesheet tags for the default skin, and alternate stylesheet tags
for other skins.  Pages thus take on the default style, as modified by custom
styles, until the user selects an alternate style, whereupon they take on the
alternate style, as modified by custom styles."

More info on the different kinds of stylesheets:

http://www.w3.org/TR/REC-html40/present/styles.html

Comment 5

[Myk Melez [:myk] [@mykmelez]]

Regarding the cascade, the following info is also relevant (it means we must put
the custom stylesheet last in Bugzilla page headers):

http://www.w3.org/TR/REC-CSS2/cascade.html#cascade

Comment 6

[Gervase Markham [:gerv]]

Comment on attachment 156553 [details] [diff] [review]
patch v1: implements feature

r=gerv. Seems OK, although I'm always wary of the permissions-setting code.

Gerv

Comment 7

[Myk Melez [:myk] [@mykmelez]]

Thanks Gerv.  Dave says this can go into 2.20.

Checking in checksetup.pl;
/cvsroot/mozilla/webtools/bugzilla/checksetup.pl,v  <--  checksetup.pl
new revision: 1.311; previous revision: 1.310
done