Browse Source

Finished writing about the file format

Samuel W. Flint 7 years ago
parent
commit
97c560e705
1 changed files with 17 additions and 2 deletions
  1. 17 2
      library.org

+ 17 - 2
library.org

@@ -59,12 +59,26 @@ As a person who has a lot of books, I like to be able to keep track of them.  I'
 #+TOC: headlines 3
 #+TOC: listings
 
-* WORKING File Format
+* DONE File Format
+CLOSED: [2016-10-06 Thu 17:29]
 :PROPERTIES:
 :CREATED:  <2016-04-13 Wed 20:17>
 :ID:       1745de61-6511-4257-bed8-112df2362fe7
 :END:
 
+The following defines the format of book records, which are used to describe each individual book in the library.  A record contains the following:
+
+ - ID :: an integer, automatically generated by the system.
+ - Title :: A string, at most, one line long.
+ - Author :: A string, in the format of ~Last, First && Second Last, First~.
+ - LCCN :: A string, being the LOC Classification of the given book.
+ - ISBN :: A string, made up of the numbers 0-9, with an optional "X" at the end.
+ - Publisher :: A string, generally unformatted.
+ - Copyright :: An integer, the year the book was published, or the copyright, whichever is later.
+ - Location :: A string denoting where the book is located.
+ - Withdrawn :: An optional timestamp denoting when a book was withdrawn from the library.
+ - Inserted :: A timestamp representing when the book was inserted into the library, this is automatically generated.
+
 #+Caption: File Format
 #+Name: file-format
 #+BEGIN_SRC text
@@ -82,9 +96,10 @@ As a person who has a lot of books, I like to be able to keep track of them.  I'
   %type: Publisher line
   %type: Copyright int
   %type: Location line
+  %type: Withdrawn date
   %type: Inserted date
   %mandatory: Title Author LCCN Inserted
-  %allowed: ISBN Publisher Copyright Location
+  %allowed: ISBN Publisher Copyright Location Withdrawn
   %auto: ID Inserted
 #+END_SRC