Menu

#560 show ODD declaration on the specs pages

AMBER
open
None
5(default)
2015-09-24
2015-05-30
No

It would be nice to see the ODD declaration (instead of the RelaxNG declaration) when looking up the specs of a given element. That'd be especially useful to understand local redefinition of attributes, see e.g. http://www.tei-c.org/release/doc/tei-p5-doc/en/html/ref-title.html

Related

Feature Requests: #560

Discussion

  • Hugh A. Cayless

    Hugh A. Cayless - 2015-08-12
    • assigned_to: Peter Stadler
     
  • Hugh A. Cayless

    Hugh A. Cayless - 2015-08-12

    Thoughts? I think this would probably be nice. If so, then this would really be a Stylesheets FR, right? Assigning to Peter to prod for feedback and open a Stylesheets issue.

     
  • Lou Burnard

    Lou Burnard - 2015-08-12

    I don't understand what is being requested here. Displaying the pure ODD version of the content model rather than the RNG or RNC version (though perfectly feasible) won't do anything to help "understand local redefinition of attributes". For that you need to understand the element's class memberships, which are already shown in the spec. Maybe Peter could give an example of what he'd like to see?

    p.s. I think as a matter of good practice, tickets should not be assigned to the person who requested them.

     
  • Lou Burnard

    Lou Burnard - 2015-08-12

    I don't understand what is being requested here. Displaying the pure ODD version of the content model rather than the RNG or RNC version (though perfectly feasible) won't do anything to help "understand local redefinition of attributes". For that you need to understand the element's class memberships, which are already shown in the spec. Maybe Peter could give an example of what he'd like to see?

    p.s. I think as a matter of good practice, tickets should not be assigned to the person who requested them.

     
  • Peter Stadler

    Peter Stadler - 2015-09-24

    Maybe I should explain my use case:
    When customizing ODD files I constantly need to look up the element specs to see what I need modify (or to get (the idea of) a "template" for a new element). I see the attribute class memberships under "Attributes", and I see the model class memberships under "Member of".
    Issue 1: The content model of the respective element is in a different notation, and mixed with the attribute definitions. That makes it hard, especially for newbies. NB: I'm not that worried about the Relax notation (which will be remedied by pure ODD) but rather I expect the dedicated display of the element spec's <content> element somewhere.
    Issue 2: Local redefinitions of attributes are not all reproducible when looking at the html page (without knowing what e.g. the descriptive text "sample values include" transfers to in ODD).

    But maybe that's a broader issue than what the ticket suggests. Thinking about it, it might even be easiest to have an XML view (aka TEI spec file) button to get a direct look at the source?!

     
  • Lou Burnard

    Lou Burnard - 2015-09-24

    issue 1: Displaying the pure ODD source for a content model (rather than the RelaxNG generated from it) is definitely what ought to happen once pure ODD is fully implemented

    issue 2: What wording would you prefer?

    If you want the full XML view, of course, you need to look at the ODD file!

     
    • Peter Stadler

      Peter Stadler - 2015-09-24

      issue 2: What wording would you prefer?

      I wouldn't change the wording at the current location. I'm just trying to argue that for customizing ODDs the spec pages are the entry point but don't offer everything needed.
      I'm frequently facing this issue when teaching ODD, but maybe it's just my incompetence …

      If you want the full XML view, of course, you need to look at the ODD file!

      Exactly, but it's not linked from the html spec page! (or am I missing something?)