RE: [dita] Groups - DITA 1.2 spec: CD 01, new topics to review (new-topics-for-review.chm) uploaded

["Bruce Nevin (bnevin)" <bnevin@cisco.com>]

Suggested clarifications to the XHTML formatting conventions topic:

The XHTML version of the specification uses certain formatting
conventions to aid readers in navigating through the specification and
locating material easily: Link previews and navigation links.
==>
To aid readers in navigating through the specification and locating
material easily, the XHTML rendition of the specification, unlike other
renditions, uses certain formatting conventions: Link previews and
navigation links.

These link previews are marked as such and visually highlighted by a
border and a colored background. 
==>
A border and a colored background marks each link preview as such and
highlights it visually.

The links previews are not normative; they contain the content of the
<shortdesc> element for the child topic, which is normatively rendered
as the first paragraph of the child topic. However, the link previews
serve as a usability improvement and enhanced navigation aid, enabling
readers to more easily locate content.
==>
The content of the <shortdesc> element is normatively rendered as the
first paragraph of a topic, as well as being non-normatively rendered as
a link preview to help the reader more easily locate the given topic.
The content is identical in both renditions. This usability enhancement
is one of the ways in which the specification exemplifies the
capabilities of DITA and DITA best practices.

The following screen capture illustrates how link previews are displayed
in the XHTML version of the specification:
==>
The following screen capture of related links illustrates how link
previews are displayed in the XHTML version of the specification:

To ease readers in navigating from one topic to another, each XHTML file
generated by a DITA topic contains the following navigation links at the
bottom:
==>
To make it easier for readers to browse through topics, each XHTML file
generated by a DITA topic contains the following navigation links at the
bottom:

When readers hover over the navigation links, the short description of
the DITA topic also is displayed.
==>
The short description of the DITA topic is displayed when the reader's
mouse cursor hovers over a navigation link of this sort.

> -----Original Message-----
> From: kris@eberleinconsulting.com 
> [mailto:kris@eberleinconsulting.com] 
> Sent: Tuesday, June 08, 2010 10:01 AM
> To: dita@lists.oasis-open.org
> Subject: [dita] Groups - DITA 1.2 spec: CD 01, new topics to 
> review (new-topics-for-review.chm) uploaded
> 
> As we've worked with Mary McRae to get closer to public 
> review, I've added three new topics to the spec:
> 
> * Normative references
> * Non-normative references
> * Formatting conventions used in the XHTML version of the 
> specification
> 
> We need to review and make any necessary changes to these 
> topics before we vote again on CD 01 next week. In 
> particular, we need to refine the topics about normative and 
> non-normative references -- right now they simply are a 
> laundry list of suggestions culled from the TC e-mail list.
> 
> I've built a CHM for convenience in reviewing these topics.
> 
> If you have problems opening the CHM:
> 
> 1. Save the CHM file to your local system. (You cannot view a 
> CHM on a networked drive.) 2. (Windows users) Right-click the 
> CHM file, and then click Properties.
> 3. Click Unblock, and then click OK. The contents now are 
> displayed when the file is opened. 
> 
> See http://support.microsoft.com/kb/902225/ for more information. 
> 
>  -- Kristen Eberlein
> 
> The document named DITA 1.2 spec: CD 01, new topics to review
> (new-topics-for-review.chm) has been submitted by Kristen 
> Eberlein to the OASIS Darwin Information Typing Architecture 
> (DITA) TC document repository.
> 
> Document Description:
> 
> 
> View Document Details:
> http://www.oasis-open.org/committees/document.php?document_id=38164
> 
> Download Document:  
> http://www.oasis-open.org/committees/download.php/38164/new-to
> pics-for-review.chm
> 
> 
> PLEASE NOTE:  If the above links do not work for you, your 
> email application may be breaking the link into two pieces.  
> You may be able to copy and paste the entire link address 
> into the address field of your web browser.
> 
> -OASIS Open Administration
>