1 rewrite of scan batch dir

README.md

@@ -7,81 +7,64 @@ few types of file directory layouts relating to these types of objects:
 
 - Books
 
+- Compound Books
+
 - Manuscripts
 
-- Newspaper Issues
+- Newspaper/Serial Issues (Paged)
+
+- Newspaper/Serial Issues (PDF)
 
 - Audio (Oral Histories or General Audio files)
 
 - Video (Oral Histories or General Videos)
 
-- Images
-
-Currently no other object types are addressed, but the script will
-identify and add them as it finds them.
-
-The script will ignore the following files and directories (including
-contents):
+- Image (Single Image)
 
-- Directory named 'ignore'
+- PDF (Single File)
 
-- File named 'manuscript.csv'
+- Page (Single Page)
 
-- File named 'manuscript.xls'
+Currently no other object types are addressed, but the script will
+identify and add them as it finds them.
 
-- File named 'manuscript.xlsx'
+The script will ignore the files and directories (including contents) of the configuration file 'skip' parameter. This is a comma separated list of patterns that the script will not process.  These are file patterns that you do not want to process.
 
 ## Google Sheet requirements:
 
-Sheet Columns:
-
-  -----------------------------------------------------------------------
-  Required Columns         Description
-  ------------------------ ----------------------------------------------
-  'id'                     The PID of the object. This column must exist.
-
-  'file'                   Leave this empty but the column must exist.
-                           This field will be updated by the script with
-                           the full path to the file.
-
-  Optional Columns         
-
-  'thumbnail'              Used for A/V media. If a .jpg or .png file is
-                           found the full path to the file will be added
-                           to this column.
-
-  'transcript'             Used for A/V media. If a .srt or .vtt file is
-                           found the full path to the file will be added
-                           to this column.
-
-
-  -----------------------------------------------------------------------
-
-Script Parameters:
-
-  -------------------------------------------------------------------------
-  Required Parameters       Description
-  ------------------------- -----------------------------------------------
-  \--config-file            Full or relative path to the configuration file
-                            used for the script.
+### Sheet Required Columns:
 
-  \--log-file               Full or relative path to the log file that will
-                            be generated.
+  |Required Columns        | Description |
+  |--- |--- |
+  |'id'                    |The PID of the object. This column must exist.|
+  |'file'                  |Leave this empty but the column must exist. This field will be updated by the script with the full path to the file.|
+  |'model'                 |This column will be added. This is the Islandora Model.|
+  |'field_model'           |This column will be added. This is the Islanodra Model Taxonomy ID.|
+  |'field_weight'          |This column will be added. This is the order of the objects in the sheet if it can be determined.|
+  |'field_resource_type'   |This column will be added. This is the Resource Type of the object in the sheet.|
 
-  \--directory              Full path of the directory we wish to scan.
+### Sheet Optional Columns:
 
-
+  |Optional Columns        | Description | 
+  |--- |--- |
+  |'thumbnail'             |Used for A/V media. If a .jpg or .png file is found the full path to the file will be added to this column.|
+  |'transcript'            |Used for A/V media. If a .srt or .vtt file is found the full path to the file will be added to this column.|
 
-  Optional Parameters       
+### Script Required Parameters:
 
-  \--in-google-sheet-id     The ID number of the Google Sheet.
+  |Required Parameters      | Description |
+  |--- |--- |
+  |\--config-file           |Full or relative path to the configuration file used for the script.|
+  |\--log-file              |Full or relative path to the log file that will be generated.|
+  |\--directory             |Full path of the directory we wish to scan.|
 
-  \--in-google-sheet-name   The Name of the Tab in the Google Sheet (E.g.:
-                            Sheet1)
+### Script Optional Parameters:        
 
-  \--in-google-creds-file   The full or relative path to the Google
-                            Credentials File.
-  -------------------------------------------------------------------------
+  |Optional Parameters      | Description |
+  |--- |--- |
+  |\--in-google-sheet-id    |The ID number of the Google Sheet.|
+  |\--in-google-sheet-name  |The Name of the Tab in the Google Sheet (E.g.: Sheet1)|
+  |\--in-google-creds-file  |The full or relative path to the Google Credentials File.|
 
 ## Google Credentials File: