Skip to content

Latest commit

 

History

History
executable file
·
69 lines (59 loc) · 4.27 KB

README.md

File metadata and controls

executable file
·
69 lines (59 loc) · 4.27 KB
Raw

UBHD_OMParthistoricum

UBHD_OMParthistoricum is a flexible, responsive Frontend portal for pkp 's Open Monograph Press written in python programming language and based on the python web framework web2py.

Demo

Features

  • Responsive design (based on twitter bootstrap)
  • Easy multilingual support
  • Intergrated-HTML viewer (based on lens)
  • Native JATS XML support for OMP
  • Chapter level metadata for monographs and edited volumes
  • Social sharing (without using external plugins)
  • Detailed usage statistics
  • Easy migration using web2py app structure

Installation

  • Prerequisites

    1. Install Open Monograph Press. See documentation
    2. Install web2py
    3. [Download] (http://web2py.com/init/default/download) web2py
    4. Unzip it
    5. change directory to the the unzipped folder
    6. If you have python installed : run python2.7 web2py.py or install python for your distribution

  • Install UBHD_OMParthistoricum

    1. cd web2py_folder/applications/
    2. git clone https://github.com/UB-Heidelberg/UBHD-OMParthistoricum.git press_name - Notice: press_name should contain only characters, numbers or _ - Please do not use - in the press_name
    3. Change the settings for your local omp installation private/appconfig.ini 1. username and password for the OMP database 2. press_id of the local omp press 3. define the press_name you selected when cloning from git
    4. Mount or symlink the files folder of the OMP to web2py_folder/applications/press_name/static/monographs/
     ```
  ln -s web2py_folder/applications/press_name/static/monographs/ omp_folder/files/presses/press_id/monographs
  ```

For developers

##General information

  • A general knowledge in python and sql is necessary for further development.
  • Some basic knowledge in web2y is helpful. See docs
  • The OJS intergration is in progress.
  • We have included a minified lens viewer. If you want to customize it, either use the lens git or contact us. We will be happy to help you.

##Folder structure strictly follows MVC (Model-View-Control) design principle

  • controllers - contains all the functions for enabling pages.
  • cron - automated tasks
  • databases - automatically generated by web2py. Do not edit this folder contents
  • languages - language files. Web2py generates automatic entries for any word written in T() Block. e.g. T('word') in python files or {{=T('word')}} in HTML. Default language is english.
  • models - database models for Open monograph press. Web2py uses a data abstraction layer.
  • private - all the files, which contain sensitive information and configuration files
  • modules - table mappings of omp and varibales that are globally accessible from the application.
  • static - all the static files as such as javascript files and css files.
  • views - for each controller (e.g. catalog.py) file, you have to add a folder with the same name (e.g. catalog) and a html file (index.html) for each function in the controller file.

##Additional information for customizations -Book view

  • Current book details page views/catalog/book.html displays xml files in the lens viewer, if you name the category into XML. But this can ba changed in private/appconfig.ini

#License This software is released under the the GNU General Public License. See the file LICENSE.md included with this distribution for the terms of this license.