update for consistent format

Author: ricko2001

RM -Change source for citation/ReadMe.txt

@@ -120,49 +120,53 @@ Run the Python installer selecting all default options.
 =========================================================================DIV80==
 NOTES
 
-*   All interactions with the utility are through the RM-Python-config.ini file
-    and the command line console window.
-    The RM-Python-config.ini file just give the location of the database to
-    modify. The same RM-Python-config.ini file can be shared with other utility
-    applications such as TestExternalFiles and GroupFromSQL.
-
-*   Information that the user enters in the command window is checked before
-    it is used. It is unlikely that random data would be accepted by
-    the utility.
-
-*   The utility asks for the name of the citation to change and the source
-    that it should use. In both cases, only enough of the name needs to be
-    entered to make it unique among all citations for all sources. 
-    It is suggested that you copy and paste from the RM source edit window.
-    There is no need to manually type input.
-    One may start the name entry with a % char and it will be used as the
-    standard  'SQL Like' wild card.
-    If the full citation name is not unique, then as a workaround, you
-    could add some text to the citation name of the citation you want
-    to modify to make the name unique.
-
-*   Checks made by the utility:
-    1- User is asked for the citation name of the citation to modify.
-        a) the name must be found.
-        b) the name must be unique among all citations for all sources.
-       You will be made aware of problems.
-    2- User is asked for the source that is to be used as the new parent of
-       the citation.
-        a) the source name must be found.
-        b) the source name must be unique.
-        c) the existing source used by the citation and the new source
-           specified must both use the same source template.
-       You will be made aware of problems.
-
-===========================================DIV50==
+=========-
+All interactions with the utility are through the RM-Python-config.ini file
+and the command line console window.
+The RM-Python-config.ini file just gives the location of the database to
+modify. The same RM-Python-config.ini file can be shared with other RM 
+utilities.
+
+=========-
+Information that the user enters in the command window is checked before
+ it is used. It is unlikely that random data would be accepted by
+ the utility.
+
+=========-
+The utility asks for the name of the citation to change and the source
+that it should use. In both cases, only enough of the name needs to be
+entered to make it unique among all citations for all sources. 
+It is suggested that you copy and paste from the RM source edit window.
+There is no need to manually type input.
+One may start the name entry with a % char and it will be used as the
+standard  'SQL Like' wild card.
+If the full citation name is not unique, then as a workaround, you
+could add some text to the citation name of the citation you want
+to modify to make the name unique.
+
+=========-
+Checks made by the utility:
+1- User is asked for the citation name of the citation to modify.
+    a) the name must be found.
+    b) the name must be unique among all citations for all sources.
+   You will be made aware of problems.
+2- User is asked for the source that is to be used as the new parent of
+   the citation.
+    a) the source name must be found.
+    b) the source name must be unique.
+    c) the existing source used by the citation and the new source
+       specified must both use the same source template.
+   You will be made aware of problems.
+
+=========-
 REPORT_FILE_DISPLAY_APP
 
 Option to automatically open the report file in a display application.
 The included ini sample file has this option activated and set to use Windows
 NotePad as the display app. It can be deactivated by inserting a # character
 at the start of the line. Your favorite editor may be substituted.
 
-===========================================DIV50==
+=========-
 RM-Python-config.ini  (the config file)
 
 If there are any non-ASCII characters in the config file then the file must be
@@ -185,39 +189,29 @@ file line- REPORT_FILE_DISPLAY_APP
 
 If no report file is generated, look at the black command
 console window for error messages that will help you fix the problem.
-There is probably something wrong with the config file line-
-REPORT_FILE_PATH
+There may be something wrong with the config file line- REPORT_FILE_PATH
 
-=========-
-Error message:
+If the black console windows displays the message-
 RM-Python-config.ini file contains a format error
-
-The problem is as stated, the solution may be harder to determine.
-Start over with the supplied config file and make sure that works, Then make your
-edits one by one to identify the problem.
-You may want to look at- https://en.wikipedia.org/wiki/INI_file
-
-A reason that report file cannot be generated is if the specified REPORT_FILE_PATH
-cannot be created.
-The default value in the supplied config file should always work.
+See the section below.
 
 If no report file is generated and the black command console window closes
 before you can read it, try first opening a command line console and then
 running the exe or py file from the command line. The window will not close
 and you'll be able to read any error messages.
 
+=========-
+Error message:
+RM-Python-config.ini file contains a format error
+
+Start over with the supplied config file and make sure that works, Then make your
+edits one by one to identify the problem.
+You may want to look at- https://en.wikipedia.org/wiki/INI_file
 
 =========================================================================DIV80==
 TODO
 *  ?? what would you find useful?
 
-*  Do you have citations in different sources with the same citation name?
-That situation will prevent you from using this app.
-I could add a workflow where the utility will first ask for the source
-and then ask for a citation name that is used by that source, but 
-it increases the effort for a situation that may not be common, especially
-as there is a workaround: temporarily change one of the citation names.
-
 
 =========================================================================DIV80==
 Feedback

RM -Change source template/ReadMe.txt

@@ -508,7 +508,6 @@ If there are changes that you did not want, make another copy of your main
 database file and copy it to the working folder and try again.
 
 
-=========================================================================DIV80==
 =========================================================================DIV80==
 NOTES
 
@@ -618,7 +617,7 @@ field (and vice versa)
 * NULL on the left side (old source template) means that the field on right
 side will be empty but correctly initialized. Must be used when adding a new
 field but without moving old data to it.
-In RM v9.1.3, an uninitialized data field will not behave as expected in
+In RM v10, an uninitialized data field will not behave as expected in
 the footnote sentence language. This may get fixed.
 
 * NULL on right side (destination) means the data on left side field will not be
@@ -714,35 +713,33 @@ at the start of the line.
 =========================================================================DIV80==
 Troubleshooting:
 
-===========-
+=========-
 No Report File displayed
 
 If the report is created, but not displayed, check the config
 file line- REPORT_FILE_DISPLAY_APP
 
 If no report file is generated, look at the black command
 console window for error messages that will help you fix the problem.
-There is probably something wrong with the config file line-
-REPORT_FILE_PATH
+There may be something wrong with the config file line- REPORT_FILE_PATH
 
-===========-
-Error message:
+If the black console windows displays the message-
 RM-Python-config.ini file contains a format error
-
-The problem is as stated, the solution may be harder to determine.
-Start over with the supplied config file and make sure that works, Then make your
-edits one by one to identify the problem.
-You may want to look at- https://en.wikipedia.org/wiki/INI_file
-
-A reason that report file cannot be generated is if the specified REPORT_FILE_PATH
-cannot be created.
-The default value in the supplied config file should always work.
+See the section below.
 
 If no report file is generated and the black command console window closes
 before you can read it, try first opening a command line console and then
 running the exe or py file from the command line. The window will not close
 and you'll be able to read any error messages.
 
+=========-
+Error message:
+RM-Python-config.ini file contains a format error
+
+Start over with the supplied config file and make sure that works, Then make your
+edits one by one to identify the problem.
+You may want to look at- https://en.wikipedia.org/wiki/INI_file
+
 ===========-
 Error Message:
 Tried to create duplicate Name in XML.

RM -Citation Sort Order/ReadMe.txt

@@ -120,6 +120,7 @@ Run the Python installer selecting all default options.
 =========================================================================DIV80==
 NOTES
 
+=========-
 CitationSortOrder can change the sort order for citations attached to Person,
 Names, and Facts.
 Currently, this utility will not change the sort order of citations attached to
@@ -129,35 +130,41 @@ This utility only changes the database table: CitationLinkTable and within
 it, only the SortOrder column..
 
 
+=========-
 Due to lack of support in the RM app, the modified sort order is not utilized
-in the "slide in" workflow for facts or in reports generated by RM.
+in the "slide in workflow" for facts or in reports generated by RM.
 
 
+=========-
 Use of this utility may be productively combined with the use of a global
 re-ordering SQL script developed by Tom Holden and Jerry Bryan.
 https://sqlitetoolsforrootsmagic.com/forum/topic/sorting-the-order-of-rm9-citations/
 
 
+=========-
 Note that after reordering, newly added citations will appear at the top
 of the list as they will have a SortOrder number of 0.
 This contrasts with behavior seen before reordering where the citations are shown
 in "order entered" sequence because all records are added with a SortOrder number of 0.
 Use this app to make desired changes.
 
 
+=========-
 Updating the sort order of a set of citations while the database is open in
 RM works OK. However, the citation lists do not have a refresh button, so,
 you'll need to navigate away from the modified sort order citation list and then
 return to it to see the new sort order.
 
 
+=========-
 To revert all citation sort order modifications made by this utility, simply
 change the sort order column to all zeros.
 UPDATE CitationLinkTable SET SortOrder = 0;
 This will change the sort order in RM v10 to "order entered", which is
 the default.
 
 
+=========-
 RM-Python-config.ini  (the config file)
 If there are any non-ASCII characters in the config file then the file must be
 saved in UTF-8 format, with no byte order mark (BOM).
@@ -169,6 +176,7 @@ File format is an option in the "Save file" dialog box in NotePad.
 config file path names may be absolute or relative to the current directory.
 
 
+=========-
 REPORT_FILE_DISPLAY_APP
 Option to automatically open the report file in a display application.
 The included ini sample file has this option activated and set to use Windows
@@ -190,27 +198,25 @@ file line- REPORT_FILE_DISPLAY_APP
 
 If no report file is generated, look at the black command
 console window for error messages that will help you fix the problem.
-There is probably something wrong with the config file line-
-REPORT_FILE_PATH
+There may be something wrong with the config file line- REPORT_FILE_PATH
+
+If the black console windows displays the message-
+RM-Python-config.ini file contains a format error
+See the section below.
+
+If no report file is generated and the black command console window closes
+before you can read it, try first opening a command line console and then
+running the exe or py file from the command line. The window will not close
+and you'll be able to read any error messages.
 
 =========-
 Error message:
 RM-Python-config.ini file contains a format error
 
-The problem is as stated, the solution may be harder to determine.
 Start over with the supplied config file and make sure that works, Then make your
 edits one by one to identify the problem.
 You may want to look at- https://en.wikipedia.org/wiki/INI_file
 
-A reason that report file cannot be generated is if the specified REPORT_FILE_PATH
-cannot be created.
-The default value in the supplied config file should always work.
-
-If no report file is generated and the black command console window closes
-before you can read it, try first opening a command line console and then
-running the exe or py file from the command line. The window will not close
-and you'll be able to read any error messages.
-
 
 =========================================================================DIV80==
 TODO

RM -Color from Group/ReadMe.txt

@@ -216,11 +216,13 @@ clearing colors in multiple color code sets.
 =========================================================================DIV80==
 NOTES
 
-*    Updating the colorization of a group while the database is open in RM 
+=========-
+Updating the colorization of a group while the database is open in RM 
 works OK. However, RM will not refresh the screen based on an external update. 
 So, switch screens and then return to see the updated color coding.
 
-*    On some occasions, the utility report file will display a "Database
+=========-
+On some occasions, the utility report file will display a "Database
 Locked" message. In that case, close RM and re-run the utility, then re-open 
 RM. It's not clear why this sometimes happens, but it is rare.
 No database damage has ever been seem after many hundreds of uses.
@@ -229,17 +231,20 @@ No database damage has ever been seem after many hundreds of uses.
 
 Less important notes.
 
-*   RM-Python-config.ini  (the config file)
+=========-
+RM-Python-config.ini  (the config file)
 If there are any non-ASCII characters in the config file then the file must be
 saved in UTF-8 format, with no byte order mark (BOM).
 The included sample ini file has an accented ä in the first line comment to
 force it to be in the correct format.
 File format is an option in the "Save file" dialog box in NotePad.
 
-*    This utility only changes the database's PersonTable.
+=========-
+This utility only changes the database's PersonTable.
 If I add the feature of renaming colors, that will affect the Config table.
 
-*    This utility will, if so configured, modify a pre-existing color coding 
+=========-
+This utility will, if so configured, modify a pre-existing color coding 
 that may be important to you. Take care when assigning the actions in the
 config file.
 

RM -Convert Fact/ReadMe.txt

@@ -315,27 +315,25 @@ file line- REPORT_FILE_DISPLAY_APP
 
 If no report file is generated, look at the black command
 console window for error messages that will help you fix the problem.
-There is probably something wrong with the config file line-
-REPORT_FILE_PATH
+There may be something wrong with the config file line- REPORT_FILE_PATH
+
+If the black console windows displays the message-
+RM-Python-config.ini file contains a format error
+See the section below.
+
+If no report file is generated and the black command console window closes
+before you can read it, try first opening a command line console and then
+running the exe or py file from the command line. The window will not close
+and you'll be able to read any error messages.
 
 =========-
 Error message:
 RM-Python-config.ini file contains a format error
 
-The problem is as stated, the solution may be harder to determine.
 Start over with the supplied config file and make sure that works, Then make your
 edits one by one to identify the problem.
 You may want to look at- https://en.wikipedia.org/wiki/INI_file
 
-A reason that report file cannot be generated is if the specified REPORT_FILE_PATH
-cannot be created.
-The default value in the supplied config file should always work.
-
-If no report file is generated and the black command console window closes
-before you can read it, try first opening a command line console and then
-running the exe or py file from the command line. The window will not close
-and you'll be able to read any error messages.
-
 
 =========================================================================DIV80==
 TODO