From 2121b7f7d8c75b10a2889ec26f95b91b49d21cf7 Mon Sep 17 00:00:00 2001
From: aireilly <aireilly@redhat.com>
Date: Tue, 12 Dec 2023 15:32:33 +0000
Subject: [PATCH] Adding en dash rule

---
 .vale/fixtures/RedHat/EnDashes/.vale.ini      |  5 +++++
 .../fixtures/RedHat/EnDashes/testinvalid.adoc |  1 +
 .vale/fixtures/RedHat/EnDashes/testvalid.adoc |  4 ++++
 .vale/styles/RedHat/CaseSensitiveTerms.yml    | 14 +++++++-----
 .vale/styles/RedHat/EnDashes.yml              |  9 ++++++++
 .vale/styles/RedHat/TermsWarnings.yml         |  3 ++-
 modules/reference-guide/nav.adoc              |  1 +
 modules/reference-guide/pages/endashes.adoc   | 22 +++++++++++++++++++
 8 files changed, 53 insertions(+), 6 deletions(-)
 create mode 100644 .vale/fixtures/RedHat/EnDashes/.vale.ini
 create mode 100644 .vale/fixtures/RedHat/EnDashes/testinvalid.adoc
 create mode 100644 .vale/fixtures/RedHat/EnDashes/testvalid.adoc
 create mode 100644 .vale/styles/RedHat/EnDashes.yml
 create mode 100644 modules/reference-guide/pages/endashes.adoc

diff --git a/.vale/fixtures/RedHat/EnDashes/.vale.ini b/.vale/fixtures/RedHat/EnDashes/.vale.ini
new file mode 100644
index 000000000..ddc1e2b80
--- /dev/null
+++ b/.vale/fixtures/RedHat/EnDashes/.vale.ini
@@ -0,0 +1,5 @@
+; Vale configuration file to test the `EnDashes` rule
+StylesPath = ../../../styles
+MinAlertLevel = suggestion
+[*.adoc]
+RedHat.EnDashes = YES
diff --git a/.vale/fixtures/RedHat/EnDashes/testinvalid.adoc b/.vale/fixtures/RedHat/EnDashes/testinvalid.adoc
new file mode 100644
index 000000000..31991b1a0
--- /dev/null
+++ b/.vale/fixtures/RedHat/EnDashes/testinvalid.adoc
@@ -0,0 +1 @@
+September - December
diff --git a/.vale/fixtures/RedHat/EnDashes/testvalid.adoc b/.vale/fixtures/RedHat/EnDashes/testvalid.adoc
new file mode 100644
index 000000000..d9d66d356
--- /dev/null
+++ b/.vale/fixtures/RedHat/EnDashes/testvalid.adoc
@@ -0,0 +1,4 @@
+numbers 12–15
+pages 100–107
+X'41'–X'FE'
+September–December
diff --git a/.vale/styles/RedHat/CaseSensitiveTerms.yml b/.vale/styles/RedHat/CaseSensitiveTerms.yml
index 03b4b072b..566728155 100644
--- a/.vale/styles/RedHat/CaseSensitiveTerms.yml
+++ b/.vale/styles/RedHat/CaseSensitiveTerms.yml
@@ -8,6 +8,7 @@ message: Use '%s' rather than '%s'.
 action:
   name: replace
 swap:
+  "(?<!.-)javadocs?": Javadoc|API documentation|Java API documentation
   "(?<!/)var": VAR
   "(?<!Business )Resource Planner|(?<!Business Resource )Planner": Business Resource Planner
   "(?<!Microsoft )Azure": Microsoft Azure
@@ -17,6 +18,7 @@ swap:
   "(?<!Red Hat )OpenStack Platform|RHOS|RH-OSP": Red Hat OpenStack Platform
   "(?<!Red Hat JBoss )BRMS(?! engine)": inference engine
   "(?<!Red Hat JBoss )BRMS|BRM|(?<!Red Hat )JBoss BRMS": Red Hat JBoss BRMS
+  "(?<!T-)BC": Business Central
   "[dD]ay-0|day 0": Day 0
   "[dD]ay-1|day 1": Day 1
   "[dD]ay-2|day 2": Day 2
@@ -27,7 +29,7 @@ swap:
   "Kernel(?!-based Virtual Machine)": kernel
   "OCM|(?<!Red Hat OpenShift )Cluster Manager|(?<!Red Hat )OpenShift Cluster Manager|the OpenShift Cluster Manager": Red Hat OpenShift Cluster Manager
   "OD": Red Hat OpenShift Dedicated
-  "(?<!.-)javadocs?": Javadoc|API documentation|Java API documentation
+  "sub version|(?<!Apache )Subversion": sub-version
   '(?<!\.)IM': instant message
   '(?<!\.)yaml|Yaml': YAML
   '(?<!JBoss )EAP|(?<!Red Hat )JBoss(?!\sCommunity|\sBroker|\sClients|\sConsole|\sAMQ|\sData\sGrid|\sBRMS|\sBPMS|\sEnterprise\sApplication\sPlatform|\.org|\sInterconnect|\sEAP|\sBPM\sSuite)': JBoss EAP
@@ -54,18 +56,19 @@ swap:
   'Red\sHat\sVirtualization\sHypervisor|RHV\sHost|RHV-H': Red Hat Virtualization Host
   'RHVM|RHV-M|RHV\sManager': Red Hat Virtualization Manager
   'self-hosted\sengine\svirtual\smachine|engine\sVM': Manager virtual machine
-  "sub version|(?<!Apache )Subversion": sub-version
+  (?<!Ansible )Playbook: playbook
   Ansible playbook: Ansible Playbook
+  Ansible rulebook: Ansible Rulebook
   Appliance Console: Appliance console
-  Applix|ApplixWare: Applixware
   application stream|Application stream: Application Stream
+  Applix|ApplixWare: Applixware
   Appstream|appstream: AppStream repository
   asciidoctor|AsciiDoctor: Asciidoctor
   asciidoc|Asciidoc: AsciiDoc
   assertj|Assertj: AssertJ
   auto-link|AutoLink: autolink
+  AWS opt in Region: AWS opt-in Region
   basic authentication|Basic Authentication|basic auth|Basic auth|Basic Auth: Basic HTTP authentication|Basic authentication
-  "(?<!T-)BC": Business Central
   Bean: bean
   Bios: BIOS
   blue print|BluePrint: blueprint
@@ -184,6 +187,7 @@ swap:
   Lightweight Directory Access Protocol over Secure Socket Layer: LDAPS
   LINUX|linux: Linux
   live-backup group: master-slave group
+  Local Zone|LZ|local zone: AWS Local Zone
   Lun|lun: LUN
   master CA: IdM CA renewal server
   master server: IdM server and replicas
@@ -205,10 +209,10 @@ swap:
   ODF: Red Hat OpenShift Data Foundation
   OK button|okay|ok: OK
   Open InfiniBand|Infiniband: InfiniBand
+  Open Telemetry: OpenTelemetry (OTel)
   openid connect|Openid Connect: OpenID Connect
   openrewrite|Openrewrite|Open Rewrite: OpenRewrite
   Openshift online|OO: Red Hat OpenShift Online
-  Open Telemetry: OpenTelemetry (OTel)
   Operating Environment: operating environment
   Operator Hub|Operator hub|Operatorhub|operatorhub: OperatorHub
   Opex|Opex|OPEX|opEx: OpEx
diff --git a/.vale/styles/RedHat/EnDashes.yml b/.vale/styles/RedHat/EnDashes.yml
new file mode 100644
index 000000000..4c9d20801
--- /dev/null
+++ b/.vale/styles/RedHat/EnDashes.yml
@@ -0,0 +1,9 @@
+---
+extends: substitution
+level: warning
+link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/endashes/
+message: "Use an en dash to show a range, or inclusive numbers, letters, pages, dates, or codes. Do not use a space before or after the en dash."
+action:
+  name: replace
+swap:
+  (?<=[\w\d]+)\s-\s(?=[\w\d]+): –
\ No newline at end of file
diff --git a/.vale/styles/RedHat/TermsWarnings.yml b/.vale/styles/RedHat/TermsWarnings.yml
index bb5e145b9..715bb35c0 100644
--- a/.vale/styles/RedHat/TermsWarnings.yml
+++ b/.vale/styles/RedHat/TermsWarnings.yml
@@ -38,16 +38,17 @@ swap:
   he|she: you
   host name: hostname
   illegal: invalid|not allowed|incorrect
-  invokable: invocable
   in order to: to
   ingests?: import|load|obtain|process
   insure: ensure
+  invokable: invocable
   kill: end|stop
   kilobytes?: KB|kB
   leverage: use
   look at: examine
   may: might|can
   on-premises|on-prem|on premise: on-premise|on-site|in-house
+  opt into|opting into: opt in
   preload: preinstall
   preloaded: preinstalled
   right double-click: double right-click
diff --git a/modules/reference-guide/nav.adoc b/modules/reference-guide/nav.adoc
index 0e69a4bdb..29a4ab042 100644
--- a/modules/reference-guide/nav.adoc
+++ b/modules/reference-guide/nav.adoc
@@ -8,6 +8,7 @@
 * xref:definitions.adoc[]
 * xref:donotuse.adoc[]
 * xref:ellipses.adoc[]
+* xref:endashes.adoc[]
 * xref:headingpunctuation.adoc[]
 * xref:headings.adoc[]
 * xref:hyphens.adoc[]
diff --git a/modules/reference-guide/pages/endashes.adoc b/modules/reference-guide/pages/endashes.adoc
new file mode 100644
index 000000000..332f3195e
--- /dev/null
+++ b/modules/reference-guide/pages/endashes.adoc
@@ -0,0 +1,22 @@
+:navtitle: endashes
+:keywords: reference, rule, endashes
+
+= En Dashes
+
+Use an en dash to show a range, or inclusive numbers, letters, pages, dates, or codes.
+Do not use spaces before or after the en dash.
+
+[NOTE]
+====
+An em dash not the same as an en dash.
+The em dash works like a comma, a colon, or parenthesis.
+Em dashes (`-`) are found on standard keyboards.
+En dashes (`–`) are used between numbers, dates, or ranges.
+En dashes are special characters.
+To render an en dash character in AsciiDoc, use two `--` dashes.
+====
+
+.Additional resources
+
+* link:{ibmsg-url-print}[{ibmsg-print} - En dashes, p.48]
+* link:{ibmsg-url}?topic=punctuation-dashes#showing-ranges-with-en-dashes[{ibmsg} - Showing ranges with en dashes]