diff --git a/src/main/java/fr/inrae/agroclim/indicators/GenerateMarkdown.java b/src/main/java/fr/inrae/agroclim/indicators/GenerateMarkdown.java index 20991b03542b97084daf39db26bad43f43b62b9a..bd44721701d4bad1078b0a35b7b3567b3264d51f 100644 --- a/src/main/java/fr/inrae/agroclim/indicators/GenerateMarkdown.java +++ b/src/main/java/fr/inrae/agroclim/indicators/GenerateMarkdown.java @@ -41,7 +41,7 @@ import lombok.extern.log4j.Log4j2; public class GenerateMarkdown { /** - * Mardown Yaml front matter. + * Mardown YAML front matter. */ private static final String FRONT_MATTER = """ --- @@ -52,6 +52,7 @@ public class GenerateMarkdown { --- """; + /** * @param args arguments : outDir, languageSep * @throws IndicatorsException while loading knowledge @@ -95,6 +96,7 @@ public class GenerateMarkdown { } } } + /** * Write a line in a table. * @@ -132,7 +134,6 @@ public class GenerateMarkdown { */ private final Locale locale; - /** * Constructor. * @@ -157,16 +158,19 @@ public class GenerateMarkdown { * Write the Markdown file showing all error codes and descriptions. * * @param path output file path - * @throws IOException file not found or error while writting + * @throws IOException file not found or error while writing */ public void writeErrorMdFile(final Path path) throws IOException { LOGGER.trace(path); + final String indicatorsVersion = fr.inrae.agroclim.indicators.resources.Version.getString("version"); try (BufferedWriter writer = new Utf8BufferedWriter(path)) { writer.write(String.format(FRONT_MATTER, i18n.get("markdown.error.title"), i18n.get("markdown.error.description"), i18n.get("markdown.error.keywords"), created)); + writer.write(i18n.format("markdown.error.version", indicatorsVersion) + "\n\n"); + writer.write(i18n.get("markdown.error.feedback") + "\n\n"); writeLn(writer, i18n.get("markdown.error.fullcode"), i18n.get("markdown.error.name"), i18n.get("markdown.error.message")); writer.write("|:----------|:-----------|:-----------|\n"); @@ -376,7 +380,6 @@ public class GenerateMarkdown { } } - /** * Whatever is the locale, the file is the same. * diff --git a/src/main/resources/fr/inrae/agroclim/indicators/resources/messages.properties b/src/main/resources/fr/inrae/agroclim/indicators/resources/messages.properties index 1c397254055fde60d5be3a5a290696635705ad52..ccd71ab8c6c940054a71ddc3754f7664426470f9 100644 --- a/src/main/resources/fr/inrae/agroclim/indicators/resources/messages.properties +++ b/src/main/resources/fr/inrae/agroclim/indicators/resources/messages.properties @@ -104,11 +104,13 @@ markdown.title.hourly=Indicators at hourly timescale markdown.keywords=indicator, agroclimatic, ecoclimatic markdown.error.category=Category markdown.error.description=List of error types: codes and descriptions. +markdown.error.feedback=Don't hesitate to give us feedback on any problems you encounter that you can't identify. markdown.error.fullcode=Error code markdown.error.keywords=library,error codes markdown.error.message=Error message markdown.error.name=Error name markdown.error.title=Error types +markdown.error.version=These are the error codes of the Indicators library (version {0}). markdown.indicators=Indicators markdown.indicators.daily={0} daily indicators markdown.indicators.hourly={0} hourly indicators diff --git a/src/main/resources/fr/inrae/agroclim/indicators/resources/messages_fr.properties b/src/main/resources/fr/inrae/agroclim/indicators/resources/messages_fr.properties index cc0929bc35c3e10d9fd54bc8a66b68306984f7a6..e7c97dcb99e855ad79496ce1350385688b2febe5 100644 --- a/src/main/resources/fr/inrae/agroclim/indicators/resources/messages_fr.properties +++ b/src/main/resources/fr/inrae/agroclim/indicators/resources/messages_fr.properties @@ -97,11 +97,13 @@ markdown.title.hourly=Indicateurs au pas de temps horaire markdown.keywords=indicateur, agroclimatique, \u00e9coclimatique markdown.error.category=Cat\u00e9gorie markdown.error.description=Liste des erreurs\u00a0: codes et descriptions. +markdown.error.feedback=N\u2019h\u00e9sitez pas \u00e0 nous faire des retours sur les \u00e9ventuels probl\u00e8mes rencontr\u00e9s que vous n\u2019arriveriez pas \u00e0 identifier. markdown.error.fullcode=Code d\u2019erreur markdown.error.keywords=biblioth\u00e8que,code d\u2019erreur markdown.error.message=Message d\u2019erreur markdown.error.name=Nom de l\u2019erreur markdown.error.title=Codes d\u2019erreurs +markdown.error.version=Voici la liste des codes d\u2019erreurs de la biblioth\u00e8que d\u2019indicateurs (version {0}). markdown.indicators=Indicateurs markdown.indicators.daily={0} indicateurs journaliers markdown.indicators.hourly={0} indicateurs horaires