Update quicktasklink.md

rogercreagh commented 1 month ago

User description

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.

PR Type

documentation

Description

Corrected spelling errors in the "Quicktask Link" section headers.
Expanded documentation to include details on specifying Quicktask titles and icons.
Added a new subsection explaining how to use Quicktask Icons, including examples with FontAwesome.
Clarified that the title translation string must be included in the language .sys.ini file.

Changes walkthrough 📝

Relevant files

Documentation

quicktasklink.md

Update Quicktask Link Documentation with Icons and Titles

versioned_docs/version-5.1/building-extensions/components/quicktasklink.md

Corrected spelling errors in section headers.

Added explanation for Quicktask title and icon.

Included examples for specifying icons, including FontAwesome.

Clarified the need for language strings in .sys.ini files.

+24/-4

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

codiumai-pr-agent-pro[bot] commented 1 month ago

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No key issues to review

codiumai-pr-agent-pro[bot] commented 1 month ago

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Code Suggestions ✨

Category	Suggestion	Score
Typo	Fix a spelling error in the explanation of where the menu link is added ___ Correct the spelling of "manifest" in the sentence explaining where the menu link is added during installation. [versioned_docs/version-5.1/building-extensions/components/quicktasklink.md [17]](https://github.com/joomla/Manual/pull/310/files#diff-be6a5b8a4f4d358dd096ce2967b5dc74883b240b9dde1f3cb62bc5982b5b010dR17-R17) ```diff -Your menu link is added in the manfest file during installation. +Your menu link is added in the manifest file during installation. ``` - [ ] Apply this suggestion Suggestion importance[1-10]: 9 Why: The suggestion correctly identifies and fixes a spelling error in the word "manifest," improving the clarity and professionalism of the documentation.	9
	Fix a spelling error in the explanation of default icon usage ___ Correct the spelling of "components" in the sentence explaining the default icon usage. [versioned_docs/version-5.1/building-extensions/components/quicktasklink.md [37]](https://github.com/joomla/Manual/pull/310/files#diff-be6a5b8a4f4d358dd096ce2967b5dc74883b240b9dde1f3cb62bc5982b5b010dR37-R37) ```diff -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 components. ``` - [ ] Apply this suggestion Suggestion importance[1-10]: 9 Why: The suggestion correctly identifies and corrects a spelling mistake in the word "components," enhancing the readability and correctness of the documentation.	9
	✅ Correct the spelling in the XML code block title for consistency ___ Suggestion Impact: The spelling of "Qicktask" was corrected to "Quicktask" in the XML code block titles. code diff: ```diff -```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. +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 - - - +```xml title="Quicktask Link and icon" + + COM_EXAMPLE + + COM_EXAMPLE_MENU_QUICKTASK_TITLE + eye + index.php?option=com_example&view=example&layout=view + ``` ___ Correct the spelling of "Quicktask" in the XML code block title to maintain consistency with the rest of the document. [versioned_docs/version-5.1/building-extensions/components/quicktasklink.md [23]](https://github.com/joomla/Manual/pull/310/files#diff-be6a5b8a4f4d358dd096ce2967b5dc74883b240b9dde1f3cb62bc5982b5b010dR23-R23) ```diff -```xml title="Qicktask Link and title" +```xml title="Quicktask Link and title" ``` - [ ] Apply this suggestion Suggestion importance[1-10]: 8 Why: The suggestion addresses a spelling error in the XML code block title, ensuring consistency and accuracy throughout the document.	8

HLeithner commented 1 month ago

That change needs to be done in /docs (and additional in versioned-docs) but /docs is the important version for such changes

rogercreagh commented 1 month ago

That change needs to be done in /docs (and additional in versioned-docs) but /docs is the important version for such changes

So does that require a separate PR - I assumed if I just edit from the published page it would update all copies which would be sensible?

HLeithner commented 2 weeks ago

thx

joomla / Manual