Restructuring the Word Lists

config.toml

@@ -8,6 +8,9 @@ summaryLength = 20
 [markup.highlight]
 style = "paraiso-dark"
 
+[blackfriday]
+extensions = ["hardLineBreak"]
+
 [params]
 font_awesome_version = "5.12.0"
 description = "Helping projects and companies make consistent, responsible choices to remove harmful language"
@@ -119,7 +122,7 @@ weight = 5
 
 [[menu.main]]
 name = "Overview"
-url = "/word-lists/overview"
+url = "/word-lists"
 parent = "lists"
 weight = 1
 
@@ -147,6 +150,12 @@ url = "/word-lists/no-change"
 parent = "lists"
 weight = 5
 
+[[menu.main]]
+name = "Wordlist Template"
+url = "/word-lists/template"
+parent = "lists"
+weight = 6
+
 [[menu.main]]
 name = "Resources"
 url = "#"

content/_index.md

@@ -1,5 +1,6 @@
 ---
 title: "Inclusive Naming Initiative"
+layout: wordlist
 ---
 
 {{< jumbotron title="Get involved" bgcolor="#2478D3" textcolor="#FFFFFF" align="text-center" >}}

content/word-lists/overview.md → content/word-lists/_index.md

@@ -1,12 +1,40 @@
 ---
 title: "Overview"
+type: wordlist
+layout: wordlist
+outputs:
+    - html
+    - json
 ---
 
 # Language recommendation lists 
 
 The Inclusive Naming Initiative produces three tiers of language recommendation. These are compiled into lists for easy consumption by adopters. Terms are separated into lists based on the severity of the term in question as well as the level of review the terms have received.
 
-## Tier 1: Replace Immediately
+To add new terms to the lists, review the [Wordlist template](/word-lists/template/) page.
+
+## JSON Formmated list
+
+The complete wordlist can be accessed in a single [JSON file](/word-lists/index.json), formatted as follows:
+
+```
+{
+    "data" : 
+        [
+            {
+                "term": "abort",
+                "tier" : "1",
+                "recommendation": "Replace when possible.",
+                "recommended_replacements": ["User-Initiated Termination","Force quit","Cancel","System-Initiated Termination","Fail","Close (app, program, connection)","End","Halt","Hard stop","Stop (something you triggered)"],
+                "term_page" : "http://inclusivenaming.org/word-lists/tier-1/abort/index.html"
+            }
+        ]
+}
+```
+
+
+
+## [Tier 1: Replace Immediately](/word-lists/tier-1/)
 
 Tier 1 terms should be replaced whenever encountered. 
 Terms included in this list have one or all of the following: 
@@ -16,19 +44,23 @@ Terms included in this list have one or all of the following:
 - Terms where the impact of change or removal is low: for example, there is little entanglement in low-level systems or standardized language set by standards bodies
 - Have passed through all the review stages in Tiers 2 and 3
 
-## Tier 2: Strongly Consider Replacing
+## [Tier 2: Strongly Consider Replacing](/word-lists/tier-2/)
 
 Terms in this list should be replaced whenever possible, barring major breaking changes.
 Terms included in this list have one or all of the following:
 
 - Are terms from Tier 3 that have undergone through external review by underrepresented minority groups and outside consultants 
 - Terms which would otherwise be in Tier 1 but have dependencies on language set by standards bodies, or are deeply embedded in low-level systems and thus difficult to change
 
-## Tier 3: Recommendations to Replace
+## [Tier 3: Recommendations to Replace](/word-lists/tier-3/)
 
 Terms in this list should be considered for replacement. 
 Terms included in this list have one or all of the following:
 
 - Review by the Inclusive Naming Initiative, with particular attention paid to finding consensus among member companies and participants' companies for replacements
 - Research conducted by the Inclusive Naming Initiative on the etymology of the word and non-tech cultural connotations, per the [Language Evaluation Framework](https://inclusivenaming.org/language/evaluation-framework/)
-- A consensus-based replacement term or terms proposed by the Language Workstream and sent for approval and review to the larger Initiative
+- A consensus-based replacement term or terms proposed by the Language Workstream and sent for approval and review to the larger Initiative.
+
+## [No-Change](/word-lists/no-change/)
+
+This word list captures terms the Inclusive Naming Initiative and its partner organizations evaluated but did not recommend any changes for. 

content/word-lists/no-change/_index.md

@@ -0,0 +1,7 @@
+---
+title: "No Change Recommended"
+---
+
+This word list captures terms the Inclusive Naming Initiative and its partner organizations evaluated but did not recommend any changes for. 
+
+## Terms

content/word-lists/no-change/blackbox.md

@@ -0,0 +1,27 @@
+---
+title: "Blackbox"
+type: wordlist
+layout: wordlist
+outputs:
+    - html
+    - json
+
+tier: 0
+term: "blackbox"
+related_terms:
+    - None
+definition: "N/A"
+use_context: "An abstraction of a device or system in which only its externally visible behavior is considered and not its implementation or inner workings."
+recommendation: "No change recommended. This term may be used without restriction. Black box refers to opacity, such as details that aren't visible or are not the focus. This term is not based on a good/bad binary where white is represented as good or black is represented as bad and so does not promote racial bias."
+recommended_replacements:
+    - None
+unsuitable_replacements:
+    - None
+rationale: |
+    N/A
+status: | 
+    N/A
+supporting_content: | 
+    Recommendation from the IBM Inclusive IT Language Initiative Words Matter working group
+
+---

content/word-lists/no-change/blackout.md

@@ -0,0 +1,27 @@
+---
+title: "Blackout"
+type: wordlist
+layout: wordlist
+outputs:
+    - html
+    - json
+
+tier: 0
+term: "Blackout"
+related_terms:
+    - None
+definition: "N/A"
+use_context: "A period of darkness, such as between acts in a play or during an electrical outage. Metaphorically, a period during which a service is unavailable."
+recommendation: "No change recommended. This term may be used without restriction. This term is not based on a good/bad binary where white is represented as good or black is represented as bad and so does not promote racial bias."
+recommended_replacements:
+    - None
+unsuitable_replacements:
+    - None
+rationale: |
+    N/A
+status: | 
+    N/A
+supporting_content: | 
+    Recommendation from the IBM Inclusive IT Language Initiative Words Matter working group
+
+---

content/word-lists/no-change/disable.md

@@ -0,0 +1,27 @@
+---
+title: "Disable"
+type: wordlist
+layout: wordlist
+outputs:
+    - html
+    - json
+
+tier: 0
+term: "disable"
+related_terms:
+    - disabled
+definition: "N/A"
+use_context: "A feature that is deactivated or made unavailable."
+recommendation: "Do not change. The terms 'disable' and 'disabled' are valid in the context of technology, such as disabling an application or a network component. In the context of talking about disabled people, however, follow the guidance around it from the AP Style Guide, the [UK Government](https://www.gov.uk/government/publications/inclusive-communication/inclusive-language-words-to-use-and-avoid-when-writing-about-disability), the [National Center for Disability and Journalism](https://ncdj.org/style-guide/), or other sources. In most cases, the recommendation is to use the word 'disabled' to refer to disabled people rather than alternate terms. The [National Center for Disability and Journalism](https://ncdj.org/style-guide/) recommends to specify the disability where relevant, instead of grouping all people under the general term."
+recommended_replacements:
+    - Deactivate/activate
+unsuitable_replacements:
+    - None
+rationale: |
+    N/A
+status: | 
+    N/A
+supporting_content: | 
+    N/A
+
+---

content/word-lists/no-change/fair-hiring-practice.md

@@ -0,0 +1,27 @@
+---
+title: "Fair Hiring Practise"
+type: wordlist
+layout: wordlist
+outputs:
+    - html
+    - json
+
+tier: 0
+term: "fair hiring practice"
+related_terms:
+    - None
+definition: "N/A"
+use_context: "N/A"
+recommendation: "No change recommended. This term is not biased because it's easy to distinguish 'fair' in the sense of unbiased from 'fair' in the sense of a light-skinned person in context."
+recommended_replacements:
+    - None
+unsuitable_replacements:
+    - None
+rationale: |
+    N/A
+status: | 
+    N/A
+supporting_content: | 
+    **Recommendation from the IBM Inclusive IT Language Initiative Words Matter working group**
+
+---