Update docs

dragomano · Jul 3, 2024 · 20299cc · 20299cc
1 parent 231644a
commit 20299cc
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 48 deletions.
diff --git a/docs/src/el/plugins/all-hooks.md b/docs/src/el/plugins/all-hooks.md
@@ -517,6 +517,12 @@ public function prepareIconList(array &$icons): void
 
 ## Ρυθμίσεις πόρταλ
 
+### extendBasicConfig
+
+(`&$configVars`)
+
+> adding custom configs in the portal basic settings area
+
 ### updateAdminAreas
 
 (`&$areas`)

diff --git a/docs/src/el/plugins/create-new.md b/docs/src/el/plugins/create-new.md
@@ -86,19 +86,6 @@ order: 2
 ```php:line-numbers
 <?php
 
-/**
- * HelloWorld.php
- *
- * @package HelloWorld (Light Portal)
- * @link https://custom.simplemachines.org/index.php?mod=4244
- * @author Nickname <email>
- * @copyright 2023 Nickname
- * @license https://spdx.org/licenses/GPL-3.0-or-later.html GPL-3.0-or-later
- *
- * @category addon
- * @version 15.02.24 (date when the source code of the plugin was created or last updated, in the format dd.mm.yy)
- */
-
 namespace Bugo\LightPortal\Addons\HelloWorld;
 
 use Bugo\Compat\{Config, Lang, Utils};
@@ -109,9 +96,20 @@ if (! defined('LP_NAME'))
 
 class HelloWorld extends Plugin
 {
-    // Used properties and methods
-    // Access to global variables: Utils::$context['user'], Config::$modSettings['variable'], etc.
-    // Access to language variables: Lang::$txt['lp_hello_world']['variable_name']
+    // FA icon (for blocks only)
+    public string $icon = 'fas fa-globe';
+
+    // Your plugin's type
+    public string $type = 'other';
+
+    // Optional init method
+    public function init(): void
+    {
+        // Access to global variables: Utils::$context['user'], Config::$modSettings['variable'], etc.
+        // Access to language variables: Lang::$txt['lp_hello_world']['variable_name']
+    }
+
+    // Custom properties and methods
 }
 
 ```

diff --git a/docs/src/it/plugins/all-hooks.md b/docs/src/it/plugins/all-hooks.md
@@ -517,6 +517,12 @@ public function prepareIconList(array &$icons): void
 
 ## Impostazioni Portale
 
+### extendBasicConfig
+
+(`&$configVars`)
+
+> aggiunta di configurazioni personalizzate nell'area delle impostazioni di base del portale
+
 ### updateAdminAreas
 
 (`&$areas`)

diff --git a/docs/src/it/plugins/create-new.md b/docs/src/it/plugins/create-new.md
@@ -86,19 +86,6 @@ Il file `index.php` può essere copiato da cartelle di altri plugin. Il file `He
 ```php:line-numbers
 <?php
 
-/**
- * HelloWorld.php
- *
- * @package HelloWorld (Light Portal)
- * @link https://custom.simplemachines.org/index.php?mod=4244
- * @author Nickname <email>
- * @copyright 2023 Nickname
- * @license https://spdx.org/licenses/GPL-3.0-or-later.html GPL-3.0-or-later
- *
- * @category addon
- * @version 15.02.24 (date when the source code of the plugin was created or last updated, in the format dd.mm.yy)
- */
-
 namespace Bugo\LightPortal\Addons\HelloWorld;
 
 use Bugo\Compat\{Config, Lang, Utils};
@@ -109,9 +96,20 @@ if (! defined('LP_NAME'))
 
 class HelloWorld extends Plugin
 {
-    // Used properties and methods
-    // Access to global variables: Utils::$context['user'], Config::$modSettings['variable'], etc.
-    // Access to language variables: Lang::$txt['lp_hello_world']['variable_name']
+    // FA icon (for blocks only)
+    public string $icon = 'fas fa-globe';
+
+    // Your plugin's type
+    public string $type = 'other';
+
+    // Optional init method
+    public function init(): void
+    {
+        // Access to global variables: Utils::$context['user'], Config::$modSettings['variable'], etc.
+        // Access to language variables: Lang::$txt['lp_hello_world']['variable_name']
+    }
+
+    // Custom properties and methods
 }
 
 ```

diff --git a/docs/src/ru/plugins/all-hooks.md b/docs/src/ru/plugins/all-hooks.md
@@ -517,6 +517,12 @@ public function prepareIconList(array &$icons): void
 
 ## Настройки портала
 
+### extendBasicConfig
+
+(`&$configVars`)
+
+> добавление пользовательских параметров в области основных настроек портала
+
 ### updateAdminAreas
 
 (`&$areas`)

diff --git a/docs/src/ru/plugins/create-new.md b/docs/src/ru/plugins/create-new.md
@@ -86,19 +86,6 @@ order: 2
 ```php:line-numbers
 <?php
 
-/**
- * HelloWorld.php
- *
- * @package HelloWorld (Light Portal)
- * @link https://custom.simplemachines.org/index.php?mod=4244
- * @author Никнейм <email>
- * @copyright 2023 Никнейм
- * @license https://spdx.org/licenses/GPL-3.0-or-later.html GPL-3.0-or-later
- *
- * @category addon
- * @version 15.02.24 (дата создания, а в дальнейшем — обновления кода плагина, в формате дд.мм.гг)
- */
-
 namespace Bugo\LightPortal\Addons\HelloWorld;
 
 use Bugo\Compat\{Config, Lang, Utils};
@@ -109,9 +96,20 @@ if (! defined('LP_NAME'))
 
 class HelloWorld extends Plugin
 {
-    // Используемые свойства и методы
-    // Доступ к глобальным переменным: Utils::$context['user'], Config::$modSettings['variable'], etc.
-    // Доступ к языковым переменным: Lang::$txt['lp_hello_world']['variable_name']
+    // FA icon (for blocks only)
+    public string $icon = 'fas fa-globe';
+
+    // Your plugin's type
+    public string $type = 'other';
+
+    // Optional init method
+    public function init(): void
+    {
+        // Access to global variables: Utils::$context['user'], Config::$modSettings['variable'], etc.
+        // Access to language variables: Lang::$txt['lp_hello_world']['variable_name']
+    }
+
+    // Custom properties and methods
 }
 
 ```