Manual icon indicating copy to clipboard operation
Manual copied to clipboard

Published 20 hours ago • verified publisher icon joomla

Update quicktasklink.md

Open rogercreagh opened this issue 1 year ago • 4 comments

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

    rogercreagh avatar Sep 11 '24 11:09 rogercreagh

    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

    qodo-code-review[bot] avatar Sep 11 '24 11:09 qodo-code-review[bot]

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

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    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]

    -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]

    -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:

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

    -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

    •   <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>

    +```xml title="Quicktask Link and icon" +

    • COM_EXAMPLE
    •    <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>

    
</details>


___


**Correct the spelling of "Quicktask" in the XML code block title to maintain <br>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

    qodo-code-review[bot] avatar Sep 11 '24 11:09 qodo-code-review[bot]

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

    HLeithner avatar Sep 11 '24 11:09 HLeithner

    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?

    rogercreagh avatar Sep 11 '24 17:09 rogercreagh

    thx

    HLeithner avatar Oct 18 '24 15:10 HLeithner