Format for Hyper Migration

The export script can be accessed as "exportToTalia.php" at nietzschesource.org - this requires a password login. The script takes the following parameters:

  • getList=true -> returns an XML with the Sigla of all elements in the Hyper
  • get=Siglum -> returns the XML representation of that Siglum

Data Elements

MATERIALS

material types ::

	'manuscript':
	subtypes::  'notebook' || 'copybook' || 'dossier' || 'manuscript_for_printing' || ('icn') || 'draft'
	
	'work':
	subtypes::  'printed_and_distributed' || 'unprinted' || 'not_distributed'
	
	'iconography':
	subtypes:: 'standard'

	


material: book 

	relations:
	      predicate : 'isInArchive'
	      object    : source siglum (archive)

	siglum
	title   
	type              :: 'manuscript' || 'work' || 'iconography'
	subtype           :: 'notebook' || 'copybook' || 'printed work' || ...
	
	copyright note    :: text
	description       :: a placeholder to be translated.
	date              :: the date of publishing or a date range stating when this material was 	             created  ( '1984-11-23' || 'June 1876 - March 1877' || 'End of 1800' || ... )
	collocation       :: where to find this book in the archive ( 'CV-12' || ...)
	publisher         :: the publisher, if it has been printed
	publishing place  :: where it has been published 
	
 --- for interface stuff:
	ordering          :: the place this book should have in the list of book of the same 			     subtype as this.

============

material: chapter

	relations:
		predicate :: 'isSubPartOf'
		object    :: source siglum  (book)

	siglum
	position     :: the position of this chapter in the book (int value)
	name	     :: the name of the chapter like "I" or "IX" or ... useful when searching for the chapter $x of the book $y
	title        :: the title of this chapter
	type         :: ('work_chapter')
	first_page   :: a foreign key referencing the first page of this chapter
	
	
============

material: page

	relations:
		predicate :: 'isSubPartOf'
		object    :: source siglum  (book)

	siglum
	title
	type          ::  ('manuscript_page' || 'work_page' || 'iconography_page' )
	width         :: the width of the page, usually expressed in cm or pixel.
	height        :: the height of the page, usually expressed in cm or pixel.
			width and height must be expressed using the same measure unit as the coordinates in the notes found in the page.
	position      :: the position of this page in the book (int value)
	position_name :: subpart of this page siglum, which identified this page 
			 (eg: if this page has 'MA,1r' as siglum - being the page 1r of the MA work - this field will contain '1r')
			 To be used when asking for a single page from within the book. (you may want to ask for the page 1r, this is where we know its "name").

=============

material: paragraph


	relations* :
		predicate :: 'isSubpartOf'
		object    :: source siglum (page)
	
	siglum
	title
	type	      :: ('manuscript_page_annotation' || 'work_page_annotation' ||  
			 'iconography_page_annotation' )
	
===========

material: zone
	paragraph     :: source siglum (paragraph)
	page  	      :: source siglum (page)
	position      :: the position of this note in one page
	coordinates   :: the coordinates of the vertex of the polygon which identifies this 	   	         note in the page.

=============


contribution types:
   'facsimile': 
    subtypes:: 'black/white' || 'grey_scale' || 'color' || 'dynamic'

   'transcription':
    subtypes:: 'ultradiplomatic' || 'diplomatic' || 'linear' || 'row_interactive' || 'word_interactive' || 'paragraph_interacrive' || 'hnml' || 'TEI' || 'WitTEI' || ''Generic XML' 

   'edition':
   subtypes:: 'hnml' || 'TEI' || 'HTML' || 'Generic XML'

   'path':
   'subtypes':: 'genetic' || 'thematic' || 'chronologic'

   'essay':
   subtypes:: 'html' || 'facsimile' || 'pdf' || 'hnml'

   'comments': 
   subtypes:: optional/free text



==========
contributions: common fields

	author(s):
	material(s):
	contribution(s):
	relations::
	        predicate :: ('cites', 'isTranslationOf', 'ifSubpartOf', 'isManifestationOf', 'relatedMaterial', 'isBibliographicCardOf', 'isCommentOf')
		object    :: source siglum		

        # the above predicase are used as follows:
        # - cites is used for essays when they cites a material
        # - isTranslationOf is used for translations and relates them to the translated contribution
        # - isSubpartOf is used for essay pages and path steps and relates them to the essays and paths they are part of
        # - relatedMaterial is used for both paths and path steps. The former will have a relation with each material their path steps 
        #                   are related to. The latter will have a relation with just one material.    
        # - isBibliographicalCardOf is used for bibliographical cards and relates them to the contributions they represent
        # - isCommentOf are used for comments.

	siglum   	 
	type		 :: contribution type  ('essay' || 'facsimile' || 'comment' || 'transcription' || 'edition' || 'path' || 'external object' || 'bibliographical card' )
	subtype		 :: 
	title            :: many contribution don't have a title, as in many cases the title is automatically generated by the system, starting from the contribution metadata.
	publishing date  :: the date when it was published in the Hyper.
	publisher	 :: the publisher (we used to have "HyperNietzsche" as the publisher of the contribution which wasn't already published in some journal and the like).
	language	 :: the language of the contribution
	alreadyPublished :: (yes||no) if it was already published in some publication
	filename         :: 
	file content	 :: base64 econded data
	file content type:: 'plain text', 'html', 'TEI xml', 'hnml', 'image', 'pdf', 'Generic XML'

	facsimile related attributes:	
		resolution :: dpi
		dimension  :: KB
	
	essay related attributes:
		abstract   :: text	
		curator(s) notes :: text

	essay page related attributes:
		[related essay :: siglum ] => stated in relations via the 'isSubpartOf' predicate
		position       :: position of this page in the essay (int value)
		position name  :: page name in the original publication (string)
	
  	path related attributes:

		description :: text

	path step:
	        [related path     :: siglum ] => stated in relations via the 'isSubpartOf' predicate
		[related source   :: the siglum of the source this step is about] => stated in relations via the 'cites' predicate		
		position         :: the position of this step in the path
	        step description :: text
		
        external object:	

                journal : if it was published in a journal here it is the name, year, issue
                book_collection: if it was published in a book collection, here it is the data of it
                publication place: the city of publication
                publisher: who published that version
                pages : number of pages (if it's a book on its own)
                first_page: first page (if it's in a journal or a collection)
                last_page:  last page (if it's in a journal or a collection)
                related_contribution : the contribution which represent this in the hyper
                related_contribution_type: the contribution type
        
        bibliographical card:
                Bibliographical Cards have all the common fields above, and they are related to the bibliographical card itself. 
                They also have the following five fields, all related to the contribution this bibliographical card is about:

                contribution_title: the title of the related contribution
                contribution_journal: if the related contribution was published in a journal here it is the name, year, issue
                contribution_book_collection: if the related contribution was published in a book collection, here it is the data of it
                contribution_publication_place: the city of publication of the related contribution
                contribution_publisher: who published the related contribution
                
           
            
======

authors:

	siglum	
 	name   
 	surname 
 	status  
 	istitution 
 	position   
 	street     
 	zip        
 	city       
 	country    
 	state      
 	telephone  
 	fax        
 	email      
 	webpage	    
 	from_date :: the day this author was registered (date)
	to_date   :: the day this author has un-registered (date)


relations::
	predicate :: ('isAuthorOf')
	object    :: source siglum


==============

archives:

	siglum
	name
	state
	city
	address