Annotationen einfügen

Mit dem annotation Operation-Element lassen sich verschiedene Anmerkungen (Annotationen) dem Dokument hinzufügen.

 

add-Operation

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<operation xmlns="http://schema.webpdf.de/1.0/operation">
<annotation>
  <add>
    <markup creator="SVD"
            name="Textmarkierung"
            subject="ein Thema"
            contents="Textinhalt"
            intents="Textmarkierung"
            opacity="75"
            hidden="false"
            invisible="false"
            locked="false"
            printable="true"
            color="#640000"
            rotatable="true"
            viewable="true"
            writable="true"
            zoomable="false"
            markupType="highlight">
      <pathElement coordinates="user"
                    metrics="mm"
                    x="156"
                    y="5"
                    width="50"
                    height="10"/>
    </markup>
    <text creator="SVD"
          name="Notiz"
          subject="ein Thema"
          contents="Textinhalt"
          intents="Textnotiz"
          opacity="75"
          hidden="false"
          invisible="false"
          locked="false"
          printable="true"
          color="#640000"
          rotatable="true"
          viewable="true"
          writable="true"
          zoomable="false"
          icon="newParagraph"
          initialOpen="true"/>
  </add>
</annotation>
</operation>

{
"operation": {
  "toolbox": [
     {
      "annotation": {
        "add": {
          "markup": [
             {
              "creator": "SVD",
              "name": "Textmarkierung",
              "subject": "ein Thema",
              "contents": "Textinhalt",
              "intents": "Textmarkierung",
              "opacity": 75,
              "hidden": false,
              "invisible": false,
              "locked": false,
              "printable": true,
              "color": "#640000",
              "rotatable": true,
              "viewable": true,
              "writable": true,
              "zoomable": false,
              "markupType": "highlight",
              "pathElement": [
                 {
                  "coordinates": "user",
                  "metrics": "mm",
                  "x": 156,
                  "y": 5,
                  "width": 50,
                  "height": 10
                 }
               ]
             }
           ],
          "text": [
             {
              "creator": "SVD",
              "name": "Notiz",
              "subject": "ein Thema",
              "contents": "Textinhalt",
              "intents": "Textnotiz",
              "opacity": 75,
              "hidden": false,
              "invisible": false,
              "locked": false,
              "printable": true,
              "color": "#640000",
              "rotatable": true,
              "viewable": true,
              "writable": true,
              "zoomable": false,
              "icon": "newParagraph",
              "initialOpen": true
             }
           ]
         }
       }
     }
   ]
 }
}

 

 

add-Element

 

<add>
 <markup creator="SVD"
        name="Textmarkierung"
        subject="ein Thema"
        contents="Textinhalt"
        intents="Textmarkierung"
        opacity="75"
        hidden="false"
        invisible="false"
        locked="false"
        printable="true"
        color="#640000"
        rotatable="true"
        viewable="true"
        writable="true"
        zoomable="false"
        markupType="highlight">
  <pathElement .../>
</markup>    
</add>

"add": {
"markup": [
   {
    "creator": "SVD",
    "name": "Textmarkierung",
    "subject": "ein Thema",
    "contents": "Textinhalt",
    "intents": "Textmarkierung",
    "opacity": 75,
    "hidden": false,
    "invisible": false,
    "locked": false,
    "printable": true,
    "color": "#640000",
    "rotatable": true,
    "viewable": true,
    "writable": true,
    "zoomable": false,
    "markupType": "highlight",
    "pathElement": [...]
   }
 ]

}

 

In dem add-Element können einer oder mehrere Elemente angegeben werden die Annotation enthalten. Zulässige Elemente sind:

 

text

markup

 

Alle Annotations-Elemente haben einige gemeinsame Basis-Attribute, die nachfolgend aufgeführt sind.

 

creator (Default: "")

 Stellt den Verfasser dieser Annotation ein.

 

name (Default: "")

 Stellt einen Namen für diese Annotation ein.

 

subject (Default: "")

Stellt das Thema dieser Annotation ein.

 

contents (Default: "")

Dieser Wert konfiguriert den textuellen Inhalt der Annotation, welcher in starker Abhängigkeit vom Annotationstypen dargestellt wird. (Im Fall einer Textnotiz wäre dies zum Beispiel der Textinhalt des Popups der Annotation.)

 

intents (Default: "")

Stellt die Beschreibung der Intention dieser Annotation ein.

 

opacity (Default: 100)

Ein prozentualer Wert der die Transparenz der Annotation festlegt.

 

hidden (Default: false)

Wenn dieser Wert auf true gesetzt wird, wird die Annotation weder auf der Seite zu sehen sein, noch gedruckt werden.

 

invisible (Default: false)

Wenn dieser Wert auf true gesetzt wird, wird die Annotation nur dann auf der Seite sichtbar sein, sofern es sich um eine PDF Standardannotation handelt, wenn sie gedruckt wird.

 

locked (Default: false)

Wenn dieser Wert auf true gesetzt wird, wird die Annotation gegen Änderungen gesperrt.

 

printable (Default: false)

Wenn dieser Wert auf true gesetzt wird, wird die Annotation auf Ausdrucken der Seite sichtbar sein.

 

color (Default: "#4800FF")

Der Farbwert der Annotation ändert die Hauptfarbe sichtbarer Annotationen. Der Farbwert wird als hexadezimaler RGB-Wert mit voran gestelltem Hash-Zeichen angegeben.

 

viewable (Default: true)

Wenn dieser Wert auf true gesetzt wird, wird die Annotation auf der Seite des Dokuments angezeigt werden.

 

writable (Default: true)

Wenn dieser Wert auf true gesetzt wird, können die Inhalte der Annotation nachträglich geändert werden.

 

zoomable (Default: true)

Wenn dieser Wert auf true gesetzt wird, wird die Annotation ihren eigenen Zoomfaktor an den der Seite anpassen, um stets gut erkennbar zu bleiben.

 

 

Es folgen die individuelle Annotations-Elemente mit ihren Attributen.

 

 

text-Element

 

Eine Annotation, die einer Seite ein Notiz Icon hinzufügt, das einen Text in einem Popup anzeigen kann.

 

<text
    ...
    icon="newParagraph"
    initialOpen="true"/>

"text": [
         {
           ...
          "icon": "newParagraph",
          "initialOpen": true
         }
       ]

 

icon (Default: true)

Gibt das Symbol an, dass für diese Notiz auf der Seite angezeigt werden soll. Die folgenden Werte stehen zur Verfügung:

 

comment = Kommentar

key = Schlüssel

note = Textnotiz

help = Hilfe

newParagraph = Neuer Absatz

paragraph = Absatz

insert = Text einfügen

 

initialOpen (Default: false)

Ist dieser Wert auf "true" gesetzt wird das Popup der entsprechenden "Notiz" Annotation sofort geöffnet, wenn die entsprechende Seite des Dokuments betrachtet wird.

 

 

markup-Element

 

Eine Annotation die eine oder mehrere Textzeilen markiert.

 

<markup

       ...
      markupType="highlight">

 <pathElement coordinates="user"
              metrics="mm"
              x="156"
              y="5"
              width="50"
              height="10"/>
</markup>

"markup": [
 {
   ...
  "markupType": "highlight",
  "pathElement": [
     {
      "coordinates": "user",
      "metrics": "mm",
      "x": 156,
      "y": 5,
      "width": 50,
      "height": 10
     }
   ]
 }
]

 

markupType (Default: true)

Stellt die Art der Text-Markierung ein. Die folgenden Werte stehen zur Verfügung:

 

highlight = Text hervorheben

underline = Text unterstreichen mit gerader Linie

strikeOut = Text durchstreichen

squiggly = Text unterstreichen mit gewellter Linie

 

 

pathElement-Element

 

Gibt die Position des zu markierenden Textes als eine Folge von Rechtecken, die durch "pathElement" definiert werden, an. Der Eintrag kann mehrfach vorkommen und jedes Rechteck markiert hierbei zum Beispiel eine Zeile Text.

 

<pathElement coordinates="user"
            metrics="mm"
            x="156"
            y="5"
            width="50"
            height="10"/>

"pathElement": [
 {
  "coordinates": "user",
  "metrics": "mm",
  "x": 156,
  "y": 5,
  "width": 50,
  "height": 10
 }
]

 

x (Default: 0)

X-Position des Rechtecks.

 

y (Default: 0)

Y-Position des Rechtecks.

 

width (0)

Breite des Rechtecks

 

height (0)

Höhe des Rechtecks

 

coordinates (Default: "user")

Legt das Koordinatensystem für die Angaben fest.

user = User-Koordinatensystem (Ausgangspunkt links-oben)

pdf = PDF-Koordinatensystem (Ausgangspunkt links-unten)

 

metrics (Default: "mm")

Maßeinheit für die Angaben der X/Y-Position und der Höhe und Breite des Rechtecks:

mm = Millimeter

px = Pixel