Page MenuHomePhabricator

Plugin page-Details Tab
Closed, ResolvedPublic

Description

Description

This task entails changing the copy, instructions and illustrations of the current How to Use section of the Details tab on the Plugin page.

Screenshot 2022-12-14 at 15.57.41.png (499×955 px, 199 KB)

Design

Header Copy Change from How to useHow to add preview links to your site

Option 1 - How to add Wikipedia Preview links using the Classic Editor:

  • Add a Wikipedia article link to your site’s content using the same process you use to add hyperlinks to your articles.

Option 2 - How to add Wikipedia Preview links using the Gutenberg/ Block Editor:

  1. Highlight the text you want to link to a Wikipedia article.

Step-1-detailed.png (786×1 px, 166 KB)

  1. Select ‘Wikipedia Preview’ from the menu.

Step-2-detailed.png (794×1 px, 202 KB)

  1. You will see a list of suggested articles. Select the one you want to link to.

Step-3-detailed.png (790×1 px, 254 KB)

  1. Wikipedia Preview will automatically turn the link into a preview of the relevant Wikipedia article. You can easily edit or remove this.

Step-4-detailed.png (790×1 px, 309 KB)

Acceptance Criteria

  • How to Use section has an updated title How to add preview links to your site
  • New illustrations and instructions added.

Test Scenarios

  • How to add preview links to your site section is updated with new illustrations and instructions for both logged in and anonymous users.

Related Objects

Event Timeline

SBisson triaged this task as Medium priority.Dec 20 2022, 2:07 PM

@SGautam_WMF @PWaigi-WMF I can't find how to embed images in the details tab outside of the screenshot section. Have you seen other plugins doing it?

@SBisson you're right, looks like it's a standard practice to use images in screenshots section in the plugin area. I tried looking for other plugin pages but couldn't find any. I am wondering if it's possible for plugin authors to use images in other sections by customizing(through code) plugin's page?

[...] I am wondering if it's possible for plugin authors to use images in other sections by customizing(through code) plugin's page?

I have not seen any way to do it, that's why I was looking for examples.

The plugin page is generated by WordPress based on markdown from the readme file. We cannot customize it through code.

Ok, @PWaigi-WMF shall we remove the illustrations then and only keep text?

hueitan subscribed.

To review it, you can check on Wordpress readme parser, https://wpreadme.com/, copy readme.txt content to see the preview.