View Issue Details

This bug affects 1 person(s).
 4
IDProjectCategoryView StatusLast Update
16998Bug reportsPluginspublic2021-01-26 16:52
ReporterMazi Assigned To 
PrioritynoneSeverityminor 
Status newResolutionopen 
Product Version4.3.34 
Summary16998: Missing readme or extended information for core plugins makes it very hard for the common user to make use of the plugins
Description

There are now quite a few shipped core plugins at LS 4, see https://github.com/LimeSurvey/LimeSurvey/tree/master/application/core/plugins

Some of them only add manir features like https://github.com/LimeSurvey/LimeSurvey/blob/master/application/core/plugins/PasswordRequirement/PasswordRequirement.php but others are far more complex like https://github.com/LimeSurvey/LimeSurvey/blob/master/application/core/plugins/expressionFixedDbVar/expressionFixedDbVar.php.

Problem is that only very few (I think https://github.com/LimeSurvey/LimeSurvey/blob/master/application/core/plugins/customToken/README.md is actually the only one) come with a readme file to explain the technical details, options and include some examples. others only come with avery short description like "Add some function in ExpressionScript Engine to get count from other responses" (https://github.com/LimeSurvey/LimeSurvey/blob/master/application/core/plugins/statFunctions/statFunctions.php#L23). The common users does not really know what this actually means or how it can be used.

So can we please have a readme fle for these core plugins similar to https://github.com/LimeSurvey/LimeSurvey/blob/master/application/core/plugins/customToken/README.md ?
There are so many great plugins like https://github.com/LimeSurvey/LimeSurvey/blob/master/application/core/plugins/expressionFixedDbVar/expressionFixedDbVar.php or https://github.com/LimeSurvey/LimeSurvey/blob/master/application/core/plugins/expressionQuestionForAll/expressionQuestionForAll.php but even I as a long term Limesurvey user do not really know how to use them.
Later on I think we should also link to the readme file from within the plugin manager if possible (or even better load the readme there if exists).

Steps To Reproduce

Check the available LS4 plugins by going to the plugin manager.
Pick a plugin like "expressionFixedDbVar".
You are shown the description like "Add SEED and other DB var in ExpressionScript Engine." and a "web page" link, but in this case it only links to https://www.sondages.pro/ and no specific page.

TagsNo tags attached.
Bug heat4
Complete LimeSurvey version number (& build)4.3.33+201228
I will donate to the project if issue is resolvedNo
BrowserChrome
Database type & versionMySQL 5
Server OS (if known)Ubuntu 18
Webserver software & version (if known)Apache
PHP Version7.2.26

Users monitoring this issue

There are no users monitoring this issue.

Activities

DenisChenu

DenisChenu

2021-01-26 15:04

developer   ~61683

You kidding ?
https://manual.limesurvey.org/ExpressionFixedDbVar
https://manual.limesurvey.org/ExpressionQuestionForAll

DenisChenu

DenisChenu

2021-01-26 15:06

developer   ~61684

You're right : webpage must go to manual (create manual after plugin)

DenisChenu

DenisChenu

2021-01-26 15:41

developer   ~61685

For information :webpage show are "authorUrl" … https://manual.limesurvey.org/LimeStore_extension_development#config.xml_specification

Ask for a manual webpage, but i'm still the author !

I add the link to manual on 2 plugins on description (no other way)

Mazi

Mazi

2021-01-26 16:00

updater   ~61686

I am not kidding :-)

I was just not aware that there is additional information available at the manual. So as you mentioned, it surely makes sense to add links within the plugin overview so for any given plugin you can define a URl with additional information.
Otherwise no one will use these great tools.

DenisChenu

DenisChenu

2021-01-26 16:51

developer   ~61690

  • authorUrl : show as "plugin url"
  • supportUrl : not shown

Else :

DenisChenu

DenisChenu

2021-01-26 16:52

developer   ~61691

PS : simple user didn't read README … 

Issue History

Date Modified Username Field Change
2021-01-21 12:40 Mazi New Issue
2021-01-26 15:04 DenisChenu Note Added: 61683
2021-01-26 15:06 DenisChenu Note Added: 61684
2021-01-26 15:41 DenisChenu Note Added: 61685
2021-01-26 16:00 Mazi Note Added: 61686
2021-01-26 16:51 DenisChenu Note Added: 61690
2021-01-26 16:51 DenisChenu File Added: Capture d’écran du 2021-01-26 16-51-25.png
2021-01-26 16:52 DenisChenu Note Added: 61691