Documentation - Merge ACEX (acemod#8526)

* Documentation - Merge ACEX

* Only show ACEX prefix note on framework pages

* Documentation - Use ACEX prefix in Fortify events
See acemod#8553

* Cleanup acex from config.yml

* English is weird

Co-authored-by: PabstMirror <[email protected]>

docs/_config.yml

@@ -12,14 +12,6 @@ ace:
     patch: 0
     build: 63
 
-acex:
-  githubUrl: https://github.com/acemod/ACEX
-  version:
-    major: 3
-    minor: 5
-    patch: 4
-    build: 23
-
 
 markdown: kramdown
 kramdown:

docs/_config_dev.yml

@@ -12,14 +12,6 @@ ace:
     patch: 2
     build: 49
 
-acex:
-  githubUrl: https://github.com/acemod/ACEX
-  version:
-    major: 3
-    minor: 5
-    patch: 2
-    build: 19
-
 
 markdown: kramdown
 kramdown:

docs/_includes/feature_list

@@ -1,5 +1,5 @@
 {% for node in feature_list %}
-    {% if node.mod == mod and node.group == group and node.category == category %}
+    {% if node.group == group and node.category == category %}
         {% if page.url == node.url or (page.parent != null and node.short == page.parent) %}
             <li class="active"><a href="{{ site.baseurl }}{{node.url}}" class="active">{{node.title}}</a></li>
         {% else %}
@@ -8,6 +8,5 @@
     {% endif %}
 {% endfor %}
 {% assign feature_list = nil %}
-{% assign mod = nil %}
 {% assign group = nil %}
 {% assign category = nil %}

docs/_includes/pages_list

@@ -1,5 +1,5 @@
 {% for node in pages_list %}
-    {% if node.mod == mod and node.group == group %}
+    {% if node.group == group %}
         {% if page.url == node.url or (page.parent != null and node.short == page.parent) %}
             <li class="active"><a href="{{ site.baseurl }}{{node.url}}" class="active">{{node.title}}</a></li>
         {% else %}
@@ -8,5 +8,4 @@
     {% endif %}
 {% endfor %}
 {% assign pages_list = nil %}
-{% assign mod = nil %}
 {% assign group = nil %}

docs/_layouts/wiki.html

@@ -31,14 +31,10 @@
 
             {% elsif page.mod == 'acex' %}
 
-                {% if page.version.major > site.acex.version.major %}
-                    <em>Will be {{type}} in ACEX v{{page.version.major}}.{{page.version.minor}}.{{page.version.patch}}</em>
-                {% elsif page.version.major == site.acex.version.major and page.version.minor > site.acex.version.minor %}
-                    <em>Will be {{type}} in ACEX v{{page.version.major}}.{{page.version.minor}}.{{page.version.patch}}</em>
-                {% elsif page.version.major == site.acex.version.major and page.version.minor == site.acex.version.minor and page.version.patch > site.acex.version.patch %}
-                    <em>Will be {{type}} in ACEX v{{page.version.major}}.{{page.version.minor}}.{{page.version.patch}}</em>
+                {% if page.version.removed %}
+                    <em>Removed in ACE3 v{{page.version.major}}.{{page.version.minor}}.{{page.version.patch}}</em>
                 {% else %}
-                    <em>{{typeCapital}} in ACEX v{{page.version.major}}.{{page.version.minor}}.{{page.version.patch}}</em>
+                    <em>Moved to ACE3 in v3.14.0 (originally added in ACEX v{{page.version.major}}.{{page.version.minor}}.{{page.version.patch}})</em>
                 {% endif %}
 
             {% endif %}
@@ -63,6 +59,12 @@ <h2 class="toc-header">Table of contents</h2>
         <section class="medium-8 medium-pull-4 small-12 columns">
             <h1>{{page.title}}</h1>
 
+            {% if page.mod == 'acex' and page.group == 'framework' %}
+                <div class="panel callout">
+                    <p>Component may use <kbd>acex</kbd> prefix in certain variables, events and class names for backwards compatibility!</p>
+                </div>
+            {% endif %}
+
             <div id="content">{{ content }}</div>
         </section>
     </div>

docs/index.html

@@ -55,23 +55,6 @@ <h2 class="subheader">{{ page.browserTitle }}</h2>
     </div>
 </div>
 
-<div class="row">
-    <div class="large-12 columns">
-        <div class="panel callout radius">
-            <div class="row">
-                <div class="large-7 columns">
-                    <h2>ACEX</h2>
-                    <h3 class="subheader">Useful frameworks and features</h3>
-                </div>
-                <div class="large-5 columns">
-                    <a class="button" target="_blank" href="{{site.acex.githubUrl}}/releases/latest" onclick="app.analytics.sendEvent('ExternalLink', 'Click', this.href);" rel="noopener"><i class="fa fa-download"></i> Get ACEX v{{site.acex.version.major}}.{{site.acex.version.minor}}.{{site.acex.version.patch}}</a><br>
-                    <a href="{{site.baseurl}}/wiki/user/installation-guide-acex.html">Installation Guide</a>
-                </div>
-            </div>
-        </div>
-    </div>
-</div>
-
 <div class="row">
     <div class="large-12 columns">
 

docs/wiki/class-names.md

@@ -1,7 +1,7 @@
 ---
 layout: wiki
 title: Class Names
-description: List of class names present in ACE3 and ACEX which mission makers, modders and scripters can use.
+description: List of class names present in ACE3 which mission makers, modders and scripters can use.
 group: wiki
 order: 11
 parent:

docs/wiki/development/index.html

@@ -10,7 +10,7 @@
     <div class="row">
         <div class="large-4 medium-4 columns">
             <h1>Development</h1>
-            <p>Information about developing ACE3 and ACEX, from setting up the development environment to guidelines and tips.</p>
+            <p>Information about developing ACE3, from setting up the development environment to guidelines and tips.</p>
         </div>
         <div class="large-8 medium-8 columns">
             <nav>

docs/wiki/featurex/fortify.md → docs/wiki/feature/fortify.md

@@ -10,6 +10,7 @@ version:
   major: 3
   minor: 3
   patch: 0
+redirect_from: "/wiki/featurex/fortify.html"
 ---
 
 ## 1. Overview
@@ -38,4 +39,4 @@ Please note that to use this function the Fortify module needs to be placed down
 
 ## 4. Dependencies
 
-{% include dependenciesx_list.md component="fortify" %}
+{% include dependencies_list.md component="fortify" %}

docs/wiki/featurex/headless.md → docs/wiki/feature/headless.md

@@ -10,6 +10,7 @@ version:
   major: 3
   minor: 0
   patch: 0
+redirect_from: "/wiki/featurex/headless.html"
 ---
 
 ## 1. Overview
@@ -18,4 +19,4 @@ Enables automatic passing of AI groups to (up to 3) Headless Clients using round
 
 ## 2. Dependencies
 
-{% include dependenciesx_list.md component="headless" %}
+{% include dependencies_list.md component="headless" %}

docs/wiki/feature/index.html

@@ -5,6 +5,7 @@
 order: 1
 short: wiki
 parent: wiki
+redirect_from: "/wiki/featurex"
 ---
 
     <div class="row">
@@ -19,7 +20,6 @@ <h2>General</h2>
             <nav>
                 <ul>
                     {% assign feature_list = site.pages | sort: "title" %}
-                    {% assign mod = 'ace' %}
                     {% assign group = 'feature' %}
                     {% assign category = 'general' %}
                     {% include feature_list %}
@@ -31,7 +31,6 @@ <h2>Interaction</h2>
             <nav>
                 <ul>
                     {% assign feature_list = site.pages | sort: "title" %}
-                    {% assign mod = 'ace' %}
                     {% assign group = 'feature' %}
                     {% assign category = 'interaction' %}
                     {% include feature_list %}
@@ -43,7 +42,6 @@ <h2>Realism</h2>
             <nav>
                 <ul>
                     {% assign feature_list = site.pages | sort: "title" %}
-                    {% assign mod = 'ace' %}
                     {% assign group = 'feature' %}
                     {% assign category = 'realism' %}
                     {% include feature_list %}
@@ -55,7 +53,6 @@ <h2>Equipment</h2>
             <nav>
                 <ul>
                     {% assign feature_list = site.pages | sort: "title" %}
-                    {% assign mod = 'ace' %}
                     {% assign group = 'feature' %}
                     {% assign category = 'equipment' %}
                     {% include feature_list %}

docs/wiki/feature/overheating.md

@@ -60,8 +60,8 @@ Your weapon will be even more prone to jams, and it'll get worse if you don't le
 
 - Weapons and spare barrels will cool off over time.
 - Cooling speed of weapons in increased in windy or rainy weather, and when swimming.
-- If AceX Field Rations is loaded then weapons can be cooled with canteens, water bottles, or other beverage items. This does not require the Field Rations system to be enabled.
-- If AceX Field Rations is enabled then weapons can also be cooled with the same water sources used to refill canteens and water bottles.
+- If ACE Field Rations is loaded then weapons can be cooled with canteens, water bottles, or other beverage items. This does not require the Field Rations system to be enabled.
+- If ACE Field Rations is enabled then weapons can also be cooled with the same water sources used to refill canteens and water bottles.
 
 ### 2.5 Avoiding cookoffs
 

docs/wiki/featurex/sitting.md → docs/wiki/feature/sitting.md

@@ -10,11 +10,9 @@ version:
   major: 3
   minor: 0
   patch: 0
-redirect_from: "/wiki/feature/sitting.html"
+redirect_from: "/wiki/featurex/sitting.html"
 ---
 
-_Sitting has been moved from ACE3 (in v3.8.0) to ACEX._
-
 ## 1. Overview
 Adds the ability to sit on chairs.
 
@@ -28,4 +26,4 @@ Please note that to be able to use this function the sitting module need to be p
 
 ## 3. Dependencies
 
-{% include dependenciesx_list.md component="sitting" %}
+{% include dependencies_list.md component="sitting" %}

docs/wiki/featurex/volume.md → docs/wiki/feature/volume.md

@@ -10,6 +10,7 @@ version:
   major: 3
   minor: 2
   patch: 0
+redirect_from: "/wiki/featurex/volume.html"
 ---
 
 ## 1. Overview
@@ -25,10 +26,10 @@ Adds the possibility of setting a keybind to toggle volume of game and music. It
 
 ## 3. Usage
 
-1. Set the keybind in ACEX controls
+1. Set the keybind in ACE controls
 2. Enable the feature in ACE options
 3. Change the options to your liking
 
 ## 4. Dependencies
 
-{% include dependenciesx_list.md component="volume" %}
+{% include dependencies_list.md component="volume" %}

docs/wiki/frameworkx/field-rations-framework.md → docs/wiki/framework/field-rations-framework.md

@@ -1,14 +1,15 @@
 ---
 layout: wiki
 title: Field Rations Framework
-description: Explains how to set-up ACEX Field Rations.
+description: Explains how to set-up ACE Field Rations.
 group: framework
 parent: wiki
 mod: acex
 version:
   major: 3
   minor: 4
   patch: 0
+redirect_from: "/wiki/frameworkx/field-rations-framework.html"
 ---
 
 ## 1. Config Values
@@ -51,7 +52,7 @@ Event Name | Passed Parameter(s) | Locality | Description
 
 ### 3.1 Getting water supply
 
-`acex_field_rations_fnc_getRemainingWater`
+`ace_field_rations_fnc_getRemainingWater`
 
 ```cpp
 * Returns the remaining water in a source.
@@ -63,12 +64,12 @@ Event Name | Passed Parameter(s) | Locality | Description
 * Remaining water <NUMBER>
 *
 * Example:
-* [_source] call acex_field_rations_fnc_getRemainingWater
+* [_source] call ace_field_rations_fnc_getRemainingWater
 ```
 
 ### 3.2 Setting water supply
 
-`acex_field_rations_fnc_setRemainingWater`
+`ace_field_rations_fnc_setRemainingWater`
 
 ```cpp
 * Sets the remaining water supply for given water source.
@@ -81,12 +82,12 @@ Event Name | Passed Parameter(s) | Locality | Description
 * None
 *
 * Example:
-* [_source, 1000] call acex_field_rations_fnc_setRemainingWater
+* [_source, 1000] call ace_field_rations_fnc_setRemainingWater
 ```
 
 ### 3.3 Adding a status modifier
 
-`acex_field_rations_fnc_addStatusModifier`
+`ace_field_rations_fnc_addStatusModifier`
 
 ```cpp
 * Adds a status modifier. Should be called on all machines.
@@ -100,5 +101,5 @@ Event Name | Passed Parameter(s) | Locality | Description
 * None
 *
 * Example:
-* [0, {random 1}] call acex_field_rations_fnc_addStatusModifier
+* [0, {random 1}] call ace_field_rations_fnc_addStatusModifier
 ```