updating the docs

Author: cesine

.gitignore

@@ -18,7 +18,6 @@ coverage
 
 # Compiled binary addons (http://nodejs.org/api/addons.html)
 build
-dist
 
 # Dependency directory
 # Deployed apps should consider commenting this line out:

README.md

@@ -5,25 +5,28 @@ A small library which can parse TextGrid into json and json into TextGrid
 
 ## Getting Started
 ### On the server
-Install the module with: `npm install textgrid`
+Install the module with: `npm install textgrid --save`
 
 ```javascript
 var textgrid = require('textgrid');
 textgrid.init(); // "init"
 ```
 
 ### In the browser
+
+Install the module with: `bower install textgrid --save` or,
+ 
 Download the [production version][min] or the [development version][max].
 
 [min]: https://raw.github.com/OpenSourceFieldlinguistics/PraatTextGridJS/master/dist/textgrid.min.js
 [max]: https://raw.github.com/OpenSourceFieldlinguistics/PraatTextGridJS/master/dist/textgrid.js
 
-In your web page:
+In your web app:
 
 ```html
-<script src="dist/textgrid.min.js"></script>
+<script src="bower_components/textgrid/dist/textgrid.min.js"></script>
 <script>
-init(); // "init"
+  var textgridAsJson = TextGrid.textgridToIGT(originalTextGridAsText);
 </script>
 ```
 
@@ -33,25 +36,83 @@ In your code, you can attach textgrid's methods to any object.
 <script>
 var exports = Bocoup.utils;
 </script>
-<script src="dist/textgrid.min.js"></script>
+<script src="bower_components/textgrid/dist/textgrid.min.js"></script>
 <script>
-Bocoup.utils.init(); // "init"
+var textgridAsJson = Bocoup.utils.textgridToIGT(originalTextGridAsText); // "init"
 </script>
 ```
 
+An example of what you can do with the result.
+
+```js
+var textgrid = TextGrid.textgridToIGT(text);
+if (textgrid.isIGTNestedOrAlignedOrBySpeaker.probablyAligned) {
+	for (itemIndex in textgrid.intervalsByXmin) {
+		if (!textgrid.intervalsByXmin.hasOwnProperty(itemIndex)) {
+			continue;
+		}
+		if (textgrid.intervalsByXmin[itemIndex]) {
+			row = {};
+			for (intervalIndex = 0; intervalIndex < textgrid.intervalsByXmin[itemIndex].length; intervalIndex++) {
+				interval = textgrid.intervalsByXmin[itemIndex][intervalIndex];
+				row.startTime = row.startTime ? row.startTime : interval.xmin;
+				row.endTime = row.endTime ? row.endTime : interval.xmax;
+				row.utterance = row.utterance ? row.utterance : interval.text.trim();
+				row.modality = "spoken";
+				row.tier = interval.tierName;
+				row.speakers = interval.speaker;
+				row.audioFileName = interval.fileName || audioFileName;
+				row.CheckedWithConsultant = interval.speaker;
+				consultants.push(row.speakers);
+				row[interval.tierName] = interval.text;
+				header.push(interval.tierName);
+			}
+			matrix.push(row);
+		}
+	}
+} else {
+	for (itemIndex in textgrid.intervalsByXmin) {
+		if (!textgrid.intervalsByXmin.hasOwnProperty(itemIndex)) {
+			continue;
+		}
+		if (textgrid.intervalsByXmin[itemIndex]) {
+			for (intervalIndex = 0; intervalIndex < textgrid.intervalsByXmin[itemIndex].length; intervalIndex++) {
+				row = {};
+				interval = textgrid.intervalsByXmin[itemIndex][intervalIndex];
+				row.startTime = row.startTime ? row.startTime : interval.xmin;
+				row.endTime = row.endTime ? row.endTime : interval.xmax;
+				row.utterance = row.utterance ? row.utterance : interval.text.trim();
+				row.modality = "spoken";
+				row.tier = interval.tierName;
+				row.speakers = interval.speaker;
+				row.audioFileName = interval.fileName || audioFileName;
+				row.CheckedWithConsultant = interval.speaker;
+				consultants.push(row.speakers);
+				row[interval.tierName] = interval.text;
+				header.push(interval.tierName);
+				matrix.push(row);
+			}
+		}
+	}
+}
+
+```
+
 ## Documentation
-_(Coming soon)_
+http://opensourcefieldlinguistics.github.io/FieldDB/
 
 ## Examples
-_(Coming soon)_
+See tests directory for more ways to use the library
 
 ## Contributing
 In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
 
-_Also, please don't edit files in the "dist" subdirectory as they are generated via Grunt. You'll find source code in the "lib" subdirectory!_
+_The "dist" subdirectory files are generated via Grunt. You'll find source code in the "lib" subdirectory!_
 
 ## Release History
-_(Nothing yet)_
+* v1.102.3 April 22 2014 Long audio import support 
+* v2.2.0 April 22 2014 Support for multiple small files each corresponding to an utterance 
+
 
 ## License
 Copyright (c) 2014 OpenSourceFieldLinguistics Contribs  

bower.json

@@ -6,7 +6,7 @@
     "OpenSourceFieldLinguistics Contribs"
   ],
   "description": "A small library which can parse TextGrid into json and json into TextGrid",
-  "main": "lib/textgrid.js",
+  "main": "dist/textgrid.js",
   "moduleType": [
     "amd",
     "node"
@@ -22,7 +22,7 @@
     "bower_components",
     "test",
     "tests",
-    "dist",
+    "lib",
     "Gruntfile.js",
     "data",
     "package.json"

lib/.jshintrc

@@ -9,5 +9,5 @@
   "undef": true,
   "boss": true,
   "eqnull": true,
-  "predef": ["exports"]
+  "predef": ["exports", "console"]
 }

lib/textgrid.js

@@ -158,7 +158,7 @@
 			return tier.name;
 		});
 		// console.log(tierNames);
-		if (tierNames.length - probablyFromElanWithSpeakerEncodedInTierNameCount == 0) {
+		if (tierNames.length - probablyFromElanWithSpeakerEncodedInTierNameCount === 0) {
 			probablyFromElanWithSpeakerEncodedInTierName = true;
 		}
 		if (!json || !json.items) {
@@ -264,12 +264,13 @@
 	};
 
 	TextGrid.printIGT = function(igtIntervalsJSON) {
+		var mapper = function(interval) {
+			return interval.xmin + "," + interval.xmax + "," + interval.text;
+		};
 		for (var interval in igtIntervalsJSON) {
 			console.log(interval);
 			if (igtIntervalsJSON.hasOwnProperty(interval)) {
-				console.log(igtIntervalsJSON[interval].map(function(interval) {
-					return interval.xmin + "," + interval.xmax + "," + interval.text;
-				}));
+				console.log(igtIntervalsJSON[interval].map(mapper));
 			}
 		}
 	};