Add help page links to some effects reference help pages (#8646)

Author: D8H

Extensions/3D/JsExtension.js

@@ -2200,6 +2200,7 @@ module.exports = {
         )
         .markAsNotWorkingForObjects()
         .markAsOnlyWorkingFor3D()
+        .setHelpPath('/objects/3d-light')
         .addIncludeFile('Extensions/3D/AmbientLight.js');
       const properties = effect.getProperties();
       properties
@@ -2224,6 +2225,7 @@ module.exports = {
         )
         .markAsNotWorkingForObjects()
         .markAsOnlyWorkingFor3D()
+        .setHelpPath('/objects/3d-light')
         .addIncludeFile('Extensions/3D/DirectionalLight.js');
       const properties = effect.getProperties();
       properties
@@ -2314,6 +2316,7 @@ module.exports = {
         )
         .markAsNotWorkingForObjects()
         .markAsOnlyWorkingFor3D()
+        .setHelpPath('/objects/3d-light')
         .addIncludeFile('Extensions/3D/HemisphereLight.js');
       const properties = effect.getProperties();
       properties

Extensions/Effects/JsExtension.js

@@ -310,6 +310,7 @@ module.exports = {
       .setFullName(_('Color Map'))
       .setDescription(_('Change the color rendered on screen.'))
       .markAsOnlyWorkingFor2D()
+      .setHelpPath('/all-features/effects/color-map')
       .addIncludeFile('Extensions/Effects/color-map-pixi-filter.js')
       .addIncludeFile('Extensions/Effects/pixi-filters/filter-color-map.js');
     const colorMapProperties = colorMapEffect.getProperties();
@@ -371,6 +372,7 @@ module.exports = {
       .setFullName(_('CRT'))
       .setDescription(_('Apply an effect resembling old CRT monitors.'))
       .markAsOnlyWorkingFor2D()
+      .setHelpPath('/all-features/effects/crt')
       .addIncludeFile('Extensions/Effects/pixi-filters/filter-crt.js')
       .addIncludeFile('Extensions/Effects/crt-pixi-filter.js');
     const crtProperties = crtEffect.getProperties();
@@ -449,6 +451,7 @@ module.exports = {
         )
       )
       .markAsOnlyWorkingFor2D()
+      .setHelpPath('/all-features/effects/displacement')
       .addIncludeFile('Extensions/Effects/displacement-pixi-filter.js');
     const displacementProperties = displacementEffect.getProperties();
     displacementProperties
@@ -502,6 +505,7 @@ module.exports = {
       .setFullName(_('Drop shadow'))
       .setDescription(_('Add a shadow around the rendered image.'))
       .markAsOnlyWorkingFor2D()
+      .setHelpPath('/all-features/effects/drop-shadow')
       .addIncludeFile('Extensions/Effects/pixi-filters/filter-kawase-blur.js')
       .addIncludeFile('Extensions/Effects/pixi-filters/filter-drop-shadow.js')
       .addIncludeFile('Extensions/Effects/drop-shadow-pixi-filter.js');
@@ -673,6 +677,7 @@ module.exports = {
       .setFullName(_('Godray'))
       .setDescription(_('Apply and animate atmospheric light rays.'))
       .markAsOnlyWorkingFor2D()
+      .setHelpPath('/all-features/effects/god-rays')
       .addIncludeFile('Extensions/Effects/pixi-filters/filter-godray.js')
       .addIncludeFile('Extensions/Effects/godray-pixi-filter.js');
     const godrayProperties = godrayEffect.getProperties();
@@ -771,6 +776,7 @@ module.exports = {
         )
       )
       .markAsOnlyWorkingFor2D()
+      .setHelpPath('/all-features/effects/kawase-blur')
       .addIncludeFile('Extensions/Effects/pixi-filters/filter-kawase-blur.js')
       .addIncludeFile('Extensions/Effects/kawase-blur-pixi-filter.js');
     const kawaseBlurProperties = kawaseBlurEffect.getProperties();
@@ -951,6 +957,7 @@ module.exports = {
       .setFullName(_('Outline'))
       .setDescription(_('Draws an outline around the rendered image.'))
       .markAsOnlyWorkingFor2D()
+      .setHelpPath('/all-features/effects/outline')
       .addIncludeFile('Extensions/Effects/pixi-filters/filter-outline.js')
       .addIncludeFile('Extensions/Effects/outline-pixi-filter.js');
     const outlineProperties = outlineEffect.getProperties();
@@ -978,6 +985,7 @@ module.exports = {
         _("Applies a pixelate effect, making display objects appear 'blocky'.")
       )
       .markAsOnlyWorkingFor2D()
+      .setHelpPath('/all-features/effects/pixelate')
       .addIncludeFile('Extensions/Effects/pixi-filters/filter-pixelate.js')
       .addIncludeFile('Extensions/Effects/pixelate-pixi-filter.js');
     const pixelateProperties = pixelateEffect.getProperties();
@@ -1111,6 +1119,7 @@ module.exports = {
         _('Applies a RGB split effect also known as chromatic aberration.')
       )
       .markAsOnlyWorkingFor2D()
+      .setHelpPath('/all-features/effects/rgb-split')
       .addIncludeFile('Extensions/Effects/pixi-filters/filter-rgb-split.js')
       .addIncludeFile('Extensions/Effects/rgb-split-pixi-filter.js');
     const rgbSplitProperties = rgbSplitEffect.getProperties();
@@ -1218,6 +1227,7 @@ module.exports = {
       .setFullName(_('Tilt shift'))
       .setDescription(_('Render a tilt-shift-like camera effect.'))
       .markAsOnlyWorkingFor2D()
+      .setHelpPath('/all-features/effects/tilt-split')
       .addIncludeFile('Extensions/Effects/pixi-filters/filter-tilt-shift.js')
       .addIncludeFile('Extensions/Effects/tilt-shift-pixi-filter.js');
     const tiltShiftProperties = tiltShiftEffect.getProperties();

newIDE/app/scripts/lib/ExtensionReferenceGenerator.js

@@ -1168,6 +1168,8 @@ const generateExtensionRawText = (
                 ].join(' ');
               }),
               '',
+              effectMetadata.getHelpPath() ? generateReadMoreLink(effectMetadata.getHelpPath()) : '',
+              '',
             ].join(`\n`),
           };
         }