Sample Visual-Meta

The text below contains most of the current and possible elements of a Visual-Meta appendix, including the description which follows next, which is also part of every Visual-Meta, in order to make it easy to implement and use:

@description {
This appendix to the document is called Visual-Meta. The purpose is to add useful metadata to the document in order that the reader software can provide useful interactions to the user, such as letting the user copy as citation, fold the document into a table of content and more
It is based on the academic BibTex citation information standard in LaTeX with added (optional) JOSN to describe the document you are reading, in order to enable rich interactions which are otherwise stripped from the document when exported to PDF or other delivery documents.
The way reader software looks for Visual-Meta in the PDF is to parse it from the end of the document and look for the @{visual-meta-end} tag. If this is found, the software then looks for the @{visual-meta-start} tag and uses the data found between these marker tags.
The introductory section, @visual-meta, specifies which version of Visual-Meta is used, followed by what software generated the Visual-Meta. This can be the software which created the document: ‘generator’ or software which appended the Visual-Meta onto the back of a previously created document, which would be labeled ‘appended by’. For example, our ‘Reader’ application looks for a DOI on the first page of the document if no Visual-Meta is found, and asks the user for permission to resolve the DOI into a BibTeX entry which can be inserted into the document.
The first informational section is usually prefaced by @article for articles/papers or @book for books. The difference is useful to determine how to display the document, for example, in our ‘Reader’ software @book opens to a single front page in full screen. This section further includes standard BibTeX information which should be appended to the clipboard/copy space when copying any text from the document, in order to allow the software–for example a word processor–the user pastes into to paste as a full citation, which the software can then automatically list in a Reference section on export.
>The above is core and the following is optional<
The @headings section is in the format and specifies what text in the document is a heading, what level heading it is as well as the name of the author for that section, if the section was authored by someone else than other than the main document, in the following way{“name”:”Heading “Name, “level”:”level2, “author”:”Author “Name}. This is valid until a following section is marked as being authored by someone else.
This information should also be added when copying text from that section, to allow the pasted citation to correctly cite the author.
@glossary This sections lists what terms are in the glossary.
Feel free to add your own tags but please describe them in this introduction section in order for others to derive value from them now and in the future.
This was written March 2021 by Frode Alexander Hegland. More information is available from https://visual-meta.info or from emailing frode@hegland.com Visual-Meta was initially implemented in the ‘Author’ word processor and the ‘Reader’ PDF viewer: https://www.augmentedtext.info
}


@{visual-meta-start}
@visual-meta{ version = {1.0},
generator = {Author 6.5 (948)}, }

@book{
author = {Manguel, Alberto},
title = {A Reader on Reading},
year = {2019},
isbn={9780300163049},
location = {Yale, USA},
copyright = {IEEE},
numpages = {320},
publisher = {Yale University Press},
keywords = {words, reading},
abstract = {In this major collection…},
abstractiveSumm = {In this major collection…},
extractiveSumm = {In this major collection…},

@headings{
<json>
[
{“name”:”Contents”, “level”:”level1″},
{“name”:”1 Introduction (4-6 pages)”, “level”:”level1″},
{“name”:”1.1 Research Aim”, “level”:”level2, “author”:”Section Author Name”},
{“name”:”1.2 Positionally”, “level”:”level2″},
{“name”:”1.3 Research”, “level”:”level2″},
]
</json>
}

@glossary {
<json>
[
“Author”,
“Paratexts”,
“Reader”,
“Visual-Meta” ]}
</json>
}

@semantic{
<json>
{
“people”:
[
{
“name”: “Ted Nelson”,
“documentPage”: 2,
“rectangle”: “{0,0,100,30}”
}
],
“places”:
[
{
“name”: “The Hague”,
“latitude”: “52.0705° N”,
“longitude”: “4.3007° E”
}
]
}
</json>
}


@{visual-meta-end}