fix markdown formatting in existing documentation (TheSuperHackers#13)

Author: tintinhamans

.markdownlint.yaml

@@ -9,6 +9,7 @@ MD033:               # Disallow inline HTML, with some exceptions
   allowed_elements:
     - details
     - summary
+    - br
 MD041: true          # First line should be h1
 MD046: true          # Enforce code block style
 MD025: true          # Disallow multiple h1 headers

Asset/Art/cameo_sizes.md

@@ -1,12 +1,15 @@
-## Description:
-These are the default sizes of the unit portraits and it's button 
+# Cameo & General Portrait Sizes
+
+These are the default sizes of the unit portraits and it's button
 images that are you used in the game; If you want to have more crisp
 button image and unit portrait visuals, just double the resolution listed below.
 
-## Cameo sizes:
+## Cameo Sizes
+
 Small Cameo - 62 X 50
 Large Portrait - 122 X 98
 
-## General portrait sizes
+## General Portrait Sizes
+
 Small Portait - 118 X 117
-Large Portrait - 334 X 330
+Large Portrait - 334 X 330

Asset/Art/dds/dds-files-and-dxt-compression.md

@@ -1,8 +1,9 @@
 # 3DSMAX
 
 After installing Autodesk 3ds Max, install following scripts:
-* [3DSMAX7 BFME2 W3D Scripts](https://github.com/TheSuperHackers/GeneralsTools/blob/main/Tools/w3d/3dsmax7_bfme2_mod_sdk.zip)
-* [3DSMAX W3D Importer](https://github.com/TheSuperHackers/GeneralsTools/blob/main/Tools/w3d/coolfile_w3d_importer.zip)
+
+- [3DSMAX7 BFME2 W3D Scripts](<https://github.com/TheSuperHackers/GeneralsTools/blob/main/Tools/w3d/3dsmax7_bfme2_mod_sdk.zip>)
+- [3DSMAX W3D Importer](<https://github.com/TheSuperHackers/GeneralsTools/blob/main/Tools/w3d/coolfile_w3d_importer.zip>)
 
 ## Configure W3D Importer
 
@@ -20,7 +21,8 @@ To import W3D File, select **File > Import W3D**.
 
 To unload it, select **File > Reset**.
 
-Note: the W3D Importer does not necessarily produce perfect imports. Vertices counts may differ between the original W3D mesh and the imported W3D mesh. If the mesh looks ok, you can use it however.
+Note: the W3D Importer does not necessarily produce perfect imports. Vertices counts may differ between the original W3D
+mesh and the imported W3D mesh. If the mesh looks ok, you can use it however.
 
 ![3dsmax8_import_w3d.png](images/3dsmax8_import_w3d.png)
 
@@ -30,10 +32,10 @@ To Export W3D File, select **File > Export** and choose the W3D file format in t
 
 ![3dsmax8_export_w3d.png](images/3dsmax8_export_w3d.png)
 
-
 ## Rescale W3D Animation
 
-To rescale a W3D animation, import the W3D file, click on the **Time Configuration** button at the bottom, hit **Re-scale Time** button and then specify the new Frame Length.
+To rescale a W3D animation, import the W3D file, click on the **Time Configuration** button at the bottom, hit
+**Re-scale Time** button and then specify the new Frame Length.
 
 Note: 30 frames correspond the 1 game second.
 

Asset/Art/w3d/3dsmax/readme.md

@@ -15,18 +15,18 @@ The following section lists the default values and available textures for each t
 
 ### ENABLEDDRAWDATA
 
-* `Active-Unchecked`
-* `Active-Checked`
+- `Active-Unchecked`
+- `Active-Checked`
 
 ### DISABLEDDRAWDATA
 
-* `Disabled-Unchecked`
-* `Disabled-Checked`
+- `Disabled-Unchecked`
+- `Disabled-Checked`
 
 ### HILITEDRAWDATA
 
-* `Active-HiLighted`
-* `Active-Checked`
+- `Active-HiLighted`
+- `Active-Checked`
 
 ## Example
 
@@ -90,8 +90,8 @@ Here's an example from the `OptionsMenu.wnd` file:
 
 ## See also
 
-* [Default control](user.md)
-* [Texturing](../texturing.md)
-* [Statuses](../statuses.md)
+- [Default control](user.md)
+- [Texturing](../texturing.md)
+- [Statuses](../statuses.md)
 
 [Category:](../Categories.md) [Controls](../Controls.md)

Asset/GUI/WND_Controls/checkbox.md

@@ -1,9 +1,12 @@
 # ComboBox Control
+
 The **ComboBox** control is used for creating a dropdown list. You can define the position, size,
-and appearance of the <b>ComboBox</b>.
+and appearance of the **ComboBox**.
 
 ## Available tags
+
 In addition to the [default control tags](user.md), the following tags are available.
+
 - The control does not have a `TEXT` tag. Unlike controls such as checkboxes, which include a text label,
 this control is self-contained and does not display or use a text label.
 
@@ -33,13 +36,15 @@ this control is self-contained and does not display or use a text label.
 | `SLIDERTHUMBHILITEDRAWDATA`              | Visual texture for the slider thumb (handle) when highlighted.               |
 
 ## Default values
+
 The following section list the default values and available textures for each tag
+
 <details>
   <summary>Click to expand</summary>
 
 ### COMBOBOXDATA
-### COMBOBOXDATA
-- **ISEDITABLE**: Defines whether the combobox is editable. 
+
+- **ISEDITABLE**: Defines whether the combobox is editable.
                   0 = non-editable (only dropdown selection allowed), 1 = editable (user can type in the field).
 - **MAXCHARS**: The maximum number of characters allowed in the edit field when the combobox is editable (e.g., 16).
 - **MAXDISPLAY**: The maximum number of items to display at once in the dropdown list without scrolling (e.g., 2).
@@ -49,53 +54,62 @@ The following section list the default values and available textures for each ta
                           0 = allows all characters, 1 = allows only letters and numbers.
 
 ### ENABLEDDRAWDATA, DISABLEDDRAWDATA, HILITEDRAWDATA
+
 - NoImage / NoImage / ListBoxHiliteSelectedItemLeftEnd
 - NoImage / NoImage / ListBoxHiliteSelectedItemRightEnd
 - NoImage / NoImage / ListBoxHiliteSelectedItemRepeatingCenter
 - NoImage / NoImage / ListBoxHiliteSelectedItemSmallRepeatingCenter
 
 ### COMBOBOXDROPDOWNBUTTONENABLEDDRAWDATA, COMBOBOXDROPDOWNBUTTONDISABLEDDRAWDATA, COMBOBOXDROPDOWNBUTTONHILITEDRAWDATA
+
 - VSliderDownButtonEnabled / VSliderDownButtonDisabled / VSliderDownButtonHilite
 - VSliderDownButtonHiliteSelected / NoImage / VSliderDownButtonHiliteSelected
 
 ### COMBOBOXEDITBOXENABLEDDRAWDATA, COMBOBOXEDITBOXDISABLEDDRAWDATA, COMBOBOXEDITBOXHILITEDRAWDATA
+
 - TextEntryEnabledLeftEnd / TextEntryDisabledLeftEnd / TextEntryHiliteLeftEnd
 - TextEntryEnabledRightEnd / TextEntryDisabledRightEnd / TextEntryHiliteRightEnd
 - TextEntryEnabledRepeatingCenter / TextEntryDisabledRepeatingCenter / TextEntryHiliteRepeatingCenter
 - TextEntryEnabledSmallRepeatingCenter / TextEntryDisabledSmallRepeatingCenter / TextEntryHiliteSmallRepeatingCenter
 
 ### COMBOBOXLISTBOXENABLEDDRAWDATA, COMBOBOXLISTBOXDISABLEDDRAWDATA, COMBOBOXLISTBOXHILITEDRAWDATA
+
 - BlackSquare
 - ListBoxHiliteItemLeftEnd / NoImage / ListBoxHiliteSelectedItemLeftEnd
 - ListBoxHiliteItemRightEnd / NoImage / ListBoxHiliteSelectedItemRightEnd
 - ListBoxHiliteItemRepeatingCenter / NoImage / ListBoxHiliteSelectedItemRepeatingCenter
 - ListBoxHiliteItemSmallRepeatingCenter / NoImage / ListBoxHiliteSelectedItemSmallRepeatingCenter
 
 ### LISTBOXENABLEDDOWNBUTTONDRAWDATA, LISTBOXDISABLEDDOWNBUTTONDRAWDATA, LISTBOXHILITEDOWNBUTTONDRAWDATA
+
 - VSliderDownButtonEnabled / VSliderDownButtonDisabled / VSliderDownButtonHilite
 - VSliderDownButtonHiliteSelected / NoImage / VSliderDownButtonHiliteSelected
 
 ### LISTBOXENABLEDSLIDERDRAWDATA, LISTBOXDISABLEDSLIDERDRAWDATA, LISTBOXHILITESLIDERDRAWDATA
+
 - NoImage
 
 ### SLIDERTHUMBENABLEDDRAWDATA, SLIDERTHUMBDISABLEDDRAWDATA, SLIDERTHUMBHILITEDRAWDATA
+
 - ScrollBarThumbEnabled / ScrollBarThumbDisabled / ScrollBarThumbHilite
 - ScrollBarThumbHiliteSelected / NoImage / ScrollBarThumbHiliteSelected
 
 </details>
 
 ## Known Issues
 
-1. **Item text color cannot be changed:**  
+1. **Item text color cannot be changed:**
    It is currently not possible to change the color of the text (for list items). By default, the text color is white.
 
-2. **Clicking items outside container boundaries:**  
+2. **Clicking items outside container boundaries:**
    If the ComboBox is inside a window container and the list extends beyond the window's boundaries,
    it is not possible to click on items that are outside of the visible area of the container.
    This may cause issues when interacting with the ComboBox.
 
 ## Example
+
 Here example from IP address ComboBox in the `OptionsMenu.wnd` file:
+
 <details>
   <summary>Click to expand</summary>
 
@@ -346,7 +360,8 @@ END
 </details>
 
 ## See also
-* [Default control](user.md)
-* [Texturing](../texturing.md)
+
+- [Default control](user.md)
+- [Texturing](../texturing.md)
 
 [Category:](../Categories.md) [Controls](../Controls.md)

Asset/GUI/WND_Controls/combobox.md

@@ -19,36 +19,36 @@ The following section list the default values and available textures for each ta
 
 ### TEXTENTRYDATA
 
-* `MAXLEN`: An integer that defines the maximum length of the input text. (e.g. `64`)
-* `SECRETTEXT`: A Boolean value that defines if input text should be hidden.
+- `MAXLEN`: An integer that defines the maximum length of the input text. (e.g. `64`)
+- `SECRETTEXT`: A Boolean value that defines if input text should be hidden.
                 (`0` = normal, `1` = hidden, displayed as asterisks).
-* `NUMERICALONLY`: A Boolean value that defines if the entry field allows only numbers.
+- `NUMERICALONLY`: A Boolean value that defines if the entry field allows only numbers.
                    (`0` = allows all characters, `1` = only numbers).
-* `ALPHANUMERICALONLY`: A Boolean value that defines if the entry field allows only letters and numbers.
+- `ALPHANUMERICALONLY`: A Boolean value that defines if the entry field allows only letters and numbers.
                         (`0` = allows all characters, `1` = only letters and numbers).
-* `ASCIIONLY`: A Boolean value that defines if the entry field allows only ASCII characters.
+- `ASCIIONLY`: A Boolean value that defines if the entry field allows only ASCII characters.
                (`0` = allows non-ASCII, `1` = only ASCII).
 
 ### ENABLEDDRAWDATA
 
-* `TextEntryEnabledLeftEnd`
-* `TextEntryEnabledRightEnd`
-* `TextEntryEnabledRepeatingCenter`
-* `TextEntryEnabledSmallRepeatingCenter`
+- `TextEntryEnabledLeftEnd`
+- `TextEntryEnabledRightEnd`
+- `TextEntryEnabledRepeatingCenter`
+- `TextEntryEnabledSmallRepeatingCenter`
 
 ### DISABLEDDRAWDATA
 
-* `TextEntryDisabledLeftEnd`
-* `TextEntryDisabledRightEnd`
-* `TextEntryDisabledRepeatingCenter`
-* `TextEntryDisabledSmallRepeatingCenter`
+- `TextEntryDisabledLeftEnd`
+- `TextEntryDisabledRightEnd`
+- `TextEntryDisabledRepeatingCenter`
+- `TextEntryDisabledSmallRepeatingCenter`
 
 ### HILITEDRAWDATA
 
-* `TextEntryHiliteLeftEnd`
-* `TextEntryHiliteRightEnd`
-* `TextEntryHiliteRepeatingCenter`
-* `TextEntryHiliteSmallRepeatingCenter`
+- `TextEntryHiliteLeftEnd`
+- `TextEntryHiliteRightEnd`
+- `TextEntryHiliteRepeatingCenter`
+- `TextEntryHiliteSmallRepeatingCenter`
 
 </details>
 
@@ -114,11 +114,12 @@ WINDOW
                   ASCIIONLY: 1;
 END
 ```
+
 </details>
 
 ## See also
 
-* [Default control](user.md)
-* [Texturing](../texturing.md)
+- [Default control](user.md)
+- [Texturing](../texturing.md)
 
 [Category:](../Categories.md) [Controls](../Controls.md)

Asset/GUI/WND_Controls/entryfiled.md

@@ -14,16 +14,16 @@ The following section list the default values and available textures for each ta
 
 ### ENABLEDDRAWDATA
 
-* `LoadingBar_L`
-* `LoadingBar_R`
-* `LoadingBar_C`
-* `LoadingBar_DePowered`
-* `LoadingBar_Progress`
-* `NoImage`
+- `LoadingBar_L`
+- `LoadingBar_R`
+- `LoadingBar_C`
+- `LoadingBar_DePowered`
+- `LoadingBar_Progress`
+- `NoImage`
 
 ### DISABLEDDRAWDATA, HILITEDRAWDATA
 
-* `NoImage` (Usually `NoImage` is used for all parts)
+- `NoImage` (Usually `NoImage` is used for all parts)
 
 ## Example
 
@@ -85,8 +85,7 @@ END
 
 ## See also
 
-* [Default control](user.md)
-* [Texturing](../texturing.md)
+- [Default control](user.md)
+- [Texturing](../texturing.md)
 
 [Category:](../Categories.md) [Controls](../Controls.md)
-

Asset/GUI/WND_Controls/progressbar.md

@@ -5,25 +5,30 @@ You can define the position, size, and appearance of the button,
 as well as how it behaves in different states (enabled, disabled, highlighted).
 
 ## Available Tags
+
 The PushButton control does not include any unique tags beyond the [default control tags](/user.md).
 It uses the same general set of tags applicable to all controls.
 
 ## Default values and usage
+
 The following section list the default values and available textures for each tag
 <details>
   <summary>Click to expand</summary>
 
 ### ENABLEDDRAWDATA
+
 - Buttons-Left
 - Buttons-Middle
 - Buttons-Right
 
 ### DISABLEDDRAWDATA
+
 - Buttons-Disabled-Left
 - Buttons-Disabled-Middle
 - Buttons-Disabled-Right
 
 ### HILITEDRAWDATA
+
 - Buttons-HiLite-Left
 - Buttons-HiLite-Middle
 - Buttons-HiLite-Right
@@ -34,6 +39,7 @@ The following section list the default values and available textures for each ta
 </details>
 
 ## Example
+
 Here example from Accept button in `OptionsMenu.wnd` file:
 <details>
   <summary>Click to expand</summary>
@@ -88,10 +94,12 @@ WINDOW
                      IMAGE: NoImage, COLOR: 255 255 255 0, BORDERCOLOR: 255 255 255 0;
 END
 ```
+
 </details>
 
 ## See also
-* [Default control](user.md)
-* [Texturing](../texturing.md)
+
+- [Default control](user.md)
+- [Texturing](../texturing.md)
 
 [Category:](../Categories.md) [Controls](../Controls.md)