[Koha-devel] OPAC dir structure redesign

Mason James mtj at kohaaloha.com
Mon May 6 01:52:13 CEST 2013


> 
> Mason,
> 
> Owen and I were talking recently about a plan to improve the current OPAC directory structure...
> 
> the big problem is there is currently much duplication of unnecessary dirs/files.
> each theme has many duplicated files - and each language for each theme has many duplicated files
> 
> all this duplication means that subtle bugs can occur...
> now that we have got the awesome new CCSR theme added, the next step is to fix the OPAC dir structure to accommodate multiple themes easily and safely :)
> 
> Agreed, but I have some reservations about your proposal (described below). 
> 
> each theme's dir (eg: prog or ccsr) only needs a 'css' dir,
> all other theme's existing subdirs can be moved to the shared top-level 'lib' and 'images' dirs
> 
> If this is prescriptive (i.e. "nothing but CSS can go in a theme"), I think this would be a problem. The entire point of themes is that you can do more than just change opac.css and colors.css. If that's all themes did, we wouldn't need them because we have system preferences to change opac.css and colors.css.


yes, a great question! what exactly is a 'theme' going to be in Koha…?

i think, a theme can only have custom css, and image files, and that is all
a theme must *not* have custom template, xslt, and include files (history has shown, to allow this would be impossible to maintain safely)

i hope most agree on this point? :)


also, i have realized i have missed some important bits of the redesign...

1/ each theme also needs its own 'images' subdir

2/ a top-level 'css' dir should be added, that contains 'css' content that is shared between all themes

so, the basic idea is that we have shared top-level 'images' and 'css' dirs. that contains content that is *common* between all themes
and some theme specific 'css' and 'images' subdirs, that contains only *unique* content, to that theme

remember 90%+ of this css/images content is common between all themes


i think,the most urgent 'bug' to fix before all this, is that each theme has its own 'includes' dir
we need to fix this before the redesign can start


so, as a first step, we symlink CCSR's 'includes' dir to PROG's 'includes' dir (as we currently do with CCSR's 'modules' dir)
and test/fix any breakage that may occur

…after that change is stable, we can then start the redesign proper


fyi: heres an example of the additional css and images dirs…

opac-tmpl
└── themes
   ├── ccsr
   │   └── css
   │   └── images
   └── prog
   │   └── css
   │   └── images
├── css
├── images


> 
> While we are reorganizing things, it might be nice to reorganize the YUI files so that we organize them the same way that the official YUI package is organized.

awesome, sounds great




-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.koha-community.org/pipermail/koha-devel/attachments/20130506/e2aaa96a/attachment.html>


More information about the Koha-devel mailing list