notepad-plus-plus / nppPluginList

The official collection of Notepad++ plugins.
1.09k stars 357 forks source link

No comprehensive list of plugins with explanations of what they do #158

Closed helpdata closed 4 years ago

helpdata commented 4 years ago

Just spent the last hour trying to find a full list of all NPP plugins with explanations of what each one does. There should be a readme.txt file somewhere with this information.

chcg commented 4 years ago

@helpdata This repo contains the input for the pluginAdmin window visible in N++ in json format containing a description for each plugin. The input therefore is: https://github.com/notepad-plus-plus/nppPluginList/blob/master/src/pl.x64.json and https://github.com/notepad-plus-plus/nppPluginList/blob/master/src/pl.x86.json where the raw data is available in text form. Do you have other needs?

akoppa commented 4 years ago

If you mean a plugin list in plain English like is normal for any software project available for a general public: the answer is NO.

helpdata commented 4 years ago

I agree with akoppa. Digging into a json file is not an adequate answer.

chcg commented 4 years ago

So your expectation is something like https://marketplace.visualstudio.com/vscode or https://github.com/emacs-tw/awesome-emacs#awesome-emacs?

There are currently no plans for that, but I think it should be possible to transform the json input to a markdown file with the plugin name + description + homepage to have at least the basic informations.

mattesh commented 4 years ago

What about a generator to build it from those files? Any language preference?

chcg commented 4 years ago

@mattesh Currently python is used to parse the json input against a schema and check that the downloads are usable. So python probably would be a good choice to create some markdown file from the x32 and x64 input files.

mattesh commented 4 years ago

... Python -> md sounds good, but. Please, don't expect smthng tomorrow ;-D

mattesh commented 4 years ago

What about this: get_pl.py takes one parameter x**.json and prints the ready made table w/o header and footer. Description "\r\n" gets replaced by <br> and "|" by & vert;

Two tables of this format would be printed:

  1. Plugin Name = ij.display-name
  2. Author = ij.author
  3. Homepage = ij.homepage
  4. Version and link = "[" + ij.version + " - " + json_file.arch + " bit](" + ij.repository +")"
  5. Description = " <details> <summary> " + first_two_lines(ij.description) + " </summary> " rest_of_text(ij.description) +"</details>"

List of Plugins 32 bit

|Plugin name | Author | Homepage | Version and link | Description | |---|---|---|---|---|---| | 3P - Progress Programmers Pal | Julien Caillon | [3P - 32 bit](https://jcaillon.github.io/3P/) | [1.8.6](https://github.com/jcaillon/3P/releases/download/v1.8.6/3P.zip) | <details> <summary> [Requires .NET framework v4.6.1]<br>Designed to help writing OpenEdge ABL (formerly known as Progress 4GL) code. It provides :</summary> <br>- a powerful auto-completion<br>- tool-tips on every words<br>- a code explorer to quickly navigate through your code<br>- a file explorer to easily access all your sources<br>- the ability to run/compile and even PROLINT your source file with an in-line visualization of errors<br>- more than 50 options to better suit your needs<br>- and so much more!<br>Visit https://jcaillon.github.io/3P/ for more details on the plugin </details> |

mattesh commented 4 years ago

Hi, what do you think about this? https://github.com/notepad-plus-plus/nppPluginList/compare/6f40c133...mattesh:e709d1935a plugin_list_x64.zip

Only point to clarify would be how to copy it into stable place when commit was taken into the master. Regards, Mattes

chcg commented 4 years ago

Plugin List - 64 bit

(version 1.1.7) Plugin name Author Homepage Version and link Description
3P - Progress Programmers Pal Julien Caillon https://jcaillon.github.io/3P/ 1.8.6 - 64 bit
[Requires .NET framework v4.6.1]
Designed to help writing OpenEdge ABL (formerly known as Progress 4GL) code. It provides :

- a powerful auto-completion
- tool-tips on every words
- a code explorer to quickly navigate through your code
- a file explorer to easily access all your sources
- the ability to run/compile and even PROLINT your source file with an in-line visualization of errors
- more than 50 options to better suit your needs
- and so much more!
Visit https://jcaillon.github.io/3P/ for more details on the plugin
AnalysePlugin Mattes H. https://sourceforge.net/projects/analyseplugin 1.12.43.0 - 64 bit
AnalysePlugin will help you to search for more than one search pattern at a time. Great for analysing log files..
Last changes and How to use you will find in Help... in Plugins Menu.
chcg commented 4 years ago

@mattesh Lokes usable to me. In your example there is an |---| to much. Only drawback seen here is the collapsed description data which makes it difficult to search.

mattesh commented 4 years ago

@chcg the solution would be a small script snippet. But we seem to be not allowed to add this directly on github. We may be able embed some html script on the server: from here. However, my limited tests did not show a solution to combine script with markdown code.

Do you have already an idea how we would make this lists visible in some place? e.g. in plugin docs? Regards, Mattes

chcg commented 4 years ago

@mattesh My first thought was to add the md files to the artefacts of a release, but then they are not immediately visible from within the browser. Maybe just add it with the release the repo and link it from the readme.

mattesh commented 4 years ago

isn't it at the time when a new release is created, when the list need to be generated and pushed into https://github.com/notepad-plus-plus/npp-usermanual ? See more in the other thread.

chcg commented 4 years ago

First test versions from appveyor CI: https://github.com/notepad-plus-plus/nppPluginList/blob/master/doc/plugin_list_x86.md and https://github.com/notepad-plus-plus/nppPluginList/blob/master/doc/plugin_list_x64.md from current master. Still needs some automatic checkin which might be easier done by github action.

chcg commented 4 years ago

Updated manually with each tagging.