Relative Conversion Command Documentation

Created documentation files for Relative conversion commands

absolute-to-relative
grid-to-relative
image-to-relative

Author: tjohnston-softdev

changelog.md

@@ -1,15 +1,8 @@
 # Changelog
 
-**./info/%subfolder%/readme.md**
-* "Return to index" now links back to the project root.
-
----
-
 **./info/commands/**
-* Added line break between 'Usage' and 'Example' for individual commands.
-
----
-
-**./info/input-types/image-config.md**
-* Recompiled 'Properties' table definition code.
-	* Full instead of compact.
+* Created new files for Relative conversion commands:
+	* absolute-to-relative.md
+	* grid-to-relative.md
+	* image-to-relative.md
+* Added links to new command files inside readme.md

info/commands/absolute-to-relative.md

@@ -0,0 +1,17 @@
+## absolute-to-relative
+**Usage:** `maze absolute-to-relative [options] <input-absolute> [output-path]`  
+**Example:** `maze absolute-to-relative ./examples/absolute/input.txt ./output.txt -r`
+
+Takes an existing Absolute definition text file, parses it into a graph, and outputs a Relative definition text file.
+
+**Options:**
+| Argument                 | Description                                                         | Default |
+|--------------------------|---------------------------------------------------------------------|---------|
+| -r --replace             | Specifies whether existing files will be replaced.                  | False   |
+| -i --ignore-parse-errors | Ignores or corrects non-fatal errors when parsing input text files. | False   |
+
+**Note:** If no output path is specified, the output file will be created in the program folder named `relative.txt`
+
+---
+
+[Commands List](./readme.md)

info/commands/grid-to-relative.md

@@ -0,0 +1,17 @@
+## grid-to-relative
+**Usage:** `maze grid-to-relative [options] <input-grid> [output-path]`  
+**Example:** `maze grid-to-relative ./examples/grid/input.txt ./output.txt -r`
+
+Takes an existing Grid definition text file, parses it into a graph, and outputs a Relative definition text file.
+
+**Options:**
+| Argument                 | Description                                                         | Default |
+|--------------------------|---------------------------------------------------------------------|---------|
+| -r --replace             | Specifies whether existing files will be replaced.                  | False   |
+| -i --ignore-parse-errors | Ignores or corrects non-fatal errors when parsing input text files. | False   |
+
+**Note:** If no output path is specified, the output file will be created in the program folder named `relative.txt`
+
+---
+
+[Commands List](./readme.md)

info/commands/image-to-relative.md

@@ -0,0 +1,25 @@
+## image-to-relative
+**Usage:** `maze image-to-relative [options] <input-image> [output-path]`  
+**Example:** `maze image-to-relative ./examples/image/small.png ./output.txt -r`
+
+Takes an existing Image file, parses it into a graph, and outputs a Relative definition text file.
+
+**Options:**
+| Argument                 | Description                                                                                                 | Default |
+|--------------------------|-------------------------------------------------------------------------------------------------------------|---------|
+| -r --replace             | Specifies whether existing files will be replaced.                                                          | False   |
+| -i --ignore-parse-errors | Ignores or corrects non-fatal errors when parsing input image files.                                        | False   |
+| --load                   | Specifies the file path of an existing image configuration file.  If this is blank, no file will be loaded. |         |
+| --save                   | Specifies the name of a saved image configuration file.  If this is blank, no file will be saved.           |         |
+| --wall                   | The hex colour of wall pixels in the target image.                                                          | #000000 |
+| --floor                  | The hex colour of floor pixels in the target image.                                                         | #FFFFFF |
+| --tolerance              | The percentage difference allowed when checking image pixel colours.                                        | 0       |
+| --size                   | The approximate size of a maze tile in pixels.                                                              | 10      |
+| -x --start-x             | The approximate X location of the first tile.                                                               | 0       |
+| -y --start-y             | The approximate Y location of the first tile.                                                               | 0       |
+
+**Note:** If no output path is specified, the output file will be created in the program folder named `relative.txt`
+
+---
+
+[Commands List](./readme.md)

info/commands/readme.md

@@ -9,6 +9,9 @@
 * [grid-to-absolute](./grid-to-absolute.md)
 * [image-to-absolute](./image-to-absolute.md)
 * [image-to-grid](./image-to-grid.md)
+* [absolute-to-relative](./absolute-to-relative.md)
+* [grid-to-relative](./grid-to-relative.md)
+* [image-to-relative](./image-to-relative.md)
 * [test-export](./test-export.md)
 
 ---

summary.md

@@ -1,12 +1,14 @@
 # Summary
 
-**Version:** 1.0.22
+**Version:** 1.0.23
 
 **Date:** 2021-03-31
 
-**Title:** Document Formatting Fixes
+**Title:** Relative Conversion Command Documentation
 
 **Description:**
 
-Fixed minor formatting errors in the documentation that
-occurred while migrating from GitLab to GitHub.
+* Created documentation files for Relative conversion commands
+	* absolute-to-relative
+	* grid-to-relative
+	* image-to-relative