KWARC Annotation Tool
KWARC Annotation Tool: An Annotation Tool for STEM Documents.
We use Grunt for minimising source files and running the demo. To get started, run:
git clone https://github.com/KWARC/KAT cd KAT npm install -g grunt-cli # Might require sudo depending on your system configuration # Update the dependencies npm install . # run either one of the commands below grunt run # To just start a server grunt serve # To develop with autoreload enabled.
You can then navigate to localhost:3000 and take a look at the demo.
Developing KAnnSpecs with KAT
Perform the steps described above. To use your own KAnnSpecs you can then:
- Place your KAnnSpec into the KAnnSpec/ directory.
- Place your document into the content/ directory. Make sure it only contains the actual document content (inside the body tag)
- Edit line 3 in js/index.js and change "content/sample1.html" to the path of the document you want to use and change "KAnnSpecs/omdoc-annotations.xml" to the annotation you want to create.
grunt runif it is not already running.
- Navigate to localhost:3000 and see the demo at work.
Developing KAT itself
The source files are in src/KAT. When your run
grunt serve the will automatically be concatinated and added to the page. The Gruntfile also enables a live reload module which reloads the page automatically when one of the modules is updated. If you add a new file, make sure to add them in Gruntfile.js.
There is auto-generated documentation in the 'doc' subdirectory. JSDoc is used to generate it. You can re-generate by running
The documentation will also be served by
grunt serve. You can access it by going to http://localhost:3000/doc.
- which depends on Bootstrap
- doT for templating of <display> elements.
- Raphael for drawing arrows to annotation references on an SVG
- Grunt - for the development part.
The library itself has been tested with latest Chrome and Firefox versions. If you want MathML support, please use Firefox.
KAT is licensed under GPL.
Copyright (c) 2014-16 by the KWARC Group (http://kwarc.info)
KAT is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
KAT is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with KAT. If not, see http://www.gnu.org/licenses/