Skip to content

Commit 083b15e

Browse files
committed
updated jump menu docs to instruct people to use the CLI.. moved in navigation
1 parent c92493a commit 083b15e

File tree

2 files changed

+26
-6
lines changed

2 files changed

+26
-6
lines changed

docs/development/jump-menu.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,30 @@ lang: ee
1515

1616
Add-ons can easily add custom items for the Jump Menu.
1717

18-
NOTE: Sample File: https://gist.github.com/obfuscode/77d0135970c9ce8bc84139c127507bb1
18+
TIP: If you are working with an existing add-on, we recommend you start with [Modernizing add-ons](development/modernizing-existing-add-ons.md)
1919

20-
Create a `jump.[addon_name].php` file in your add-on folder
20+
## Creating your add-on jump file.
21+
Jumps are created via the CLI by using the `make:jump` command.
2122

22-
Your jump file MUST have the following:
23+
```
24+
php eecli.php make:jump
25+
Let's create an add-on Jump File!
26+
What add-on is the Jumps file being added to? (amazing_add_on, cron,): [amazing_add_on]
27+
Building Add-on Jumps file now.
28+
Jumps file successfully created! Please note: You may need to clear your browser cache before you can see the new jump menu items
29+
30+
```
31+
32+
Follow the prompts to add a jump file to your add-on.
33+
This will create a `jump.amazing_add_on.php` file in your add-on.
34+
35+
```
36+
amazing_add_on
37+
┣ jump.amazing_add_on.php
38+
┗ ...
39+
```
40+
41+
Please note, your jump file will have the following:
2342

2443
use ExpressionEngine\Service\JumpMenu\AbstractJumpMenu;
2544

@@ -36,7 +55,7 @@ Your jump file MUST have the following:
3655
'target' => 'See Below. Behavior changes based on dynamic element above'
3756
));
3857

39-
To Add Jump Menu commands to your add-on, you simply add array elements to the $items array in the example above
58+
To Add Jump Menu commands to your add-on, you simply add array elements to the $items array in the example generated
4059

4160
The array of a Jump Menu command is comprised of the following keys:
4261

docs/toc_sections/_advanced_usage_toc.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,8 @@
154154
href: cli/displaying-output.md
155155
- name: Adding Template Tags
156156
href: development/custom-template-tags.md
157+
- name: Adding Jump Menu Items
158+
href: development/jump-menu.md
157159
- name: Using Language Files
158160
href: development/add-on-language-files.md
159161
- name: Adding Publish Form Tabs
@@ -162,6 +164,7 @@
162164
href: development/prolets.md
163165
- name: Adding Dashboard Widgets
164166
href: development/widgets.md
167+
165168
#- name: REMOVE - Adding Text Formatting Options
166169
# href: development/text-formatting.md
167170
- name: Accessing the Database
@@ -302,8 +305,6 @@
302305
- name: Wiki Module
303306
href: development/extension-hooks/module/wiki.md
304307

305-
- name: Jump Menu
306-
href: development/jump-menu.md
307308
- name: Learn About the Core
308309
href: development/architecture.md
309310
- name: Services

0 commit comments

Comments
 (0)