Lowercase command and option descriptions.

When displaying help on the command line, all command and
option descriptions are now lowercase.

Author: tjohnston-softdev

changelog.md

@@ -1,4 +1,7 @@
 # Changelog
 
-* Deleted './src/output/result-control.js'
-	* It has been split into different files.
+**./src/common/sub-interface/**
+* When displaying help on the command line, all command and option descriptions are now lowercase.
+* This affects the files:
+	* cmd-desc.js
+	* option-desc.js

src/common/sub-interface/cmd-desc.js

@@ -4,24 +4,24 @@ const mapAbsoluteDesc = writeMapDesc("an absolute node graph text file");
 const mapGridDesc = writeMapDesc("a predefined binary grid text file");
 const mapRelativeDesc = writeMapDesc("a relative node graph text file");
 const mapImageDesc = writeMapDesc("an existing image file of a maze");
-const createImageConfigDesc = "Creates a configuration file that can be used when reading images.";
-const loadImageConfigDesc = "Reads and validates an existing image configuration file.";
-const gridToAbsoluteDesc = writeAbsoluteConversionDesc("Grid definition text");
-const imageToAbsoluteDesc = writeAbsoluteConversionDesc("Image");
+const createImageConfigDesc = "creates a configuration file that can be used when reading images.";
+const loadImageConfigDesc = "reads and validates an existing image configuration file.";
+const gridToAbsoluteDesc = writeAbsoluteConversionDesc("grid definition text");
+const imageToAbsoluteDesc = writeAbsoluteConversionDesc("image");
 const imageToGridDesc = writeImageToGridDesc();
-const absoluteToRelativeDesc = writeRelativeConversionDesc("Absolute definition text");
-const gridToRelativeDesc = writeRelativeConversionDesc("Grid definition text");
-const imageToRelativeDesc = writeRelativeConversionDesc("Image");
-const testExportDesc = "Used to test file output by exporting a hard-coded graph.";
-const versionDesc = "Displays current version number.";
+const absoluteToRelativeDesc = writeRelativeConversionDesc("absolute definition text");
+const gridToRelativeDesc = writeRelativeConversionDesc("grid definition text");
+const imageToRelativeDesc = writeRelativeConversionDesc("image");
+const testExportDesc = "used to test file output by exporting a hard-coded graph.";
+const versionDesc = "displays current version number.";
 
 
 
 function writeMapDesc(fileDesc)
 {
 	var writeRes = "";
 
-	writeRes += "Takes ";
+	writeRes += "takes ";
 	writeRes += fileDesc;
 	writeRes += ", converts it into an interactive diagram, and performs a pathfinding algorithm.";
 
@@ -33,9 +33,9 @@ function writeAbsoluteConversionDesc(inputDesc)
 {
 	var writeRes = "";
 
-	writeRes += "Takes an existing ";
+	writeRes += "takes an existing ";
 	writeRes += inputDesc;
-	writeRes += " file, parses it into a graph, and outputs an Absolute definition text file.";
+	writeRes += " file, parses it into a graph, and outputs an absolute definition text file.";
 
 	return writeRes;
 }
@@ -45,9 +45,9 @@ function writeRelativeConversionDesc(inputDesc)
 {
 	var writeRes = "";
 
-	writeRes += "Takes an existing ";
+	writeRes += "takes an existing ";
 	writeRes += inputDesc;
-	writeRes += " file, parses it into a graph, and outputs a Relative definition text file.";
+	writeRes += " file, parses it into a graph, and outputs a relative definition text file.";
 
 	return writeRes;
 }
@@ -56,7 +56,7 @@ function writeImageToGridDesc()
 {
 	var writeRes = "";
 
-	writeRes += "Takes an existing image file, ";
+	writeRes += "takes an existing image file, ";
 	writeRes += "parses it into a grid, and ";
 	writeRes += "outputs it as a definition text file.";
 

src/common/sub-interface/option-desc.js

@@ -1,26 +1,26 @@
 // Option description text.
 
-const outputFolderDesc = "Specifies the folder path where output result files will be written.";
+const outputFolderDesc = "specifies the folder path where output result files will be written.";
 const ignoreTextParseDesc = writeIgnoreParseDesc("text");
 const ignoreImageParseDesc = writeIgnoreParseDesc("image");
-const exportGraphDesc = "Indicates whether to export the resulting graph diagram.";
-const exportRawDesc = "Exports raw graph and path data to separate files.";
+const exportGraphDesc = "indicates whether to export the resulting graph diagram.";
+const exportRawDesc = "exports raw graph and path data to separate files.";
 const loadImageConfigDesc = writeLoadSaveImageConfigDesc("file path of an existing", "loaded.");
 const saveImageConfigDesc = writeLoadSaveImageConfigDesc("name of a saved", "saved.");
 const wallColourDesc = writeColourDesc("wall", "#000000");
 const floorColourDesc = writeColourDesc("floor", "#FFFFFF");
-const tolerancePercentDesc = "The percentage difference allowed when checking image pixel colours. (default: 0)";
-const tileSizeDesc = "The approximate size of a maze tile in pixels. (default: 10)";
-const imageOriginDescX = writeOriginDesc("X");
-const imageOriginDescY = writeOriginDesc("Y");
-const replaceExistingFileDesc = "Specifies whether existing files will be replaced.";
-const saveImageConvConfigDesc = "Specifies the path where the image configuration file will be saved. If this is blank, no file will be saved.";
+const tolerancePercentDesc = "the percentage difference allowed when checking image pixel colours. (default: 0)";
+const tileSizeDesc = "the approximate size of a maze tile in pixels. (default: 10)";
+const imageOriginDescX = writeOriginDesc("x");
+const imageOriginDescY = writeOriginDesc("y");
+const replaceExistingFileDesc = "specifies whether existing files will be replaced.";
+const saveImageConvConfigDesc = "specifies the path where the image configuration file will be saved. if this is blank, no file will be saved.";
 
 
 
 function writeIgnoreParseDesc(typeDesc)
 {
-	var writeRes = "Ignores or corrects non-fatal errors when parsing input " + typeDesc + " files.";
+	var writeRes = "ignores or corrects non-fatal errors when parsing input " + typeDesc + " files.";
 	return writeRes;
 }
 
@@ -29,9 +29,9 @@ function writeLoadSaveImageConfigDesc(valueDesc, fileAction)
 {
 	var writeRes = "";
 
-	writeRes += "Specifies the " + valueDesc;
+	writeRes += "specifies the " + valueDesc;
 	writeRes += " image configuration file. ";
-	writeRes += " If this is blank, no file will be ";
+	writeRes += " if this is blank, no file will be ";
 	writeRes += fileAction;
 
 	return writeRes;
@@ -42,7 +42,7 @@ function writeColourDesc(pixelDesc, defaultHex)
 {
 	var writeRes = "";
 
-	writeRes += "The hex colour of ";
+	writeRes += "the hex colour of ";
 	writeRes += pixelDesc;
 	writeRes += " pixels in the target image. (default: ";
 	writeRes += defaultHex;
@@ -54,7 +54,7 @@ function writeColourDesc(pixelDesc, defaultHex)
 
 function writeOriginDesc(oPlane)
 {
-	var writeRes = "The approximate " + oPlane + " location of the first tile. (default: 0)";
+	var writeRes = "the approximate " + oPlane + " location of the first tile. (default: 0)";
 	return writeRes;
 }
 

summary.md

@@ -1,11 +1,12 @@
 # Summary
 
-**Version:** 1.0.24
+**Version:** 1.0.25
 
 **Date:** 2021-03-31
 
-**Title:** Result Control Delete
+**Title:** Lowercase command and option descriptions.
 
 **Description:**
 
-Deleted original 'result-control.js' file.
+When displaying help on the command line, all command and
+option descriptions are now lowercase.