Skip to content

Commit 8a1859a

Browse files
authored
Merge branch 'main' into 5.0
2 parents 8f79303 + 132a708 commit 8a1859a

File tree

8 files changed

+1875
-9881
lines changed

8 files changed

+1875
-9881
lines changed

docs/using-core-functions/dashboard.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,17 @@ This is done in the manifest file:
1313
Add a dashboard to your component:
1414
==================================
1515

16-
A parameter < dashboard > expands the menu entry with link to a dashboard for your component. You can give this dashboard any name you want, but <strong> Note:</strong> use lowercase and only "-", never underscore for the dashboard name.
16+
A parameter "dashboard" expands the menu entry to your component with a link to a dashboard. You can give this dashboard any name you want, but <strong> Note:</strong> use lowercase and only "-", never underscore for the dashboard name.
1717
my-example or example are correct, my_example, Com-MY_EXAMPLE are wrong.
1818

19-
The param < dashboard >
19+
The param dashboard
2020
- will make a dashboard icon appear next to the administrator menu item for the component
2121
- The dashboard icon will click through to display modules assigned to the cpanel-example administrator module position
2222
- The title and icon defined in the XML file will be used as the header and icon at the top of the component's dashboard page.
2323

2424
```xml title="Dashboard Link "
2525
<administration>
26-
<menu img="class:calendar">
26+
<menu>>
2727
COM_EXAMPLE
2828
<params>
2929
<dashboard>example</dashboard>
@@ -41,27 +41,25 @@ Give your dashboard a name and an icon. Add this to your manifest file:
4141

4242
```xml title="Dashboard title and icon"
4343
<dashboards>
44-
<dashboard title="COM_EXAMPLE" icon="icon-calendar">COM_EXAMPLE_DASHBOARD_NAME</dashboard>
44+
<dashboard title="COM_EXAMPLE" icon="icon-calendar">example</dashboard>
4545
</dashboards>
4646
```
4747

4848
## Submenu
4949
If you want to address different views of your component, expand the menu with a submenu.
5050

5151
```xml title="Submenu items"
52-
<menu img="class:folder">
52+
<menu>
5353
COM_EXAMPLE
5454
<params>
5555
<dashboard>example</dashboard>
5656
</params>
5757
</menu>
5858
<submenu>
59-
<menu link="option=com_example" view="examples"
60-
alt="10 good examples">COM_EXAMPLE_EXAMPLES</menu>
61-
<menu link="option=com_categories&amp;extension=com_example"
62-
view="categories" alt="Example Categories">COM_EXAMPLE_CATEGORIES</menu>
63-
<menu link="option=com_fields&amp;view=fields&ap;mp;context=com_example_example">COM_EXAMPLE_FIELDS</menu>
64-
<menu link="option=com_fields&amp;view=groups&amp;context=com_example_example">>COM_EXAMPLE_FIELDGROUPS</menu>
59+
<menu link="option=com_example" view="examples">COM_EXAMPLE_MENU</menu>
60+
<menu link="option=com_categories&amp;extension=com_example" view="categories">COM_EXAMPLE_ENU_CATEGORIES</menu>
61+
<menu link="option=com_fields&amp;view=fields&ap;mp;context=com_example.example">COM_EXAMPLE_MENU_FIELDS</menu>
62+
<menu link="option=com_fields&amp;view=groups&amp;context=com_example.example">COM_EXAMPLE_MENU_FIELD_GROUPS</menu>
6563
</submenu>
6664
```
6765

@@ -93,14 +91,14 @@ In a folder 'presets' create a preset file, name it example.xml.
9391
dashboard="example"
9492
>
9593
<menuitem
96-
title="COM_EXAMPLE_EXAMPLE"
94+
title="COM_EXAMPLE_MENU"
9795
type="component"
9896
element="com_example"
9997
link="index.php?option=com_example&amp;view=examples"
10098
/>
10199

102100
<menuitem
103-
title="COM_EXAMPLE_CATEGORY"
101+
title="COM_EXAMPLE_MENU_CATEGORIES"
104102
type="component"
105103
element="com_categories"
106104
link="index.php?option=com_categories&amp;view=categories&amp;extension=com_example"
@@ -127,7 +125,7 @@ In a folder 'presets' create a preset file, name it example.xml.
127125
<folder>tmpl</folder>
128126
<filename>access.xml</filename>
129127
<filename>config.xml</filename>
130-
<filename>eaxmple.xml</filename>
128+
<filename>example.xml</filename>
131129
</files>
132130
</administration>
133131
```
Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
Quicktask Link and Icon
22
=======================
33

4-
In general, a component has has one or more links to its views.They are defined in the manifest file and is added into the menu during installation.
4+
In general, a component has has one or more links to its views. They are defined in the manifest file and added to the menu during installation.
55

66
```xml title="A link to your component "
77
<administration>
8-
<menu img="class:calendar">
8+
<menu>
99
COM_EXAMPLE
1010
</menu>
1111

1212
[..]
1313
</administration>
1414
```
15-
Sometimes it is useful to add so called <strong>quicktask link</strong> which enables an action calling from the menu without first visiting the Overview.
15+
Sometimes it is useful to add a so called <strong>quicktask link</strong> which enables an action calling from the menu without first visiting the Overview.
1616
You can see this for Joomla core components, for example articles in com_content, here the quicktask is the plus icon and lets you add a new article in a single click.
1717
Your menu link is added in the manfest file during installation.
1818

@@ -22,9 +22,9 @@ A quicktask link and icon are added as params to a menu item.
2222

2323
```xml title="Qicktask Link and icon"
2424
<menu link="option=com_example&amp;view=examples">
25-
COM_EXAMPLE_MENU_EXAMPLE
25+
COM_EXAMPLE
2626
<params>
27-
<menu-quicktask-title>>COM_EXAMPLE_QUICKTASK_TITLE</menu-quicktask-title>
27+
<menu-quicktask-title>COM_EXAMPLE_MENU_QUICKTASK_TITLE</menu-quicktask-title>
2828
<menu-quicktask>index.php?option=com_example&amp;view=example&amp;layout=edit</menu-quicktask>
2929
</params>
3030
</menu>
@@ -33,32 +33,32 @@ A quicktask link and icon are added as params to a menu item.
3333

3434
## Example
3535

36-
This example shows a complete menu with dashboard, submenu and a quicktask.
36+
This example shows a complete menu entry with dashboard, submenu and a quicktask.
3737

3838
```xml
39-
<menu img="class:calendar">
39+
<menu>
4040
COM_EXAMPLE
4141
<params>
42-
<dashboard>wickedevent</dashboard>
42+
<dashboard>example</dashboard>
4343
</params>
4444
</menu>
4545
<submenu>
4646
<menu link="option=com_example">
47-
COM_EXAMPLE
47+
COM_EXAMPLE_MENU
4848
<params>
49-
<menu-quicktask-title>>COM_EXAMPLE_EXAMPLES</menu-quicktask-title>
49+
<menu-quicktask-title>COM_EXAMPLE_MENU_QUICKTASK_TITLE</menu-quicktask-title>
5050
<menu-quicktask>index.php?option=com_example&amp;view=example&amp;layout=edit</menu-quicktask>
5151
</params>
5252
</menu>
5353
<menu link="option=com_categories&amp;extension=com_example">
54-
JCATEGORY
54+
COM_EXAMPLE_MENU_CATEGORIES
5555
<params>
56-
<menu-quicktask-title>JCATEGORY</menu-quicktask-title>
56+
<menu-quicktask-title>COM_EXAMPLE_MENU_CATEGORIES</menu-quicktask-title>
5757
<menu-quicktask>index.php?option=com_categories&amp;view=category&amp;layout=edit&amp;extension=com_example</menu-quicktask>
5858
</params>
5959
</menu>
60-
<menu link="option=com_fields&amp;view=fields&amp;context=com_example,example">Felder</menu>
61-
<menu link="option=com_fields&amp;view=groups&amp;context=com_example,example">Feldgruppen</menu>
60+
<menu link="option=com_fields&amp;view=fields&amp;context=com_example,example">COM_EXAMPLE_MENU_FIELDS</menu>
61+
<menu link="option=com_fields&amp;view=groups&amp;context=com_example,example">COM_EXAMPLE_MENU_FIELDS_GROUP</menu>
6262
</submenu>
6363

6464
```

docs/web-services-api/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Web Services API
2+
3+
This is the content for tutorials how to work with the webservices API of Joomla.
4+
:::caution TODO
5+
6+
This page is unfinished, please use the **Edit this Page** link at the bottom of this page to help make it more useful.
7+
8+
:::
25 KB
Loading

0 commit comments

Comments
 (0)