Extension of rules sh:010 and sh:011

Change rule sh:010 to allow comma after the period. Change rule sh:011 to allow comma after the period. Add "e.g." to rule sh:011
sylvainhalle · Jul 19, 2019 · a043c22 · a043c22
1 parent 2d0f38b
commit a043c22
Show file tree

Hide file tree

Showing 130 changed files with 387 additions and 306 deletions.
diff --git a/Readme.md b/Readme.md
@@ -496,8 +496,8 @@ If the `--check` option is used, you can add the `--languagemodel xx` option to
 
 ### LaTeX subtleties 
 
-- Use a backslash after the last period in "i.e." and "et al."; otherwise
-  LaTeX will think it is a full stop ending a sentence. [sh:010, sh:011]
+- Use a backslash or a comma after the last period in "i.e.", "e.g." and "et al.";
+  otherwise LaTeX will think it is a full stop ending a sentence. [sh:010, sh:011]
 - There should not be a space before a semicolon or a colon. If in your
   language, typographic rules require a space here, LaTeX takes care of
   inserting it without your intervention. [sh:d:005, sh:d:006]

diff --git a/Source/Core/src/ca/uqac/lif/textidote/rules/regex.csv b/Source/Core/src/ca/uqac/lif/textidote/rules/regex.csv
@@ -4,9 +4,9 @@ sh:003		\\(sub)*section\{[A-Z0-9\s,:;]*?\}		A section title should not be writte
 sh:007		\\paragraph\{\s*[a-z].*?\}				A paragraph heading should start with a capital letter.
 sh:008		\\paragraph\{.*?[\.,;:]\s*\}			A paragraph heading should not end with a punctuation symbol.
 sh:009		\\paragraph\{[A-Z0-9\s,:;]*?\}			A paragraph heading should not be written in all caps. The LaTeX stylesheet takes care of rendering titles in caps if needed.
-sh:010		et al\.[^\\]							Use a backslash after the period; otherwise LaTeX will think it is a full stop ending a sentence.
-sh:011		i\.e\.[^\\]								Use a backslash after the second period; otherwise LaTeX will think it is a full stop ending a sentence.
-sh:012		\\fg\s									Utilisez '\fg{}' au lieu de '\fg'; sinon le mot suivant sera collé au guillemet fermant. 
+sh:010		et al\.[^\\,]							Use a backslash or comma after the period; otherwise LaTeX will think it is a full stop ending a sentence.
+sh:011		(i\.e\.|e\.g\.)[^\\,]			Use a backslash or comma after the second period; otherwise LaTeX will think it is a full stop ending a sentence.
+sh:012		\\fg\s										Utilisez '\fg{}' au lieu de '\fg'; sinon le mot suivant sera collé au guillemet fermant. 
 
 # Citations and references
 

diff --git a/Source/CoreTest/src/ca/uqac/lif/textidote/rules/CheckRegexTest.java b/Source/CoreTest/src/ca/uqac/lif/textidote/rules/CheckRegexTest.java
@@ -103,4 +103,85 @@ public void testCmul5()
 		List<Advice> ad_list = r.evaluate(in_string, in_string);
 		assertEquals(1, ad_list.size());
 	}
+
+	@Test
+	public void test010_1()
+	{
+		AnnotatedString in_string = AnnotatedString.read(new Scanner("et al. foo"));
+		Rule r = m_rules.get("sh:010");
+		List<Advice> ad_list = r.evaluate(in_string, in_string);
+		assertEquals(1, ad_list.size());
+	}
+
+	@Test
+	public void test010_2()
+	{
+		AnnotatedString in_string = AnnotatedString.read(new Scanner("et al.\\ foo"));
+		Rule r = m_rules.get("sh:010");
+		List<Advice> ad_list = r.evaluate(in_string, in_string);
+		assertEquals(0, ad_list.size());
+	}
+
+	@Test
+	public void test010_3()
+	{
+		AnnotatedString in_string = AnnotatedString.read(new Scanner("et al., foo"));
+		Rule r = m_rules.get("sh:010");
+		List<Advice> ad_list = r.evaluate(in_string, in_string);
+		assertEquals(0, ad_list.size());
+	}
+
+	@Test
+	public void test011_1()
+	{
+		AnnotatedString in_string = AnnotatedString.read(new Scanner("i.e. foo"));
+		Rule r = m_rules.get("sh:011");
+		List<Advice> ad_list = r.evaluate(in_string, in_string);
+		assertEquals(1, ad_list.size());
+	}
+
+	@Test
+	public void test011_2()
+	{
+		AnnotatedString in_string = AnnotatedString.read(new Scanner("i.e.\\ foo"));
+		Rule r = m_rules.get("sh:011");
+		List<Advice> ad_list = r.evaluate(in_string, in_string);
+		assertEquals(0, ad_list.size());
+	}
+
+	@Test
+	public void test011_3()
+	{
+		AnnotatedString in_string = AnnotatedString.read(new Scanner("i.e., foo"));
+		Rule r = m_rules.get("sh:011");
+		List<Advice> ad_list = r.evaluate(in_string, in_string);
+		assertEquals(0, ad_list.size());
+	}
+
+	@Test
+	public void test011_4()
+	{
+		AnnotatedString in_string = AnnotatedString.read(new Scanner("e.g. foo"));
+		Rule r = m_rules.get("sh:011");
+		List<Advice> ad_list = r.evaluate(in_string, in_string);
+		assertEquals(1, ad_list.size());
+	}
+
+	@Test
+	public void test011_5()
+	{
+		AnnotatedString in_string = AnnotatedString.read(new Scanner("e.g.\\ foo"));
+		Rule r = m_rules.get("sh:011");
+		List<Advice> ad_list = r.evaluate(in_string, in_string);
+		assertEquals(0, ad_list.size());
+	}
+
+	@Test
+	public void test011_6()
+	{
+		AnnotatedString in_string = AnnotatedString.read(new Scanner("e.g., foo"));
+		Rule r = m_rules.get("sh:011");
+		List<Advice> ad_list = r.evaluate(in_string, in_string);
+		assertEquals(0, ad_list.size());
+	}
 }
diff --git a/docs/javadoc/allclasses-frame.html b/docs/javadoc/allclasses-frame.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Sat Jan 19 11:21:03 EST 2019 -->
+<!-- Generated by javadoc (1.8.0_222) on Fri Jul 19 21:00:14 CEST 2019 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>All Classes (TeXtidote Documentation)</title>
-<meta name="date" content="2019-01-19">
+<meta name="date" content="2019-07-19">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/javadoc/allclasses-noframe.html b/docs/javadoc/allclasses-noframe.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Sat Jan 19 11:21:03 EST 2019 -->
+<!-- Generated by javadoc (1.8.0_222) on Fri Jul 19 21:00:14 CEST 2019 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>All Classes (TeXtidote Documentation)</title>
-<meta name="date" content="2019-01-19">
+<meta name="date" content="2019-07-19">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>

diff --git a/docs/javadoc/ca/uqac/lif/textidote/Advice.html b/docs/javadoc/ca/uqac/lif/textidote/Advice.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Sat Jan 19 11:21:01 EST 2019 -->
+<!-- Generated by javadoc (1.8.0_222) on Fri Jul 19 21:00:13 CEST 2019 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>Advice (TeXtidote Documentation)</title>
-<meta name="date" content="2019-01-19">
+<meta name="date" content="2019-07-19">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>

diff --git a/docs/javadoc/ca/uqac/lif/textidote/AdviceRenderer.html b/docs/javadoc/ca/uqac/lif/textidote/AdviceRenderer.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Sat Jan 19 11:21:01 EST 2019 -->
+<!-- Generated by javadoc (1.8.0_222) on Fri Jul 19 21:00:13 CEST 2019 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>AdviceRenderer (TeXtidote Documentation)</title>
-<meta name="date" content="2019-01-19">
+<meta name="date" content="2019-07-19">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>

diff --git a/docs/javadoc/ca/uqac/lif/textidote/Linter.Language.html b/docs/javadoc/ca/uqac/lif/textidote/Linter.Language.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Sat Jan 19 11:21:01 EST 2019 -->
+<!-- Generated by javadoc (1.8.0_222) on Fri Jul 19 21:00:13 CEST 2019 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>Linter.Language (TeXtidote Documentation)</title>
-<meta name="date" content="2019-01-19">
+<meta name="date" content="2019-07-19">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>

diff --git a/docs/javadoc/ca/uqac/lif/textidote/Linter.html b/docs/javadoc/ca/uqac/lif/textidote/Linter.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Sat Jan 19 11:21:01 EST 2019 -->
+<!-- Generated by javadoc (1.8.0_222) on Fri Jul 19 21:00:13 CEST 2019 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>Linter (TeXtidote Documentation)</title>
-<meta name="date" content="2019-01-19">
+<meta name="date" content="2019-07-19">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>

diff --git a/docs/javadoc/ca/uqac/lif/textidote/LinterException.html b/docs/javadoc/ca/uqac/lif/textidote/LinterException.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Sat Jan 19 11:21:01 EST 2019 -->
+<!-- Generated by javadoc (1.8.0_222) on Fri Jul 19 21:00:13 CEST 2019 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>LinterException (TeXtidote Documentation)</title>
-<meta name="date" content="2019-01-19">
+<meta name="date" content="2019-07-19">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>

diff --git a/docs/javadoc/ca/uqac/lif/textidote/Main.html b/docs/javadoc/ca/uqac/lif/textidote/Main.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Sat Jan 19 11:21:01 EST 2019 -->
+<!-- Generated by javadoc (1.8.0_222) on Fri Jul 19 21:00:14 CEST 2019 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>Main (TeXtidote Documentation)</title>
-<meta name="date" content="2019-01-19">
+<meta name="date" content="2019-07-19">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>

diff --git a/docs/javadoc/ca/uqac/lif/textidote/Rule.html b/docs/javadoc/ca/uqac/lif/textidote/Rule.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Sat Jan 19 11:21:01 EST 2019 -->
+<!-- Generated by javadoc (1.8.0_222) on Fri Jul 19 21:00:14 CEST 2019 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>Rule (TeXtidote Documentation)</title>
-<meta name="date" content="2019-01-19">
+<meta name="date" content="2019-07-19">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>

diff --git a/docs/javadoc/ca/uqac/lif/textidote/RuleException.html b/docs/javadoc/ca/uqac/lif/textidote/RuleException.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Sat Jan 19 11:21:01 EST 2019 -->
+<!-- Generated by javadoc (1.8.0_222) on Fri Jul 19 21:00:14 CEST 2019 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>RuleException (TeXtidote Documentation)</title>
-<meta name="date" content="2019-01-19">
+<meta name="date" content="2019-07-19">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>

diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/AnnotatedString.html b/docs/javadoc/ca/uqac/lif/textidote/as/AnnotatedString.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Sat Jan 19 11:21:02 EST 2019 -->
+<!-- Generated by javadoc (1.8.0_222) on Fri Jul 19 21:00:14 CEST 2019 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>AnnotatedString (TeXtidote Documentation)</title>
-<meta name="date" content="2019-01-19">
+<meta name="date" content="2019-07-19">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>

diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/Match.html b/docs/javadoc/ca/uqac/lif/textidote/as/Match.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Sat Jan 19 11:21:02 EST 2019 -->
+<!-- Generated by javadoc (1.8.0_222) on Fri Jul 19 21:00:14 CEST 2019 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>Match (TeXtidote Documentation)</title>
-<meta name="date" content="2019-01-19">
+<meta name="date" content="2019-07-19">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>

diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/Position.Nowhere.html b/docs/javadoc/ca/uqac/lif/textidote/as/Position.Nowhere.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Sat Jan 19 11:21:02 EST 2019 -->
+<!-- Generated by javadoc (1.8.0_222) on Fri Jul 19 21:00:14 CEST 2019 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>Position.Nowhere (TeXtidote Documentation)</title>
-<meta name="date" content="2019-01-19">
+<meta name="date" content="2019-07-19">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>

diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/Position.html b/docs/javadoc/ca/uqac/lif/textidote/as/Position.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Sat Jan 19 11:21:02 EST 2019 -->
+<!-- Generated by javadoc (1.8.0_222) on Fri Jul 19 21:00:14 CEST 2019 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>Position (TeXtidote Documentation)</title>
-<meta name="date" content="2019-01-19">
+<meta name="date" content="2019-07-19">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>

diff --git a/docs/javadoc/ca/uqac/lif/textidote/as/Range.html b/docs/javadoc/ca/uqac/lif/textidote/as/Range.html
@@ -2,10 +2,10 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (1.8.0_191) on Sat Jan 19 11:21:02 EST 2019 -->
+<!-- Generated by javadoc (1.8.0_222) on Fri Jul 19 21:00:14 CEST 2019 -->
 <meta http-equiv="Content-Type" content="text/html; charset=utf8">
 <title>Range (TeXtidote Documentation)</title>
-<meta name="date" content="2019-01-19">
+<meta name="date" content="2019-07-19">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>