WordPress.org

Forums

Plugin Notes
[resolved] Feature request: text formatting editor controls (31 posts)

  1. Greybox
    Member
    Posted 1 year ago #

    Would this be possible to add some text editor controls like bold, italic, link? Your plugin is able to display formatted text when I enter something like:

    <strong>Wonderful</strong> <em>plugin!</em>
    
    <a title="http://wordpress.org/support/view/plugin-reviews/plugin-notes" href="http://wordpress.org/support/view/plugin-reviews/plugin-notes">http://wordpress.org/support/view/plugin-reviews/plugin-notes</a>
    ,

    but there are no text formatting control buttons.

    https://wordpress.org/plugins/plugin-notes/

  2. jrf
    Member
    Plugin Author

    Posted 1 year ago #

    Would markdown syntax be helpful to you ?

    I haven't got round to releasing a new version yet, but I've nearly finished one which includes mark-down amongst other new features, such as multiple notes per plugin, auto-magic variables etc.

  3. Greybox
    Member
    Posted 1 year ago #

    Anything that would help formatting without manually typing the formatting code will work.

    Would that be easier to use the controls already embedded into standard WordPress visual/text editor?

  4. jrf
    Member
    Plugin Author

    Posted 1 year ago #

    It's not that easy to add the controls, especially when you have numerous forms on the page for which you'd want to use them.

    I'll try to find some time in the next month or so to finish off version 2.0.

    In the mean time you could try the unofficial versions 1.5 and/or 1.6 which already have markdown included: https://github.com/jrfnl/WP-plugin-notes/releases

    Hope that helps.

  5. Greybox
    Member
    Posted 1 year ago #

    I will try that.

    In the meantime, could you add just a minor, maybe a bogus change to the existing official plugin version, make it official 1.2 just to get rid of "This plugin hasn't been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues when used with more recent versions of WordPress." I hope more people will start using this excellent plugin.

  6. esmi
    Forum Moderator
    Posted 1 year ago #

    maybe a bogus change to the existing official plugin version,

    Um... that kind of behaviour can result in a plugin being removed from the WPORG repository full stop.

  7. Greybox
    Member
    Posted 1 year ago #

    It makes sense and my idea was bad. I apologize. I take "bogus" back, just a minor change then.

    Anything WordPress can do to eliminate that message? This plugin IS working with WordPress 3.8.1.

  8. jrf
    Member
    Plugin Author

    Posted 1 year ago #

    Let's just keep our fingers crossed that I can finish v2.0 soon ;-) That version should be a major step up and is the reason the original author has allowed me access to the repo to take over.

    Just to give you some idea:

    New version is a near complete rewrite and will have:

    • Color coded notes (choose your own background color - already included in v1.5)
    • Variable replacement for a number of common things (like link to WP repo for the plugin) (already included in v1.5)
    • Markdown syntax (it's a tool which will mainly be used by site admins/developers and they often find mark down quicker than html) (already included in v1.5)
    • Ability to change the allowed html tags
    • Note templates which you can set yourself (useful if you want to keep a common format to the notes)
    • Private notes (for your eyes only)
    • Versionnr of a plugin you were on when the note was written/last saved
    • Multiple notes per plugin
    • A choice of display methods for multiple notes (tabbed, accordion, as was)
    • Import/Export of notes
    • Upgrade routine to convert your saved notes to the new multi-note format
  9. Greybox
    Member
    Posted 1 year ago #

    Wow!!! Thanks for doing all this!!!

    Why can't you make 1.5 official while you are working on 2.0?

  10. jrf
    Member
    Plugin Author

    Posted 1 year ago #

    Why can't you make 1.5 official while you are working on 2.0?

    I've seen some cases where that version didn't work so well on WP3.8+, so I'm not too sure that the javascript is completely compatible with the newer jQuery version which has been shipped with WP since 3.6.

  11. jrf
    Member
    Plugin Author

    Posted 1 year ago #

    If you can confirm that it works for you without issues on WP 3.8, I might just upload it anyway, but not change the official stable version, so people would not get an auto-update notification. How would that be ?

  12. Greybox
    Member
    Posted 1 year ago #

    I will give it a try. What exactly didn't work well, what should I pay attention to? Will I be able to return back to stable 1.1 and keep my previously entered data if there is a serious issue?

  13. jrf
    Member
    Plugin Author

    Posted 1 year ago #

    What exactly didn't work well, what should I pay attention to?

    I seem to remember notes not being saved anymore, don't remember exactly what else (if anything).

    Will I be able to return back to stable 1.1 and keep my previously entered data if there is a serious issue?

    Not automatically. Please make a backup/export of the plugin_notes record in the wp_options table via phpMyAdmin or something before you upgrade. That way you can delete the new record of the option (and import the exported version) if you'd want to downgrade.

  14. Greybox
    Member
    Posted 1 year ago #

    I am not sure now: will my previously entered user data be in the database if I upgrade from 1.1 to 1.5? And also any similar issues upgrading from 1.1 or 1.5 to 2.0?

    It seems to be easier and safer just to copy/paste my existing notes into a text document than messing up with the database. If I uninstall 1.5, will the uninstall automatically clean up the user data in the database? This way I could just uninstall 1.5, install 1.1 from scratch and copy/paste my data into 1.1 from my text file.

  15. jrf
    Member
    Plugin Author

    Posted 1 year ago #

    Hi Greybox,

    I'll try and answer your question, please let me know if you need more info/clarification:

    I am not sure now: will my previously entered user data be in the database if I upgrade from 1.1 to 1.5? And also any similar issues upgrading from 1.1 or 1.5 to 2.0?

    Upgrading
    The plugin contains an upgrade routine to *up*-grade between version, this means in effect that your notes (and once you've upgraded - your settings), will still be available after the upgrade. They may be saved slightly differently under the hood, but as a user you should not notice that.

    Downgrading
    The downside of this, is of course that if the saving of notes/settings changes between version (and it has), downgrading will cause problems as old versions will not know how to handle the new note/settings format.

    The new way of saving notes/settings will always overwrite the old settings, so the old format will no longer be available after an upgrade.

    If I uninstall 1.5, will the uninstall automatically clean up the user data in the database?

    Uninstalling
    The original version which is currently in the WP repo does not remove notes/settings form the database on uninstall.
    The newer versions I'm working on, *do*, starting with version 1.5. So if you uninstall version 1.5, any previously entered notes will be deleted.

    It seems to be easier and safer just to copy/paste my existing notes into a text document than messing up with the database. This way I could just uninstall 1.5, install 1.1 from scratch and copy/paste my data into 1.1 from my text file.

    If you only have a few notes, that might well be the easiest way if you are not very comfortable using tools like phpmyadmin.

    Hope this helps ;-)

    Smile,
    Juliette

  16. Greybox
    Member
    Posted 1 year ago #

    Thank you!
    I tried to upgrade, but found that inside your 1.6 zip file the root folder name is \WP-plugin-notes-1.6 while 1.1 zip root folder name is different - \plugin-notes folder. How should I upgrade properly?

  17. jrf
    Member
    Plugin Author

    Posted 1 year ago #

    Unzip the file locally, FTP into your webserver, remove the content of the wp-content/plugins/plugin-notes/ folder, but not the folder itself, then upload the contents of the locally unzipped folder into the wp-content/plugins/plugin-notes/ folder on the server.

  18. Greybox
    Member
    Posted 1 year ago #

    Thank you for your quick answer and detailed explanation!

    I installed 1.6 on my I use WordPress 3.8.1. and I could not find any bugs - the plugin description is saved, the color and the template for new notes is saved properly so your plugin works perfectly fine and I don't have any reason to downgrade. I think it is safe to make it official stable version after you try yourself and confirm again what I just said.

    And also markdown syntax works, but it is not compatible with WordPress posts and pages and will not be convenient for wordpress users who use visual text editor.

    Another little feature request: will it be possible for you to add the link at the bottom to the official wordpress.org plugin page next to the author's web site (plugin site)?

  19. jrf
    Member
    Plugin Author

    Posted 1 year ago #

    Thanks for testing! I'll do some more tests with various WP versions when I get a chance and will upload if they all turn out positive.

    And also markdown syntax works, but it is not compatible with WordPress posts and pages and will not be convenient for wordpress users who use visual text editor.

    True. The notes are saved in a different format than posts which is why the compatibility is not something I would consider an issue.
    And yes, I don't expect 'ordinary' users to use markdown, but then again, I doubt many 'ordinary' users use this plugin in the first place. I kind of have the feeling that it's more a plugin used by developers/advanced admins. In any case, the notes are only available to admins/users with the plugin install capacity, not to ordinary users.

    Another little feature request: will it be possible for you to add the link at the bottom to the official wordpress.org plugin page next to the author's web site (plugin site)?

    I'll have a look at that again when I continue development for 2.0 - you may want to open this as an issue on GitHub to make sure I remember ;-) -. I seem to remember that I previously choose not to implement it as some plugin authors already show the WP link and others link to their own website, which in effect would mean that you could end up with two links to the WP repo in that same line.
    Also, the filter used to add the plugin notes, gets the fully formed html of that last line (and basically adds the plugin notes functionality to (and before) the line). That means that adding a link to the line would involve, parsing the html back to the individual parts, adding the link somewhere in between and the glueing it all together again, which does seem kind of error-prone.
    Knowing that, what do you think ?

  20. jrf
    Member
    Plugin Author

    Posted 1 year ago #

    Oh and more about that link: it also would create invalid links for premium plugins and plugins which aren't in the WP repo. Unless of course I'd test to see that the link is valid which would create quite some overhead what with the round trip to the WP site to check for each plugin.

    The link can be added to the note with the variable replacement anyhow and using the variable is a user choice, so they would be 'responsible' for the validity of the link in that case ;-)

    Does that clarify it more ?

  21. Greybox
    Member
    Posted 1 year ago #

    I am the site admin, but I use visual editor most of the time because manually typing the code is more difficult. I thought we could have a few basic buttons similar to the editing window in this forum. I was also under impression that if visual editor is already available for wordpress posts and pages, the code could be re-used for the note editor by calling the appropriate functions/libraries. But it looks like I was wrong and it is not that simple. Your plugin is great anyways!

    If there is a variable for the link to wordpress.org plugin page, this would be a solution.

  22. jrf
    Member
    Plugin Author

    Posted 1 year ago #

    Yes, the visual editor is available for re-use, but I seem to remember with only one instance per admin page, which makes it difficult to use for the plugin notes.

    I added the variable replacement in v1.5, you can read more about which variables you can use (and the other new features) in the readme.txt file. In v2.0, the information in the help tab at the top of the plugin page has been extended to include a list of the variables (in v1.5 it mentions the feature, not the codes).

    Variables can be used in templates too and the result will change depending on the plugin the note is for ;-)

    Quote from the readme.txt file of version 1.5:

    = Which variables can I use ? =

    There are a number of variables you can use in the notes which will automagically be replaced. Most aren't that useful as the info is provided by default for the plugin, but they are included anyway for completeness.

    Example use: you want a link to the WordPress Plugin repository for each plugin.
    Instead of manually adding each and every link, you can just add the following note to each plugin and the link will be automagically placed:

    Plugin: %WPURI_LINK%

    **Available variables**:
    %PLUGIN_PATH% : Plugin uri path on your website
    %WPURI% : URI of the WordPress repository of the plugin (Please note: it is not tested whether the plugin is actually registered in the WP plugin repository!)
    %WPURI_LINK% : A link to the above WordPress repository of the plugin

    **Already showing for each plugin (less useful)**:
    %NAME%: Plugin Name
    %URI%: URI of the plugin website
    %AUTHOR%: Name of the plugin author
    %AUTHORURI%: Website of the plugin author
    %VERSION%: Current plugin version
    %DESCRIPTION%: Description of the plugin

  23. Greybox
    Member
    Posted 1 year ago #

    The variables work fine, thank you!

    Is it possible to make all the links clickable by default? Otherwise I had to use [%WPURI%](%WPURI%).

  24. jrf
    Member
    Plugin Author

    Posted 1 year ago #

    The %WPURI_LINK% variable automatically makes the link. Does that help ?

  25. Greybox
    Member
    Posted 1 year ago #

    Yes, it does help, thanks for pointing this out!

    Other links, are not clickable, but they already show at the bottom. So this is not a big deal and can be left alone (unless it is very easy to make them all clickable by default).

    Thanks again!!!

  26. jrf
    Member
    Plugin Author

    Posted 1 year ago #

    As you say: they are already clickable at the bottom, which is why I didn't bother too much with them ;-)

  27. Amber
    Member
    Posted 10 months ago #

    Is this update still being worked on?

  28. Greybox
    Member
    Posted 10 months ago #

    @JRF: I've been actively using the unofficial version 1.6 for more than two months now and I love this plugin! It makes my life so much easier. It works perfectly fine with WordPress 3.8.1 and even 3.9.1 and I didn't see any problems whatsoever. For some reason the latest official stable version is still 1.1 instead of 1.6 and I am sure WordPress community is missing this wonderful plugin!

  29. mehtuus
    Member
    Posted 8 months ago #

    It's rather quiet here lately. Is this on hold or is it still being developed? I have been using this plugin for a long time and happen to be eager for the updates that were mentioned above.

  30. tadees
    Member
    Posted 5 months ago #

    Really, really wanted to try this plugin, but the WordPress Gods have deemed it broken (in v.4, that is). Specifically, when activated it returns a "does not have a valid header" error and deactivates.

    edit: the above error is for v.1.6 The stable release completely stopped by site dead in its tracks. Would not recommend on v.4 currently.

Topic Closed

This topic has been closed to new replies.

About this Plugin

About this Topic

Tags

No tags yet.