forked from UB-Heidelberg/UBHD-OMPPortal
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
205 changed files
with
29,023 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Compiled source # | ||
################### | ||
*.com | ||
*.class | ||
*.dll | ||
*.exe | ||
*.o | ||
*.so | ||
*.pyc | ||
*.*~ | ||
|
||
# Packages # | ||
############ | ||
|
||
*.7z | ||
*.dmg | ||
*.gz | ||
*.iso | ||
*.jar | ||
*.rar | ||
*.tar | ||
*.zip | ||
|
||
# Logs and databases # | ||
###################### | ||
*.log | ||
*.sql | ||
*.sqlite | ||
|
||
# OS generated files # | ||
###################### | ||
.DS_Store | ||
.DS_Store? | ||
._* | ||
.Spotlight-V100 | ||
.Trashes | ||
ehthumbs.db | ||
Thumbs.db | ||
*.bak | ||
databases/* | ||
.idea/* | ||
sessions/* | ||
static/monographs/* | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
This software is developped by Dulip Withanage in the Heidelberg University Library |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
# UBHD-OMPPortal | ||
UBHD-OMPPortal is a flexible, responsive Frontend portal for [pkp](https://pkp.sfu.ca/) 's [Open Monograph Press](https://pkp.sfu.ca/omp/) written in python programming language and based on the python web framework [web2py](http://www.web2py.com). | ||
|
||
# Demo | ||
- Heidelberg University Publishing [Web](http://heiup.uni-heidelberg.de/) | ||
- Customized lens based HTML Viewer [Full book](http://heiup.uni-heidelberg.de/reader/index/43/heiUP_habenstein_abwesenheit_2015.xml) , [Chapter ](http://heiup.uni-heidelberg.de/reader/index/43/43-69-209-1-10-20150717.xml) , [Chapter with images](http://heiup.uni-heidelberg.de/reader/index/43/43-69-220-1-10-20150723.xml#figures) | ||
 | ||
|
||
# Features | ||
- Responsive design (based on twitter bootstrap) | ||
- Easy multilingual support | ||
- Intergrated-HTML viewer (based on [lens](https://github.com/elifesciences/lens/)) | ||
- Native [JATS](http://jats.nlm.nih.gov/) 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](http://pkp.sfu.ca/omp/README) | ||
2. Install web2py | ||
1. [Download] (http://web2py.com/init/default/download) web2py | ||
2. Unzip it | ||
3. change directory to the the unzipped folder | ||
4. If you have python installed : run ```python2.7 web2py.py``` or install [python](https://www.python.org/downloads/release/python-2710/) for your distribution | ||
- Install UBHD-OMPPortal | ||
1. ```cd web2py_folder/applications/``` | ||
2. ```git clone https://github.com/UB-Heidelberg/UBHD-OMPPortal.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](http://web2py.com) | ||
- The OJS intergration is in progress. | ||
- We have included a minified [lens](https://github.com/elifesciences/lens/) viewer. If you want to customize it, either use the [lens git](https://github.com/elifesciences/lens/) or [contact us](mailto:[email protected]). 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](LICENSE.md). | ||
See the file [LICENSE.md](LICENSE.md) included with this distribution for the terms of this license. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# -*- coding: utf-8 -*- | ||
''' | ||
Copyright (c) 2015 Heidelberg University Library | ||
Distributed under the GNU GPL v3. For full terms see the file | ||
LICENSE.md | ||
''' | ||
|
||
|
||
def mission_statement(): | ||
return dict() | ||
|
||
|
||
def profile(): | ||
return dict() | ||
|
||
|
||
def advisory_board(): | ||
return dict() | ||
|
||
|
||
def team(): | ||
return dict() |
Oops, something went wrong.