From 5c69c7a3317d693a2b50a544a33786bf49ff40fc Mon Sep 17 00:00:00 2001 From: rogercreagh <44980188+rogercreagh@users.noreply.github.com> Date: Wed, 11 Sep 2024 12:43:42 +0100 Subject: [PATCH 1/2] Update quicktasklink.md Correct spelling typo in "Quicktask link" sub -head Changed Quicktask link section text to refer to title which appears as a mouseover the icon, and to state that the language string needs to be in the .sys.ini lanuage file Added new sub-section Quicktask Icon with explanation and example. Added fontawesome icon example to the Example section NB there is also a tag but I can find no information how to use it. --- .../components/quicktasklink.md | 28 ++++++++++++++++--- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/versioned_docs/version-5.1/building-extensions/components/quicktasklink.md b/versioned_docs/version-5.1/building-extensions/components/quicktasklink.md index 3e776846..a07e1283 100644 --- a/versioned_docs/version-5.1/building-extensions/components/quicktasklink.md +++ b/versioned_docs/version-5.1/building-extensions/components/quicktasklink.md @@ -16,11 +16,11 @@ Sometimes it is useful to add a so called quicktask link which 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="Qicktask Link and title" COM_EXAMPLE @@ -29,11 +29,30 @@ A quicktask link and icon are added as params to a menu item. +``` +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" + + COM_EXAMPLE + + COM_EXAMPLE_MENU_QUICKTASK_TITLE + eye + index.php?option=com_example&view=example&layout=view + + + ``` ## 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 quicktask. The second item with a quicktask includes a fontawesome icon that has not been aliased. ```xml @@ -54,6 +73,7 @@ This example shows a complete menu entry with dashboard, submenu and a quicktask COM_EXAMPLE_MENU_CATEGORIES COM_EXAMPLE_MENU_CATEGORIES + fas fa-person-hiking index.php?option=com_categories&view=category&layout=edit&extension=com_example From e866f4cea812ee0e9ac9b2e496022a1fc26dff4a Mon Sep 17 00:00:00 2001 From: Harald Leithner Date: Fri, 18 Oct 2024 17:57:15 +0200 Subject: [PATCH 2/2] Sync with 5.2 and fix some typos --- .../components/quicktasklink.md | 91 ++++++++++------- .../components/quicktasklink.md | 97 +++++++++---------- 2 files changed, 101 insertions(+), 87 deletions(-) diff --git a/docs/building-extensions/components/quicktasklink.md b/docs/building-extensions/components/quicktasklink.md index 3e776846..915c8b8a 100644 --- a/docs/building-extensions/components/quicktasklink.md +++ b/docs/building-extensions/components/quicktasklink.md @@ -1,7 +1,7 @@ Quicktask Link and Icon ======================= -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. +In general, a component has one or more links to its views. They are defined in the manifest file and added to the menu during installation. ```xml title="A link to your component " @@ -16,49 +16,66 @@ Sometimes it is useful to add a so called quicktask link which 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" - - COM_EXAMPLE - - COM_EXAMPLE_MENU_QUICKTASK_TITLE - index.php?option=com_example&view=example&layout=edit - - +```xml title="Quicktask Link and title" + + COM_EXAMPLE + + COM_EXAMPLE_MENU_QUICKTASK_TITLE + index.php?option=com_example&view=example&layout=edit + + +``` +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="Quicktask Link and icon" + + COM_EXAMPLE + + COM_EXAMPLE_MENU_QUICKTASK_TITLE + eye + index.php?option=com_example&view=example&layout=view + + ``` ## 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 quicktask. The second item with a quicktask includes a fontawesome icon that has not been aliased. ```xml - - COM_EXAMPLE - - example - - - - - COM_EXAMPLE_MENU - - COM_EXAMPLE_MENU_QUICKTASK_TITLE - index.php?option=com_example&view=example&layout=edit - - - - COM_EXAMPLE_MENU_CATEGORIES - - COM_EXAMPLE_MENU_CATEGORIES - index.php?option=com_categories&view=category&layout=edit&extension=com_example - - - COM_EXAMPLE_MENU_FIELDS - COM_EXAMPLE_MENU_FIELDS_GROUP - - + + COM_EXAMPLE + + example + + + + + COM_EXAMPLE_MENU + + COM_EXAMPLE_MENU_QUICKTASK_TITLE + index.php?option=com_example&view=example&layout=edit + + + + COM_EXAMPLE_MENU_CATEGORIES + + COM_EXAMPLE_MENU_CATEGORIES + fas fa-person-hiking + index.php?option=com_categories&view=category&layout=edit&extension=com_example + + + COM_EXAMPLE_MENU_FIELDS + COM_EXAMPLE_MENU_FIELDS_GROUP + ``` diff --git a/versioned_docs/version-5.1/building-extensions/components/quicktasklink.md b/versioned_docs/version-5.1/building-extensions/components/quicktasklink.md index a07e1283..27b7b51e 100644 --- a/versioned_docs/version-5.1/building-extensions/components/quicktasklink.md +++ b/versioned_docs/version-5.1/building-extensions/components/quicktasklink.md @@ -1,7 +1,7 @@ Quicktask Link and Icon ======================= -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. +In general, a component has one or more links to its views. They are defined in the manifest file and added to the menu during installation. ```xml title="A link to your component " @@ -20,65 +20,62 @@ Your menu link is added in the manfest file during installation. A quicktask link and title are added as params to a menu item. -```xml title="Qicktask Link and title" - - COM_EXAMPLE - - COM_EXAMPLE_MENU_QUICKTASK_TITLE - index.php?option=com_example&view=example&layout=edit - - - +```xml title="Quicktask Link and title" + + COM_EXAMPLE + + COM_EXAMPLE_MENU_QUICKTASK_TITLE + index.php?option=com_example&view=example&layout=edit + + ``` -NB the title translation string needs to appear in the language `.sys.ini` file for the extension +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. +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" - - COM_EXAMPLE - - COM_EXAMPLE_MENU_QUICKTASK_TITLE - eye - index.php?option=com_example&view=example&layout=view - - +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="Quicktask Link and icon" + + COM_EXAMPLE + + COM_EXAMPLE_MENU_QUICKTASK_TITLE + eye + index.php?option=com_example&view=example&layout=view + + ``` -## Example +## Example This example shows a complete menu entry with dashboard, submenu and a quicktask. The second item with a quicktask includes a fontawesome icon that has not been aliased. ```xml - - COM_EXAMPLE - - example - - - - - COM_EXAMPLE_MENU - - COM_EXAMPLE_MENU_QUICKTASK_TITLE - index.php?option=com_example&view=example&layout=edit - - - - COM_EXAMPLE_MENU_CATEGORIES - - COM_EXAMPLE_MENU_CATEGORIES - fas fa-person-hiking - index.php?option=com_categories&view=category&layout=edit&extension=com_example - - - COM_EXAMPLE_MENU_FIELDS - COM_EXAMPLE_MENU_FIELDS_GROUP - - + + COM_EXAMPLE + + example + + + + + COM_EXAMPLE_MENU + + COM_EXAMPLE_MENU_QUICKTASK_TITLE + index.php?option=com_example&view=example&layout=edit + + + + COM_EXAMPLE_MENU_CATEGORIES + + COM_EXAMPLE_MENU_CATEGORIES + fas fa-person-hiking + index.php?option=com_categories&view=category&layout=edit&extension=com_example + + + COM_EXAMPLE_MENU_FIELDS + COM_EXAMPLE_MENU_FIELDS_GROUP + ```