Difference between revisions of "ISFDB Design Documentation"
| Line 2: | Line 2: | ||
The topics referred to in this article discuss the overall scope and concepts behind the changes from ISFDB1 to ISFDB2. Articles on the layout of the online database schema, XML data submission formats, and the REST API can be found here. | The topics referred to in this article discuss the overall scope and concepts behind the changes from ISFDB1 to ISFDB2. Articles on the layout of the online database schema, XML data submission formats, and the REST API can be found here. | ||
| + | |||
==Concept of Operations== | ==Concept of Operations== | ||
The Concept of Operations document is an IEEE standard (1362-1998) for describing the differences between a current system definition and a proposed one. It is less technical and rigorous than well documented feature or system requirements, which makes it more readable to non-engineers. Many things have changed since version 1.0 of the [http://www.isfdb.org/CONOPS.pdf CONOPS] was written in 2001; these changes are reflected in the new [[Concept of Operations]] documentation. | The Concept of Operations document is an IEEE standard (1362-1998) for describing the differences between a current system definition and a proposed one. It is less technical and rigorous than well documented feature or system requirements, which makes it more readable to non-engineers. Many things have changed since version 1.0 of the [http://www.isfdb.org/CONOPS.pdf CONOPS] was written in 2001; these changes are reflected in the new [[Concept of Operations]] documentation. | ||
| + | |||
==Database Schema== | ==Database Schema== | ||
| Line 22: | Line 24: | ||
A simple set of ISFDB web services exist that allow a remote application to make queries about publications and to make remote submissions. The submission capability requires a registered login id and a license key. Details on the API can be found in the [[Web API]] article. | A simple set of ISFDB web services exist that allow a remote application to make queries about publications and to make remote submissions. The submission capability requires a registered login id and a license key. Details on the API can be found in the [[Web API]] article. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| Line 35: | Line 33: | ||
* [[Requirements:Publication Display]] | * [[Requirements:Publication Display]] | ||
* [[Requirements:Award Display]] | * [[Requirements:Award Display]] | ||
| + | |||
| + | |||
| + | ==Examples== | ||
| + | |||
| + | [[Michael J. Cross]] (who is also a short fiction contributor to the ISFDB) has a prototype website up and running using the MySQL database. It is under development, not complete, and subject to change. Here are the links to the [http://www.michaelcross.me.uk/devarea/ Project Page] and the [http://www.michaelcross.me.uk/isfdb/ Database Page]. | ||
Revision as of 20:13, 7 May 2008
Introduction
The topics referred to in this article discuss the overall scope and concepts behind the changes from ISFDB1 to ISFDB2. Articles on the layout of the online database schema, XML data submission formats, and the REST API can be found here.
Concept of Operations
The Concept of Operations document is an IEEE standard (1362-1998) for describing the differences between a current system definition and a proposed one. It is less technical and rigorous than well documented feature or system requirements, which makes it more readable to non-engineers. Many things have changed since version 1.0 of the CONOPS was written in 2001; these changes are reflected in the new Concept of Operations documentation.
Database Schema
The ISFDB data resides in a MySQL database. The data resides in tables which are grouped into four categories: author-related, table-related, publication-related, and global data. The online bibliographic pages are constructed directly from these database tables. Modifications to the database are made by inserting XML-formatted submissions into a special submissions table; they are later integrated by a moderator while has the appropriate privileges.
Details on table structure and relationships can be found in the Database Schema article.
Data Submission XML Formats
Updates to the database are made by submitting data requests. These requests are XML-based, and follow specific Data Submission Formats. The requests can either be generated via online editing tools available at the main site, or may generated by offline tools and submitted via the Web Services API.
Web Services
A simple set of ISFDB web services exist that allow a remote application to make queries about publications and to make remote submissions. The submission capability requires a registered login id and a license key. Details on the API can be found in the Web API article.
Display Requirements
The following pages are intended to capture the detailed display requirements for each type of bibliographic record:
- Requirements:Author Display
- Requirements:Title Display
- Requirements:Publication Display
- Requirements:Award Display
Examples
Michael J. Cross (who is also a short fiction contributor to the ISFDB) has a prototype website up and running using the MySQL database. It is under development, not complete, and subject to change. Here are the links to the Project Page and the Database Page.