Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update tag.md #287

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 30 additions & 6 deletions docs/building-extensions/components/quicktasklink.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Quicktask Link and Icon
Quicktask Link
=======================

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.
Expand All @@ -12,15 +12,19 @@ In general, a component has has one or more links to its views. They are defined
[..]
</administration>
```
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.
For the main entries in the menu you can define an icon by including it in the language string. eg `COM_EXAMPLE="<i class='icon-address-book'></i> Example Component"`

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. It appears as an icon justified to the right hand side of the menu block. In general you should use an icon that clearly indicates the action relating to the view referenced by the main menu entry. It can also have a title which appears on mouseover.

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.

Your menu link is added in the manfest file during installation.

## Qicktask link
## Quicktask Link and Title

A quicktask link and icon are added as params to a menu item.
A quicktask link and title are added as params to a menu item.

```xml title="Qicktask Link and icon"
```xml title="Quicktask Link and icon"
<menu link="option=com_example&amp;view=examples">
COM_EXAMPLE
<params>
Expand All @@ -30,10 +34,29 @@ A quicktask link and icon are added as params to a menu item.
</menu>

```
NB the title translation string needs to appear in the language `.sys.ini` file for the extension

## Quicktask Icon

The default icon is the '+' sign indicating create a new item as this is the most common usage in the built-in compponents.

You can specify a different icon, either as a simple name for the built in common aliased icons (the `icon-` prefix will be automatically added), or as the font-awesome specification.

```xml title="Qicktask Link and icon"
<menu link="option=com_example&amp;view=examples">
COM_EXAMPLE
<params>
<menu-quicktask-title>COM_EXAMPLE_MENU_QUICKTASK_TITLE</menu-quicktask-title>
<menu-quicktask-icon>eye</menu-quicktask-icon>
<menu-quicktask>index.php?option=com_example&amp;view=example&amp;layout=view</menu-quicktask>
</params>
</menu>
```

## Example

This example shows a complete menu entry with dashboard, submenu and a quicktask.
This example shows a complete menu entry with dashboard, submenu and a two quicktasks. The first quicktask will use the default +plus icon.
The second quicktask includes a fontawesome icon that has not been aliased as `icon-name` so is specified using the full fontawesome code.

```xml
<menu>
Expand All @@ -58,6 +81,7 @@ This example shows a complete menu entry with dashboard, submenu and a quicktask
</params>
</menu>
<menu link="option=com_fields&amp;view=fields&amp;context=com_example,example">COM_EXAMPLE_MENU_FIELDS</menu>
<menu-quicktask-icon>fas fa-person-hiking</menu-quicktask-icon>
<menu link="option=com_fields&amp;view=groups&amp;context=com_example,example">COM_EXAMPLE_MENU_FIELDS_GROUP</menu>
</submenu>

Expand Down
2 changes: 1 addition & 1 deletion docs/building-extensions/components/table-columns.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ $wa->useScript('table.columns');
#### Notes
Your table will need to be a valid html table with a `<thead>` and each column a `<th>`.

Your table can not include `<tfoot>` or `<colgroup>` or `<colspan>` elements. These will cause the table to display empty columns at the end of the row and will break any classes or styles applied in the `<colgroup>`. ([Tracking Issue](https://github.com/joomla/joomla-cms/issues/43564))
Your table can not include `<tfoot>` or `<colgroup>` or `<colspan>` elements. These will cause the table to display empty columns at the end of the row and will break any classes or styles applied in the `<colgroup>`. [feature request](https://github.com/joomla/joomla-cms/issues/43266) refers, but is not planned for action)

If you have multiple tables on the page and you want to prevent the script loading on one of those tables then you can add the class "columns-order-ignore" to the table.

9 changes: 7 additions & 2 deletions docs/general-concepts/forms-fields/standard-fields/tag.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,31 @@ The **tag** form field type provides a point where you can enter tags - this is
- **name** (mandatory) is the unique name of the field.
- **label** (mandatory) (translatable) is the field html label.
- **description** (optional) (translatable) is the [field description](../standard-form-field-attributes.md#description).
- **mode** (optional) (translatable) is either "ajax" or "nested".
- **mode** (optional) (translatable) is either "ajax" or "nested". Defaults to value set in com_tags Options|Data Entry|Tag Entry Mode.
- **id** (optional) is the id to add to the field. Note if none is set this will be the name of the field.
- **class** (optional) is the class to add to the field.
- **published** (optional) determines if non published tags should be allowed.
- **language** (optional) is language to filter the existing tags by.
- **multiple** (optional) is the ability to add more than 1 tag to the form field.
- **custom** (optional) if the ajax mode is chosen setting this to "deny" will prevent users from adding in new tags.
**remote-search** (optional) Enables Ajax search - if using mode="nested" you need to set this to "false" or you will only get a partial option list and a broken hierarchy.

You can see the difference between "ajax" mode and "nested" mode by setting the Global Configuration / Tags / Data Entry and then entering data into the Tags field of an existing article.

**Ajax mode**

- The field searches tags (via Ajax) while the user types them in the tag field.
- Three min characters are required to launch the first background AJAX search.
- Three min characters are required to launch the first background AJAX search. This value is set in com_tags Options|Item Selection|Minimum Search Length
- The field also allows custom tag insertion by writing the new tag and pressing the ENTER key (but no longer the COMMA key).
- All the new custom tags inserted in the field are created on the fly in the database.
- The item list is sorted with most-used tags at the top and the path (parent tags if any) is displayed with the tag name.

**Nested mode**

- The tag dropdown list displays a hierarchical list of tags (shown in a similar way to how categories are shown)
- You cannot create new tags on the fly
- This list is sorted by heirarchy order (ordering in the com_tags tag list view) rather than alphabetically by path name
- **NB** *Currently (J5.1.2 and earlier) selected tags are removed from the list which breaks the hierarchy display* (*see* [*issue #43705*](https://github.com/joomla/joomla-cms/issues/43803])
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not really happy referencing issues in the manual, this would get an maintenance nightmare and could fill the manual with 1000 of referenced issues and pull requests which often is irrelevant and need to be removed if a pr exists or worse keep in the manual if it never get fixed or if it's an expected behavior.

It's a different story in the changelog/migration section which automatically gets obsolete with new versions at some point in time.


Implemented by: libraries/src/Form/Field/TagField.php

Expand Down Expand Up @@ -58,5 +62,6 @@ Implemented by: libraries/src/Form/Field/TagField.php
mode="nested"
class="inputbox span12 small"
multiple="true"
remote-search="false"
/>
```