diff --git a/docs/guide.md b/docs/guide.md index 074dc76..4dedfd0 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -7,19 +7,30 @@ version 0.1 * QURATOR project (https://qurator.ai/) ### 2. User Guide -#### Technical Requirements (Javascript enabled, Browser-Compatibility) -* Input format (https://sites.google.com/site/germeval2014ner/data) +#### Technical Requirements +* Javascript enabled, Browser-Compatibility? +* Data input format (https://sites.google.com/site/germeval2014ner/data) * Data preparation ([Python tools](https://github.com/cneud/ner.edith/tree/master/tools)) #### Overview of Editor Features * Navigation * use mouse wheel to scroll up and down * use navigation `<<` and `>>` to move faster + * show image snippet + * Tagging + * adding a tag + * removing a tag + * changing a tag + * OCR correction + * editing the token text + * Segmentation correction + * merging two tokens + * splitting a token #### Data export/Saving progress - The editor runs fully locally in the browser. Therefore it can not automatically save any changes you made to disk. You have to use the "Save changes" button in order to do that manually from time to time. +The editor runs fully locally in the browser. Therefore it can not automatically save any changes you made to disk. You have to use the "Save changes" button in order to do that manually from time to time. - If your browser automatically saves all downloads to your "Downloads" folder, you might want to configure it such that it asks you where to save it. +If your browser automatically saves all downloads to your "Downloads" folder, you might want to configure it such that it asks you where to save it. - Configuration option in Firefox: +Configuration option in Firefox: ![Screenshot](./../.screenshots/firefox.png)