Merge branch 'master' into Iniz

Author: kdaud

README.md

@@ -200,6 +200,7 @@ See the [documentation on Initializer's logging properties](readme/rtprops.md#lo
 * Fix for Liquibase Loader to ensure compatibility with OpenMRS versions 2.5.5+.
 * Fix for OCL Loader to ensure it throws an Exception if the OCL import fails.
 * Fix for Validator to not encounter failure upon repeated execution on the same JVM process.
+* Fix for null config directory path in `DeleteDomainChecksumsChangeset`.
 
 #### Version 2.6.0
 * Added support for 'cohorttypes' and 'cohortattributetypes' domains.

omod/src/main/java/org/openmrs/module/initializer/web/controller/InitializerController.java

@@ -26,7 +26,7 @@
 import org.springframework.web.bind.annotation.RequestMethod;
 
 /**
- * This class configured as controller using annotation and mapped to an URL.
+ * This class is configured as a controller using annotation and mapped to a URL.
  */
 @Controller(InitializerConstants.COMPONENT_LEGACY_CONTROLLER)
 @RequestMapping(value = "module/" + InitializerConstants.MODULE_ARTIFACT_ID + "/" + InitializerConstants.MODULE_ARTIFACT_ID
@@ -73,15 +73,15 @@ public String onPost(HttpSession httpSession, @ModelAttribute("anyRequestObject"
 	}
 
 	/**
-	 * This class returns the form backing object. This can be a string, a boolean, or a normal java
-	 * pojo. The bean name defined in the ModelAttribute annotation and the type can be just defined by
+	 * This class returns the form backing object. This can be a string, a boolean, or a normal Java
+	 * POJO. The bean name is defined in the ModelAttribute annotation and the type can be just defined by
 	 * the return type of this method
 	 */
 	@ModelAttribute("users")
 	protected List<User> getUsers() throws Exception {
 		List<User> users = userService.getAllUsers();
 
-		// this object will be made available to the jsp page under the variable name
+		//This object will be made available to the JSP page under the variable name
 		// that is defined in the @ModuleAttribute tag
 		return users;
 	}

readme/csv_conventions.md

@@ -1,6 +1,6 @@
 ## Conventions for CSV files
-There are a number of conventions that apply to CSV files across all domains, typically the meaning of certain columns (or headers). Headers are in general optional, it is up to the implementor to provide or not the fields that are required to create or edit the OpenMRS objects. Mandatory headers will be specifically indicated.
-<br/>Each CSV line is meant to provide enough data to create, edit or void/retire an OpenMRS object of the domain.
+Several conventions apply to CSV files across all domains, typically the meaning of certain columns (or headers). Headers are in general optional, it is up to the implementor to provide or not the fields that are required to create or edit the OpenMRS objects. Mandatory headers will be specifically indicated.
+<br/>Each CSV line is meant to provide enough data to create, edit, or void/retire an OpenMRS object of the domain.
 
 ###### Header `Uuid` (mandatory)
 * If the value under this header is missing the OpenMRS object will be created with a new random UUID.
@@ -11,12 +11,12 @@ There are a number of conventions that apply to CSV files across all domains, ty
 
 ###### Header `Void/Retire`
 Set this to **true** to indicate that the OpenMRS object with the provided UUID should be voided or retired.
-<br/>When `Void/Retire` is set to true, the parsing of the remaining of the CSV line is interrupted since the only objective is to retire the concept. And to this end, only the UUID and the retire flag are needed.
+<br/>When `Void/Retire` is set to true, the parsing of the remaining part of the CSV line is interrupted since the only objective is to retire the concept. And to this end, only the UUID and the retire flag are needed.
 
 ###### Localized Header `Display`
-This is a locale specific header that should not be used as such ;  it should be used with a locale ISO code appended to it, eg: `Display:en` or `Display:fr` or `Display:es` ... etc. The values under those display headers for each locale are used to localise the display string of the OpenMRS metadata entity being defined on the CSV line. Under the hood this sets up Java localization messages that comply to the so-called _UI Framework convention_ (see more on this [here](https://github.com/mekomsolutions/openmrs-module-initializer/issues/95#issue-813691920)).
+This is a locale-specific header that should not be used as such;  it should be used with a locale ISO code appended to it, eg: `Display:en` or `Display:fr` or `Display:es` ... etc. The values under those display headers for each locale are used to localize the display string of the OpenMRS metadata entity being defined on the CSV line. Under the hood, this sets up Java localization messages that comply with the so-called _UI Framework convention_ (see more on this [here](https://github.com/mekomsolutions/openmrs-module-initializer/issues/95#issue-813691920)).
 
-For example for an OpenMRS metadata entity display string to be localised in English (locale 'en') and French (locale 'fr'), simply name the headers `Display:en` and `Display:fr` and give them the corresponding localised values respectively in English and French making sure the 'uuid' field is filled and not left blank:
+For example for an OpenMRS metadata entity display string to be localized in English (locale 'en') and French (locale 'fr'), simply name the headers `Display:en` and `Display:fr` and give them the corresponding localized values respectively in English and French making sure the 'uuid' field is filled and not left blank:
 
 | <sub>UUID</sub> | ... | <sub>Display:en</sub> | <sub>Display:fr</sub> | ... | <sub>Void/Retired</sub> | ...|
 | --- | --- | --- | --- | --- | --- | --- |
@@ -35,7 +35,7 @@ ui.i18n.Location.name.eb96c0d4-6248-476b-a079-0aaabfa2f614=Salle d'urgences
 org.openmrs.Location.eb96c0d4-6248-476b-a079-0aaabfa2f614=Salle d'urgences
 ```
 
-In general, for each locale, a pair of messages are created as such
+In general, for each locale, a pair of messages is created as such
 ```
 ui.i18n.<OpenMRS entity short class name>.name.<OpenMRS entity UUID>=<message in locale>
 org.openmrs.<OpenMRS entity short class name>.<OpenMRS entity UUID>=<message in locale>
@@ -46,10 +46,10 @@ Special headers are used to provide metadata information about the CSV file itse
 <br/>All metadata headers start with an underscore, eg. `_version:1`, `_order:1000`, ... etc.
 
 ###### Header `_order:*`
-This metadata header specifies the order of loading of the CSV file _within the domain_. In many cases the creation of OpenMRS objects relies on the existence of other OpenMRS objects that are referred to. This use case is covered by the order header that allows to control the order of loading of files in a given domain.
+This metadata header specifies the order of loading of the CSV file _within the domain_. In many cases, the creation of OpenMRS objects relies on the existence of other OpenMRS objects that are referred to. This use case is covered by the order header that allows control of the order of loading of files in a given domain.
 <br/>For example `_order:1000` indicates that all CSV files with an order smaller than 1,000 will be processed _before_ this file within the domain.
-<br/> If the order metadata cannot be parsed or is missing, then the file will be processed last after all the ordered CSV files of the domain. However if several CSV files have no order defined, then the loading order between them is undefined.
+<br/> If the order metadata cannot be parsed or is missing, then the file will be processed last after all the ordered CSV files of the domain. However, if several CSV files have no order defined, then the loading order between them is undefined.
 
 ###### Header `_version:*`
 Versions are primarily introduced to allow for evolutions in the implementation of CSV parsers. Those evolutions may require to modify the CSV headers which will likely lead to backward compatibility issues. Using versions works around this by ensuring that specific parsers are used based on the version specified via the CSV file header.
-<br/>When no version header is provided the initializer will fallback on a default one or may complain in its log messages that no version was specified.
+<br/>When no version header is provided the initializer will fall back on a default one or may complain in its log messages that no version was specified.