[librecat-dev] LibreCat UI Documentation

[Windisch, Nils Kolja]

Hi Patrick,

thank you very much for your quick reply. It helped me identify on where to start to work on a UI level.

Looking forward to talk to you and others at the meeting.

Best,
Nils


On 24.05.16, 11:47, "Patrick Hochstenbach" <Patrick.Hochstenbach at UGent.be> wrote:

>Yes. The code is made for a production environment in Bielefeld. We in Ghent and you in Göttingen want to transform this environment
>into something that can be adapted to the layout/backend requirements of our local institutions. This is something that is on the roadmap which I don’t think
>is quite hard to do (just go into the templates and change what you need), but requires some coding guides/rules and a generic layout to make this process easier and straightforward for any installation.
> 
>We are at the moment creating an agenda for Bielefeld and Göttingen and others who are interested, to come together very soon in Ghent and discuss these issues.
>Indeed, the UI is now very much targeted to Bielefeld and all of us need a themed approach. We believe all that LibreCat as created by Bielefeld is the way forward and want to contribute to make this happen.
>
>Here is a tentative agenda for our meeting (there is no date yet). Maybe you want to join us, or can elaborate a bit more on the things you would like to see changed?
>
>Agenda
>-=-=-=-=-
>
> * Introduction in LIbreCat + Catmandu
> * Current state of the LibreCat repository software
> * Demo’s of the Perl API and command line
> * Roadmap voor version 1.0 to be release by the end of the year
>     * Generic install + layout
>     * How to extend the repository for local layouts
>     * Import + validation of records
>     * Workers
>     * Metadata + File storage
>     * Deployment
> * Tickets, feature requests, who to assign jobs
> * Documentation 
>
>> On 24 May 2016, at 10:44, Windisch, Nils Kolja <windisch at sub.uni-goettingen.de> wrote:
>> 
>> it’s about LibreCat. My initial question would be how to adapt LibreCat for my own institution from a user interface point of view.
>> 
>> I had a look at the LibreCat wiki, but couldn’t find information on how to change (UI related) code systematically. It’s obvious that Template-Toolkit is used for templating purposes and bootstrap as CSS framework, but I couldn’t find some sort of theming approach (per instituition). It seems that the code is very much tied to University Bielefeld as the master branch contains hard coded links[1].
>> 
>> Is there a place where coding conventions/rules are documented?
>> I get confused by e. g. things like the images folder[2]: camel case, hyphen, uppercase, german/english names, gif/jpg/png file format.
>> 
>> [1] like here: https://github.com/LibreCat/LibreCat/blob/master/views/websites/logo_contact.tt#L9
>> [2] https://github.com/LibreCat/LibreCat/tree/master/public/images
>> 
>> On 23.05.16, 11:02, "Patrick Hochstenbach" <Patrick.Hochstenbach at UGent.be> wrote:
>> 
>>> If you mean the LibreCat institutional repository currently in development I can refer you to our Wiki: https://github.com/LibreCat/LibreCat/wiki
>>> 
>>> If you mean the data processing toolkit Catmandu. This is a collection of command line tools. Install it on a Unix server and use ‘man Catmandu’ to read a full documentation.
>>> 
>>>> On 23 May 2016, at 10:00, Windisch, Nils Kolja <windisch at sub.uni-goettingen.de> wrote:
>>>> 
>>>> I’d be grateful for every hint on finding documents that describe the current UI implementation of LibreCat.