docs: fix corpus input docs

voyanttools · Sep 25, 2024 · e225eb6 · e225eb6
1 parent 275665f
commit e225eb6
Showing 1 changed file with 22 additions and 7 deletions.
diff --git a/src/corpus.js b/src/corpus.js
@@ -27,7 +27,7 @@ function isDocumentsMode(config={}) {
  * - **formats**:
  * 	- **Text**: {@link #inputRemoveFrom}, {@link #inputRemoveFromAfter}, {@link #inputRemoveUntil}, {@link #inputRemoveUntilAfter}
  * 	- **XML**: {@link #xmlAuthorXpath}, {@link #xmlCollectionXpath}, {@link #xmlContentXpath}, {@link #xmlExtraMetadataXpath}, {@link #xmlKeywordXpath}, {@link #xmlPubPlaceXpath}, {@link #xmlPublisherXpath}, {@link #xmlTitleXpath}
- * 	- **Tables**: {@link #tableAuthor}, {@link #tableContent}, {@link #tableDocuments}, {@link #tableNoHeadersRow}, {@link #tableTitle}
+ * 	- **Tables**: {@link #tableAuthor}, {@link #tableContent}, {@link #tableDocuments}, {@link #tableNoHeadersRow}, {@link #tableTitle}, {@link #tableGroupBy}
  * - **other**: {@link #inputFormat}, {@link #subTitle}, {@link #title}, {@link #tokenization}
 
  * @memberof Spyral
@@ -108,7 +108,7 @@ class Corpus {
  * - **rows**: each row of the table is a separate document
  * - **columns**: each column of the table is a separate document
  * 
- * See also [Creating a Corpus Tokenization](#!/guide/corpuscreator-section-tables).
+ * See also [Creating a Corpus with Tables](#!/guide/corpuscreator-section-tables).
  */
 
 /**
@@ -123,7 +123,7 @@ class Corpus {
  * - **1,2**: use columns 1 and 2 separately
  * - **1+2,3**: combine columns 1 and two and use column 3 separately
  * 
- * See also [Creating a Corpus Tokenization](#!/guide/corpuscreator-section-tables).
+ * See also [Creating a Corpus with Tables](#!/guide/corpuscreator-section-tables).
  */
 
 /**
@@ -138,7 +138,7 @@ class Corpus {
  * - **1,2**: use columns 1 and 2 separately
  * - **1+2,3**: combine columns 1 and two and use column 3 separately
  * 
- * See also [Creating a Corpus Tokenization](#!/guide/corpuscreator-section-tables).
+ * See also [Creating a Corpus with Tables](#!/guide/corpuscreator-section-tables).
  */
 
 /**
@@ -153,15 +153,30 @@ class Corpus {
  * - **1,2**: use columns 1 and 2 separately
  * - **1+2,3**: combine columns 1 and two and use column 3 separately
  * 
- * See also [Creating a Corpus Tokenization](#!/guide/corpuscreator-section-tables).
+ * See also [Creating a Corpus with Tables](#!/guide/corpuscreator-section-tables).
+ */
+
+/**
+ * @cfg {String} tableGroupBy Specify a column (or columns) by which to group documents; only used for table-based documents, in rows mode.
+ * 
+ * Columns are referred to by numbers, the first is column 1 (not 0).
+ * You can specify separate columns by using a comma or you can combined the contents of columns/cells by using a plus sign.
+ * 
+ * Some examples:
+ * 
+ * - **1**: use column 1
+ * - **1,2**: use columns 1 and 2 separately
+ * - **1+2,3**: combine columns 1 and two and use column 3 separately
+ * 
+ * See also [Creating a Corpus with Tables](#!/guide/corpuscreator-section-tables).
  */
 
 /**
  * @cfg {String} tableNoHeadersRow Determine if the table has a first row of headers; only used for table-based documents.
  * 
  * Provide a value of "true" if there is no header row, otherwise leave it blank or undefined (default).
  * 
- * See also [Creating a Corpus Tokenization](#!/guide/corpuscreator-section-tables).
+ * See also [Creating a Corpus with Tables](#!/guide/corpuscreator-section-tables).
  */
 
 /**
@@ -253,7 +268,7 @@ class Corpus {
  */
 
 /**
- * @cfg {String} xmlGroupByXpath The XPath expression that defines the location of each document's collection name; only used for XML-based documents.
+ * @cfg {String} xmlGroupByXpath The XPath expression by which to group multiple documents; only used for XML-based documents.
  * 
  * 		loadCorpus("<doc><sp s='Juliet'>Hello!</sp><sp s='Romeo'>Hi!</sp><sp s='Juliet'>Bye!</sp></doc>", {
  * 			 xmlDocumentsXpath: '//sp',