Difference between revisions of "XML:PubUpdate"

From ISFDB
Jump to navigation Jump to search
(→‎Optional Tags: Update to match the 2019 format)
 
(3 intermediate revisions by the same user not shown)
Line 11: Line 11:
 
==Optional Tags==
 
==Optional Tags==
  
The PubUpdate submission also contains a number of optional tags. These tags should be used whenever an update is made to a particular field. If a particular field is unchaged, it should not be included in the submission. If a field value needs to be deleted, the tag should be included, but the value should be empty. The following section describes the tags are supported in the metadata section. You should refer to [[Help:Screen:EditPub]] for more detailed information on data entry. The bold text in the description refers to specific labels found in the Help article:
+
The PubUpdate submission also contains a number of optional tags. These tags should be used whenever an update is made to a particular field. If a particular field is unchaged, it should not be included in the submission. If a field value needs to be deleted, the tag should be included, but the value should be empty. The following section describes the tags are supported in the metadata section. Refer to [[Help:Screen:EditPub]] for detailed information on the values supported for each field. The bold text in the description refers to specific labels found in the Help article:
  
 
* '''Title''' - The '''Title''' of the publication.
 
* '''Title''' - The '''Title''' of the publication.
* '''Authors''' - The '''Author''' list associated with the publication. This XML tag will enclose:
+
* '''TransTitles''' -- If present includes one of more '''TransTitle''' tags. A '''TransTitle''' tag contains one transliterated title.
** '''Author''' - There should be one '''Author''' entry for each individual who wrote or edited the publication.
+
* '''Authors''' - The '''Author''' list associated with the publication. This XML tag includes one more '''Author'''. An '''Author''' tag contains one entry for a person who wrote or edited the publication.
* '''Artists''' - The '''Artist''' list associated with the publication. This XML tag will enclose:
+
* '''Year''' - The '''Date''' of publication using the YYYY-MM-DD format.
** '''Artist''' - There should be one '''Artist''' entry for each individual who wrote or edited the publication.
+
* '''Publisher''' - The '''Publisher''' of the publication.
* '''Year''' - The '''Year''' of publication using the YYYY-MM-DD format.
+
* '''PubSeries''' - The '''Publication series''' of the publication.
 +
* '''PubSeriesNum''' - The publication series number of the publication.
 
* '''Pages''' - The number of '''Pages''' in the publication.
 
* '''Pages''' - The number of '''Pages''' in the publication.
 
* '''Binding''' - The '''Pub Format''' of the publication.
 
* '''Binding''' - The '''Pub Format''' of the publication.
 
* '''PubType''' - The '''Pub Type''' type of the publication.
 
* '''PubType''' - The '''Pub Type''' type of the publication.
* '''Isbn''' - The '''ISBN / Catalog #''' of the publication.
+
* '''Isbn''' - The '''ISBN''' of the publication.
 +
* '''Catalog''' - The '''Catalog ID''' of the publication.
 
* '''Price''' - The '''Price''' of the publication.
 
* '''Price''' - The '''Price''' of the publication.
 
* '''Image''' - The '''Image URL''' associated with the publication cover art.
 
* '''Image''' - The '''Image URL''' associated with the publication cover art.
 
* '''Note''' - A '''Note''' specific to this publication.
 
* '''Note''' - A '''Note''' specific to this publication.
* '''Publisher''' - The '''Publisher''' of the publication.
+
* '''Content''' - Some amount of content may be associated with the publication. Only those titles undergoing change should be included in this section. If no titles are modified, the '''Content''' section must be present, although it will be empty. Any number of the following content type entries are supported:
* '''PubSeries''' - The '''Publication series''' of the publication
+
** '''Cover''' - This entry type is for covers.
* '''PubSeriesNum''' - The '''Publication series number''' of the publication* '''Content''' - Some amount of content may be associated with the publication. Only those titles undergoing change should be included in this section. If no titles are modified, the '''Content''' section must be present, although it will be empty. Any number of the following content type entries are supported:
+
** '''ContentTitle''' - This entry type is for normal content, such as short stories or essays.
** '''ContentTitle''' - This is for normal content, such as short stories or essays.
+
** '''ContentReview''' - This is a specialized entry type for reviews, taking into account the author writing the review, and the author who wrote the work being reviewed.
** '''ContentReview''' - This is a specialized format for reviews, taking into account the author writing the review, and the author who wrote the work being reviewed.
+
** '''ContentInterview''' - This is a specialized entry type for interviews, taking into account the author that conducted the interview, and the author who was interviewed.
** '''ContentInterview''' - This is a specialized format for interviews, taking into account the author that conducted the interview, and the author who was interviewed.
+
 
 +
====Cover====
 +
 
 +
* '''Record''' - The record number of the title. If this tag is not included, then the cover is considered new.
 +
* '''cTitle''' - The name of the title (should match the title of the publication).
 +
* '''cDate''' - The date of the cover.
 +
* '''cArtists''' - The artist(s) responsible for this cover. Note that multiple artists are separated with a '''+'''; they are not enclosed in separate XML tags.
  
 
====ContentTitle====
 
====ContentTitle====
Refer to [[Help:Screen:EditPub#General_contents]] for detailed data-entry help:
+
 
* '''Record''' - The record number of the title. If missing the title is considered new.
+
* '''Record''' - The record number of the title. If this tag is not included, then the title is considered new.
 
* '''cTitle''' - The name of the title.
 
* '''cTitle''' - The name of the title.
 
* '''cAuthors''' - The author(s) of the title. Note that multiple authors are separated with a '''+'''; they are not enclosed in separate XML tags.
 
* '''cAuthors''' - The author(s) of the title. Note that multiple authors are separated with a '''+'''; they are not enclosed in separate XML tags.
Line 42: Line 50:
 
* '''cType''' - The '''Entry Type''' of the title.
 
* '''cType''' - The '''Entry Type''' of the title.
 
* '''cLength''' - The '''Length''' of the title.
 
* '''cLength''' - The '''Length''' of the title.
 +
Refer to [[Help:Screen:EditPub#Regular_Titles]] for detailed information on the values supported for each field.
  
 
====ContentReview====
 
====ContentReview====
Refer to [[Help:Screen:EditPub#Reviews]] for detailed data-entry help:
+
* '''Record''' - The record number of the title. If this tag is not included, then the review is considered new.
* '''Record''' - The record number of the title. If missing the review is considered new.
 
 
* '''cTitle''' - The name of the title.
 
* '''cTitle''' - The name of the title.
 
* '''cBookAuthors''' - The author(s) of the book being reviewed. Note that multiple authors are separated with a '''+'''; they are not enclosed in separate XML tags.
 
* '''cBookAuthors''' - The author(s) of the book being reviewed. Note that multiple authors are separated with a '''+'''; they are not enclosed in separate XML tags.
Line 51: Line 59:
 
* '''cDate''' - The date of the review.
 
* '''cDate''' - The date of the review.
 
* '''cPage''' - The page the review appears on.
 
* '''cPage''' - The page the review appears on.
 +
Refer to [[Help:Screen:EditPub#Reviews]] for detailed information on the values supported for each field.
  
 
====ContentInterview====
 
====ContentInterview====
Refer to [[Help:Screen:EditPub#Interviews]] for detailed data-entry help:
+
* '''Record''' - The record number of the title. If this tag is not included, then the interview is considered new.
* '''Record''' - The record number of the title. If missing the interview is considered new.
 
 
* '''cTitle''' - The name of the title.
 
* '''cTitle''' - The name of the title.
 
* '''cInterviewee''' - The author(s) conducting the interview. Note that multiple authors are separated with a '''+'''; they are not enclosed in separate XML tags.
 
* '''cInterviewee''' - The author(s) conducting the interview. Note that multiple authors are separated with a '''+'''; they are not enclosed in separate XML tags.
Line 60: Line 68:
 
* '''cDate''' - The date of the interview.
 
* '''cDate''' - The date of the interview.
 
* '''cPage''' - The page the interview appears on.
 
* '''cPage''' - The page the interview appears on.
 +
Refer to [[Help:Screen:EditPub#Interviews]] for detailed information on the values supported for each field.
  
 
==Example==
 
==Example==

Latest revision as of 11:18, 27 June 2019

Introduction

The PubUpdate submission updates publication information for a single specific publication.

Required Tags

The submission contains one required tag:

  • Record - Required tag. Specifies which publication record to update. Note that this is the Publication Record Number rather than a Publication Tag String.

Optional Tags

The PubUpdate submission also contains a number of optional tags. These tags should be used whenever an update is made to a particular field. If a particular field is unchaged, it should not be included in the submission. If a field value needs to be deleted, the tag should be included, but the value should be empty. The following section describes the tags are supported in the metadata section. Refer to Help:Screen:EditPub for detailed information on the values supported for each field. The bold text in the description refers to specific labels found in the Help article:

  • Title - The Title of the publication.
  • TransTitles -- If present includes one of more TransTitle tags. A TransTitle tag contains one transliterated title.
  • Authors - The Author list associated with the publication. This XML tag includes one more Author. An Author tag contains one entry for a person who wrote or edited the publication.
  • Year - The Date of publication using the YYYY-MM-DD format.
  • Publisher - The Publisher of the publication.
  • PubSeries - The Publication series of the publication.
  • PubSeriesNum - The publication series number of the publication.
  • Pages - The number of Pages in the publication.
  • Binding - The Pub Format of the publication.
  • PubType - The Pub Type type of the publication.
  • Isbn - The ISBN of the publication.
  • Catalog - The Catalog ID of the publication.
  • Price - The Price of the publication.
  • Image - The Image URL associated with the publication cover art.
  • Note - A Note specific to this publication.
  • Content - Some amount of content may be associated with the publication. Only those titles undergoing change should be included in this section. If no titles are modified, the Content section must be present, although it will be empty. Any number of the following content type entries are supported:
    • Cover - This entry type is for covers.
    • ContentTitle - This entry type is for normal content, such as short stories or essays.
    • ContentReview - This is a specialized entry type for reviews, taking into account the author writing the review, and the author who wrote the work being reviewed.
    • ContentInterview - This is a specialized entry type for interviews, taking into account the author that conducted the interview, and the author who was interviewed.

Cover

  • Record - The record number of the title. If this tag is not included, then the cover is considered new.
  • cTitle - The name of the title (should match the title of the publication).
  • cDate - The date of the cover.
  • cArtists - The artist(s) responsible for this cover. Note that multiple artists are separated with a +; they are not enclosed in separate XML tags.

ContentTitle

  • Record - The record number of the title. If this tag is not included, then the title is considered new.
  • cTitle - The name of the title.
  • cAuthors - The author(s) of the title. Note that multiple authors are separated with a +; they are not enclosed in separate XML tags.
  • cDate - The date of the title.
  • cPage - The page the title appears on.
  • cType - The Entry Type of the title.
  • cLength - The Length of the title.

Refer to Help:Screen:EditPub#Regular_Titles for detailed information on the values supported for each field.

ContentReview

  • Record - The record number of the title. If this tag is not included, then the review is considered new.
  • cTitle - The name of the title.
  • cBookAuthors - The author(s) of the book being reviewed. Note that multiple authors are separated with a +; they are not enclosed in separate XML tags.
  • cReviewers - The author(s) writing the review. Note that multiple authors are separated with a +; they are not enclosed in separate XML tags.
  • cDate - The date of the review.
  • cPage - The page the review appears on.

Refer to Help:Screen:EditPub#Reviews for detailed information on the values supported for each field.

ContentInterview

  • Record - The record number of the title. If this tag is not included, then the interview is considered new.
  • cTitle - The name of the title.
  • cInterviewee - The author(s) conducting the interview. Note that multiple authors are separated with a +; they are not enclosed in separate XML tags.
  • cInterviewer - The author(s) being interviewed. Note that multiple authors are separated with a +; they are not enclosed in separate XML tags.
  • cDate - The date of the interview.
  • cPage - The page the interview appears on.

Refer to Help:Screen:EditPub#Interviews for detailed information on the values supported for each field.

Example

 <?xml version="1.0" encoding="iso-8859-1" ?>
 <IsfdbSubmission>
   <PubUpdate>
     <Record>56773</Record>
     <Submitter>Davecat</Submitter>
     <Subject>Analog Science Fact -&gt; Science Fiction, September 1962</Subject>
     <Note>Vol. LXX, No. 1.</Note>
     <Content>
       <ContentTitle>
         <Record>772165</Record>
         <cTitle>Hugos and Others</cTitle>
         <cAuthors>The Editor</cAuthors>
       </ContentTitle>
       <ContentTitle>
         <Record>54317</Record>
         <cLength>ss</cLength>
       </ContentTitle>
       <ContentReview>
         <cTitle>The Sixth Galaxy Reader</cTitle>
         <cBookAuthors>H. L. Gold</cBookAuthors>
         <cReviewers>P. Schuyler Miller</cReviewers>
         <cDate>1962-09-00</cDate>
         <cPage>152</cPage>
       </ContentReview>
       <ContentInterview>
         <cTitle>Dan Simmons Interview</cTitle>
         <cInterviewees>Dan Simmons</cInterviewees>
         <cInterviewers>Bob Morrish</cInterviewers>
         <cDate>1990-00-00</cDate>
       </ContentInterview>
     </Content>
   </PubUpdate>
 </IsfdbSubmission>