As you suggested, I'm copying this to vufind-tech so others can join the conversation.
Thanks for your willingness to contribute back to VuFind. We're certainly happy to look at any proposals you're willing to share. Your proposal for separating out the language control sounds reasonable to me -- anything that makes theming less painful is a step in the right direction.
As far as guidelines go, all we have is what's in the wiki:
This doesn't really address conventions within the templates, which have been a continuous work in progress. I'd recommend aiming for consistency with what you see, and if you do anything that seems out of line with past practice, I'll let you know when I review your pull request. It would be a good idea to write up something more formal, but as we're currently about to begin a migration toward Bootstrap 3, there may be another significant round of changes in the near future (curse these frameworks and their ever-moving targets!).
I'm also always happy to discuss specific issues if questions arise during your development.
From: Markus Mächler [mmaechler@...]
Sent: Friday, June 06, 2014 11:12 AM
To: Demian Katz
Subject: Contributing to vufind-org/vufind
We are going to relaunch the http://www.swissbib.ch platform based on a vufind
bootstrap theme. In our current version we did override a lot of the
vufind classes and templates. Thus we could not benefit a lot from your
As there are a lot of great new features we would like to get back
closer to the vufind core implementation in order to benefit also from
your future development.
Currently we are doing some research on how to achieve that. We
discovered that sometimes changing just a little bit of the template
structure could be a huge benefit for us.
For instance we would like to have a language menu that is different
from the vufind implementation (because we only support 4 languages). In
the current implementation we would have to override the entire
header.phtml file. If we would make a language.phtml template and
include it in the header.phtml with $this->render() we could just
override the language.phtml and leave the header.phtml. Or sometimes
adding a css class could give us an easy way to alter the look without
really changing the template.
Now my questions. Are you willing to include such changes into the
vufind core? We think the community could benefit from this as well as
we are not limiting or changing the functionality.
If you are willing to include such changes, do you have any naming
conventions for classes, ids or templates? Or do you even have something
like a developer documentation (coding guidelines) for people willing to
contribute to vufind?
I was not sure whether to send this via the tech-list. If you feel like
this would be interesting for everybody feel free to send your response
and my email to the tech-list!
Thanks for your answers and your great work on vufind!
Markus Mächler | Application Developer
Direkt +41 58 680 32 36 | E-Mail mmaechler@...
snowflake productions gmbh | http://www.snowflake.ch
Birmensdorferstr. 94, 8003 Zürich
Tel +41 58 680 32 32 | Fax +41 58 680 32 33
snowflake | PREMIUM OPEN SOURCE