PDF Viewer functionality is underdocumented

[sdruskat]

The respective section of the user guide says

pdf/pdfdoc – it is possible to configure the height of the pdf window using the height instruction (in pixels), as well as the name (node_key) of the node annotation to be used to give individual page numbers aligned with a span of tokens (relevant for pdf only, pdfdoc always shows all pages). The instructions can be combined as follows: node_key:pp;height:400.

This is outdated and not of great help. At least the following info should be included:

• The key has changed to pdf_page_key. It must be included in the viz setup in resolver_vis_map.annis.
• If you want to auto-link between annotations on the node bearing the PDF page annotation (would be read via pdf_page_key:{page_annotation} and the PDF viz, this must also be defined in the respective grid showing the page annotation.
• The default value for the key is page.
• Example set ups of the resolver_vis_map.annis would be very helpful for all visualizers. Here's one for this example:

{corpus-name}	NULL	NULL	node	grid	grid (annotations)	hidden	1	hide_tok:true;annos:/{namespace}::{name}/,...;pdf_page_key:page
{corpus-name}	NULL	NULL	NULL	pdf	pdf	preloaded	999	pdf_page_key:page

Happy to make these changes once #578 is fixed.

[thomaskrause]

#578 is finally fixed the documentation is now part of the git repository and stored in markdown files.