Inhaltsübersicht bearbeiten

Mit dem outline Operation-Element lässt sich die Inhaltsübersicht des Dokuments ändern.

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<operation xmlns="http://schema.webpdf.de/1.0/operation">
<outline>

  <add>

    <item path="/Kapitel 1/Seite 250"

           pathPosition="inplace"

           itemName="3D Ansicht"

           isOpen="false"

           bold="false"

           italic="true"

           color="#0000FF">

      <goTo>

        <fitWidth page="4"

                  top="796"

                   metrics="px"/>

      </goTo>

       <goTo3DView index="0">

         <annotation name="3D1"

                    page="5"/>

       </goTo3DView>

    </item>

  </add>

</outline>
</operation>

{
"outline": {

  "add": {

     "item": [

       {

         "path": "/Kapitel 1/Seite 250",

         "pathPosition": "inplace",

         "itemName": "3D Ansicht",

        "isOpen": false,

        "bold": false,

        "italic": true,

         "color": "#0000FF",

         "actions": [

           {

             "goTo": {

               "destination": {

                "fitWidth": {

                   "page": 4,

                   "top": 796,

                   "metrics": "px"

                 }

               }

             }

           },

           {

             "goTo3DView": {

               "index": 0,

              "annotation": {

                 "name": "3D1",

                 "page": 5

               }

             }

           }

         ]

       }

     ]

   }
 }
}

 

 

outline-Element

 

Erlaubt das Bearbeiten der Inhaltsstruktur eines PDF-Dokuments (dessen Bookmarks/Outline). Die Elemente add, remove, clear schließen sich gegenseitig aus.

 

<outline>

 <add .../>

 <remove .../>

 <clear .../>

</outline>

"outline": {

 "add": {

  item: [...]

 },

 "remove": {

  item: [...]

 },

 "clear": {...}
}

 

 

add-Element

 

Erlaubt das Hinzufügen von Einträgen der Inhaltsstruktur eines PDF-Dokuments (dessen Bookmarks/Outline).

 

Die Einträge werden als flache Liste ohne Verschachtelungen angegeben.

Die erwartete Baumstruktur entsteht durch Auflösung der in den "item" Elementen angegebenen Pfade. Die Einträge werden in ihrer Reihenfolge im "add" Element erzeugt. Elternelemente, die im Pfad angegeben sind, aber noch nicht in der Inhaltsstruktur vorhanden sind, werden automatisch ebenfalls ergänzt. Knoten, die bereits in der Inhaltsstruktur existieren, werden mit den hier enthaltenen Werten aktualisiert.

Das "add" Element fügt einer bestehenden Inhaltsstruktur neue Elemente hinzu und erstellt sie nicht von Grund auf neu. Die Angabe bestehender Einträge, die nicht bearbeitet werden sollen, ist daher nicht nötig.

Die Pfade der Elemente setzen sich aus den durch Slash (/) abgetrennten sichtbaren Namen der Einträge in der Inhaltsstruktur zusammen.

Verfügt das Dokument noch nicht über eine Inhaltsstruktur, so wird diese mit gegebenem Inhalt erstellt.

 

Dieses Element kann eine beliebige Anzahl von "item" Elementen enthalten.

 

<add>

 <item .../>

 <item .../>

</add>

"add": {

 "item": [

   {...},

   {...}

 ]

}

 

 

item-Element (für das Hinzufügen von Einträgen (add))

 

Gibt sämtliche gewünschten Eigenschaften eines zu erschaffenden Eintrags der Inhaltsstruktur an, inklusive der von ihm ausgelösten Aktionen.

 

Ein Eintrag kann die angegebenen Unterelemente in beliebiger Anzahl und Reihenfolge enthalten. Alle Unterelemente repräsentieren eine Art von Aktion, die bei Klick auf den Eintrag ausgelöst und nacheinander abgearbeitet werden.

 

<item path="/Kapitel 1/Seite 250"

     pathPosition="inplace"

     itemName="3D Ansicht"

     isOpen="false"

     bold="false"

     italic="true"

     color="#0000FF"/>

 <goTo .../>

 <launchApplication .../>

 <resolveURI .../>

 <playSound .../>

 <hideAnnotation .../>

 <executeNamed .../>

 <submitForm .../>

 <resetForm .../>

 <importSchema .../>

 <executeJavaScript .../>

 <setLayerState .../>

 <setTransition .../>

 <goTo3DView .../>

 <goToThread .../>

</item>

"item": {

 "path": "/Kapitel 1/Seite 250",

 "pathPosition": "inplace",

 "itemName": "3D Ansicht",

"isOpen": false,

"bold": false,

"italic": true,

 "color": "#0000FF",

 "actions": [

   {

     "goTo": {...},

     "launchApplication": {...},

     "resolveURI": {...},

     "playSound": {...},

     "hideAnnotation": {...},

     "executeNamed": {...},

     "submitForm": {...},

     "resetForm": {...},

     "importSchema": {...},

     "executeJavaScript": {...},

     "setLayerState": {...},

     "setTransition": {...},

     "goTo3DView": {...},

     "goToThread": {...}

   }

 ]

}

 

path (Default: "")

Die Pfade der Elemente setzen sich aus den durch Slash (/) abgetrennten sichtbaren Namen der Einträge in der Inhaltsstruktur zusammen, beginnend mit einem initialen Slash.

 

pathPosition (Default: "inPlace")

Selektiert die Position, auf der der Eintrag erstellt werden soll. Abhängig von diesem Wert wird der in "path" übergebene Pfad interpretiert.

before = Ein Eintrag wird auf gleicher Ebene vor dem Eintrag erzeugt, der über "path" angewählt wurde.

inplace = Der Eintrag, der über "path" angewählt wurde, wird als Elternelement behandelt und enthält den neu erzeugten Eintrag.

after = Ein Eintrag wird auf gleicher Ebene nach dem Eintrag erzeugt, der über "path" angewählt wurde.

 

itemName (Default: "")

Der Name des neuen Eintrags der Inhaltsstruktur, der relativ zum gewählten Pfad platziert werden soll.

 

isOpen (Default: "false")

Wird dieser Wert auf true gesetzt, so ist dieses Element bei Öffnen des Dokuments bereits expandiert.

 

bold (Default: "false")

Wird dieser Wert auf true gesetzt, so wird der Name des Elements mit erhöhter Schriftstärke angezeigt.

 

italic (Default: "false")

Wird dieser Wert auf true gesetzt, so wird der Name des Elements kursiv angezeigt.

 

color (Default: "#000000")

Stellt die Farbe ein, mit der der Name des Elements angezeigt wird. Die Angabe erfolgt in RGB-Werten.

 

 

goTo-Element(Action)

 

Das goTo-Element springt zu einem bestimmten Ort (destination) des Dokuments. Das goTo-Element repräsentiert eine auslösbare Aktion. Es kann nur ein einziges Unterelement vorhanden sein. Die angegebenen Unterelemente repräsentieren jeweils eine bekannte Ortsbestimmung im Dokument, zu der gesprungen werden kann.

 

<goTo>

 <zoomPage .../>

 <fitPage .../>

 <fitWidth .../>

 <fitHeight .../>

 <fitRectangle .../>

 <fitBoundingBox .../>

 <fitBoundingBoxWidth .../>

 <goToNamed .../>

</goTo>

"goTo": {

 "destination": {

   "zoomPage": {...},

   "fitPage": {...},

   "fitWidth": {...},

   "fitHeight": {...},

   "fitRectangle": {...},

   "fitBoundingBox": {...},

   "fitBoundingBoxWidth": {...},

   "goToNamed": {...}

 }

}

 

 

zoomPage-Element (Destination)

 

Das zoomPage-Element ist eine Ortsangabe innerhalb des Dokuments. Es springt zu einer Seite des Dokuments und wählt einen Sichtbereich und eine Vergrößerung für die Anzeige.

 

<zoomPage page="1"

        leftOffset="15"

         topOffset="20"

         zoom="50"

         metrics="px"/>

"zoomPage": {

 "page": 1,

 "leftOffset": 15,

 "topOffset": 20,

 "zoom": 50,

 "metrics": "px"

}

 

page (Default: "1")

Die Seite des Dokuments, auf die gesprungen werden soll.

 

leftOffset (Default: "0")

Der Abstand des sichtbaren Bereichs vom linken Seitenrand.

 

topOffset (Default: "0")

Der Abstand des sichtbaren Bereichs vom oberen Seitenrand.

 

metrics (Default: "px")

Gibt die Maßeinheit an, in der die maximalen Größen angegeben werden.

mm = Millimeter

px = Pixel

 

zoom (Default: "0")

Legt den Wert für die Vergrößerung fest (dies ist ein prozentualer Wert).

 

 

fitPage-Element (Destination)

 

Das fitPage-Element ist eine Ortsangabe innerhalb des Dokuments. Es springt zu einer Seite des Dokuments und wählt eine Vergrößerung, die dazu geeignet ist, den gesamten Seitenbereich anzuzeigen.

 

<fitPage page="1"/>

"fitPage": {

 "page": 1

}

 

page (Default: "1")

Die Seite des Dokuments, auf die gesprungen werden soll.

 

 

fitWidth-Element (Destination)

 

Das fitWidth-Element ist eine Ortsangabe innerhalb des Dokuments. Es springt zu einer Seite des Dokuments und wählt eine Vergrößerung, die dazu geeignet ist, die gesamte Breite der Seite anzuzeigen.

 

<fitWidth page="1"

         topOffset="20"

         metrics="px"/>

"fitWidth": {

 "page": 1,

 "topOffset": 20,

 "metrics": "px"

}

 

page (Default: "1")

Die Seite des Dokuments, auf die gesprungen werden soll.

 

topOffset (Default: "0")

Der Abstand des sichtbaren Bereichs vom oberen Seitenrand.

 

metrics (Default: "px")

Gibt die Maßeinheit an, in der die maximalen Größen angegeben werden.

mm = Millimeter

px = Pixel

 

 

fitHeight-Element (Destination)

 

Das fitHeight-Element ist eine Ortsangabe innerhalb des Dokuments. Es springt zu einer Seite des Dokuments und wählt eine Vergrößerung, die dazu geeignet ist, die gesamte Höhe der Seite anzuzeigen.

 

<fitHeight page="1"

          leftOffset="15"

          metrics="px"/>

"fitHeight": {

 "page": 1,

 "leftOffset": 15,

 "metrics": "px"

}

 

page (Default: "1")

Die Seite des Dokuments, auf die gesprungen werden soll.

 

leftOffset (Default: "0")

Der Abstand des sichtbaren Bereichs vom linken Seitenrand.

 

metrics (Default: "px")

Gibt die Maßeinheit an, in der die maximalen Größen angegeben werden.

mm = Millimeter

px = Pixel

 

 

fitRectangle-Element (Destination)

 

Das fitRectangle-Element ist eine Ortsangabe innerhalb des Dokuments. Es springt zu einer Seite des Dokuments und wählt eine Vergrößerung, die möglichst geeignet ist, um ein Rechteck anzuzeigen, das durch Angabe der Abstände von den Seitenrändern entsteht.

 

<fitRectangle page="1"

            leftOffset="15"

            bottomOffset="20"

            rightOffset="15"

             topOffset="20"

             metrics="px"/>

"fitRectangle": {

 "page": 1,

 "leftOffset": 15,

 "bottomOffset": 20,

 "rightOffset": 15,

 "topOffset": 20,

 "metrics": "px"

}

 

page (Default: "1")

Die Seite des Dokuments, auf die gesprungen werden soll.

 

leftOffset (Default: "0")

Der Abstand des sichtbaren Bereichs vom linken Seitenrand.

 

bottomOffset (Default: "0")

Der Abstand des sichtbaren Bereichs vom unteren Seitenrand.

 

rightOffset (Default: "0")

Der Abstand des sichtbaren Bereichs vom rechten Seitenrand.

 

topOffset (Default: "0")

Der Abstand des sichtbaren Bereichs vom oberen Seitenrand.

 

metrics (Default: "px")

Gibt die Maßeinheit an, in der die maximalen Größen angegeben werden.

mm = Millimeter

px = Pixel

 

 

fitBoundingBox-Element (Destination)

 

Das fitBoundingBox-Element ist eine Ortsangabe innerhalb des Dokuments. Es springt zu einer Seite des Dokuments und wählt eine Vergrößerung, die dazu geeignet ist, den gesamten Inhaltsbereich anzuzeigen.

 

<fitBoundingBox page="1"/>

"fitBoundingBox": {

 "page": 1

}

 

page (Default: "1")

Die Seite des Dokuments, auf die gesprungen werden soll.

 

 

fitBoundingBoxWidth-Element (Destination)

 

Das fitBoundingBoxWidth-Element ist eine Ortsangabe innerhalb des Dokuments. Es springt zu einer Seite des Dokuments und wählt eine Vergrößerung, die dazu geeignet ist, die gesamte Breite des Inhaltsbereichs anzuzeigen.

 

<fitBoundingBoxWidth page="1"

                    topOffset="20"

                    metrics="px"/>

"fitBoundingBoxWidth": {

 "page": 1,

 "topOffset": 20,

 "metrics": "px"

}

 

page (Default: "1")

Die Seite des Dokuments, auf die gesprungen werden soll.

 

topOffset (Default: "0")

Der Abstand des sichtbaren Bereichs vom oberen Seitenrand.

 

metrics (Default: "px")

Gibt die Maßeinheit an, in der die maximalen Größen angegeben werden.

mm = Millimeter

px = Pixel

 

 

goToNamed-Element (Destination)

 

Das goToNamed-Element ist eine Ortsangabe innerhalb des Dokuments. Es springt zu einem benannten und bereits definierten Ort des Dokuments. (Dieses Element erlaubt lediglich die Referenzierung auf, aber nicht die Neudefinition des Ortes.)

 

<goToNamed name="Ansicht1"/>

"goToNamed": {

 "name": "Ansicht1"

}

 

name (Default: "Ansicht1")

Der Name des Ortes, an den gesprungen werden soll.

 

 

launchApplication-Element (Action)

 

Das launchApplication-Element öffnet bei Anwahl eine andere Applikation oder ein anderes Dokument. Das Unterelement "applicationPath" ist erforderlich, "launchParameters" sind optional.

 

<launchApplication newWindow="userPreference">

 <applicationPath .../>

 <launchParameters .../>

</launchApplication>

"launchApplication": {

 "newWindow": "userPreference"

}

 

newWindow (Default: "userPreference")

Wählt das Fenster, in dem die Applikation/das Dokument geöffnet werden soll.

 

userPreference = Nutze die Variante, die in der darstellenden Applikation üblich oder vom Nutzer eingestellt ist.

newWindow = Erzwinge das Öffnen der Anwendung oder des Dokuments in einem neuen Fenster.

sameWindow = Versuche (wenn möglich), das Dokument im aktuellen Fenster der darstellenden Applikation zu öffnen.

 

 

applicationPath-Element

 

Gibt Ort und grundsätzliche Parameter für das Ausführen einer Applikation oder das Öffnen eines Dokuments an.

 

<applicationPath volatileFile="false"

                description="eine Applikation"

                resourceURL="C:/some/file.app"/>

</applicationPath>

"applicationPath": {

 "volatileFile": false,

 "description": "eine Applikation",

 "resourceURL": "C:/some/file.app",

}

 

volatileFile (Default: "false")

Wird dieser Wert auf true gesetzt, so ist das angewählte Dokument ständigen Änderungen unterworfen und die darstellende Applikation ist gezwungen, das Dokument stets neu zu laden und nicht zu cachen.

 

description (Default: "")

Eine Beschreibung der Applikation, die geöffnet werden soll.

 

resourceURL (Default: "")

Der Pfad oder die URL der Applikation/des Dokuments. Als Pfadtrenner sollen hier grundsätzlich Slashes genutzt werden. Die Verwendung plattformspezifischer Zeichen ist potentiell möglich, aber nicht empfohlen. Ein jedes dieser plattformspezifischen Zeichen ist in diesem Fall über einen vorangestellten Backslash '\' zu markieren.

 

 

launchParameters/windows-Element

 

Gibt für die Ausführung einer Applikation zusätzliche Argumente an und selektiert die Datei in einer plattformspezifischen Art. (Andere Betriebssysteme außer Microsoft Windows werden für diese Argumentübergabe bisher nicht unterstützt.)

 

<launchParameters>

 <windows fileName="file/file.app"

          directory="C:\some\windows"

          operation="open"

          arguments="/help"/>

</launchParameters>

"launchParameters": {

 "windows": {

  "fileName": "file/file.app",

  "directory": "C:\some\windows",

  "operation": "open",

  "arguments": "/help"

 }

}

 

fileName (Default: "")

Ein Windows-Dateiname in Standard-Windows-Pfadschreibweise. Ist ein Backslash in der Pfadangabe vorhanden, so soll er durch einen weiteren vorangestellten Backslash markiert (escaped) werden.

 

directory (Default: "")

Spezifiziert den Basispfad, von dem aus navigiert werden soll, in Standard-DOS-Syntax.

 

operation (Default: "open")

Gibt die Standardoperation an, die mit dem angegebenen Dokument durchgeführt werden soll.

 

open = Öffne das Dokument.

print = Drucke das Dokument.

 

arguments (Default: "")

Die Argumente, die bei Aufruf an die Applikation übergeben werden sollen.

 

 

resolveURI-Element (Action)

 

Das resolveURI-Element öffnet bei Anwahl eine gegebene URI in einem dafür geeigneten Programm.

 

<resolveURI uri="http://www.softvision.de"/>

"resolveURI": {

"uri": "http://www.softvision.de"

}

 

uri (Default: "")

Eine URI, die aufgelöst und in einem geeigneten Programm angezeigt werden soll.

 

 

playSound-Element (Action)

 

Das playSound-Element gibt bei Anwahl die angegebenen Audiodaten wieder.

 

<playSound sound="LOkBjn...XrT8h2YY2"

          volume="100"

          synchronous="true"

          repeat="false"

          mix="false"

          samplingRate="8000"

          soundChannels="1"

          sampleSize="8"

          encoding="Raw"/>

"playSound": {

"sound": "LOkBjn...XrT8h2YY2",

"volume": 100,

"synchronous": true,

"repeat": false,

"mix": false,

"samplingRate": 8000,

"soundChannels": 1,

"sampleSize": 8,

"encoding": "Raw"

}

 

sound-Element

Die Audiodatei, die wiedergegeben werden soll. Die Datei muss als BASE64-codierter Wert übergeben werden. Die übergebene Datei muss absolut eigenständig sein und vollständig alle Informationen und Daten enthalten, die zu ihrer Wiedergabe nötig sind. Die Audioformate AIFF, AIFF-C, RIFF (*.wav), snd(*.au) werden beispielsweise unterstützt.

 

volume (Default: "100")

Eine Gleitkommazahl zwischen 100 und -100, die die Lautstärke der Audiowiedergabe konfiguriert. (Dies ist ein prozentualer Wert.)

 

synchronous (Default: "false")

Wird dieser Wert auf true gesetzt, soll das darstellende Programm eine absolut synchrone und ungestörte Wiedergabe der Tonspur gewährleisten und somit während des Spielzeitraums weitere Nutzerinteraktionen außer dem Abbruch der Wiedergabe unterbinden.

 

repeat (Default: "false")

Wird dieser Wert auf true gesetzt, soll die Wiedergabe der Audiospur endlos wiederholt werden.

 

mix (Default: "false")

Wird dieser Wert auf true gesetzt, soll die Wiedergabe der Audiospur gleichzeitig mit anderen Audiospuren möglich sein. Wird dieser Wert auf false gesetzt, so werden alle bereits spielenden Audiospuren vorher gestoppt.

 

samplingRate (Default: "8000")

Die Sample Rate in Samples pro Sekunde.

 

soundChannels (Default: "1")

Die Anzahl der Audiokanäle.

 

sampleSize (Default: "8")

Die Anzahl der Bits pro Sample pro Audiokanal.

 

encoding (Default: "Raw")

Das Encoding der Audiodatei. Mögliche Werte sind: Raw, Signed, muLaw, ALaw

 

 

hide-Element (Action)

 

Das hide-Element blendet bei Anwahl die selektierten Annotationen aus oder ein.

 

<hideAnnotation hide="true">

 <annotation .../>

</hideAnnotation>

"hideAnnotation": {

"hide": true,

 [

  "annotation": {...}

 ]

}

 

hide (Default: "true")

Legt fest, ob die gewählten Annotationen aus- oder eingeblendet werden sollen.

 

 

executeNamed-Element (Action)

 

Die executeNamed-Aktion führt eine vorbereitete Aktion aus, die der darstellenden Applikation unter einem bestimmten Namen bekannt ist. Es gibt einige Standardaktionen, die jeder darstellenden Applikation bekannt sein sollen, allerdings kann eine Applikation jederzeit weitere Namen definieren.

Die Ausführung der Aktionen und deren Wirkung wird allein durch die darstellende Applikation definiert, daher kann sich das Verhalten hier durchaus unterscheiden.

 

<executeNamed namedOperation="NextPage"/>

"executeNamed": {

 "namedOperation": "NextPage"

}

 

namedOperation (Default: "")

Der Name der Aktion, die ausgeführt werden soll. Vorgegebene Namen, die einer darstellenden Applikation grundsätzlich bekannt sein sollten, sind:

 

NextPage = Springe auf die nächste Seite

PrevPage = Springe auf die vorhergehende Seite

FirstPage = Springe auf die erste Seite

LastPage = Springe auf die letzte Seite

 

 

submitForm-Element (Action)

 

Die submitForm-Aktion sendet bei Anwahl die Namen und Werte aller angewählten Formularfelder an die angegebene URL (Uniform Resource Locator). Das "field"-Element darf beliebig oft enthalten sein.

 

<submitForm url="http://softvision.de"

           exclude="false"

          includeNoValueFields="false"
           exportFormat="false"
           getMethod="false"

           submitCoordinates="false"

          xfdf="false"

          includeAppendSaves="false"

           includeAnnotations="false"

           submitPDF="false"

          canonicalFormat="false"

          excludeNonUserAnnotations="false"

          excludeFDFSourceOrTargetFile="false"

          embedForm="false">

 <field .../>

</submitForm>

"submitForm": {

 "url": "http://softvision.de",

 "exclude": false,

 "includeNoValueFields": false,

 "exportFormat": false,

 "getMethod": false,

 "submitCoordinates": false,

 "xfdf": false,

 "includeAppendSaves": false,

 "includeAnnotations": false,

 "submitPDF": false,

 "canonicalFormat": false,

 "excludeNonUserAnnotations": false,

 "excludeFDFSourceOrTargetFile": false,

 "embedForm": false,

"field": [

   {...}

 ]

}

 

url (Default: "")

Die URL, an die die Daten übermittelt werden sollen.

 

exclude (Default: "false")

Wenn true, dann sollen alle Formularfelder außer den angewählten exportiert werden. Bei einem Wert von false ausschließlich die angewählten.

 

includeNoValueFields (Default: "false")

Wenn true, dann sollen auch Formularfelder exportiert werden, die noch nicht ausgefüllt wurden/keinen Wert enthalten.

 

exportFormat (Default: "false")

Dieser Wert ist nur relevant, wenn "submitPDF" und "xfdf" nicht gesetzt sind. Wenn dieser Wert auf true gesetzt wird, dann werden die Daten als HTML-Formular exportiert, andernfalls werden sie im *.fdf (Forms Data Format) exportiert.

 

getMethod (Default: "false")

Dieser Wert ist nur relevant, wenn "exportFormat" ebenfalls gesetzt und verwendet wird. In diesem Fall bestimmt dieser Wert darüber, ob Namen und Werte mittels HTTP GET- (true) oder mittels HTTP POST- (false) Anfragen übermittelt werden.

 

submitCoordinates (Default: "false")

Dieser Wert ist nur relevant, wenn "exportFormat" ebenfalls gesetzt und verwendet wird. In diesem Fall bestimmt dieser Wert darüber, ob die Position des Mausklicks, der den Export ausgelöst hat, ebenfalls Teil des Exports sein soll.

 

xfdf (Default: "false")

Dieser Wert ist nur relevant, wenn "submitPDF" nicht gesetzt wird. In diesem Fall bestimmt dieser Wert darüber, ob die Daten im XFDF-Format übermittelt werden sollen.

 

includeAppendSaves (Default: "false")

Dieser Wert ist nur relevant, wenn die Daten im FDF-Format übermittelt werden sollen. In diesem Fall bestimmt dieser Wert darüber, ob die übermittelten Daten sämtliche inkrementellen Änderungen an den Formulardaten abbilden.

 

includeAnnotations (Default: "false")

Dieser Wert ist nur relevant, wenn die Daten im FDF-Format übermittelt werden sollen. In diesem Fall bestimmt dieser Wert darüber, ob die gesetzten Markup-Annotationen in den übermittelten Daten enthalten sein sollen.

 

submitPDF (Default: "false")

Wenn dieser Wert gesetzt wird, dann werden die Daten als PDF-Datei übermittelt.

 

canonicalFormat (Default: "false")

Wenn dieser Wert gesetzt wird, dann werden sämtliche Daten und Uhrzeiten in ein kanonisches Standardformat überführt, soweit möglich.

 

excludeNonUserAnnotations (Default: "false")

Dieser Wert ist nur relevant, wenn die Daten im FDF-Format übermittelt werden sollen und "includeAnnotations" gesetzt ist. In diesem Fall bestimmt dieser Wert darüber, ob die übermittelten Daten ausschließlich die vom ausfüllenden Nutzer gesetzten Annotation (true) oder sämtliche Annotationen enthalten sein sollen (false).

 

excludeFDFSourceOrTargetFile (Default: "false")

Dieser Wert ist nur relevant, wenn die Daten im FDF-Format übermittelt werden sollen. In diesem Fall bestimmt dieser Wert darüber, ob die URL im Export enthalten sein soll, an die die Daten übermittelt werden.

 

embedForm (Default: "false")

Dieser Wert ist nur relevant, wenn die Daten im FDF-Format übermittelt werden sollen. In diesem Fall bestimmt dieser Wert darüber, ob die PDF-Datei, die das Formular enthält, in die übermittelten Daten integriert werden soll.

 

 

resetForm-Element (Action)

 

Die resetForm-Aktion leert die  Werte aller angewählten Formularfelder. Das "field"-Element darf beliebig oft enthalten sein.

 

<resetForm exclude="false">

 <field .../>

</resetForm>

"resetForm": {

 "exclude": false

 "field": [

   {...}

 ]

}

 

exclude (Default: "false")

Wenn true, dann sollen alle Formularfelder außer den angewählten exportiert werden. Bei einem Wert von false ausschließlich die angewählten.

 

 

field-Element

 

Selektiert ein Formularfeld zur Bearbeitung.

 

<field name="Vorname"/>

"field": [

 {

   "name": "Vorname"

 }

]

 

name (Default: "")

Der Name des selektierten Formularfeldes.

 

 

importSchema-Element (Action)

 

Die importSchema-Aktion ersetzt die  Werte aller Formularfelder durch die Werte in einer entsprechenden Formular-Datei.

 

<importSchema>

 <file .../>

</importSchema>

"importSchema": {

 "file": {...}

}

 

file-Element

 

Gibt den Speicherort einer Datei an.

 

<applicationPath volatileFile="false"

                description="eine Applikation"

                resourceURL="C:/some/file.app"/>

</applicationPath>

"applicationPath": {

 "volatileFile": false,

 "description": "eine Applikation",

 "resourceURL": "C:/some/file.app",

}

 

volatileFile (Default: "false")

Wird dieser Wert auf true gesetzt, so ist das angewählte Dokument ständigen Änderungen unterworfen und die darstellende Applikation ist gezwungen, das Dokument stets neu zu laden und nicht zu cachen.

 

description (Default: "")

Eine Beschreibung der Applikation, die geöffnet werden soll.

 

resourceURL (Default: "")

Der Pfad oder die URL der Applikation/des Dokuments. Als Pfadtrenner sollen hier grundsätzlich Slashes genutzt werden. Die Verwendung plattformspezifischer Zeichen ist potentiell möglich, aber nicht empfohlen. Ein jedes dieser plattformspezifischen Zeichen ist in diesem Fall über einen vorangestellten Backslash '\' zu markieren.

 

 

executeJavaScript-Element (Action)

 

Die executeJavaScript-Aktion führt übergebenen JavaScript-Code aus.

 

<executeJavaScript jsAction="JS-CODE"/>

"executeJavaScript": {

 "jsAction": "JS-CODE",

}

 

jsAction (Default: "")

Ein String, der alle nötigen JavaScript-Anweisungen enthält. Referenzen auf Bibliotheken und externe Definitionen sind insoweit gültig, als der PDF-Standard sie unterstützt und die darstellende Applikation entsprechende Schnittstellen anbietet.

 

 

setLayerState-Element (Action)

 

Die setLayerState schaltet die Sichtbarkeit der selektierten Dokumentenebenen auf den gewünschten Wert.

 

<setLayerState>

 <layerState .../>

</setLayerState>

"setLayerState": {

 [

   "layerState": {...}

]

}

 

 

LayerState-Element

 

Das LayerState-Element schaltet die Sichtbarkeit der selektierten Dokumentenebenen auf den gewünschten Wert.

 

<layerState state="ON">

 <referencedLayer name="Annotationen"/>

</layerState>

"layerState": {

 "state": "ON",

[

   "referencedLayer": {

     "name": "Annotationen"

  }

 ]

}

 

state (Default: "ON")

Die Statusänderung, die bei Anwahl durchgeführt werden soll.

 

ON = Die Ebene/n wird/werden eingeblendet.

OFF = Die Ebene/n wird/werden ausgeblendet.

Toggle = Die Ebenensichtbarkeit wird umgeschaltet.

 

referencedLayer-Element

Ein "layerState"-Element kann 1 bis n "referencedLayer"-Elemente enthalten, die je eine Dokumentenebene anwählen.

 

name

Der Name der Ebene, die angewählt werden soll.

 

 

setTransition-Element

 

Die setTransition-Aktion blendet die Änderungen, die aus den Aktionen resultieren, unter Verwendung der definierten Übergangsanimation ein.

 

<setTransition scaling="100"

              effectDimensionHorizontal="true"

              motionInward="true"

              flyAreaOpaque="true"

              flyscale="50"

              direction="leftToRight"

              style="blinds"

              duration="2.0"/>

"setTransition": {

 "scaling": 100,

"effectDimensionHorizontal": true,

"motionInward": true,

"flyAreaOpaque": true,

"flyscale": 50,

"direction": "leftToRight",

"style": "blinds",

"duration": 2.0,

}

 

scaling (Default: "100")

Legt den Wert für die Vergrößerung fest (dies ist ein prozentualer Wert).

 

effectDimensionHorizontal (Default: "true")

Option für die Animationsstile Split und Blinds - bestimmt die Achse, entlang der der Effekt ausgeführt werden soll. True wählt die horizontale, false die vertikale Achse.

 

motionInward (Default: "true")

Option für die Animationsstile Split, Box und Fly - bestimmt, ob die Animationsrichtung von den Seitenrändern in Richtung Seitenmitte (true) oder von der Seitenmitte in Richtung Ränder (false) ausgeführt werden soll.

 

flyAreaOpaque (Default: "false")

Option für den Animationsstil "fly" - bestimmt, ob der Seitenhintergrund der einfliegenden Seite initial durchsichtig sein soll.

 

flyScale (Default: "100")

Option für den Animationsstil "fly" - bestimmt die Anfangsskalierung der einfliegenden Seite, aus der sie fließend auf die Größe der angezeigten Seite skaliert wird (dies ist ein prozentualer Wert).

 

direction (Default: "leftToRight")

 Die Richtung der Übergangsanimation (sofern auf die Animation anwendbar).

 leftToRight = Von links nach rechts

 bottomToTop = Von unten nach oben

 rightToLeft = Von recht nach links

 topToBottom = Von oben nach unten

 topLeftToBottomRight = Von oben links nach unten rechts

 none = Nutze den Standardwert für die Animation

 

style (Default: "none")

Der Stil der Übergangsanimation.

blinds = Überblenden

box = In Rechteck überblenden

cover = Überdecken

dissolve = Auflösen

fade = Verblassen

fly = Seite einfliegen

glitter = Seite auflösen und ersetzen

push = Seite aus dem Bild schieben

split = Seite zerteilen

uncover = Seite aufdecken

wipe = Umblättern

none = Kein besonderer Effekt

 

duration (Default: "1.0")

Die Dauer der Seiten-Übergangsanimation in Sekunden. Zu hohe Werte sollten vermieden werden, da einige Anzeigeprogramme erzwingen, dass die komplette Animation angezeigt wird, ohne Möglichkeit, sie zu unterbrechen. Andererseits kann eine zu lange Animation zu Darstellungs- und Ausführungsfehlern im Anzeigeprogramm führen. Werte unter 10 Sekunden sind empfehlenswert.

 

 

goTo3DView-Element (Aktion)

 

Die goTo3DView-Aktion springt bei Anwahl zu einer bestimmten Ansicht eines 3D-Objekts (einer 3D-Annotation).

 

<goTo3DView index="2"

          name="Frontalansicht"

           relative="Last">

 <annotation .../>

</goTo3DView>

"goTo3DView": {

 "index": 2,

"name": "Frontalansicht",

"relative": "Last",

 [

  "annotation": {...}

 ]

}

 

index

Der Index der Ansicht der 3D-Annotation. Dieser Wert ist alternativ zu "name" und "relative" und muss nicht gesetzt werden, wenn einer dieser Werte gegeben wurde.

 

name

Der Name der Ansicht der 3D-Annotation. Dieser Wert ist alternativ zu "index" und "relative" und muss nicht gesetzt werden, wenn einer dieser Werte gegeben wurde.

 

relative

Eine Ansicht der 3D-Annotation, die relativ zur aktuell präsentierten Ansicht definiert wurde. Dieser Wert ist alternativ zu "name" und "index" und muss nicht gesetzt werden, wenn einer dieser Werte gegeben wurde.

 

First = Die erste Ansicht der 3D-Annotation.

Last = Die letzte Ansicht der 3D-Annotation.

Next = Die nächste Ansicht der 3D-Annotation.

Previous = Die vorhergehende Ansicht der 3D-Annotation.

Default = Die Standard-Ansicht der 3D-Annotation.

 

 

annotation-Element

 

Das Annotation-Element dient der Anwahl von Annotationen des Dokuments, die modifiziert werden sollen. Der Name des enthaltenden "annotations"-Containers ist abhängig vom Definitionskontext. Der Container kann 0 bis n "annotation"-Elemente enthalten, die wie folgt definiert sind.

 

<annotation page="1"

           index="2"

           name="Underline01"/>

"annotation": {

 "page": 1,

"index": 2,

"name": "someAnnot"

}

 

 

page (Default: "1")

Die Seitennummer der Seite, auf der sich die Annotation befindet.

 

index

Der Index der Annotation im Annotationsverzeichnis der Seite. Dieser Wert ist alternativ zum Annotationsnamen und muss nicht gesetzt werden, wenn ein Annotationsname gegeben wurde.

 

name

Der Name der Annotation im Annotationsverzeichnis der Seite. Dieser Wert ist alternativ zum Annotationsindex und muss nicht gesetzt werden, wenn ein Annotationsindex gegeben wurde.

 

 

goToThread-Element (Aktion)

 

Die goToThread-Aktion springt bei Anwahl zu einem bestimmten im Dokument definierten Artikel.

 

<goToThread threadIndex="2"

          threadTitle="Artikel 1"

           page="1"

           beadIndex="3">

</goTo3DView>

"goToThread": {

 "threadIndex": 2,

"threadTitle": "Artikel 1",

 "page": 1,

 "beadIndex": 3,

}

 

threadIndex

Der Index des Artikels im Artikelverzeichnis des Dokuments, zu dem gesprungen werden soll. Dieser Wert ist alternativ zu "threadTitle" und muss nicht gesetzt werden, wenn dieser Wert gegeben wurde.

 

threadTitle

Der Titel des Artikels, zu dem gesprungen werden soll. Dieser Wert ist alternativ zu "threadIndex" und muss nicht gesetzt werden, wenn dieser Wert gegeben wurde.

 

beadIndex

Der Index des Abschnitts des Artikels, zu dem gesprungen werden soll. Dieser Wert ist optional und muss nicht angegeben werden.

 

page (Default: "1")

Die Seitennummer der Seite, auf der sich der Artikel befindet.

 

 

remove-Element

 

Erlaubt das Entfernen von Einträgen der Inhaltsstruktur eines PDF-Dokuments (dessen Bookmarks/Outline).

 

Die Einträge werden als flache Liste ohne Verschachtelungen angegeben.

Die erwartete Baumstruktur wird durch Auflösung der in den "item"-Elementen angegebenen Pfade abgeleitet. Die Einträge werden in ihrer Reihenfolge im "remove"-Element entfernt.

Die Pfade der Elemente setzen sich aus den durch Slash (/) abgetrennten sichtbaren Namen der Einträge in der Inhaltsstruktur zusammen.

Wird ein Element entfernt, das über Untereinträge verfügt, so werden auch diese entfernt. Wird ein Eintrag entfernt, der in einem anderen Knoten enthalten ist, so bleibt das enthaltende Element bestehen.

 

Dieses Element kann eine beliebige Anzahl von "item" Elementen enthalten.

 

<remove>

 <item .../>

</remove>

"remove": {

 "item": [

   {...}

 ]

}

 

 

item-Element (Für das Entfernen von Einträgen (remove))

 

Selektiert Einträge der Inhaltsstruktur anhand ihres Pfades, um diese aus der Inhaltsstruktur des Dokuments zu entfernen.

 

<item path="/Kapitel 1/Seite 250/3D Ansicht"/>

"item": [

 {

   "path": "/Kapitel 1/Seite 250/3D Ansicht"

 }

]

 

path (Default: "")

Die Pfade der Elemente setzen sich aus den durch Slash (/) abgetrennten sichtbaren Namen der Einträge in der Inhaltsstruktur zusammen.

 

 

clear-Element

 

Entfernt alle Einträge der Inhaltsstruktur und die Wurzel der Inhaltsstruktur selbst, benötigt daher keine weitere Konfiguration.

 

<clear/>

"clear": {}