Difference between revisions of "Data Submission Formats"

From ISFDB
Jump to navigation Jump to search
(→‎Title Related Submissions: Moving TitleUnmerge)
(→‎Title Related Submissions: Moving MakeVariant)
Line 43: Line 43:
 
* [[XML:TitleMerge]] - Merges two or more title records.
 
* [[XML:TitleMerge]] - Merges two or more title records.
 
* [[XML:TitleUnmerge]] - Unmerges one or more title records.
 
* [[XML:TitleUnmerge]] - Unmerges one or more title records.
 +
* [[XML:MakeVariant]] - Makes a title a variant title.
  
 
===MakeVariant===
 
 
This submission is used to make current title a variant title. It can either link to an existing parent title, or it can specify that a parent title be created.
 
 
Example where parent exists:
 
 
<?xml version="1.0" encoding="iso-8859-1" ?>
 
<IsfdbSubmission>
 
  <MakeVariant>
 
    <Submitter>CoachPaul</Submitter>
 
    <Subject>Luella Miller</Subject>
 
    <Record>883909</Record>
 
    <Parent>99468</Parent>
 
  </MakeVariant>
 
</IsfdbSubmission>
 
 
Example where parent is created:
 
 
<?xml version="1.0" encoding="iso-8859-1" ?>
 
<IsfdbSubmission>
 
  <MakeVariant>
 
    <Record>884039</Record>
 
    <Submitter>Rkihara</Submitter>
 
    <Subject>Buying Time: A Jaunt in Time and Space</Subject>
 
    <Title>Buying Time: A Jaunt in Time and Space</Title>
 
    <Year>2001-00-00</Year>
 
    <TitleType>NOVEL</TitleType>
 
    <Authors>
 
      <Author>Alan Glasser</Author>
 
    </Authors>
 
  </MakeVariant>
 
</IsfdbSubmission>
 
  
 
===VariantTitle===
 
===VariantTitle===

Revision as of 13:53, 21 May 2008

Introduction

The data submitted to the ISFDB must be a well-formed XML string. All submissions must contain the following:

  • An xml header utilizing version 1.0, and a recommended encoding of iso-8859-1.
  • The data must be enclosed within a set of IsfdbSubmission tags.
  • The data must contain a valid registered user within a set of Submitter tags.
  • The data must contain a subject heading within a set of Subject tags. This subject is displayed in the moderator queue, and is not integrated into the ISFDB data.

A stubbed out version of a generic submission looks like this:

<?xml version="1.0" encoding="iso-8859-1" ?>
<IsfdbSubmission>
  <...Type...>
     <Submitter>Registered_User_Name</Submitter>
     <Subject>Subject Line That Will Appear in Moderator Queue</Subject>
     ...
  </...Type...>
</IsfdbSubmission>

Author Related Submissions

There are two data submission types necessary for the upkeep of the authors table:

  • XML:AuthorMerge - handles merging two authors together; it does have side effects on publication and title mapping tables, as one of the authors is replaced with the other.
  • XML:AuthorUpdate - handles changes made to the author-related tables; it has no side effects on other tables.

Note that their are no submission types to create or delete author entries. Author entries are created on demand when a title or publication requires them. Likewise author entries are delete when no other records refer to them.

Publication Related Submissions

There are four data submission types necessary for the upkeep of the pubs table:

Title Related Submissions


VariantTitle

This submission is used to add a variant title to the current title. This is useful if you know from a secondary bibliography that a variant title exists, but no publication has every been entered under that title as yet. Usage of this submission type is fairly rare.

Example:

<?xml version="1.0" encoding="iso-8859-1" ?>
<IsfdbSubmission>
  <VariantTitle>
    <Submitter>Ahasuerus</Submitter>
    <Subject>Nad Bezdnoj</Subject>
    <Parent>877998</Parent>
    <Title>Nad Chernoj Bezdnoj</Title>
    <Year>1927-00-00</Year>
    <Storylen>ss</Storylen>
    <TitleType>SHORTFICTION</TitleType>
    <Note>Originally published as "Nad Chernoj Bezdnoj", book publication as "Nad Bezdnoj".</Note>
    <Authors>
      <Author>Alexander Beliaev</Author>
    </Authors>
  </VariantTitle>
</IsfdbSubmission>