From zedwiki

Contents 1 Z39.98-AI Frequently Asked Questions 1.1 General 1.1.1 Which editors can I use to create Z39.98-AI documents? 1.2 Validation 1.2.1 Where do I find schemas and schema documentation? 1.2.2 How do I validate Z39.98-AI documents? 1.3 Document creation 1.3.1 How do I attach/create a MODS metadata record? 1.3.2 How do I attach a stylesheet? 1.3.3 How do I use namespaces in ZAI documents 1.4 Content creation 1.4.1 How do I add descriptions for content and structures 1.4.2 Do I use RDFa attributes or the role attribute? 1.5 Profile creation 1.5.1 Can I create elements in the ZAI namespace? 1.6 Where do I report bugs or request features?

Z39.98-AI Frequently Asked Questions

General

Which editors can I use to create Z39.98-AI documents?

An (incomplete) list of editors and how to set them up is available at ZedAI_XML_Editors.

(Note that the profile's resource directories contains document templates that you can use as a starting point.)

Validation

Where do I find schemas and schema documentation?

All Z39.98-AI profiles maintained by the Z39.98 advisory committee are listed in the profile catalog at daisy.org. By following the links provided in this catalog, you will find resource directories that contain schemas and schema documentation.

How do I validate Z39.98-AI documents?

If the editor you use does not support complete validation against the normative schemas of the profile, then you can use a standalone validator to check the validity status of your document.

Refer to Validation-only configuration for information on how to set up validation tools for local use.

Note that we also intend to make an online validation service available.

Document creation

How do I attach/create a MODS metadata record?

A general guide outlining MODS metadata records and how to attach them to a Z39.98-AI document is available at ZedAI_MODS_Metadata.

The official MODS site should also be consulted for complete information about the standard and how to create records (including schemas, usage guidelines and primers).

How do I attach a stylesheet?

The Associating Style Sheets with XML documents specification allows CSS stylesheet to be attached to a Z39.98-AI document. A guide to attaching stylesheets is available at ZedAI_Attaching_Stylesheets.

How do I use namespaces in ZAI documents

A quick explanation about the pitfalls of declaring namespaces using the xmlns attribute and why you should declare all your namespace prefixes on the document element, together with a list of the common namespaces and prefixes used in ZAI documents, is available at ZedAI_Using_Namespace_Prefixes.

Content creation

How do I add descriptions for content and structures

A quick guide on how to use the desc attribute and description element to describe images, graphics and structures in Z39.98-AI documents is available at ZedAI_Content_and_Structure_Descriptions.

Do I use RDFa attributes or the role attribute?

A common question when first encountering RDFa for attaching metadata is what the distinction is between the RDFa property attribute and the role attribute, and when each should be used in a ZedAI document. A general rule of thumb is that:

• the property attribute should be used to indicate document properties, such as the title, author, etc. (i.e., information that is typically included in bibliographic metadata records, but some producers also prefer to annotate this information within their documents); and
• the role attribute should be used to add add semantic inflection to elements in the document (e.g., to indicate that a quote represents an epigraph or that a block contains a figure).

The use of RDFa attributes becomes more complex as you move beyond describing general document properties, however, and into describing discrete bits of information within a document. General guidelines for RDFa and role usage are available at ZedAI_RDFa_Usage_Guidelines.

Profile creation

Can I create elements in the ZAI namespace?

There are no restrictions against creating new elements in the ZAI authoring namespace (http://www.daisy.org/ns/z3986/authoring/). Your contributions must, of course, still adhere to the requirements for creating new elements and modules as outlined in the Z39.98 Authoring and Interchange Framework specification.

Adding new elements to this namespace will allow you to avoid prefixing the elements you contribute, which for many authors will simplify the markup process.

If you create a new module or feature for your profile, please consider making your work available to the broader DAISY community by submitting for inclusion in the ZAI Core Modules. Information on how to contact the Committee is available from the DAISY web site at http://www.daisy.org

Where do I report bugs or request features?

The Z39.98-AI working group runs an issue tracker where bugs and feature requests are handled collectively. You can report your issues there.

You can also ask questions at the Z39.98-AI forum.