Learn how easy it is to sync an existing GitHub or Google Code repo to a SourceForge project! See Demo

Close

#581 `<attRef>` needs better documentation

AMBER
open
Martin Holmes
None
5(default)
2014-11-19
2013-06-24
Martin Holmes
No

As pointed out during the thread starting here on TEI-L:

http://listserv.brown.edu/archives/cgi-bin/wa?A2=ind1306&L=TEI-L&F=&S=&P=86274

the <attRef> element is never mentioned in chapter 22. There are also only two examples for it, which are identical. The use-case discussed in the thread might provide possible examples.

Discussion

  • The example given in the P5 documentation is as follows:

    <attRef name="att.global.attribute.xml:id"/>
    

    but I was not able to get it to work. However, this worked:

    <attRef name="att.global.attribute.xmlid"/>
    
     
  • Martin Holmes
    Martin Holmes
    2013-11-13

    Louis-Dominique's issue has been corrected -- you have to drop the colons, and the examples now shows correctly, but that fact also has to be documented.

     
  • Martin Holmes
    Martin Holmes
    2013-11-13

    • status: open --> open-accepted
    • assigned_to: Martin Holmes
    • Group: AMBER --> GREEN
     
  • Martin Holmes
    Martin Holmes
    2013-11-13

    This is potentially a solution to the unease with which we contemplate the idea of claiming membership of a class, then deleting some of its attributes; with this, you can have an element that does not claim membership of the class, and instead pulls in only the attributes it wants from that class.

     
  • Martin Holmes
    Martin Holmes
    2013-11-13

    • Group: GREEN --> AMBER
     
  • Syd Bauman
    Syd Bauman
    2013-11-13

    We really need to revamp the syntax, here, though. Instead of name= having a RELAX NG pattern, we really should refer to the class and particular attribute. E.g. <attRef class="att.global" name="xml:id"/>.

     
    Last edit: Martin Holmes 2013-11-13
  • Martin Holmes
    Martin Holmes
    2013-11-13

    Action on MH to watch as SR and SB implement this, and then document it properly when it's done.

     
  • Martin Holmes
    Martin Holmes
    2013-11-13

    LB suggests we can use classRef instead, using include or exclude of attributes. Therefore we might be able to get rid of this element.

     
  • Martin Holmes
    Martin Holmes
    2014-06-06

    Posted to the Council list asking for any answers to these questions:

    1. Are there (currently) any good use-cases for end-users which depend
      on the use of <attRef> and which will work with current ODD processing?

    2. If there are such use-cases, can the same results be achieved using
      other existing elements and attributes?

    3. Will future plans for ODD make <attRef> obsolete anyway?

     
  • Martin Holmes
    Martin Holmes
    2014-06-29

    No responses to the questions as of today. I guess this will need to be discussed in the FtF.

     
  • Lou Burnard
    Lou Burnard
    2014-06-30

    Feature request to extract attribute from locally defined element, either because it's special or because it over rides class definition, would be useful. Maybe add @element as an alternative to @class

     
  • Martin Holmes
    Martin Holmes
    2014-09-09

    • status: open-accepted --> open
     
  • James Cummings
    James Cummings
    2014-11-19

    F2F Raleigh: Prods MH to progress ticket.