Editing/ Adding Tips?help notes

Help / Discuss
1

Good morning all, I would like to find out f their is a clear description of how to edit/ add tips under the help extension. The documentation on the following links do not really give me any understanding of how to work with them:

I was able to get to this point but got stumped as to what I had to do next or how the extension parameters affect what is shown in the tip. Also, where does the actual text in the tips seat, as editing the content part seems to do nothing for me(I am probably doing it wrong honestly)

getting started tip
getting started tip1220×723 20.7 KB

Any help is greatly appreciated as always.

2

@Syn I coded this UIXP so I can probably help. I’d like to improve the documentation but I don’t understand what you don’t understand :slight_smile:

This link provides all the details you need normally: http://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/ExtensionPoint/AddTipToTipsPanels

Note that if you’re looking for a tutorial on how UI Extensions work you should check the link on http://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/ExtensionPoint/

The tip parameter is the tip text… Is that where you’re stumped?

The doc says:

  • tip: the text of the tip to display. Note that it could use translations such as {{code}}tip=$services.localization.render(‘help.tipsPanel.gettingStartedTip’){{/code}}
3

Yes, that’s exactly where I am stumped, I should have been clearer. I don’t understand where I have to go to add/edit the text.

I hope that makes sense.

4

Well, in the parameter as described :slight_smile:

For example: tip=My new tip

If the question is how to add a translation then it has nothing to do with UI Extensions. In this case you should read http://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/Tutorials/InternationalizingApplications/

Hope it helps

1 Like
5 
tip=$services.localization.render(‘help.tipsPanel.gettingStartedTip’)

$services.localization is a service used for translations, so the help.tipsPanel.gettingStartedTip is a translation key that has it’s text in a translation page. In the case of Help Application that page is located in Help/Translations.

You can:

  • stop using translation keys (if you don’t need your content in multiple languages) and just put the text
    tip=Text
  • modify the current translation key, by editing the Help/Translations pages
  • add your own translation page and translation keys are use them;

You can:

  • add your own Tips by creating new pages that use the extension point;
  • disable some old Tips;
  • etc.

Hope this helped.

2 Likes
6

Thank you for the explanations, was much simpler than I had initially assumed :sweat_smile: But both @evalica and @vmassol have covered what I was asking. As always, thank you for you great help and support.

7

Syn, I’m glad that you liked my answer and marked it as solution. If you find the documentation to be too complex or is lacking content, please help us make it better :slight_smile:

Have fun adding new tips and if you have good ones, consider making some Pull Requests with them, since our plan is to add more tips for users.

8

Will do, as I get more acquainted with the features, I will definitely contribute on the topics I found challenging myself, again, thanks for the help.