Name
nw-page-editor - Simple app for visual editing of Page XML files.
Version: 2017.12.29
Description
nw-page-editor is an application for editing ground truth information for diverse purposes related to the area of handwriting text recognition (HTR). The edition is done interactively and visually on top of images of scanned documents. The format used for storing the ground truth information is based on the Page XML schema, but with a few minor extensions. It is available in two variants. The first variant is as a desktop application, based on the NW.js framework thus making it cross-platform. The second variant is as a web application that can be easily setup as a docker container.
Desktop variant installation
Linux/Mac/Cygwin:
-
Download the NW.js package appropriate for your platform from http://nwjs.io/downloads. Extract it to a location where you store applications and add to your PATH the directory containing the nw/nwjs binary: root of package in Linux/Cygwin or nwjs.app/Contents/MacOS in OSX.
-
Move the nw-page-editor directory to a location where you store applications and add the package's bin directory to your PATH.
Windows:
-
Download the NW.js package appropriate for your platform from http://nwjs.io/downloads. Extract it to a location where you store applications and move or copy or clone the files of this repository such that package.json is in the same directory as nw.exe.
-
Create a shortcut to nw.exe to ease opening of the app. In windows it is not possible to open files directly from the command line.
Command line synopsis
nw-page-editor
nw-page-editor <path_to_page_xml>...
nw-page-editor <path_to_dir_containing_page_xmls>
nw-page-editor --list <file_listing_page_xmls>
Application usage shortcuts
| Shortcut | Command |
|---|---|
| ctrl/cmd + q | Quit application |
| ctrl/cmd + o | Open file dialog |
| ctrl/cmd + s | Save changes to file |
| ctrl/cmd + shift + s | Save as new file dialog |
| ctrl/cmd + m | Open/close menu |
| ctrl/cmd + n | New window |
| pageup | Load previous page |
| pagedown | Load next page |
| ctrl/cmd + z | Undo last change |
| ctrl/cmd + y | Redo last change |
| mouse click | Select or deselect element |
| esc | Deselect the currently selected element |
| tab | Select the next element |
| shift + tab | Select the previous element |
| ctrl + tab | Select the next dragpoint |
| ctrl + shift + tab | Select the previous dragpoint |
| ctrl + f | Enable/disable text filtering |
| ctrl/cmd + del | Delete selected element |
| del | Delete selected element (only when text not editable) |
| minus + . | Delete selected dragpoint |
| plus + . | Add dragpoint next to selected |
| ctrl/cmd + 0 | View full page (initial zoom) |
| ctrl/cmd + plus/minus | Zoom in/out |
| shift + mouse wheel | Zoom in/out |
| ctrl/cmd + arrows | Move (pan) the image in the respective direction |
| mouse wheel | Move (pan) the image in the respective direction |
| mouse drag | Move (pan) the image in the respective direction |
| ctrl/cmd + e | Open property editor for selected element |
| ctrl/cmd + pageup | Increase font size |
| ctrl/cmd + pagedown | Decrease font size |
| ctrl/cmd + g | Change gamma of image |
| alt + arrows | Change table selected cell in the respective direction |
| plus + c/r | Split selected table column/row |
| minus + c/r | Remove selected table column/row |
| move dragpoint | Modifies dragpoint and its opposite dragpoint(s) |
| shift+ move dragpoint | Modifies only the dragpoint, not the opposite(s) |
| ctrl/cmd + p | Toggle selected element protection |
Copyright
The MIT License (MIT)
Copyright (c) 2015-present, Mauricio Villegas mauricio_ville@yahoo.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.