Pundit 2 -- Version to work with MPIWG linguistic services

This is a fork of pundi2 which enables lmguistic annotations. For more see: https://it-dev.mpiwg-berlin.mpg.de/tracs/mpdl-project-content/wiki/pundit

Copyright for the changes by MPIWG at 2015 (http://www.mpiwg-berlin.mpg.de)

The annomatic modul has been adapted to communicate with the texttool api at

http://md.mpiwg-berlin.mpg.de/tt

A hint for installation:

Pundit relies havily on cross-domain access. Therefore the server wehere you install pundit2 needs to have CORS aenabled from all websites otherwise some parts of the bookmarklet don't work. Also additional services which are loaded by pundid need to have CORS enabled.

---

The following is the original README from Net7

License

http://thepund.it/license/

and

http://www.gnu.org/licenses/agpl-3.0.html for the MPIWG additions

Install

To install the project and be ready to develop you need a few components:

• npm (nodejs >0.9)
• grunt-cli

On ubuntu 12.04 (and maybe others) you might need to add a repository for a recent version of nodejs

sudo apt-get update
sudo apt-get install -y python-software-properties python g++ make
sudo add-apt-repository -y ppa:chris-lea/node.js
sudo apt-get update
sudo apt-get install nodejs

Install npm, grunt

sudo apt-get install npm
sudo npm -g install grunt-cli grunt

Install bower

sudo npm install -g bower

Install pundit2

WARNING: this step must NOT be run as root, npm will just let you down.

npm install

This will install the full toolchain to develop, build and deploy the application.

Develop

grunt dev

Examples are built in examples/*html from examples/src/*html.

To create a new one: add a new .html in examples/src/, include the header and footer comments for grunt to build them correctly. Or copy one of the existing into a new one, directly.

The list of examples is built and included everywhere automatically.

To get a list of grunt targets:

  grunt --help

Build

grunt build

Will build a production ready pundit2 distribution in /build/:

• css/ver.pundit.css
• css/fonts/*
• scripts/ver.libs.js
• scripts/ver.pundit2.js

Plus all of the examples using the production code: index.html or just *.html.

Plus the documentation in /Docs.

Code + naming policies

• Modules: "Pundit2.ModuleName", camel case with first capitalized
• Constants: "PUNDITDEFAULTCONF", all capitalized
• Services/Factories/Providers: "ServiceName", camel case with first capitalized
• Filenames:
  • javascript: "$name.$what.js" (eg Example.dir.js)
    • $what is one of: module, service, factory, ctrl, constant, dir (directive)...
    • $name is the same name of the $what defined inside (camel case etc)
  • templates: "$name.$what.tmpl.html" (eg: Example.dir.tmpl.html)
    • $name.$what is the same name of module this template belongs to
  • unit test: "$name.$what.unit.test.js" (eg: Example.service.unit.test.js)
  • e2e test: "$name.e2e.test.js" (eg: Example.e2e.test.js)
• Directories: name of the module / component
• Css classnames:
  • words are separated by hyphens "-"
  • they all start with "pnd-" (eg: pnd-dashboard-container)
  • they are all lowercase

Used in this project

• Js framework: Angular js https://docs.angularjs.org/api
• Css/html framework: Bootstrap http://getbootstrap.com/css/
• js+css/html: Angular strap http://mgcrea.github.io/angular-strap/
• Unit tests: http://jasmine.github.io/1.3/introduction.html
• E2E tests: https://github.com/angular/protractor/blob/master/docs/api.md