Menu

#554 guidance on use of @calendar and @datingMethod

GREEN
open
None
5(default)
2015-05-29
2015-05-26
No

Could anyone provide better differentiation between the <date> attributes @calendar and @datingMethod? Ideally in the pages of the two attribute classes where each of them is defined, for clearer comparison of their use.</date>

Discussion

  • BODARD Gabriel

    BODARD Gabriel - 2015-05-26

    I agree this would be really useful, as I've had several people come to me confused about these attributes. They are fairly well explained in the body of the Guidelines chapter, of course, but since most people (including myself) look in the element and class spec pages for guidance in the first instance, it would probably be useful to state:

    (1) in att.datable that the @calendar attribute refers to the content of the dating element, unlike @datingMethod which refers only to the normalization method of the @*-custom attributes, and

    (2) in att.datable.custom that the @datingMethod attribute refers to the system to which the @when-custom and other attributes normalize this date, unlike @calendar which refers to the original date contained by the element itself.

    I'm sure this could be made even clear, but I'm happy to take a first pass at this in the Guidelines if no one else is inclined to?

     
  • Martin Holmes

    Martin Holmes - 2015-05-26

    This is pretty confusing. We have a detailed page on encoding dates on the Map of Early Modern London site; we might re-purpose some of the content there for the Guidelines and Specs pages:

    http://mapoflondon.uvic.ca/encoding_dates.htm

     
  • Hugh A. Cayless

    Hugh A. Cayless - 2015-05-28
    • assigned_to: BODARD Gabriel
     
  • Hugh A. Cayless

    Hugh A. Cayless - 2015-05-28

    Gabby, are you still willing to implement this? Please do, if you can.

     
  • BODARD Gabriel

    BODARD Gabriel - 2015-05-29

    I was just going to add a couple of lines to the classSpec, as suggested above. A few more lines of transparent explanation or examples (as in Martin's documentation) might also be useful, but I'll leave that to him to implement.

     
  • Martin Holmes

    Martin Holmes - 2015-05-29

    Gabby, when you're done, if you think it's worth my adding something in the prose too, assign the ticket to me so I don't forget.

     
  • BODARD Gabriel

    BODARD Gabriel - 2015-05-29

    Explanation and examples added in [r13226]. Assigning back to Martin in case he wants to add more prose.

     

    Related

    Commit: [r13226]

  • Martin Holmes

    Martin Holmes - 2015-05-29

    A couple of references to att classes were encoded as ref elements instead of idents, which broke the build; I've just fixed those in r13227 and 13228.

     
  • Martin Holmes

    Martin Holmes - 2015-05-29
    • assigned_to: BODARD Gabriel --> Martin Holmes
    • Group: AMBER --> GREEN