Update help of extensions

julianmendez · Feb 9, 2019 · 4833537 · 4833537
1 parent 8d1f671
commit 4833537
Show file tree

Hide file tree

Showing 13 changed files with 17 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -264,11 +264,11 @@ Each extension registers at the beginning of the execution and is available to b
 
 The following example contains some of the extensions listed by the application, when no parameters are given.
 
-- `simple` *(input)* *(output)* : creates a Tabula/Properties file (this is the default format)
-- `oldformat` *(input)* *(output)* : creates an old Tabula/Properties file, i.e. using the equals sign instead of colon 
-- `parsejson` *(input)* *(output)* : creates a Tabula/Properties file by parsing a Tabula/JSON file 
-- `json` *(input)* *(output)* : creates a Tabula/JSON file
-- `yaml` *(input)* *(output)* : creates a Tabula/YAML file
+- `simple` *(input)* *(output)* : create a Tabula/Properties file (this is the default format)
+- `oldformat` *(input)* *(output)* : create an old Tabula/Properties file, i.e. using the equals sign instead of colon 
+- `parsejson` *(input)* *(output)* : create a Tabula/Properties file by parsing a Tabula/JSON file 
+- `json` *(input)* *(output)* : create a Tabula/JSON file
+- `yaml` *(input)* *(output)* : create a Tabula/YAML file
 
 The command line application can be executed with:
 

diff --git a/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/extension/DefaultExtension.scala b/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/extension/DefaultExtension.scala
@@ -13,7 +13,7 @@ import de.tudresden.inf.lat.tabulas.table.TableMap
 class DefaultExtension extends Extension {
 
   val Name: String = "simple"
-  val Help: String = "(input) (output) : parse and create output file with a simple text format"
+  val Help: String = "(input) (output) : create a Tabula/Properties file (this is the default format)"
   val RequiredArguments: Int = 2
 
   override def process(arguments: Seq[String]): Boolean = {

diff --git a/...s-core/src/main/scala/de/tudresden/inf/lat/tabulas/extension/NormalizationExtension.scala b/...s-core/src/main/scala/de/tudresden/inf/lat/tabulas/extension/NormalizationExtension.scala
@@ -13,7 +13,7 @@ import de.tudresden.inf.lat.tabulas.table.TableMap
 class NormalizationExtension extends Extension {
 
   val Name: String = "normalize"
-  val Help: String = "(input) : normalize a file with a simple text format"
+  val Help: String = "(input) : normalize a Tabula/Properties file (this is the default format)"
   val RequiredArguments: Int = 1
 
   override def process(arguments: Seq[String]): Boolean = {

diff --git a/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/extension/OldFormatExtension.scala b/tabulas-core/src/main/scala/de/tudresden/inf/lat/tabulas/extension/OldFormatExtension.scala
@@ -13,7 +13,7 @@ import de.tudresden.inf.lat.tabulas.table.TableMap
 class OldFormatExtension extends Extension {
 
   val Name: String = "oldformat"
-  val Help: String = "(input) (output) : parse and create an output file with the old simple text format (using equals sign)"
+  val Help: String = "(input) (output) : create an old Tabula/Properties file, i.e. using the equals sign instead of colon"
   val RequiredArguments: Int = 2
 
   override def process(arguments: Seq[String]): Boolean = {

diff --git a/...-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/parser/CalendarParserExtension.scala b/...-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/parser/CalendarParserExtension.scala
@@ -16,7 +16,7 @@ class CalendarParserExtension extends Extension {
 
   val Name: String = "parsecalendar"
 
-  val Help: String = "(input) (output) : create output file with a simple text format parsing a calendar file"
+  val Help: String = "(input) (output) : create a Tabula/Properties file by parsing a calendar (iCalendar) file (this is experimental and does not parse all properties)"
 
   val RequiredArguments: Int = 2
 

diff --git a/tabulas-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/parser/CsvParserExtension.scala b/tabulas-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/parser/CsvParserExtension.scala
@@ -14,7 +14,7 @@ import de.tudresden.inf.lat.tabulas.table.TableMap
 class CsvParserExtension extends Extension {
 
   val Name: String = "parsecsv"
-  val Help: String = "(input) (output) : create output file with a simple text format parsing a comma-separated values (CSV) file"
+  val Help: String = "(input) (output) : create a Tabula/Properties file by parsing a comma-separated values (CSV) file"
   val RequiredArguments: Int = 2
 
   override def process(arguments: Seq[String]): Boolean = {

diff --git a/tabulas-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/parser/JsonParserExtension.scala b/tabulas-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/parser/JsonParserExtension.scala
@@ -12,7 +12,7 @@ import de.tudresden.inf.lat.tabulas.table.TableMap
 class JsonParserExtension extends Extension {
 
   val Name: String = "parsejson"
-  val Help: String = "(input) (output) : create output file with a simple text format parsing a JSON file"
+  val Help: String = "(input) (output) : create a Tabula/Properties file by parsing a Tabula/JSON file"
   val RequiredArguments: Int = 2
 
   override def process(arguments: Seq[String]): Boolean = {

diff --git a/tabulas-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/renderer/CsvExtension.scala b/tabulas-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/renderer/CsvExtension.scala
@@ -13,7 +13,7 @@ import de.tudresden.inf.lat.tabulas.table.TableMap
 class CsvExtension extends Extension {
 
   val Name: String = "csv"
-  val Help: String = "(input) (output) : create output as a comma-separated values (CSV) file"
+  val Help: String = "(input) (output) : create a comma-separated values (CSV) file"
   val RequiredArguments: Int = 2
 
   override def process(arguments: Seq[String]): Boolean = {

diff --git a/tabulas-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/renderer/HtmlExtension.scala b/tabulas-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/renderer/HtmlExtension.scala
@@ -13,7 +13,7 @@ import de.tudresden.inf.lat.tabulas.table.TableMap
 class HtmlExtension extends Extension {
 
   val Name: String = "html"
-  val Help: String = "(input) (output) : create output as HTML file"
+  val Help: String = "(input) (output) : create an HTML file"
   val RequiredArguments: Int = 2
 
   override def process(arguments: Seq[String]): Boolean = {

diff --git a/tabulas-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/renderer/JsonExtension.scala b/tabulas-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/renderer/JsonExtension.scala
@@ -13,7 +13,7 @@ import de.tudresden.inf.lat.tabulas.table.TableMap
 class JsonExtension extends Extension {
 
   val Name: String = "json"
-  val Help: String = "(input) (output) : create output as JSON file"
+  val Help: String = "(input) (output) : create a Tabula/JSON file"
   val RequiredArguments: Int = 2
 
   override def process(arguments: Seq[String]): Boolean = {

diff --git a/tabulas-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/renderer/SqlExtension.scala b/tabulas-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/renderer/SqlExtension.scala
@@ -13,7 +13,7 @@ import de.tudresden.inf.lat.tabulas.table.TableMap
 class SqlExtension extends Extension {
 
   val Name: String = "sql"
-  val Help: String = "(input) (output) : create output as SQL dump file"
+  val Help: String = "(input) (output) : create an SQL dump file"
   val RequiredArguments: Int = 2
 
   override def process(arguments: Seq[String]): Boolean = {

diff --git a/tabulas-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/renderer/WikitextExtension.scala b/tabulas-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/renderer/WikitextExtension.scala
@@ -13,7 +13,7 @@ import de.tudresden.inf.lat.tabulas.table.TableMap
 class WikitextExtension extends Extension {
 
   val Name: String = "wikitext"
-  val Help: String = "(input) (output) : create output as Wiki text file"
+  val Help: String = "(input) (output) : create a Wiki text file"
   val RequiredArguments: Int = 2
 
   override def process(arguments: Seq[String]): Boolean = {

diff --git a/tabulas-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/renderer/YamlExtension.scala b/tabulas-ext/src/main/scala/de/tudresden/inf/lat/tabulas/ext/renderer/YamlExtension.scala
@@ -13,7 +13,7 @@ import de.tudresden.inf.lat.tabulas.table.TableMap
 class YamlExtension extends Extension {
 
   val Name: String = "yaml"
-  val Help: String = "(input) (output) : create output as YAML file"
+  val Help: String = "(input) (output) : create a Tabula/YAML file"
   val RequiredArguments: Int = 2
 
   override def process(arguments: Seq[String]): Boolean = {