View Issue Details
ID | Project | Category | View Status | Date Submitted | Last Update |
---|---|---|---|---|---|
16998 | Bug reports | Plugins | public | 2021-01-21 12:40 | 2021-01-26 16:52 |
Reporter | Mazi | Assigned To | |||
Priority | none | Severity | minor | ||
Status | new | Resolution | open | ||
Product Version | 4.3.34 | ||||
Summary | 16998: 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 ? | ||||
Steps To Reproduce | Check the available LS4 plugins by going to the plugin manager. | ||||
Tags | No tags attached. | ||||
Bug heat | 4 | ||||
Complete LimeSurvey version number (& build) | 4.3.33+201228 | ||||
I will donate to the project if issue is resolved | No | ||||
Browser | Chrome | ||||
Database type & version | MySQL 5 | ||||
Server OS (if known) | Ubuntu 18 | ||||
Webserver software & version (if known) | Apache | ||||
PHP Version | 7.2.26 | ||||
You kidding ? |
|
You're right : webpage must go to manual (create manual after plugin) |
|
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) |
|
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. |
|
Else : |
|
PS : simple user didn't read README … |
|
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 |