additional_items -> custom_items

Author: jaclu

.gitignore

@@ -11,5 +11,5 @@ __pycache__
 # tmux-menus cache
 cache/
 
-# Additional loocal menus not managed by git
-additional_items/
+# Custom loocal menus not managed by git
+custom_items/

content/additional_index_template

@@ -5,14 +5,14 @@
 #
 #  Part of https://github.com/jaclu/tmux-menus
 #
-#  Template additional item, copy this into additional_items and modify!
+#  Template custom item, copy this into custom_items and modify!
 #
 
 static_content() {
 
     set -- \
-        0.0 M Left "Back to Additional items $nav_prev" "$f_additional_items_index" \
-        0.0 M Left "Back to Main menu        $nav_home" main.sh \
+        0.0 M Left "Back to Custom items $nav_prev" "$f_custom_items_index" \
+        0.0 M Left "Back to Main menu   $nav_home" main.sh \
         0.0 S \
         0.0 T "*** Replace this line with one or more lines of custom contnent! ***"
 
@@ -33,12 +33,12 @@ D_TM_BASE_PATH="$(dirname -- "$(dirname -- "$(realpath "$0")")")"
 # shellcheck source=scripts/dialog_handling.sh
 . "$D_TM_BASE_PATH"/scripts/dialog_handling.sh
 
-# An additional items menu must define menu_key & menu_label,
-# in order to be listed in the additional_items index menu
+# A custom items menu must define menu_key & menu_label,
+# in order to be listed in the custom_items index menu
 
 # Since this will be used to point to this menu from the index,
-# it is recommended to use uppercase in order to follow the conventions in this plugin,
-# but anything goes!
+# it is recommended to use uppercase in order to follow the conventions
+# in this plugin, but anything goes!
 # If a "special" char is used it might need to be prefixed with \
 menu_key="?"
-menu_label="My additional menu" # short description of this menu
+menu_label="My Custom menu" # short description of this menu

content/additional_item_template.sh renamed to content/custom_item_template.sh

@@ -1,18 +1,18 @@
 # Custom menus
 
-This plugin automatically handles custom menus placed in the `additional_items/`
+This plugin automatically handles custom menus placed in the `custom_items/`
 directory.
 
 ## How It Works
 
 regenerate
 the index listing all custom menus.
-`additional_items/_index.sh` (listing all custom menus, from now on referred
+`custom_items/_index.sh` (listing all custom menus, from now on referred
 to just by `_index.sh`).
 
 ### **Monitoring Changes**
 
-When files in `additional_items/` change, on next startup the plugin will
+When files in `custom_items/` change, on next startup the plugin will
 process all files found.
 
 - It creates or updates an inex listing all valid custom menus.
@@ -40,12 +40,12 @@ If these hints are missing or invalid, a notification will be displayed next tim
 `_index.sh` is generated, and that custom menu will be ignored until it is fixed.
 
 There is a template that can be used when creating custom menus.
-copy `content/additional_item_template.sh` into `additional_items/` with a
+copy `content/custom_item_template.sh` into `custom_items/` with a
 suitable name
 
 ## Summary
 
-This approach ensures your custom menus are always recognized and properly linked to the
-Main Menu, keeping everything neat and user-friendly.
+This approach ensures your custom menus are always recognized and properly linked to
+the Main Menu, keeping everything neat and user-friendly.
 
 Just make sure your custom menu include valid labels and shortcuts!

docs/custom_menus.md

@@ -16,7 +16,13 @@ static_content() {
     rld_cmd="command-prompt -I '$cfg_tmux_conf' -p 'Source file:' \
         'run-shell \"$d_scripts/reload_conf.sh %% $reload_in_runshell\"'"
 
-    # 12.0 M S
+    [ -f "$f_custom_items_index" ] && {
+        set -- \
+            0.0 M \+ "Custom items $nav_next" "$f_custom_items_index"
+
+        menu_generate_part 1 "$@"
+    }
+
     #  Menu items definition
     set -- \
         1.8 M N "Navigate & Search $nav_next" nav_search.sh \
@@ -26,18 +32,8 @@ static_content() {
         1.8 M B "Paste buffers     $nav_next" paste_buffers.sh \
         0.0 M L "Layouts           $nav_next" layouts.sh \
         0.0 M V "Split view        $nav_next" split_view.sh \
-        2.0 M M "Missing Keys      $nav_next" missing_keys.sh
-
-    menu_generate_part 1 "$@"
-
-    [ -f "$f_additional_items_index" ] && {
-        set -- \
-            0.0 M A "Additinoal items $nav_next" "$f_additional_items_index"
-
-        menu_generate_part 2 "$@"
-    }
-    set -- \
-        0.0 M O "Advanced Options  $nav_next" advanced.sh \
+        2.0 M M "Missing Keys      $nav_next" missing_keys.sh \
+        0.0 M A "Advanced Options  $nav_next" advanced.sh \
         0.0 M E "Extras            $nav_next" extras.sh \
         0.0 S \
         3.2 T "-#[nodim]On-the-Fly Config" \
@@ -51,7 +47,8 @@ static_content() {
         "$d_hints/customize-mode.sh $f_current_script" \
         0.0 M H "Help             $nav_next" \
         "$d_help/help_summary.sh $f_current_script"
-    menu_generate_part 3 "$@"
+
+    menu_generate_part 2 "$@"
 }
 
 #===============================================================

items/main.sh

@@ -44,10 +44,10 @@ initialize_plugin=1
 # implied check if caching is used
 [ -d "$d_cache" ] && cache_add_ok_vers "$tmux_vers"
 
-if [ -f "$f_update_additional_inventory" ]; then
-    $f_update_additional_inventory
+if [ -f "$f_update_custom_inventory" ]; then
+    $f_update_custom_inventory
 else
-    log_it "config file missing: $f_update_additional_inventory"
+    log_it "config file missing: $f_update_custom_inventory"
 fi
 
 if $cfg_use_whiptail; then

menus.tmux

@@ -757,7 +757,7 @@ uncached_wt_actions=""
 uncached_item_splitter="||||"
 
 # Just a dummy statement, so that the shellcheck disable doesn't need to be done in
-# every additional_item
+# every custom_item
 _="$menu_key $menu_label"
 
 alt_dialog_action_separator=":/:/:/:"

scripts/dialog_handling.sh

@@ -362,9 +362,9 @@ d_items="$D_TM_BASE_PATH"/items
 d_help="$d_items"/help
 d_hints="$d_items"/hints
 d_scripts="$D_TM_BASE_PATH"/scripts
-d_additional_items="$D_TM_BASE_PATH"/additional_items
-f_additional_items_index="$d_additional_items"/_index.sh
-f_update_additional_inventory="$d_scripts"/update_additional_inventory.sh
+d_custom_items="$D_TM_BASE_PATH"/custom_items
+f_custom_items_index="$d_custom_items"/_index.sh
+f_update_custom_inventory="$d_scripts"/update_custom_inventory.sh
 
 # will be set to true at end of this, this indicates everything is prepared
 env_initialized=false