Feature request #5236: Add an About field, and make it mandatory - QGIS Plugin Site - QGIS Issue Tracking

Feature request #5236

Add an About field, and make it mandatory

Added by Paolo Cavallini over 12 years ago. Updated over 10 years ago.

Status:	Closed
Priority:	Normal
Assignee:	Alessandro Pasotti
Category:	-
Pull Request or Patch supplied:	No

Description

It would be nice to have a short (<140 characters) title and a compulsory description, with the possibility to hit a 'more details' button in the plugin manager and see a paragraph.
The description should be added to the plugin's page.
The author should be notified with a message "Please add a description of your plugin, explaining its usage".

History

#1 Updated by Paolo Cavallini over 12 years ago

Subject changed from Make it compulsory a description to Make a plugin description compulsory

#2 Updated by Gary Sherman over 12 years ago

Assignee set to Alessandro Pasotti

#3 Updated by Alessandro Pasotti over 12 years ago

Status changed from Open to Feedback

Either I dont' understand or this is exactly how it is already (now): "description" field is required, mandatory (compulsory?) and is shown on the plugin page.

By clicking on "toggle descriptions" the user sees the longer description.

The only missing piece is a check for title length not exceeding the twitter length, now the maximum limit for the plugin title is 256.

#4 Updated by Paolo Cavallini over 12 years ago

Subject changed from Make a plugin description compulsory to Add an About field, and make it mandatory

#5 Updated by Gary Sherman over 12 years ago

The problem is the "short" description does not provide enough information for a user to determine exactly what the plugin does. This information is needed so a decision can be made to install or not. A file included in the plugin package (mailing list has some discussion) that contains such information and that could be displayed both on this site and within the installer would help greatly.

#6 Updated by Borys Jurgiel over 10 years ago

Please note the plugin installer actually accepts two tags:

description - displayed with a bigger bold font. It is meant to contain one-sentence answer for the question: "what the plugin does"

about - displayed with a normal paragraph font. This one is meant to contain a longer description how the plugin works and how to use it. For example, an author can put there a short info what menu the plugin is localized in.

I believe we were discussing it in Brighton and then we forgot about it.