From 65df821e2b5b2d420eda3813ad3bf5d20b0f423c Mon Sep 17 00:00:00 2001 From: jonpas Date: Thu, 8 Sep 2016 21:19:07 +0200 Subject: [PATCH] Add wiki ACEX sections and merge Mission Makers and Framework sections (#4307) * Update documentation guidelines * Add version info part 1 * Add version info part 2 * Add removed in version to frontmatter and tag testmissions as removed * Add version info part 3 * Seaparate ACE3 and ACEX Features/Framework menus, Add ACEX Headless documentation * Add ACEX support to extract_dependencies.py * Merge useful-functions into frameworks * Move class-names to main menu * Prettify class-names table titles * Fix table of contents on documentation guidelines and tips * Merge mission-tools into frameworks * Merge modules into frameworks * Rename to Frameworks (plural) * Fix capitalization in class-names * Improve wiki menu positioning * Add 'mod' to documentation guidelines * Update frameworks sections description for new content * Update wiki menu descriptions * Fix class-names 4 digit versions * More places for descriptions * Include documentation in PRs if applicable note * Add short ACE3 and ACEX description page, outlining the difference --- .github/PULL_REQUEST_TEMPLATE.md | 1 + docs/_includes/dependenciesx_list.md | 12 + docs/_includes/feature_list | 3 +- docs/_includes/pages_list | 3 +- docs/wiki/{missionmaker => }/class-names.md | 241 +++---- .../documentation-guidelines-and-tips.md | 10 +- docs/wiki/development/index.html | 2 +- docs/wiki/feature/advanced-ballistics.md | 81 +-- docs/wiki/feature/index.html | 10 +- docs/wiki/feature/missionmodules.md | 6 +- docs/wiki/feature/winddeflection.md | 8 +- docs/wiki/featurex/headless.md | 21 + docs/wiki/featurex/index.html | 65 ++ .../advanced-ballistics-framework.md | 80 +++ docs/wiki/framework/checkPBOs-framework.md | 46 ++ docs/wiki/framework/events-framework.md | 1 + docs/wiki/framework/explosives-framework.md | 43 ++ docs/wiki/framework/index.html | 11 +- .../framework/missile-guidance-framework.md | 4 +- .../framework/missionmodules-framework.md | 23 + docs/wiki/framework/respawn-framework.md | 60 ++ docs/wiki/framework/slideshow-framework.md | 59 ++ docs/wiki/framework/switchunits-framework.md | 31 + docs/wiki/framework/vehiclelock-framework.md | 65 ++ docs/wiki/framework/weather-framework.md | 31 + .../framework/winddeflection-framework.md | 23 + docs/wiki/frameworkx/headless-framework.md | 40 ++ .../{missionmaker => frameworkx}/index.html | 12 +- docs/wiki/index.html | 66 +- docs/wiki/missionmaker/mission-tools.md | 140 ---- docs/wiki/missionmaker/modules.md | 629 ------------------ docs/wiki/missionmaker/useful-functions.md | 62 -- docs/wiki/user/ace3-and-acex.md | 20 + docs/wiki/user/index.html | 2 +- docs/wiki/user/information-center.md | 2 +- docs/wiki/user/installation-guide-acex.md | 2 +- docs/wiki/user/installation-guide.md | 2 +- tools/extract_dependencies.py | 67 +- 38 files changed, 882 insertions(+), 1102 deletions(-) create mode 100644 docs/_includes/dependenciesx_list.md rename docs/wiki/{missionmaker => }/class-names.md (77%) create mode 100644 docs/wiki/featurex/headless.md create mode 100644 docs/wiki/featurex/index.html create mode 100644 docs/wiki/framework/advanced-ballistics-framework.md create mode 100644 docs/wiki/framework/checkPBOs-framework.md create mode 100644 docs/wiki/framework/missionmodules-framework.md create mode 100644 docs/wiki/framework/respawn-framework.md create mode 100644 docs/wiki/framework/slideshow-framework.md create mode 100644 docs/wiki/framework/switchunits-framework.md create mode 100644 docs/wiki/framework/vehiclelock-framework.md create mode 100644 docs/wiki/framework/weather-framework.md create mode 100644 docs/wiki/framework/winddeflection-framework.md create mode 100644 docs/wiki/frameworkx/headless-framework.md rename docs/wiki/{missionmaker => frameworkx}/index.html (50%) delete mode 100644 docs/wiki/missionmaker/mission-tools.md delete mode 100644 docs/wiki/missionmaker/modules.md delete mode 100644 docs/wiki/missionmaker/useful-functions.md create mode 100644 docs/wiki/user/ace3-and-acex.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f96a900cb7..2dbbc268af 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,5 @@ **When merged this pull request will:** - Describe what this pull request will do - Each change in a separate line +- Include documentation if applicable - Respect the [Development Guidelines](http://ace3mod.com/wiki/development/) diff --git a/docs/_includes/dependenciesx_list.md b/docs/_includes/dependenciesx_list.md new file mode 100644 index 0000000000..8f387be41d --- /dev/null +++ b/docs/_includes/dependenciesx_list.md @@ -0,0 +1,12 @@ +{% if include.component == "headless" %} +`acex_main` +{% endif %} + +{% if include.component == "sitting" %} +`acex_main`, `ace_interaction` +{% endif %} + +{% if include.component == "viewrestriction" %} +`acex_main` +{% endif %} + diff --git a/docs/_includes/feature_list b/docs/_includes/feature_list index b5d5ac4009..130a7826ec 100644 --- a/docs/_includes/feature_list +++ b/docs/_includes/feature_list @@ -1,5 +1,5 @@ {% for node in feature_list %} - {% if node.group == group and node.category == category %} + {% if node.mod == mod and node.group == group and node.category == category %} {% if page.url == node.url or (page.parent != null and node.short == page.parent) %}
  • {{node.title}}
    • {% else %} @@ -8,5 +8,6 @@ {% endif %} {% endfor %} {% assign feature_list = nil %} +{% assign mod = nil %} {% assign group = nil %} {% assign category = nil %} diff --git a/docs/_includes/pages_list b/docs/_includes/pages_list index de449d71bb..4a4c93a50a 100644 --- a/docs/_includes/pages_list +++ b/docs/_includes/pages_list @@ -1,5 +1,5 @@ {% for node in pages_list %} - {% if group == null or group == node.group %} + {% if node.mod == mod and node.group == group %} {% if page.url == node.url or (page.parent != null and node.short == page.parent) %}
  • {{node.title}}
    • {% else %} @@ -8,4 +8,5 @@ {% endif %} {% endfor %} {% assign pages_list = nil %} +{% assign mod = nil %} {% assign group = nil %} diff --git a/docs/wiki/missionmaker/class-names.md b/docs/wiki/class-names.md similarity index 77% rename from docs/wiki/missionmaker/class-names.md rename to docs/wiki/class-names.md index c4db6d993b..ebd8236f1b 100644 --- a/docs/wiki/missionmaker/class-names.md +++ b/docs/wiki/class-names.md @@ -1,34 +1,37 @@ --- layout: wiki -title: Class names -description: A list of all the class names in ACE3 -group: missionmaker +title: Class Names +description: List of class names present in ACE3 and ACEX which mission makers, modders and scripters can use. +group: wiki order: 11 -parent: wiki +parent: +redirect_from: "/wiki/missionmaker/class-names.html" --- Everything is ordered alphabetically. You know an in-game name but want the class name? CTRL + F -## AtragMX -`added in 3.0.0.3` +## ACE3 -class name | in game name | type | +### AtragMX +`Added in 3.0.0` + +Class Name | In-Game Name | Type | ---------- | --------- | --------- | ACE_ATragMX | ATragMX | ACE_ItemCore | -## Attachable -`added in 3.0.0.3` +### Attachable +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- | ACE_IR_Strobe_Item | IR strobe | ACE_ItemCore | -## Ballistics -`added in 3.0.0.3` +### Ballistics +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- | ACE_100Rnd_65x39_caseless_mag_Tracer_Dim | 6.5mm IR-DIM | Magazine | ACE_200Rnd_65x39_cased_Box_Tracer_Dim | 6.5mm IR-DIM | Magazine | @@ -63,46 +66,46 @@ ACE_30Rnd_9x19_mag | 9x19mm | Magazine | ACE_16Rnd_9x19_mag | 9x19mm | Magazine | ACE_10Rnd_762x54_Tracer_mag | 7.62mm | Magazine | -## Captive -`added in 3.0.0.3` +### Captive +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_CableTie | cable tie | ACE_ItemCore | -## Common -`added in 3.0.0.3` +### Common +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_Banana | banana | ACE_ItemCore | -## Concertina Wire -`added in 3.1.1` +### Concertina Wire +`Added in 3.1.1` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_ConcertinaWireCoil | Concertina Wire Coil | ThingX | ACE_ConcertinaWire | Concertina Wire | deployed concertina wire | -## DAGR -`added in 3.1.1` +### DAGR +`Added in 3.1.1` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_DAGR | DAGR | ACE_ItemCore | -## Disposable -`added in 3.0.0.3` +### Disposable +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_launch_NLAW_Used_F | used NLAW | Weapon | -## Explosives -`added in 3.0.0.3` +### Explosives +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_Cellphone | Cellphone | ACE_ItemCore | ACE_Clacker| M57 Firing Device | ACE_ItemCore | @@ -110,19 +113,19 @@ ACE_M26_Clacker| M26 Firing Device | ACE_ItemCore | ACE_DefusalKit | Defusal Kit | ACE_ItemCore | ACE_DeadManSwitch | Dead Man's Switch | ACE_ItemCore | -## Flashlights -`added in 3.3.0` +### Flashlights +`Added in 3.3.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_Flashlight_MX991 | Fulton MX-991 | ACE_ItemCore | ACE_Flashlight_KSF1 | KSF-1 | ACE_ItemCore | ACE_Flashlight_XL50 | Maglite XL50 | ACE_ItemCore | -## Grenades -`added in 3.0.0.3` +### Grenades +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_HandFlare_White | M127A1 Hand Held Signal (White) | Grenade | ACE_HandFlare_Red | M127A1 Hand Held Signal (Red | Grenade | @@ -130,67 +133,67 @@ ACE_HandFlare_Green | M127A1 Hand Held Signal (Green) | Grenade | ACE_HandFlare_Yellow | M127A1 Hand Held Signal (Yellow) | Grenade | ACE_M84 | M84 Stun Grenade | Grenade | -## Gun Bag -`added in 3.6.0.0` +### Gun Bag +`Added in 3.6.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_gunbag | Gunbag | Backpack | ACE_gunbag_Tan | Gunbag | Backpack | -## Hearing -`added in 3.0.0.3` +### Hearing +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_EarPlugs | Earplugs | ACE_ItemCore | -## HuntIR -`added in 3.1.1` +### HuntIR +`Added in 3.1.1` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_HuntIR_monitor | HuntIR monitor | ACE_ItemCore | ACE_HuntIR_M203 | HuntIR Round | Grenade shell | ACE_HuntIR_Box | HuntIR Transport Box | ammo box | -## Kestrel -`added in 3.0.0.3` +### Kestrel +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_Kestrel4500 | Kestrel 4500NV | ACE_ItemCore | -## Laser Pointers -`added in 3.0.0.3` +### Laser Pointers +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- acc_pointer_IR | Laser Pointer (red) | Weapon accessory | ACE_acc_pointer_red | Laser Pointer (green) | Weapon accessory | ACE_acc_pointer_green_IR | Laser Pointer (green) | Weapon accessory | ACE_acc_pointer_green | Laser Pointer (green) | Weapon accessory | -## Logistics -`added in 3.0.0.3` +### Logistics +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_UAVBattery | UAV Battery | ACE_ItemCore | ACE_wirecutter | Wirecutter | ACE_ItemCore | -## Map Tools -`added in 3.0.0.3` +### Map Tools +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_MapTools | Map Tools | ACE_ItemCore | -## Medical -`added in 3.0.0.3` +### Medical +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_atropine | Atropin auto injector | ACE_ItemCore | ACE_fieldDressing | Bandage (Basic) | ACE_ItemCore | @@ -214,25 +217,25 @@ ACE_salineIV_250 | Saline IV (250ml) | ACE_ItemCore | ACE_surgicalKit | Surgical Kit | ACE_ItemCore | ACE_tourniquet | Tourniquet (CAT) | ACE_ItemCore | -## MicroDAGR -`added in 3.0.0.3` +### MicroDAGR +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_microDAGR | MicroDAGR GPS | ACE_ItemCore | -## Mine Detector -`added in 3.6.0.0` +### Mine Detector +`Added in 3.6.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_VMH3 | VMH3 | Pistol_Base_F | ACE_VMM3 | VMM3 | Pistol_Base_F | -## MK6 Mortar -`added in 3.0.0.3` +### MK6 Mortar +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_RangeTable_82mm | 82mm Rangetable | ACE_ItemCore | ACE_1Rnd_82mm_Mo_HE | 82mm HE Round | Magazine | @@ -241,18 +244,18 @@ ACE_1Rnd_82mm_Mo_Illum | 82mm Illumination Round | Magazine | ACE_1Rnd_82mm_Mo_HE_Guided | 82mm Guided HE Round | Magazine | ACE_1Rnd_82mm_Mo_HE_LaserGuided | 82mm Laser Guided HE Round | Magazine | -## M2XA -`added in 3.1.1` +### M2XA +`Added in 3.1.1` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_MX2A | MX-2A | Binocular | -## Nightvision -`added in 3.0.0.3` +### Nightvision +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_NVG_Gen1 | NV Goggles (Gen1) | NVG | ACE_NVG_Gen2 | NV Goggles (Gen2) | NVG | @@ -261,10 +264,10 @@ ACE_NVG_Gen4 | NV Goggles (Gen4) | NVG | ACE_NVG_Wide | NV Goggles (Wide) | NVG | -## Optics -`added in 3.0.0.3` +### Optics +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_optic_Arco_2D | ARCO (2D) | Weapon accessory | ACE_optic_Arco_PIP | ARCO (PIP) | Weapon accessory | @@ -277,41 +280,41 @@ ACE_optic_MRCO_PIP | MRCO (PIP) | Weapon accessory | ACE_optic_Hamr_2D | RCO (2D) | Weapon accessory | ACE_optic_Hamr_PIP | RCO (PIP) | Weapon accessory | -## Overheating -`added in 3.0.0.3` +### Overheating +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_SpareBarrel | Spare barrel | ACE_ItemCore | -## Parachute +### Parachute `last modified in 3.2.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_Altimeter | Altimeter Watch | ACE_ItemCore | ACE_NonSteerableParachute | Non-Steerable Parachute | Backpack | ACE_ReserveParachute | Reserve Parachute | Backpack | -## Rangecard -`added in 3.1.1` +### Rangecard +`Added in 3.1.1` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_RangeCard | rangecard | ACE_ItemCore | -## Repair -`added in 3.3.0` +### Repair +`Added in 3.3.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_Track | Spare Track | thingX | ACE_Wheel | Spare Wheel | thingX | -## Respawn +### Respawn `last modified in 3.2.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_Rallypoint_West | Rallypoint West | FlagCarrier | ACE_Rallypoint_East | Rallypoint East | FlagCarrier | @@ -320,59 +323,59 @@ ACE_Rallypoint_West_Base | Rallypoint West (Base) | FlagCarrier | ACE_Rallypoint_East_Base | Rallypoint East (Base) | FlagCarrier | ACE_Rallypoint_Independent_Base | Rallypoint Independent (Base) | FlagCarrier | -## Sandbag -`added in 3.1.1` +### Sandbag +`Added in 3.1.1` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_Sandbag_empty | Sandbag (empty) | ACE_ItemCore | ACE_SandbagObject | Sandbag | ThingX | -## Spotting Scope -`added in 3.1.1` +### Spotting Scope +`Added in 3.1.1` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_SpottingScope | Spotting Scope | ACE_ItemCore | ACE_SpottingScopeObject | Spotting Scope (placed) | StaticATWeapon | -## Tactical Ladder -`added in 3.1.1` +### Tactical Ladder +`Added in 3.1.1` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_TacticalLadder_Pack | Telescopic Ladder | Backpack | ACE_Tactical_Ladder | Telescopic Ladder (placed) | house | -## Tagging -`added in 3.5.0` +### Tagging +`Added in 3.5.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_SpraypaintBlack | Spraypaint Black | ACE_ItemCore | ACE_SpraypaintBlue | Spraypaint Blue | ACE_ItemCore | ACE_SpraypaintGreen | Spraypaint Green | ACE_ItemCore | ACE_SpraypaintRed | Spraypaint Red | ACE_ItemCore | -## Trenches -`added in 3.5.0` +### Trenches +`Added in 3.5.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_EntrenchingTool | Entrenching Tool | ACE_ItemCore | -## Tripod -`added in 3.1.1` +### Tripod +`Added in 3.1.1` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_Tripod | SSWT Kit | ACE_ItemCore | ACE_TripodObject | SSWT Kit (placed) | ThingX | -## Vehicle Lock -`added in 3.0.0.3` +### Vehicle Lock +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_key_master | Vehicle Key: Master | ACE_ItemCore | ACE_key_lockpick | Lockpick | ACE_ItemCore | @@ -381,18 +384,18 @@ ACE_key_east | Vehicle Key: East | ACE_ItemCore | ACE_key_indp | Vehicle Key: Independent | ACE_ItemCore | ACE_key_civ | Vehicle Key: Civilian | ACE_ItemCore | -## Vector -`added in 3.0.0.3` +### Vector +`Added in 3.0.0` -class name | in game name | type | +Class Name | In-Game Name | Type | --------- | --------- | --------- ACE_Vector | Vector 21 | Binoculars | ACE_VectorDay | Vector 21 (Day) | Binoculars | -## Yardage 450 -`added in 3.1.1` +### Yardage 450 +`Added in 3.1.1` -class name | in game name | type | +Class Name | In-Game Name | Type | ---------- | --------- | --------- ACE_Yardage450 | Yardage 450 | Binocular | diff --git a/docs/wiki/development/documentation-guidelines-and-tips.md b/docs/wiki/development/documentation-guidelines-and-tips.md index 9f9c154511..102081d37e 100644 --- a/docs/wiki/development/documentation-guidelines-and-tips.md +++ b/docs/wiki/development/documentation-guidelines-and-tips.md @@ -6,7 +6,7 @@ parent: wiki order: 19 --- -# 1. Documentation Guidelines +## 1. Documentation Guidelines - A line between each entry like above. - This is especially necessary for the kramdown markup syntax. Kramdown needs a line break between each block level element (paragraphs, lists, codeblocks, etc ...) @@ -18,12 +18,12 @@ order: 19 - Capitals at the start of a sentence and `.`at the end. - Verify everything in game -## 1.1 Tips +### 1.1 Tips - Use [http://dillinger.io/](http://dillinger.io/) to keep your sanity - [Markdown cheat sheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) -## 1.2 Feature Template +### 1.2 Feature Template ``` --- @@ -33,6 +33,7 @@ description: Description of the feature. group: feature category: interaction parent: wiki +mod: ace version: major: 3 minor: 0 @@ -72,7 +73,7 @@ Short description of sub-feature 2. Information about other guides and pages about this feature. ``` -## 1.3 Framework Template +### 1.3 Framework Template ``` --- @@ -81,6 +82,7 @@ title: Component Framework description: Description of the framework. group: framework parent: wiki +mod: ace version: major: 3 minor: 0 diff --git a/docs/wiki/development/index.html b/docs/wiki/development/index.html index 09f51dc13f..8fdacb3d50 100644 --- a/docs/wiki/development/index.html +++ b/docs/wiki/development/index.html @@ -10,7 +10,7 @@ parent: wiki

    Development

    -

    If you're an aspiring developer, you'll find all necessary information here.

    +

    Information about developing ACE3 and ACEX, from setting up the development environment to guidelines and tips.