nw-page-editor - Simple app for visual editing of Page XML files.
Version: 2022.09.13
nw-page-editor is an application for viewing/editing ground truth or predicted information for diverse purposes related to the areas of document processing and text recognition. The edition is done interactively and visually on top of images of scanned documents. Additionally the app supports many keyboard shortcuts to allow more efficient editing, see section Application usage shortcuts.
The app 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 allows remote editing by multiple users and can be easily setup via a docker container.
The format used for storing the information is the omni:us Pages Format hightly based on the PRImA Page XML schema, but only supports a subset of elements and has a few minor extensions.
New XML files created by the app are saved as the latest version of the omni:us schema. Modifications to existing XML files using older omni:us schemas or PRImA schemas since version 2013-07-15 are saved using the original schema. Note that this might mean that the saved XMLs are no longer valid according to that schema. Additionally the app supports importing XMLs from other formats, namely: PRImA 2010-03-19, alto v2 and v3, tet and poppler's pdftotext xhtml. Many details from imported formats might be lost and there is no functionality to export back to those formats.
After correct installation of the desktop app, the standard way in Linux and Mac to start the app is through the command line, normally specifying which file(s) to open. In windows currently it is not possible to open files directly from the command line, so you need to start the app and then select a file to open.
nw-page-editor [*page.xml*]+ [*pages_dir*]+ [--list *pages_list*]+ [--css *file.css*]+ [--js *file.js*]+
You can find example Page XML files in the nw-page-editor source code
repository, the directory examples. Thus, you can open the examples as:
nw-page-editor examples/*.xml
-
Download the SDK version of 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|nwjsbinary: root of package in Linux ornwjs.app/Contents/MacOSin OSX. Alternatively to setting the PATH it is also possible to simply symlink thenw|nwjsexecutable to a directory already in your path. -
Clone the nw-page-editor repository (using the
--recursiveoption) to a location where you store applications and add the package'sbindirectory to your PATH. Like in the previous step, alternatively you can simply symlink thebin/nw-page-editorexecutable to a directory already in your path.
In the github repository's releases there are for selected version prebuilt
packages for windows. To install, go to
https://github.com/mauvilsa/nw-page-editor/releases and download and extract the
latest nw-page-editor-win-x64.zip file. To open the app, execute the
nw-page-editor.exe and for convenience create a shortcut to open the app.
If you are interested in the latest version for which there is no prebuilt package, follow the following instructions:
-
Download the SDK version of the NW.js package appropriate for your platform from http://nwjs.io/downloads. Extract it to a location where you store applications renaming the base directory to nw-page-editor.
-
Move, copy or clone the files of this github repository such that the file
package.jsonis in the same directory asnw.exe. If cloning be sure that you use the--recursiveoption. -
For convenience rename the
nw.exeexecutable tonw-page-editor.exeand create a shortcut to it in your desktop to ease opening the app.
- The reason to install the SDK version of NW.js is to allow inspection of elements using the Chrome DevTools and for example be able to do Page XML modifications not implemented in the app.
The --css and --js command line options can be used to modify the appearance or execute custom code on startup. For example, the following JavaScript code changes the position, color and size of overlayed text, and prints to a pdf.
setTimeout( function() {
$.stylesheet('#page_styles { #xpg .TextEquiv }').css( 'fill', 'green' ); /* Set font color to green */
$.stylesheet('#page_styles { #xpg .TextEquiv }').css( 'font-size', '60px' ); /* Set font size to 60px */
pageCanvas.cfg.textPositionOffset = [ 10, 0 ]; /* Set text position x and y offsets */
pageCanvas.util.positionText(); /* Update text position */
nw.Window.get().print({pdf_path:loadedFile.replace(/\.xml$/,'.pdf')}); /* Print to pdf */
}, 500 );To run this example save this code snippet to a file test.js and start the editor from the command line as
nw-page-editor --js test.js examples/lorem.xml
The page editor can also be used as a web server allowing multiple users to edit page xmls remotely. Moreover, the server can be configured so that all the history of changes of the page xmls are saved in a git repository with commits associated to the respective users. To ease the installation and usage of the web server version, docker is used.
The steps for installation are the following:
-
Install docker in the server and for convenience configure it so that sudo is not required to run containers.
-
Either pull the latest image of nw-page-editor-web from docker hub by choosing one of the available tags or build the docker image from the source.
## Pull from docker hub ##
TAG="YOUR CHOSEN TAG HERE"
docker pull mauvilsa/nw-page-editor-web:$TAG
## Build docker image from source ##
TAG="local"
docker build -t mauvilsa/nw-page-editor-web:$TAG .- Create a directory for the data and copy the images and page xml that will be available to access remotely. It is highly recommended to make the data directory a git repository so that change history is kept.
## Create directory for data ##
mkdir data
## Copy documents, e.g. the examples in nw-page-editor source ##
cp $NW_PAGE_EDITOR_SOURCE/examples/* data
## Create list of xmls if use of lists is needed ##
ls data/*.xml | sed 's|^data/||' | head -n 2 > data/xmls.lst
## Init data directory as git repo ##
git init data- By default the web app can be accessed without authentication in which case
all git commits are associated to the anonymous user. Alternatively you can
create users with passwords to restrict the access to the app and associate
commits to different people. This is done by creating the file
data/.htpasswdusing the htpasswd tool. This tool might not be available in the server, but it is included in the nw-page-editor-web docker image. To ease the usage of htpasswd within this image, it is recommended that you use the docker-cli script. Just download it into some directory included in your PATH and then do the following.
## Create users and passwords ##
docker-cli -- mauvilsa/nw-page-editor-web:$TAG htpasswd -cb data/.htpasswd [email protected] pass1
docker-cli -- mauvilsa/nw-page-editor-web:$TAG htpasswd -b data/.htpasswd [email protected] pass2
## For more details on htpasswd usage ##
docker-cli -- mauvilsa/nw-page-editor-web:$TAG htpasswd --help- Start a container exposing the web server port 80 to a port of your preference (e.g. 8080) and set the data directory as a volume.
docker run --rm -d -p 8080:80 \
-v $(pwd)/data:/var/www/nw-page-editor/data \
mauvilsa/nw-page-editor-web:$TAG- The Page XMLs can be accessed using URLs like the example ones below. Three
different GET parameters can be used to specify which documents to view. In
all cases relative paths with respect to the data directory must be given.
The three supported parameters are:
f: to specify a single xml filel: to specify a list of xml filesd: to specify a directory
http://$SERVER_ADDRESS:8080/app?f=lorem.xml
http://$SERVER_ADDRESS:8080/app?l=xmls.lst
http://$SERVER_ADDRESS:8080/app?d=.
By default the files created/modified by the web server will use a default umask
and have the same owner and group as the data directory. These defaults can be
overridden by defining the DATA_UMASK, DATA_UID and DATA_GID environment
variables.
docker run --rm -d -p 8080:80 \
-e DATA_UMASK=007 -e DATA_UID=1234 -e DATA_GID=5000 \
-v $(pwd)/data:/var/www/nw-page-editor/data \
mauvilsa/nw-page-editor-web:$TAGSimilar to the desktop variant, the web variant can also receive css and js
files to modify the appearance or execute custom code on startup. To use this
functionality the css and js files need to be included in some path inside
the data directory. Then the docker container should be started setting as value
to the CSS and JS environment variables, relative paths to the files
separated by spaces. For example:
docker run --rm -d -p 8080:80 \
-e CSS=mystyle.css -e JS=mycode.js \
-v $(pwd)/data:/var/www/nw-page-editor/data \
mauvilsa/nw-page-editor-web:$TAG| 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 + p | |
| ctrl/cmd + enter | Open/close menu |
| ctrl/cmd + n | New window |
| pageup | Load previous document |
| pagedown | Load next document |
| shift + pageup | Load previous 10th document |
| shift + pagedown | Load next 10th document |
| 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 |
| mouse click | Start creating or add point to polygon/polyline |
| ctrl/cmd + mouse click | Add point to and finish creating polygon/polyline |
| 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 document (initial zoom) |
| ctrl/cmd + 1 | Zoom to page of selected element or hovered |
| ctrl/cmd + 2 | Zoom to selected element or hovered |
| 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 + , | Select the next edit mode element level |
| ctrl + shift + , | Select the previous edit mode element level |
| ctrl + . | Select the next edit mode type |
| ctrl + shift + . | Select the previous edit mode type |
| ctrl/cmd + e | Open property editor for selected element |
| ctrl/cmd + shift + pageup | Increase bottom pane text font size |
| ctrl/cmd + shift + pagedown | Decrease bottom pane text font size |
| ctrl/cmd + pageup | Increase overlayed text font size |
| ctrl/cmd + pagedown | Decrease overlayed text 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 + r | Toggle selected element protection |
The MIT License (MIT)
Copyright (c) 2015-present, Mauricio Villegas [email protected]
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.