OASIS Darwin Information Typing Architecture (DITA) TC

 View Only
  • 1.  Groups - DITA Proposed Feature #12013 Referencing a range of elements (conrefrange.html) uploaded

    Posted 09-25-2007 16:44
    Hello TC members,
    
    This proposal has been updated but is is not the final version and will not
    ready for a vote til we have a side meeting and can close the issues around
    processing. 
    
    At least one more draft will go out prior to a vote.
    
    
    
     -- Ms. Yas Etessam
    
    The document revision named DITA Proposed Feature #12013 Referencing a
    range of elements (conrefrange.html) has been submitted by Ms. Yas Etessam
    to the OASIS Darwin Information Typing Architecture (DITA) TC document
    repository.  This document is revision #2 of ConrefRange.html.
    
    Document Description:
    HTML version of DITA Proposed Feature #12013 Referencing a range of
    elements
    
    View Document Details:
    http://www.oasis-open.org/apps/org/workgroup/dita/document.php?document_id=25393
    
    Download Document:  
    http://www.oasis-open.org/apps/org/workgroup/dita/download.php/25393/conrefrange.html
    
    Revision:
    This document is revision #2 of ConrefRange.html.  The document details
    page referenced above will show the complete revision history.
    
    
    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
    


  • 2.  RE: [dita] Groups - DITA Proposed Feature #12013 Referencing a range of elements (conrefrange.html) uploaded

    Posted 09-25-2007 18:14
     
    
    > 


  • 3.  RE: [dita] Groups - DITA Proposed Feature #12013 Referencing a range of elements (conrefrange.html) uploaded

    Posted 09-25-2007 21:00
    Well I'm glad to hear that the proposal is moving into a better
    direction.  Thank you for the useful feedback and suggestions.
    
    > With the singleton approach, I suggest we continue with
    > "the first element in the source must be the same
    > type as the start element of the target range" and
    > the rest of the usual conref validation, but we don't
    > do any such validation for the target of the conrefend.
    
    Great suggestion.  After all, there's nothing for the conrefend to be
    compared with in the singleton model.  I agree that the recursive model
    makes much more sense on the singleton model.  
    
    
    > 


  • 4.  RE: [dita] Groups - DITA Proposed Feature #12013 Referencing a range ofelements (conrefrange.html) uploaded

    Posted 09-27-2007 16:34
    Hi Yas,
    
    I've just got a few comments about the proposal before we have a meeting on
    it. Aside from what's below, I have an initial positive impression of
    Paul's suggestion to work purely with singletons, though I probably have
    not thought it through completely yet.
    
    1) "The user must only create ranges on target elements that share the same
    parent element. " -- Does this mean that a source range inside  can
    only be to a target inside ? Or does it just mean that the target
    start/end must be siblings and thus share the same parent node? I think it
    means the latter, but I know the former was discussed a while back.
    
    2) The "Processing behaviors" section seems to state that the domains
    attribute on the source and target topics must be an exact match. That is
    more restrictive than the current restriction on conref, in which
    compatibility is guaranteed when "the list of domains in the referenced
    topic instance (declared on the domains attribute) is the same as or a
    subset of the list of domains in the referencing document" [1]. That is,
    when the source topic has domains="(topic hi-d) (topic sw-d)", target topic
    values of "(topic hi-d)" and "(topic sw-d) (topic hi-d)" should both be
    valid, but requiring an exact match would rule them out. The language here
    should match the existing language for single point conrefs.
    
    3) I don't understand this comment: "Note: The current DITA Open Toolkit
    implementation does not perform validate beyond class and domain matching.
    It is already possible to include invalid content". The toolkit looks for a
    valid subset of domains, rather than an exact match - I think it has always
    done this, though it may have been added in an early release.
    
    4) I also do not quite understand this: "Note: Generalizing on the fly,
    proposal 12012, has been deferred to DITA 1.3..." The specification today
    already says this about conref generalization, in the domains paragraph:
    "In the preferred approach, a processor resolving a conref should tolerate
    specializations of valid elements and generalize elements in the content
    fragment as needed for the referencing context." [1] Deborah Pickett
    contributed code to the toolkit that performs this generalization for
    domain elements -- when conref of a paragraph causes me to pull  into a
    topic that does not allow highlighting, the  is generalized to 


  • 5.  RE: [dita] Groups - DITA Proposed Feature #12013 Referencing a range of elements (conrefrange.html) uploaded

    Posted 09-27-2007 17:48
    fwiw, a couple comments from me on Robert's email below. 
    
    > 


  • 6.  RE: [dita] Groups - DITA Proposed Feature #12013 Referencing a range ofelements (conrefrange.html) uploaded

    Posted 09-27-2007 18:01

    > 1) "The user must only create ranges on target elements that
    > share the same
    > parent element. " -- Does this mean that a source range
    > inside <body> can
    > only be to a target inside <body>?


    One reason for it to mean that would be to avoid situations like allowing conref of a range of elements into a context where only one of them is allowed, or where the range includes elements disallowed in the referencing context. If the parent elements are the same, then the rules of what's allowed in the range are the same.

    With generalization-on-the-fly, the parent element of the range could be a specialization of the parent element of the reference, but it does seem to me that you'd get an important validity guarantee by comparing the parents in the range case. Otherwise conref-with-range would open up a world of referencing invalid content that conref currently prevents. In other words, without a check on the parent element, we would be dramatically loosening the constraints on what conref allows, in just this one place.

    Speaking of which, I think Yas also mentioned:

    >It is already possible to include invalid content

    Is this true? It's definitely not the intent of conref. I thought it was doing a pretty good job of avoiding validation errors. What case were you thinking of?

    Michael Priestley
    Lead IBM DITA Architect
    mpriestl@ca.ibm.com
    http://dita.xml.org/blog/25



    "Grosso, Paul" <pgrosso@ptc.com>

    09/27/2007 01:47 PM

    To
    <dita@lists.oasis-open.org>
    cc
    Subject
    RE: [dita] Groups - DITA Proposed Feature #12013 Referencing a range of elements   (conrefrange.html) uploaded





    fwiw, a couple comments from me on Robert's email below.

    >



  • 7.  RE: [dita] Groups - DITA Proposed Feature #12013 Referencing a range of elements (conrefrange.html) uploaded

    Posted 09-27-2007 18:55
    
    
    
    
    
    
    
    
    
    
    

    I think the original intention of that statement was to ensure that the two target elements were siblings, so that you couldn’t conref to <li>s in two different lists or conref to unbalanced ranges. Michael brings up a good point though, that validation of the innards of the range must be ensured. Checking the parent element of both the source and the targets could provide this validation.

    Another option would be to restrict all the element siblings in the range to be all of the same type e.g. all <li>s or all <step>s etc. This would prevent users from creating a conref to the following types of ranges (from x -> y):

    <b id=”x”>Some bold text</b><mySpecialisedElement>Some non-bold </mySpecialisedElement> text<b id=”y”>More bold</b>

    This is probably be too restrictive to be useful though.

    Michael.

    From: Michael Priestley [mailto:mpriestl@ca.ibm.com]
    Sent: September 27, 2007 11:00
    To: Grosso, Paul
    Cc: dita@lists.oasis-open.org
    Subject: RE: [dita] Groups - DITA Proposed Feature #12013 Referencing a range of elements (conrefrange.html) uploaded


    > 1) "The user must only create ranges on target elements that
    > share the same
    > parent element. " -- Does this mean that a source range
    > inside <body> can
    > only be to a target inside <body>?


    One reason for it to mean that would be to avoid situations like allowing conref of a range of elements into a context where only one of them is allowed, or where the range includes elements disallowed in the referencing context. If the parent elements are the same, then the rules of what's allowed in the range are the same.

    With generalization-on-the-fly, the parent element of the range could be a specialization of the parent element of the reference, but it does seem to me that you'd get an important validity guarantee by comparing the parents in the range case. Otherwise conref-with-range would open up a world of referencing invalid content that conref currently prevents. In other words, without a check on the parent element, we would be dramatically loosening the constraints on what conref allows, in just this one place.

    Speaking of which, I think Yas also mentioned:

    >It is already possible to include invalid content

    Is this true? It's definitely not the intent of conref. I thought it was doing a pretty good job of avoiding validation errors. What case were you thinking of?

    Michael Priestley
    Lead IBM DITA Architect
    mpriestl@ca.ibm.com
    http://dita.xml.org/blog/25


    "Grosso, Paul" <pgrosso@ptc.com>

    09/27/2007 01:47 PM

    To

    <dita@lists.oasis-open.org>

    cc

    Subject

    RE: [dita] Groups - DITA Proposed Feature #12013 Referencing a range of elements   (conrefrange.html) uploaded




    fwiw, a couple comments from me on Robert's email below.

    >


    > From: Robert D Anderson [mailto:robander@us.ibm.com]
    > Sent: Thursday, 2007 September 27 11:34
    > To: Yas Etessam
    > Cc: dita@lists.oasis-open.org
    > Subject: RE: [dita] Groups - DITA Proposed Feature #12013
    > Referencing a range of elements (conrefrange.html) uploaded
    >
    > Hi Yas,
    >
    > I've just got a few comments about the proposal before we
    > have a meeting on
    > it. Aside from what's below, I have an initial positive impression of
    > Paul's suggestion to work purely with singletons, though I
    > probably have
    > not thought it through completely yet.
    >
    > 1) "The user must only create ranges on target elements that
    > share the same
    > parent element. " -- Does this mean that a source range
    > inside <body> can
    > only be to a target inside <body>? Or does it just mean that
    > the target
    > start/end must be siblings and thus share the same parent
    > node? I think it
    > means the latter, but I know the former was discussed a while back.

    I think it means the latter, and this is irrelevant if we
    go with the singleton model (which is one big advantage of
    the singleton model).

    >
    > 2) The "Processing behaviors" section seems to state that the domains
    > attribute on the source and target topics must be an exact
    > match. That is
    > more restrictive than the current restriction on conref, in which
    > compatibility is guaranteed when "the list of domains in the
    > referenced
    > topic instance (declared on the domains attribute) is the same as or a
    > subset of the list of domains in the referencing document"
    > [1]. That is,
    > when the source topic has domains="(topic hi-d) (topic
    > sw-d)", target topic
    > values of "(topic hi-d)" and "(topic sw-d) (topic hi-d)"
    > should both be
    > valid, but requiring an exact match would rule them out. The
    > language here
    > should match the existing language for single point conrefs.

    I agree that we should (and, I assumed, meant to) match what
    happens for single point conrefs in this regard.

    paul



  • 8.  RE: [dita] Groups - DITA Proposed Feature #12013 Referencing a range of elements (conrefrange.html) uploaded

    Posted 09-27-2007 19:13
    Yes, the intent is to match the same processing rules as single point
    conref.
    
    Deborah asked for more information about processing to be explicitly
    spelled out in the proposal.  Maybe it is appropriate to cut that back
    down to a core assumption about inheriting similar processing rules,
    rather than my poor (and clearly inaccurate) attempt to describe the
    actual processing rules.
    
    
    > 


  • 9.  RE: [dita] Groups - DITA Proposed Feature #12013 Referencing a range of elements (conrefrange.html) uploaded

    Posted 09-27-2007 19:13
    
    >