CDR Tickets

Issue Number 3216
Summary [Citation] Formatted Citation for Citation Type Database and Database Entry
Created 2010-09-02 10:06:02
Issue Type Improvement
Submitted By Osei-Poku, William (NIH/NCI) [C]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2010-09-27 11:39:40
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.107544
Description

BZISSUE::4904
BZDATETIME::2010-09-02 10:06:02
BZCREATOR::William Osei-Poku
BZASSIGNEE::Volker Englisch
BZQACONTACT::William Osei-Poku

-To be discussed in today's meeting -

The formatted references for Citation type Database and Database entry appear to be incorrect. We will like to change them to the correct formats. I have attached the Specs.

Comment entered 2010-09-02 10:06:45 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2010-09-02 10:06:45
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::1

added attachment.

Comment entered 2010-09-02 10:06:45 by Osei-Poku, William (NIH/NCI) [C]

Attachment Citation Type.docx has been added with description: citation types

Comment entered 2010-09-02 11:17:21 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-09-02 11:17:21
BZCOMMENTOR::Volker Englisch
BZCOMMENT::2

Shouldn't a URL be included for a database citation reference?

Comment entered 2010-09-02 11:20:17 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-09-02 11:20:17
BZCOMMENTOR::Volker Englisch
BZCOMMENT::3

We have this Citation Formatting Requirements document and we probably should include these new Database citation types to keep all of these things together.

Comment entered 2010-09-02 11:20:17 by Englisch, Volker (NIH/NCI) [C]

Attachment Citation_formatting_new.doc has been added with description: Citation Formatting Requirements

Comment entered 2010-09-02 11:57:59 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2010-09-02 11:57:59
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::4

Agreed. The following note has been added to the document:

Note:
Look for External Ref. Available online. in Publication Information element and create a link to the URL

Comment entered 2010-09-02 11:57:59 by Osei-Poku, William (NIH/NCI) [C]

Attachment Citation Type.docx has been added with description: citation types new

Comment entered 2010-09-02 11:58:37 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2010-09-02 11:58:37
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::5

(In reply to comment #3)
> Created attachment 1992 [details]
> Citation Formatting Requirements
>
> We have this Citation Formatting Requirements document and we probably should
> include these new Database citation types to keep all of these things together.

We'll update this document and let you know.

Comment entered 2010-09-07 10:34:02 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2010-09-07 10:34:02
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::6

Added updated documentation

Comment entered 2010-09-07 10:34:02 by Osei-Poku, William (NIH/NCI) [C]

Attachment Citation_formatting_new_rev_Sept10.doc has been added with description: updated documentation

Comment entered 2010-09-10 16:05:26 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-09-10 16:05:26
BZCOMMENTOR::Volker Englisch
BZCOMMENT::7

From the provided document:
Note: In this example, after publication Information, it does not
print period (after 2009).

The reason for this is that the period is part of the data element PubInfo and that period is missing for the sample citation.

Comment entered 2010-09-10 16:34:44 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-09-10 16:34:44
BZCOMMENTOR::Volker Englisch
BZCOMMENT::8

I've updated the Citation Requirements documentation to keep the same formatting throughout the document. (Section 17 - Database Formatting)

Comment entered 2010-09-10 16:34:44 by Englisch, Volker (NIH/NCI) [C]

Attachment CitationRequirements_20100910.doc has been added with description: Citation Formatting Requirements (updated)

Comment entered 2010-09-10 16:36:05 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-09-10 16:36:05
BZCOMMENTOR::Volker Englisch
BZCOMMENT::9

Oops! I forgot: The document is stored on MAHLER under

mahler.nci.nih.gov\d$\cdr\documentation\requirements

Comment entered 2010-09-13 15:58:39 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-09-13 15:58:39
BZCOMMENTOR::Volker Englisch
BZCOMMENT::10

The following filter has been updated:
CDR258630 - Module: Citation Formatting

This is ready for review on MAHLER.

Comment entered 2010-09-15 13:37:47 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2010-09-15 13:37:47
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::11

The Database format looks good. But there appears to be a problem with the Database entry format. It is missing the parent information - Author, Title and Publication Info. Please see CDR672006.

Comment entered 2010-09-15 15:42:50 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-09-15 15:42:50
BZCOMMENTOR::Volker Englisch
BZCOMMENT::12

Are you referring to CDR672006 or CDR672005?
CDR672006 doesn't contain any Authors information on MAHLER.

Comment entered 2010-09-15 15:49:14 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2010-09-15 15:49:14
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::13

(In reply to comment #12)
> Are you referring to CDR672006 or CDR672005?
> CDR672006 doesn't contain any Authors information on MAHLER.

I was referring to CDR672006. It is a child of CDR672005. If you check the <PublishedIn> element in CDR672006, there is a link from CDR672006 to CDR672005. So the missing information needs to be retrieved from CDR672005 (the Database record).

Comment entered 2010-09-15 17:49:09 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-09-15 17:49:09
BZCOMMENTOR::Volker Englisch
BZCOMMENT::14

OK, I didn't really get that from the requirements and the documentation.

I've updated the filter to display the "Database entry" type as you've listed in your "should look" example. When testing please make sure to also look at other citation types because the citation formatting filters are borrowing templates between citation types and you want to make sure I didn't break anything.
Please also review the output that lists:
In: U.S. Food and Drug Administration.: Code of Federal
I don't think the ".:" is proper punctuation but I leave that for somebody else to decide.

This is ready for review on MAHLER.

Comment entered 2010-09-21 14:08:47 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2010-09-21 14:08:47
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::15

We have reviewed all the different citation types and what appears to be a problem is an extra period that is printed after the Publication Info. I have attached examples of what we identified.

Comment entered 2010-09-21 14:08:47 by Osei-Poku, William (NIH/NCI) [C]

Attachment citations QA.docx has been added with description: Citations QA

Comment entered 2010-09-21 17:17:05 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-09-21 17:17:05
BZCOMMENTOR::Volker Englisch
BZCOMMENT::16

I have fixed the filter to adjust all of the examples that you have listed except for the last one. In addition to the double-period you also highlighted the section "0102. [Abstract]" which had not changed from the previous version.

Does that need to be fixed/changed?

Comment entered 2010-09-21 17:21:34 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2010-09-21 17:21:34
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::17

(In reply to comment #16)
> I have fixed the filter to adjust all of the examples that you have listed
> except for the last one. In addition to the double-period you also highlighted
> the section "0102. [Abstract]" which had not changed from the previous version.
>
> Does that need to be fixed/changed?

No. Don't fix it yet. We are still researching it. We believe there was a reason for making the format that way in the first place, so depending on what we can find, we will either ask for a change or leave it as is.

Comment entered 2010-09-22 17:52:43 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2010-09-22 17:52:43
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::18

It appears some new formatting issues have been introduced or may be we did not see them during our last review. Please see attachment.

Comment entered 2010-09-22 17:52:43 by Osei-Poku, William (NIH/NCI) [C]

Attachment Citations QA1.doc has been added with description: Citations QA

Comment entered 2010-09-23 09:34:26 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-09-23 09:34:26
BZCOMMENTOR::Volker Englisch
BZCOMMENT::19

No, you didn't overlook these.

The ".x" and ".b" were testing strings I forgot to remove. There are several places in the code that add a period to the string and adding the right punctuation based on the different citation types and existing (or missing) elements can be challenging at times.

The problems have been corrected on MAHLER.

Comment entered 2010-09-23 10:34:35 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2010-09-23 10:34:35
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::20

(In reply to comment #19)
>
> The problems have been corrected on MAHLER.

Verified. Please promote to Bach.

Comment entered 2010-09-24 12:01:35 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-09-24 12:01:35
BZCOMMENTOR::Volker Englisch
BZCOMMENT::21

The following filter has been copied to FRANCK:
CDR258630: Module: Citation Formatting - R9900

I'm currently running a diff report on FRANCK.

Comment entered 2010-09-24 13:07:18 by Englisch, Volker (NIH/NCI) [C]

BZDATETIME::2010-09-24 13:07:18
BZCOMMENTOR::Volker Englisch
BZCOMMENT::22

The diff report of the Citation QC report did not show any differences other then a change of double-periods and missing periods, which are now displaying properly.

The following filter has been copied to BACH:
CDR258630: Module: Citation Formatting - R9900

Please verify on BACH and close this bug.

Comment entered 2010-09-27 11:39:13 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2010-09-27 11:39:13
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::23

(In reply to comment #22)
> The diff report of the Citation QC report did not show any differences other
> then a change of double-periods and missing periods, which are now displaying
> properly.
>
> The following filter has been copied to BACH:
> CDR258630: Module: Citation Formatting - R9900
>
> Please verify on BACH and close this bug.

Verified on Bach. Issue closed. Thank you!

Comment entered 2010-09-27 11:39:40 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2010-09-27 11:39:40
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::24

Closed.

Attachments
File Name Posted User
Citation_formatting_new_rev_Sept10.doc 2010-09-07 10:34:02 Osei-Poku, William (NIH/NCI) [C]
Citation_formatting_new.doc 2010-09-02 11:20:17 Englisch, Volker (NIH/NCI) [C]
CitationRequirements_20100910.doc 2010-09-10 16:34:44 Englisch, Volker (NIH/NCI) [C]
citations QA.docx 2010-09-21 14:08:47 Osei-Poku, William (NIH/NCI) [C]
Citations QA1.doc 2010-09-22 17:52:43 Osei-Poku, William (NIH/NCI) [C]
Citation Type.docx 2010-09-02 11:57:59 Osei-Poku, William (NIH/NCI) [C]
Citation Type.docx 2010-09-02 10:06:45 Osei-Poku, William (NIH/NCI) [C]

Elapsed: 0:00:00.001403