editioncrafter-cli 1.2.0

.gitignore

@@ -5,3 +5,5 @@ public/
 data/config.json
 out/*
 out.xml
+*.sqlite
+!data/example.sqlite

README.md

@@ -70,6 +70,16 @@ editioncrafter process -i <tei_file> -o <output_path> -u <base_url>
 ```
 This will create all of the artifacts that EditionCrafter needs in order to display your document on the web, and place them in the specified `<output_path>` folder. The `<base_url>` parameter should be the URL at which you intend to host these artifacts.
 
+### `database`
+
+Process the TEI document into a SQLite file containing a directory of categories and tags. This can be used with the Record List component from the EditionCrafter viewer package, or it can be browsed directly with a SQLite viewer.
+
+Usage: `editioncrafter database [-i tei_file] [-o output_path]`
+
+Required parameters:
+* -i tei_file
+* -o output_path (must end in .sqlite)
+
 ## Command line options
 
 ### `-c` or `--config`

data/images-example.xml

@@ -286,24 +286,24 @@
 <lb />Flavius Vopiscus
 </ab>
 <ab>
-<lb />   
-<lb />   
+<lb />
+<lb />
 </ab>
 <ab>
-<lb />          
+<lb />
 <lb />[List of books]
 </ab>
 <ab>
 <lb />Aquatilium animalium historiæ, Hypolito
 <lb />Salviano Typhernate authore, Romæ 1554
-<lb />        
+<lb />
 </ab>
 <ab>
-<lb />  
-<lb />  
+<lb />
+<lb />
 </ab>
 <ab>
-<lb />        
+<lb />
 <lb />Les Annales de
 <lb />Normandie
 </ab>
@@ -429,11 +429,11 @@
 <lb />Counterfeit coral
 </ab>
 <ab>
-<lb />    
+<lb />
 <lb />                  
 <lb />                  
 <lb />        +
-<lb />    
+<lb />
 </ab>
 <ab>
 <lb />One needs to first make the branches of wood or take a
@@ -442,7 +442,7 @@
 <lb />subtly ground vermilion with walnut oil, and if
 <lb />you add in a little Venice laque platte, the
 <lb />color will be more vivid, and stir everything in the resin melted
-<lb />over a charcoal fire and not of flame, for fear that it catches fire. 
+<lb />over a charcoal fire and not of flame, for fear that it catches fire.
 <lb />Next dip in your branches while turning, &amp; if any filaments
 <lb />should remain on it, turn the branch over the heat of the
 <lb />charcoal.
@@ -513,20 +513,20 @@
 <lb />drips more than two months after it has been applied to the
 <lb />planks. But this one does not drip like that of times
 <lb />past, which was made of linseed oil, garlic boiled in it
-<lb />to extinguish it &amp; rid it of grease, 
+<lb />to extinguish it &amp; rid it of grease,
 <lb />&amp; with wheat. And this one yellowed &amp;
 <lb />rendered greenish the blue color of paintings. This one is made like the
 <lb />other one except that one puts coarse common turpentine
 </ab>
 <ab>
-<lb />        
-<lb />    
+<lb />
+<lb />
 <lb />But it is used to heighten colors which have soaked in and to keep them
 <lb />from dust. Mastic varnish does not resist rain,
-<lb />whereas that of oil and rosin does.  
+<lb />whereas that of oil and rosin does.
 </ab>
 <ab>
-<lb />    
+<lb />
 <lb />
 </ab>
 
@@ -575,7 +575,7 @@
 <lb />of spike lavender &amp; sandarac. Also, that of spike
 <lb />lavender does not require any glue on iron &amp;
 <lb />similar things that do not absorb. But on wood &amp; on colors
-<lb />which &lt;-have-&gt; do not have gum or 
+<lb />which &lt;-have-&gt; do not have gum or
 <lb />distemper glue, it is necessary to lay one coat of the said
 <lb />hide glue &amp; to let it dry &amp; to
 <lb />varnish.
@@ -684,7 +684,7 @@
 <lb />open space.
 </ab>
 <ab>
-<lb /> 
+<lb />
 </ab>
 <ab>
 <lb />In five or six lb of oil, one must put one lb
@@ -730,4 +730,4 @@
 
   </div></body>
       </text>
-  </TEI>
+  </TEI>

docs.md

@@ -48,6 +48,16 @@ Optional parameters:
 * -u base_url
 * -c: Config file
 
+### `database`
+
+Process the TEI document into a SQLite file containing a directory of categories and tags. This can be used with the Record List component from the EditionCrafter viewer package, or it can be browsed directly with a SQLite viewer.
+
+Usage: `editioncrafter database [-i tei_file] [-o output_path]`
+
+Required parameters:
+* -i tei_file
+* -o output_path (must end in .sqlite)
+
 ### help
 
 Displays this help.