Bug #5338

ISO 8601 Basic Date formatting in Start/End date fields resets on save.

Added by Dan Gillean almost 9 years ago. Updated almost 9 years ago.

Status:VerifiedStart date:07/11/2013
Priority:MediumDue date:
Assignee:José Raddaoui Marín% Done:

100%

Category:Information objectEstimated time:4.00 hours
Target version:Release 1.4.0
Google Code Legacy ID: Tested version:
Sponsored:No Requires documentation:

Description

To reproduce
  • Create a new archival description
  • Add a date of creation:
    • Display date: January 1, 2011
    • Start: 20110101
    • End: 20110101
  • Save record.
  • Hit EAD export, and look at @NORMAL attribute of <unitdate>, OR edit record again, and look at values in start/end

Resulting error
When re-editing the record, or exporting it, @NORMAL values reset to zero if date is formatted according to ISO-8601 basic (i.e., YYYYMMDD). Note that YYYY-MM-DD (ISO-8601 Extended) will roundtrip.

Expected Result
ISO-8601 Basic format-compliant dates (YYYYMMDD) roundtrip properly

Ideal behavior
The tooltip for the dates is updated across templates to list acceptable formats:
YYYYMMDD, YYYY-MM-DD, YYYY-MM, YYYY

Note that the current tooltip on the ISAD templates references ISAD rule 3.1.3, but it does NOT quote it - rule 3.1.3 recommends following ISO-8601 conventions but does not specify a preference for basic format for extended format. We should support both, and make this explicit.

History

#1 Updated by José Raddaoui Marín almost 9 years ago

  • Status changed from New to QA/Review
  • % Done changed from 0 to 100

Applied in changeset atom|commit:59b80315468555fc31ff5cfa1ced194cc16c185a.

#2 Updated by Dan Gillean almost 9 years ago

This looks good - everything is reformatted when saved to ISO 8601 extended format, but the dates are accurate and the file is not overwritten.

Radda could you add information to the RAD tooltips for start and end? Right now it says: "Enter the start year. Do not use any qualifiers or typographical symbols to express uncertainty" for the start date. I think it would help if the tooltip read:

"Enter the start year. Do not use any qualifiers or typographical symbols to express uncertainty. Acceptable date formats: YYYYMMDD, YYYY-MM-DD, YYYY-MM, YYYY."

And though there is an extra sentence in the End dates tooltip, the fix should be the same, adding the sentence above.

#3 Updated by Dan Gillean almost 9 years ago

  • Status changed from QA/Review to Feedback

#4 Updated by José Raddaoui Marín almost 9 years ago

  • Status changed from Feedback to QA/Review

Applied in changeset atom|commit:3f2469c3d9dd5f3b3a4c44882fba0c0bcd05e541.

#5 Updated by Jessica Bushey almost 9 years ago

  • Status changed from QA/Review to Feedback

Radda, in comment #2 Dan suggests a change in the tooltip for Start Date. I checked and the tool tip is missing "Acceptable date formats: YYYYMMDD, YYYY-MM-DD, YYYY-MM, YYYY."

Could you please make this change?

#6 Updated by José Raddaoui Marín almost 9 years ago

  • Estimated time set to 4.00

#7 Updated by José Raddaoui Marín almost 9 years ago

  • Status changed from Feedback to QA/Review

The tooltips for those fields are not the same in all the templates:

In the RAD event dialog for creation dates (and others event dialogs), there is a tooltip for every field. Here is where you can see the change.

START:"Enter the start year. Do not use any qualifiers or typographical symbols to express uncertainty. Acceptable date formats: YYYYMMDD, YYYY-MM-DD, YYYY-MM, YYYY."
END:"Enter the end year. Do not use any qualifiers or typographical symbols to express uncertainty. Acceptable date formats: YYYYMMDD, YYYY-MM-DD, YYYY-MM, YYYY. If the start and end years are the same, enter data only in the "Date" field and leave the "End date" blank."

Maybe both should have the two sentences?

But in the ISAD Date(s) table, and other tables with dates, the tooltip is for the whole table. Should I change those tooltips too?

Regards.

#8 Updated by Dan Gillean almost 9 years ago

Hi Radda,

I've reviewed the tooltips and I agree with your suggestions. Here are my proposed revisions to the tooltips:

ISAD template Date field

“Identify and record the date(s) of the unit of description. Identify the type of date given. Record as a single date or a range of dates as appropriate.” (ISAD 3.1.3) The Date display field can be used to enter free-text date information, including typographical marks to express approximation, uncertainty, or qualification.

Use YYYY-MM-DD format in the start and end fields to make the date(s) searchable.

RAD template Date field

“Give the date(s) of creation of the unit being described either as a single date, or range of dates (for inclusive dates and/or predominant dates). Always give the inclusive dates. When providing predominant dates, specify them as such, preceded by the word predominant…” (RAD 1.4B2) The Date display field can be used to enter free-text date information, including typographical marks to express approximation, uncertainty, or qualification. Record probable and uncertain dates in square brackets, using the conventions described in RAD 1.4B5.

Use YYYY-MM-DD format in the start and end fields to make the date(s) searchable.

Start/End (all templates – including DC if possible!):

Enter the [start/end] year. Do not use any qualifiers or typographical symbols to express uncertainty. Acceptable date formats: YYYYMMDD, YYYY-MM-DD, YYYY-MM, YYYY. If the start and end years are the same, enter data only in the "Date" field and leave the "End date" blank."


HOWEVER something that I have realized is that this brings up another issue, where what we advise in the tooltip is NOT the default behaviour for AtoM. If you enter a single date in the display field (say 2012), AtoM will populate both the start AND end date fields automatically with 2012. Therefore, if we advise people that "If the start and end years are the same, enter data only in the "Date" field and leave the 'End date' blank," then the application is actually working against them.

In terms of search results, what is better? do we want to change AtoM's behaviour, or just change the tooltip? (ie remove that line)

My suggestions will make the tooltips a bit longer as well - Jessica, I would appreciate your thoughts on them before we proceed.

#9 Updated by José Raddaoui Marín almost 9 years ago

Hi Dan,

We are using one unique tooltip for all the fields in the tables (ISAD Dates) for example.

Maybe I could try to separate it for each field, but I don't know how it'll look. Now the tooltip takes all the table and it's not moving. Probably this would be different.

Or just modify the one we have, with the three tooltips.

#10 Updated by Dan Gillean almost 9 years ago

If making it have 3 tooltips is going to be too much work, then we can just include all the info in one tooltip, as it is now. Like so perhaps:

“Identify and record the date(s) of the unit of description. Identify the type of date given. Record as a single date or a range of dates as appropriate.” (ISAD 3.1.3) The Date display field can be used to enter free-text date information, including typographical marks to express approximation, uncertainty, or qualification.

Use the start and end fields to make the dates searchable. Do not use any qualifiers or typographical symbols to express uncertainty. Acceptable date formats: YYYYMMDD, YYYY-MM-DD, YYYY-MM, YYYY. If the start and end years are the same, enter data only in the "Date" field and leave the "End date" blank.

We still need to decide if we keep that last sentence or not, re: only entering data in the date field - it's kind of confusing, shouldn't it at least say in the date and start field? I need insight into how AtoM searches dates to know if we should just cut this last part out, or change it or what.

#11 Updated by José Raddaoui Marín almost 9 years ago

Hi Dan,

About using three tooltips in the tables, I think is better to keep it the way it is. I tried with a little fix, but the tooltips appears in the middle of the table.

About the last phrase in the start and end dates tooltips, I think we should remove it, because as you said, if you enter a good formated date in the date field, the start and end dates fields are populated with the same date.

#12 Updated by Dan Gillean almost 9 years ago

Okay, that makes sense.

So then the tooltips should be:

ISAD

“Identify and record the date(s) of the unit of description. Identify the type of date given. Record as a single date or a range of dates as appropriate.” (ISAD 3.1.3) The Date display field can be used to enter free-text date information, including typographical marks to express approximation, uncertainty, or qualification. Use the start and end fields to make the dates searchable. Do not use any qualifiers or typographical symbols to express uncertainty. Acceptable date formats: YYYYMMDD, YYYY-MM-DD, YYYY-MM, YYYY."

For RAD, I've noticed that you've already implemented the suggested changes above. So the only change would be removing that last sentence on the End date tooltip (ie, remove: "If the start and end years are the same, enter data only in the "Date" field and leave the "End date" blank.")

Thanks Radda!

#13 Updated by Jessica Bushey almost 9 years ago

  • Status changed from QA/Review to Feedback

#14 Updated by José Raddaoui Marín almost 9 years ago

  • Status changed from Feedback to QA/Review

OK, it's done. I've also changed the tooltip for DC dates, using the ISAD tooltip without the reference code.

#15 Updated by Jessica Bushey almost 9 years ago

  • Status changed from QA/Review to Feedback

This is missing from the RAD start and end date tooltips.

"If the start and end years are the same, enter data only in the "Date" field and leave the "End date" blank."

#16 Updated by Jessica Bushey almost 9 years ago

  • Status changed from Feedback to Verified

Sorry! Reread everything a third time and I see that Dan wanted that sentence removed, please ignore my last comment.

Also available in: Atom PDF