Best Practices zum Erstellen von XFA-basierten Formularen mit LiveCycle Designer

Vorausgesetzte Kenntnisse

Einige frühere Erfahrungen mit dem Entwerfen von XFA-basierten Formularen mit Adobe LiveCycle Designer sind wünschenswert.

Anwenderebene

Alle

In diesem Artikel werden einige der Best Practices zum Erstellen von LiveCycle-Formularen mit LiveCycle Designer erläutert. Dies gilt nicht für eine bestimmte Version von LiveCycle Designer und sollte nicht als schrittweise Anleitung zum Erstellen von Formularen betrachtet werden. Es werden allerdings allgemeine Verfahren zur Verbesserung und Standardisierung von Prozessen dargestellt. Bevor Sie diese Best Practices umsetzen, stellen Sie sicher, dass diese in Ihre Gesamtstrategie für die Entwicklung von Formularen und zu Ihren organisatorischen Anforderungen passen.

Die Festlegung von Best Practices und deren Umsetzung in Verfahren sind eine permanente Aktivität, da Einzelpersonen und Teams Erfahrungen mit der Erstellung von Formularen sammeln.

Designlayout

Wichtige Aspekte jedes LiveCycle-Formulars sind seine Gestaltung und sein Layout. Diese legen fest, wie einfach oder schwierig es für Benutzer ist, mit dem Formular zu interagieren. Idealerweise sollte ein Formular lesbar, übersichtlich, logisch angeordnet und einfach zu verwenden sein.

Beachten Sie beim Entwerfen eines Formularlayouts die folgenden Vorgehensweisen:

  • Halten Sie das Design einfach.
  • Minimieren Sie die Anzahl der Felder. Sie können auch erwägen, Beschriftungen hinzuzufügen und die Felder in komplexen Formularen zu nummerieren.
  • Verwenden Sie den richtigen Typ von numerischen, Text- und Datumsfeldern, um die Dateneingabe zu erleichtern.
  • Verwenden Sie keine Animationen, es sei denn, dies ist unbedingt erforderlich.
  • Verwenden Sie Schriftarten, die von allen Geräten gelesen und wie gewünscht wiedergegeben werden können.
  • Wählen Sie Schriftarten, die es Acrobat ermöglichen, Zeichen in Unicode-Text zu extrahieren, damit sie mit einer Bildschirmlesehilfe gelesen werden können, oder um Text für einen Braille-Drucker zu speichern.
  • Verwenden Sie an den passenden Stellen Leerzeichen, um den logischen Fluss des Formulars anzuzeigen.
  • Verwenden Sie Seitensätze, um die Reihenfolge und Sichtbarkeit der Seiten im Formularentwurf zu steuern.
  • Verwenden Sie die Tab-Reihenfolge, um das Wechseln von einem Feld zu einem anderen zu ermöglichen.
  • Verwenden Sie aus Konsistenzgründen Vorlagen, anstatt ein Formular komplett neu zu gestalten,
  • Verwenden Sie Stilkataloge, um Objekte in einem Formularentwurf zu bearbeiten und Stile darauf anzuwenden. Dadurch wird eine einheitliche Formatierung innerhalb eines Formulars oder über mehrere Formulare hinweg sichergestellt.

Namenskonventionen

Ein weiterer wichtiger Aspekt bei der Standardisierung von Prozessen zum Erstellen von Formularen ist die Einhaltung einer Namenskonvention. Wenn Sie Ausdrücke des Skriptobjektmodells (SOM) zum Verweisen auf Objekte verwenden, ist es umso wichtiger, einfache und standardisierte Namenskonventionen zu befolgen.

Namenskonventionen sind in der Regel organisationsspezifisch und sollten daher unter Berücksichtigung der Anforderungen festgelegt werden, bevor die Entwicklung von Formularen beginnt.

Die folgenden Best Practices unterstützen Sie beim Festlegen von Standards für Namenskonventionen:

  • Achten Sie auf die Formulardesignobjekte und Variablennamen in Ihrem Formular.
  • Verwenden Sie anstelle der Standardnamen beschreibende Namen für Objekte, um die Funktion oder die Verwendung des Objekts zu beschreiben.
  • Vermeiden Sie die Verwendung der Namen von Eigenschaften, Funktionen und Objekten des XML-Formularobjektmodells für Formularentwurfsobjekte und Variablen.
  • Wählen Sie die Feldnamenskonventionen, die sich von den Namenskonventionen für das XML-Formularobjektmodell unterscheiden, um Namenskonflikte zu vermeiden.
  • Verwenden Sie für jedes Objekt im Formular unterschiedliche Namen, um Namenskonflikte zu vermeiden.
  • Halten Sie den Objektnamen kurz, wenn ein 2D-Barcode verwendet wird, um den Lauftext im Barcode zu vermeiden.

Wiederverwendbarkeit von Komponenten

Um die Erstellung von Formularen zu beschleunigen und gleichzeitig den Aufwand zu minimieren, sollten Sie das Anlegen von Vorlagen und wiederverwendbaren Formularkomponenten in Erwägung ziehen. Diese Vorlagen und wiederverwendbaren Komponenten können ein guter Ausgangspunkt für die schnelle Erstellung neuer Formulare und die Freigabe von Komponenten zwischen mehreren Formularen sein. Dies ermöglicht ein nahtloses und skalierbares Formularmodell innerhalb eines Unternehmens. Darüber hinaus hilft es Ihrem Unternehmen bei der Standardisierung von Formularen.

In den folgenden Listen werden einige der Best Practices für die Wiederverwendung von Komponenten aufgezeigt:

  • Verwenden Sie nach Möglichkeit Formularvorlagen, anstatt Formulare von Grund auf neu zu erstellen.
  • Verwenden Sie die Designer-Funktion „Dokument importieren“, um Formulare aus anderen Formularerstellungstools wie Acrobat, Microsoft Word oder Microsoft Excel in Designer zu importieren.
  • Verwenden Sie häufiger die Paletten „Objektbibliothek“ und „Fragmentbibliothek“, um vorhandene Objekte und Fragmente in Ihrem Formular zu verwenden.
  • Nutzen Sie Fragmente, um die Erstellung und Wartung einer großen Anzahl von Formularen zu beschleunigen. Fragmente sind wiederverwendbare Abschnitte, z. B. ein Adressblock oder ein Logo, die Sie in einer wiederverwendbaren Objektbibliothek speichern können. Eine Objektbibliothek kann ein einzelnes Feld, eine Gruppe von Feldern, eine Seite oder nur ein Skript enthalten.

Skripterstellung und -leistung

Designer-Skripte und -Berechnungen können die Funktionen von Formularen erweitern, um eine umfassende Benutzererfahrung zu bieten. Obwohl die meisten Verbesserungen mit verschiedenen Funktionen in Designer vorgenommen werden können, sind einige Formularentwickler mit der Skripterstellung besser vertraut.

Im Folgenden finden Sie einige Best Practices für die Verwendung von Skripten in Designer:

  • Verwenden Sie Skriptobjekte, um JavaScript-Funktionen und -Werte getrennt von einem bestimmten Formularobjekt zu speichern, das Sie an jedem beliebigen Ereignis im Formular aufrufen können. Dadurch wird der Skripting-Aufwand verringert und eine Duplizierung von Codes vermieden. Sie sollten ein Skript in ein Fragment einfügen, wenn dieses von mehreren Formularen verwendet wird.
  • Vermeiden Sie die Duplizierung des Universally Unique Identifier (UUID), um die Leistung zu verbessern. Doppelte UUIDs werden normalerweise erzeugt, wenn Sie eine XDP von einem Formular in ein anderes kopieren.
  • Verwenden Sie die Funktionen resolveNode() und resolveNodes() mit Bedacht, um Knoten aufzulösen und die gewünschten Informationen abzurufen. Sie können bei unsachgemäßer Verwendung Leistungseinbußen verursachen. Verwenden Sie SOM-Ausdrücke, um mehrere Knoten zurückzugeben.
    Tipp: Halten Sie STRG, und klicken Sie auf ein Objekt, um dessen SOM-Ausdruck zu sehen.
  • Verwenden Sie einen geeigneten impliziten oder expliziten Überprüfungsalgorithmus, wenn Skriptfunktionen mit JavaScript eingesetzt werden.
  • Verwenden Sie zur Fehlerbehebung bei Kodierungsfehlern das JavaScript-Debugging-Tool in Designer oder ein beliebiges Lint-Prüfwerkzeug, z. B.http://www.jslint.com/. Drücken Sie Strg+J in Designer, um den JavaScript-Debugger zu öffnen.
  • Wählen Sie „Tools > Action Builder“, um häufig verwendete interaktive Funktionen in Formularen mit flexiblem Layout ohne Skripting schnell zu erstellen. Sie können sich das Skript jederzeit ansehen und später ändern.
  • Testen Sie das Skript mithilfe der Registerkarte „PDF-Vorschau“ oder in Ihrer Testumgebung.

Barrierefreiheit

Barrierefreiheit ist ein wichtiger Faktor, der beim Entwerfen von XFA-basierten Formularen berücksichtigt werden muss. Die Einhaltung der Barrierefreiheitsstandards stellt sicher, dass Ihr Formular von Benutzern mit Behinderungen besser genutzt werden kann. Die Palette „Barrierefreiheit“ in Designer ermöglicht es Ihnen, die Nutzbarkeit von Formularen für Anwender mit Behinderungen mithilfe von LiveCycle-Formularen und getaggten Formularen zu verbessern.

Alle in diesem Artikel behandelten Punkte tragen zur Erstellung barrierefreier Formulare bei. Achten Sie außerdem auf Folgendes:

  • Fügen Sie QuickInfos in Ihr Formular ein, da die meisten Bildschirmlesehilfen QuickInfos lesen können.
  • Erstellen Sie Formulare, die Eingaben sowohl von einer Tastatur als auch von einer Maus akzeptieren.
  • Vermeiden Sie farbigen Hintergrund.
  • Vermeiden Sie die Verwendung von Auswahlknöpfen, wenn Sie ein Listenfeld verwenden können, da Browser und Bildschirmlesehilfen Auswahlknöpfe inkonsistent behandeln.
  • Verwenden Sie keine komplexen Tabellen.
  • Implementieren Sie die Lese- und Tabulatorbefehle ordnungsgemäß. Dadurch wird sichergestellt, dass Hilfsgeräte in einer bestimmten Reihenfolge durch das Formular navigieren.
  • Verwenden Sie so weit wie möglich Standardobjekte aus der Palette „Objektbibliothek“, um zusätzlichen Aufwand beim Festlegen von Barrierefreiheitseigenschaften zu vermeiden.
  • Fügen Sie alternativer Text zu Bildern hinzu, da Bildschirmlesehilfen Alternativtext lesen können.
  • Stellen Sie sicher, dass die Barrierefreiheit-Tags unter Formulareigenschaften/Speicheroptionen so eingestellt sind, dass Acrobat sie erkennt.
  • Verwenden Sie Kennzeichnungen und Beschriftungen zur Formularsteuerung
  • Testen Sie Ihre Formulare auf Barrierefreiheit, bevor Sie sie veröffentlichen.

Wie geht es weiter?

Wir haben kurz die Best Practices für die Gestaltung von LiveCycle-Formularen besprochen. Weitere Informationen finden Sie unter den Links im Abschnitt „Lesevorschläge“ im gesamten Artikel.

Die Dokumentation und das Referenzmaterial für LiveCycle Designer 10 finden Sie außerdem auf der Seite LiveCycle ES3-Dokumentation.

Auch wenn die Dokumentation die meisten Ihrer Fragen beantworten sollte, zögern Sie nicht, Diskussionen einzuleiten und daran teilzunehmen.