hasanatkazmi / nopsa-ribbon-api Goto Github PK

API for HIIT's NOPSA which is currently used by MS Office Ribbon / addin

License: MIT License

C# 67.35% JavaScript 0.94% Python 31.71%

nopsa-ribbon-api's Introduction

This is RESTful API interface for NOPSA plugins for Word Processors etc.

http://nopsa.hiit.fi/
Project website: link_to_ec2_instance


HOW TO INSTALL

Note: These set of instructions assume that you are running Debian (Lenny). 
It might also work for other systems as well.
It is also assumed that you have sql server installed.


1) changing sources.list temporarily:
	create a backup of source.list:
	cp /etc/apt/sources.list /etc/apt/sources.list.backup
	rm /etc/apt/sources.list
	echo "deb http://ftp.debian.org/debian/ squeeze main" > /etc/apt/sources.list

2) update apt-get:
	sudo apt-get update

3) install tornado, sqlalchemy, simplejson:
	sudo apt-get install python2.6 python-tornado python-sqlalchemy python-simplejson

4) undo changes in source.list which we did in step 1:
	rm /etc/apt/sources.list
	cp /etc/apt/sources.list.backup /etc/apt/sources.list
	rm /etc/apt/sources.list.backup

5) update apt-get:
	sudo apt-get update

Please don't skip step 4 and 5 as it will update other installed binaries which may harm other servers running on machine.


6) now tornado is installed but tornado version is 1.0.1 (we need atleast 1.2.1) and doesn't support all features are used in ribbon API.
	So lets manually update tornado.
	(we installed old tornado at first place so that all depedences can be installed):
	wget -O tornado.tar.gz https://github.com/downloads/facebook/tornado/tornado-1.2.1.tar.gz
	tar -xvvf tornado.tar.gz
	cd tornado-1.2.1
	python2.6 setup.py install

7) run tornado tests to confirm install:
	cd tornado/test
	python2.6 runtests.py

	confirm that all tests run successfully

8) download the server code:
	(cd into the directory you want server code to reside)
	wget -O ribbon.tar.gz https://github.com/hasanatkazmi/NOPSA-Ribbon-API/tarball/master
	tar -xvvf ribbon.tar.gz
	cd hasanatkazmi*
    cd serverside
	python2.6 tornado.py


By now server must be up and running. Visit http://localhost:8000 in a web browswer

DEBUG:
    0)  Use aptitute to install if apt-get creates problems 
	1) 	Confirm database connectivity string in config.py
	2)	Confirm that line 137 of web/demp.htm conforms to the exact server address

nopsa-ribbon-api's People

Contributors

Stargazers

Watchers

Forkers

yefengcn paba

nopsa-ribbon-api's Issues

Installer does not update all necessary DLLs

In many computers, the installer fails to install the Ribbon correctly, and this causes errors when an image is double-clicked. The reason is supposedly in the old DLLs and Windows Service Pack update. The installer should take this into account.

Vertical scrollbars are not visible

Often the plugin computes its horizontal space incorrectly, and the vertical scrollbar becomes unreachable because it is drawn outside the program's viewport. Resizing the window helps.

The addition of images should be triggered with a single click

While the preview of the image is done with the mouse hover, the addition of images to slides requires double click. I don't see any reason why it could not be a single click.

Attribution information also on the slide where image is

The sidebar could have an option to insert the attribution information also on the page where the user inserts the image.

Pressing next and prev buttons advances to next page unreliably

Often the same images appear also on the next page, after a press on a black prev or next button.

Addin not integrated with all color schemes on Office

Addin must adopt UI colors as per color schemes chosen by user for Office. Currently, it looks very unpleasant wien e.g. blue color is chosen.
(nIn power point, go to option -> General and choose different "color scheme" . you would feel what I mean)

Vertical window resize makes the plugin miscalculate the vertical location of black arrows

If the window is vertically resized, the black next+prev-buttons are drawn in an incorrect height in the screen.

The ribbon bar should have a way to control which sources are searched

The API service provides a way to search from several sources. The ribbon has plenty of space which could be used for source selection buttons. This way the user could select the source easily without using more of the vertical search area's space..

Support for multi-word searches

Currently the search does not handle the use of multiple keywords very well. A more flexible tag matching would be useful.

Insertion into PPT slide creates tiny lowres images

When you insert an image, it often appears as a tiny square-shaped image in to top-left corner of the slide. Often the image has also very low resolution, but not always.

Add licensing information

The project is an open source project. However, it is missing the licensing information on the project page.

No user feedback on search progress

The spinner does not communicate enough to the user about the progress of the search. It should help the user understand which of the 3 alternatives will be the result:

search returns 0 images (sometimes this is communicated so that the spinner disappears, and a blank screen shows, but that is not enough)
search is still in progress and some results have already been found, and the user should wait
search is not going to terminate or there are unexpected delays, and no images will be returned

a small thumbnail of the image placed next to the CC information. This way it is possible to know which image is related to which attribution.
there could be an URL to the page where the user can download or read more about the Ribbon.

hasanatkazmi / nopsa-ribbon-api Goto Github PK

nopsa-ribbon-api's Introduction

nopsa-ribbon-api's People

Contributors

Stargazers

Watchers

Forkers

nopsa-ribbon-api's Issues

Recommend Projects

Recommend Topics

Recommend Org

Jobs