Support » Requests and Feedback » Installed plugin page – missing view details / documents

  • hi all, i’m actually just starting out with wordpress, wordpress is really cool thanks for all that effort!
    i started meddling a little into the plugins and managed to create a simple plugin

    however, i noted the view details and document links are missing in the installed plugins page in part as i’ve not yet published my plugin, i.e. i don’t have a Plugin URI: yet
    https://codex.wordpress.org/File_Header

    i tried building a readme.txt file using other existing plugins as examples but that did not result in the view details or document links showing up

    i did some google searches and came across this post, that basically says the plugin needs to be hosted on wordpress web before view details (and doc?) links is displayed
    https://wordpress.stackexchange.com/questions/162146/plugin-view-details-link

    i’d like to suggest that a plugin documentation / help link can be supported e.g. specified in the plugin file header comments and displayed in the installed plugin entry so that users can click that ‘view details’ or ‘doc’ link to jump to / open (the locally installed) documentation page to learn about the plugin.
    e.g. that i’m providing various short codes that could be embedded in pages, what are those short codes and how to use them, it would help to have it displayed in a html help guide
    i’m happy if the link could be present and simply link to readme.txt or readme.md and it is parsed/formatted with a stylesheet so that it is more visually pleasing rather than raw text.

    at the moment i’m hacking a a href url tag into the description entry in the file header section https://codex.wordpress.org/File_Header
    but as it stands, that’s probably not encouraged nor supported

    thanks in advance

    • This topic was modified 3 weeks, 6 days ago by  ag1233.
    • This topic was modified 3 weeks, 6 days ago by  ag1233.
    • This topic was modified 3 weeks, 6 days ago by  ag1233.
    • This topic was modified 3 weeks, 6 days ago by  ag1233.
    • This topic was modified 3 weeks, 6 days ago by  ag1233.
    • This topic was modified 3 weeks, 6 days ago by  ag1233.
    • This topic was modified 3 weeks, 6 days ago by  ag1233.
    • This topic was modified 3 weeks, 6 days ago by  ag1233.
    • This topic was modified 3 weeks, 6 days ago by  ag1233.
    • This topic was modified 3 weeks, 6 days ago by  ag1233.
    • This topic was modified 3 weeks, 4 days ago by  Jan Dembowski.
Viewing 1 replies (of 1 total)
  • Moderator bcworkz

    (@bcworkz)

    Welcome to WordPress and these forums!

    That’s right, the readme.txt file is specific to the plugin’s page in the .org repository, it is entirely ignored (if even provided) in the local installation. You have wide latitude in what appears on your plugin page in the repository, you can link to documents hosted elsewhere AFAIK. I’m not part of the plugins team, so am not up to speed on exactly what’s allowed or not.

    You can also add extra information to the plugin’s file header, but honestly, few users will see it there. There’s no point in embedding an anchor tag link in the comment header because it is not parsed as HTML. You are free to add a documentation and/or settings page as part of your plugin installation, just be sure it is not intrusive or spammy.

Viewing 1 replies (of 1 total)
  • You must be logged in to reply to this topic.