Merge pull request #42 from couchbaselabs/DOC-13594-latin-updates

[DOC-13594] Fix Latin Abbreviation Flags

Author: sarahlwelton

ValeStyles/Couchbase/Latin.yml

@@ -0,0 +1,21 @@
+extends: substitution
+message: "Use '%s' instead of '%s'."
+link: https://docs.couchbase.com/styleguide/latin-abbreviations.html
+ignorecase: true
+level: error
+nonword: true
+scope: raw # required to parse the `. ` alternatives
+action:
+  name: replace
+swap:
+  # e.g.
+  '(?i)\b(eg|e\.g)\b': for example
+  '(?i)\be\. g\b': for example
+
+  # i.e.
+  '(?i)\b(ie|i\.e)\b': specifically
+  '(?i)\bi\. e\b': specifically
+
+  # etc.
+  '(?i)\b(etc|e\.t\.c)\b': and so on
+  '(?i)\bet ?cetera\b': and so on

ValeStyles/Couchbase/Terminology.yml

@@ -32,12 +32,12 @@ swap:
   '(?:de-select|unselect|un-select)': clear
   '(?:de-selected|unselected|un-selected)': cleared
   '(?:different to|different than)': different from
-  '(?:eg|e\.g)': for example
+  #'(?:eg|e\.g)': for example
   encryptor: encrypter
   end user experience: end-user experience
   ensure: make sure|verify
   '(?:e-payment)': ePayment
-  etc: and so on
+  #etc: and so on
   file name: filename
   file system: filesystem
   '(?:fine grained|finegrained)': fine-grained

ValeStyles/Google/Latin.yml

@@ -10,6 +10,7 @@
 ** xref:contractions.adoc[]
 ** xref:values.adoc[]
 ** xref:directional-language.adoc[]
+** xref:latin-abbreviations.adoc[]
 ** xref:less-fewer.adoc[]
 ** xref:only.adoc[]
 ** xref:there-is.adoc[]

styleguide/modules/ROOT/nav.adoc

@@ -0,0 +1,23 @@
+= Latin Abbreviations 
+
+Do not use the following Latin abbreviations in Couchbase documentation: 
+
+* e.g.
+* i.e.
+* etc. 
+
+If you feel you need to use these Latin abbreviations, try 1 of the following alternatives: 
+
+|====
+|Instead of... |Try...
+
+| e.g. 
+| for example
+
+| i.e.
+| specifically
+
+| etc. 
+| and so on
+
+|====