ZedAI DTBook Conversion

From zedwiki

Jump to: navigation, search

Contents

Attributes

alt/longdesc

Could someone post an example of an acceptable way to represent an image with both 
alternate text and a long description?  For example, would this work?

<object src="myimage.png" desc="image-desc-01"> <p>A sunset at the beach</p> </object>
<description id="image-desc-01">
   <p>The sky is pink, the sun low in the sky, there are three birds on the shore, the tide 
      is low, and the sun is about to set.</p>
</description>

Where object/p is the alt text and description is the long desc.

Or do you think it's preferable to put both as direct children of object?

There is currently no way to retain the long/short description length difference in the description.

Child elements of an object represent an implied author's content description, so embedding a short description is not possible. Each description must have a unique role attribute, so it is also not possible to include two descriptions for the same purpose.

Discussions ongoing on how to rectify...

Update: "When translating image attributes, @alt should use @ref/desc, and @longdesc should use diagram project constructs."

title

In DTBook, @title is one of the core attributes.  It is described as "advisory title or
amplification of the element " [1]. 

I don't see any equivalent in ZedAI.

This attribute is not being ported forward.

widths/heights

Is there a way to express image height and width? 
I don't see any attributes or @role values.

Height, width and other style properties are best addressed by an attached CSS stylesheet. See Attaching Stylesheets

page front/normal/special

When going from dtbook:pagenum to zedai:pagebreak, there does not seem to be a translation
for @page=front|normal|special.  I also don't see anything in the pagination vocabulary.

These attributes don't provide information pertinent to the pagebreak. The pagebreak's context is determined by its position in the front/body/back matter.

link attributes

When going from dtbook:a to zedai:ref, the following attributes need to be mapped (or agreed to be dropped):

 * @type (a mime type)
 * @hreflang (langcode for the href target)
 * @accesskey
 * @tabindex

These attributes will not be ported forward.

cite attribute

Both dtbook:blockquote and dtbook:q have an optional attribute @cite, which contains a URI.  In ZedAI, the equivalent element for both blockquote and q is quote.  It can have a child citation element, which must be non-empty, and which may contain @xlink:href.  How to express the original @cite attribute?  E.g.:

DTBook source example:
<q cite="http://example.org/an-internet-comment-thread">This product is the best ever!</q>

ZedAI possibility:

<quote>This product is the best ever! <citation xlink:href="http://example.org/an-internet-comment-thread">http://example.org/an-internet-comment-thread</citation></quote>

table, td, th attributes

Looking for the appropriate ZedAI equivalents for these attributes

* <table>: @summary @frame @rules
* <td> @abbr @axis
* <th> @axis
  • @abbr, @axis: legacy attributes that aren't getting carried forward
  • @summary:
[Matt] @summary is still around and could be useful, but my first thought is it
looks sort of like a specialized kind of annotation or description. I'm not
a big fan of prose in attributes for all the commonly-cited reasons, so I'd
prefer if we could find some other way to accommodate.

[Romain]
FYI, @summary is listed as an obsolete non-conforming feature by HTML5
[1], and the spec suggests a list of techniques for describing tables
instead [2]. Maybe we can get take some hints from this list.
[1] http://dev.w3.org/html5/spec-LC/obsolete.html#attr-table-summary
[2] http://dev.w3.org/html5/spec-LC/tabular-data.html#table-descriptions-techniques

[Matt] Use annotation for @summary

  • @frame, @rules:
[Matt]
@frame and @rules are probably better done with CSS (putting aside any
porting pain that may cause).

[Marisa]
Could @frame ("identifies the sides that are visually framed.") and
@rules ("identifies where visual rulings appear.") be expressed with
something like CSS border?  If they are in use, they might be
incorporated in a later revision of DTBook to ZedAI.

annotation ref attribute

dtb:annotation has no @ref but zedai:annotation (phrase variant) requires it

Anchor floating annotations to their parent section element. Leave temporary annotation indicating that this has been done.

Elements

address

Here is a question about DTBook's address element, which has no like element in ZedAI.  
What role would you give it?  Would you say that "publisher-address" is accurate or 
not even close?  In the DAISY 3 structure guidelines [1], dtbook:address is described as:

"The address element may be used by authors to supply contact information for a 
document or a major part of a document such as a form."

And in ZedAI, the "publisher-address" vocabulary term [2] is given as:

"The publisher's address, which can be abbreviated to city and postal code only."

They don't necessarily seem equivalent, but then again, the description for 
publisher-address is not very elaborate

The publisher-address is intended for the address found on the title page verso; it is not intended for addresses in general.

One of the current issues with addresses is that they require dual-nature terms in order to indicate first that the element represents an address and second the nature of the address.

Update: use the 'address' element in ZedAI

br

Is there an equivalent of dtbook:br?  zedai:transition does not seem appropriate for inline use, and a line break isn't a pagebreak either.

Here is a sample DTBook use case, taken from the [http://www.daisy.org/z3986/structure/SG-DAISY3/part2-inline.html#br structure guidelines entry for br]:

<p>Now, listen to the rhythm as you say the poem again (da = short 
    beat; dum =  stressed beat). Here is the beat: </p>
<p>da dum da/ da dum da /da dum (3 feet)<br/> 
    da dum da /da dum da /da dum (3 feet)<br/> 
    da dum da /da dum (2 feet)<br/> 
    da dum da /da dum (2 feet)<br/> 
    da dum da /da dum da /da dum (3 feet)</p>

Answer: use the ln element in ZedAI to mark lines.

byline

In the structure guidelines [1], it says 
"A byline contains information about the creator of or contributor to a work, 
usually consisting of more than just an author's name. ". 

In ZedAI, there is no identical element, so I would use zedai:p, which is fairly neutral.  
I looked at the available @role values, and found that "contributor" was maybe the 
closest thing.  There is also "byline" in the articles vocabulary, but I am concentrating 
on books, so I wasn't planning on using this vocabulary.  Do you think that ZedAI 
<p role="contributor"> sounds reasonable for DTBook <byline> or would you use a 
different approach?

The DTBook byline is somewhat loose in its interpretation of a byline. Bylines typically only appear in articles and occasionally anthologies between the headline/title and story.

For photo credits, the citation element should be used with the object.

For bylines in anthologies, the Periodicals Vocabulary contains a term that can be used.

author/docauthor/doctitle/covertitle

In DTBook, a poem or cite element may have a child element "author". 
Would you use DC metadata and RDFa to express this in ZedAI?
1. dtbook:docauthor becomes zedai:p @property="dc:author"

We are not sure whether to use @property or @role. 
If we use dublin core, does that imply that we should also use RDFa?

2. dtbook:doctitle becomes zedai:h @role="title" or zedai:h @property="dc:title"

Similar issue as above

3. dtbook:covertitle becomes zedai:block @role="covertitle"

The RDFa property attribute should be used to indicate the author and other properties related to the document.

When the author/title/etc. are contained in elements in the front or body matter, the RDFa property attribute can be used to identify them:

<p property="author">Charles Darwin</p>

These properties apply to the document when no other subject is specified.

For the author of quotes and subsections within a document, the property attribute must be used in conjunction with an about attribute that identifies the relationship:

<quote xml:id="q1">
   <p>...</p>
   <citation about="#q1"><name property="author">Charles Darwin</name>, 
         <span property="title">On the Origin of Species</span></citation>
</quote>

The DTBook author should be replaced by ZedAI's citation and/or name elements depending on the context in which it's been used.

Terms from the Z39.86-2011 RDF Vocabularies should always be used in preference to external vocabularies. The Structural Semantics Vocabulary includes author and title terms.

The cover title can be included in the cover element:

<cover>
   <frontcover>
        <block role="covertitle">
            <ln><name>Charles Darwin</name></ln>
            <ln>Die Entstehung der Arten</ln>
        </block>
   </frontcover>
</cover>

dateline

As far as I can tell, the element dtbook:dateline has no ZedAI element or role equivalent. 
Is this intended to be handled in a particular way, i.e. via RDFa / dcterms 'date'?

The ZedAI element set includes a time element for dates:

<p>Dated <time value="1858-01-12">January 12, 1858</time></p>

The articles profile includes also includes a dateline term:

<p><span role="dateline">NEW YORK (AP)</span> ...</p>

kbd

DTBook has special markup for mentioning keyboard keys, e.g.

<p>To copy the selection to the clipboard, press <kbd>CTRL+C</kbd>.</p>

There is no direct ZedAI equivalent, but <code> seems like the closest match. 
From its description [1]: 

"intended for general instances of code as found in works of fiction and similar
non-technical documents, which includes computer programming code, commands and 
command input/output"

Are keyboard keys considered command input?  Could I write this in ZedAI?

<p>To copy the selection to the clipboard, press <code>CTRL+C</code></p>

Yes, the code element is a general-purpose element intended for these situations. A more comprehensive computer programming module is desirable but will not be part of the initial release.

samp

For dtbook:samp, do you think zedai:p @role="practice" is a good translation?  

To recap, dtbook:samp is defined as [1] "A sample of work created by the author used 
as an example or template within the text."

And zedai @role="practice" is [2]: "A review exercise or sample"

In everyday language, I wouldn't think that the terms meant the same thing.
However, the definitions seem to overlap.

Samp as html’s terminal output is consumed by the ZedAI code element. Development of a more comprehensive computer code module is currently an open issue.

An example term has been added to cover this use case, so the general use aspect of the DTBook element can be expressed as:

<block role=”example”>
   <p>...</p>
</block>

Content rendering

If you have a DTBook element with @render= optional | required, what would you call it in ZedAI? 
I don't see anything about skippability in the spec/schema doc/vocab.

The notion of skippability of content from DTBook has been removed from ZedAI, as it is a rendering feature not an authoring. A ZedAI document reflects the content and structure of the book. Content that may be optional or not necessary in an output or when navigating an output should be dealt with in transforming the document to that output and/or by systems that read/consume the output.

If content may change depending on the output, however, the Content Selection feature can be used.

Metadata

In DTBook-2005, the following terms are defined under our "dtb:" prefix:

* sourceDate
* sourceEdition
* sourcePublisher
* sourceRights
* sourceTitle
* multimediaType
* multimediaContent
* narrator
* producer
* producedDate
* revision
* revisionDate
* revisionDescription
* totalTime
* audioFormat

When going from DTBook to ZedAI, it seems that many of these terms don't have an equivalent, especially those relevant to republishing (producer, multimedia, narrator).  

I've skimmed MODS, ONIX, MARC21 and not found equivalents, but these are huge specifications, so before I go through them again, I thought I'd ask here if anyone has already looked into it.

For sourceDate, sourcePublisher, sourceRights, and sourceTitle, I think I'll rename them dc:Date, dc:Publisher, dc:Rights, and dc:Title, and attach them via RDFa to dc:Source 
(assuming that info is provided), unless there is a better way to express this in ZedAI.
Personal tools