From b558b9347a515e3417fce58011a03dff074350bc Mon Sep 17 00:00:00 2001 From: Christian Schnegelberger Date: Fri, 26 Sep 2025 16:19:55 +0200 Subject: [PATCH 1/2] Update to respect current status of phpBB 4 --- development/language/guidelines.rst | 30 +++++++---------------- development/language/validation.rst | 37 ++++++++++++++++------------- 2 files changed, 29 insertions(+), 38 deletions(-) diff --git a/development/language/guidelines.rst b/development/language/guidelines.rst index 7cf65ced..ccab9c44 100644 --- a/development/language/guidelines.rst +++ b/development/language/guidelines.rst @@ -14,7 +14,7 @@ If your language pack is denied and then resubmitted, it is placed at the end of 2) Submissions have to be complete. Partial translations are not allowed and will be automatically denied. E-mails, text files and theme-images must also be fully translated. -3) Language packs can contain three additional files (one mandatory and four optionals) that are not present in the British English language pack: ``LICENSE`` (mandatory), ``README.md`` (optional) and ``CHANGELOG.md`` (optional). You are free to write whatever you want in the ``README.md`` file and you can list the entire version history in the ``CHANGELOG.md`` file. The ``LICENSE`` file is automatically added during the upload process so you do not have to manually add the file. Its purpose is to inform the user what license is used. Language packs inherit phpBB's license of `GNU General Public License 2.0`_ and no additional or alternative licenses are allowed. All of these additional files must be placed in the ``language/{iso}/`` directory, next to the ``iso.txt`` file. Any other additional file(s) will be detected and your submission will be denied. +3) Language packs can contain three additional files (one mandatory and four optionals) that are not present in the British English language pack: ``LICENSE`` (mandatory), ``README.md`` (optional) and ``CHANGELOG.md`` (optional). You are free to write whatever you want in the ``README.md`` file and you can list the entire version history in the ``CHANGELOG.md`` file. The ``LICENSE`` file is automatically added during the upload process so you do not have to manually add the file. Its purpose is to inform the user what license is used. Language packs inherit phpBB's license of `GNU General Public License 2.0`_ and no additional or alternative licenses are allowed. All of these additional files must be placed in the ``language/{iso}/`` directory, next to the ``composer.json`` file. Any other additional file(s) will be detected and your submission will be denied. 4) Submissions must have the following files and structure: @@ -55,20 +55,6 @@ If your language pack is denied and then resubmitted, it is placed at the end of styles.php users.php email/ - short/ - bookmark.txt - newtopic_notify.txt - post_approved.txt - post_disapproved.txt - post_in_queue.txt - privmsg_notify.txt - quote.txt - report_pm.txt - report_post.txt - topic_approved.txt - topic_disapproved.txt - topic_in_queue.txt - topic_notify.txt admin_activate.txt admin_send_email.txt admin_welcome_activated.txt @@ -83,6 +69,7 @@ If your language pack is denied and then resubmitted, it is placed at the end of group_request.txt index.htm installed.txt + mention.txt newtopic_notify.txt pm_report_closed.txt pm_report_deleted.txt @@ -96,6 +83,7 @@ If your language pack is denied and then resubmitted, it is placed at the end of report_closed.txt report_deleted.txt report_pm.txt + report_pm_closed.txt report_post.txt test.txt topic_approved.txt @@ -104,7 +92,7 @@ If your language pack is denied and then resubmitted, it is placed at the end of topic_notify.txt user_activate.txt user_activate_inactive.txt - user_activate_password.txt + user_forgot_password.txt user_reactivate_account.txt user_remind_inactive.txt user_resend_inactive.txt @@ -116,6 +104,7 @@ If your language pack is denied and then resubmitted, it is placed at the end of app.php captcha_qa.php captcha_recaptcha.php + captcha_turnstile.php cli.php CHANGELOG.md (optional) common.php @@ -138,12 +127,12 @@ If your language pack is denied and then resubmitted, it is placed at the end of prosilver/ theme/ {iso}/ - index.htm (optional) + index.htm stylesheet.css -5) Submissions should follow the recommendations in the `4.0 Translation (i18n/L10n) Guidelines`_ as closely as possible, especially the `4.0 Writing style`_. +5) Submissions should follow the recommendations in the `Coding Guidelines`_ as closely as possible. -6) All PHP and text files must be encoded in UTF-8 without BOM and a new line at the end of the file. Many modern text editors use this as a default setting, but we recommend checking it in your editor's settings. We recommend you use `Notepad++`_ or `PSPad`_, both lightweight and free. +6) All PHP and text files must be encoded in UTF-8 without BOM and have new line at the end of the file. Many modern text editors use this as a default setting, but we recommend checking it in your editor's settings. We recommend you use `Notepad++`_ or `PSPad`_, both lightweight and free. 7) The translation is mostly your work and you have a right to hold a copyright on the translation and put your name or the names of those on your team in the ``composer.json`` file in the authors section. @@ -162,8 +151,7 @@ If your language pack is denied and then resubmitted, it is placed at the end of .. _Customisations Database: https://www.phpbb.com/go/customise/language-packs/4.0 .. _Language Packs Database: https://www.phpbb.com/languages/ .. _GNU General Public License 2.0: https://opensource.org/license/gpl-2-0 -.. _4.0 Translation (i18n/L10n) Guidelines: https://area51.phpbb.com/docs/40x/coding-guidelines.html#translation -.. _4.0 Writing style: https://area51.phpbb.com/docs/40x/coding-guidelines.html#writingstyle +.. _Coding Guidelines: https://area51.phpbb.com/docs/dev/master/development/index.html .. _Notepad++: https://notepad-plus-plus.org/ .. _PSPad: http://www.pspad.com/en/ .. _officially: https://www.phpbb.com/support/intl/ diff --git a/development/language/validation.rst b/development/language/validation.rst index 166a74eb..0216cb38 100644 --- a/development/language/validation.rst +++ b/development/language/validation.rst @@ -35,8 +35,8 @@ Package ``_`` folder. The files from above should be placed in this folder. * Revision name in the `Customisation Database`_ should be left blank, contain - the phpBB package version and/or package release name (e.g. ``3.3.10`` / - ``Bertie's translation`` for 3.3.10) for more understanding. + the phpBB package version and/or package release name (e.g. ``4.0.0`` / + ``Bertie's translation`` for 4.0.0) for more understanding. Package Validation ================== @@ -48,7 +48,7 @@ Package Validation + ``language/en/`` + ``styles/prosilver/theme/en/`` -* Language packages must contain 1 additional files: +* Language packages must contain 1 additional file: + ``language/{iso}/LICENSE`` @@ -58,13 +58,13 @@ Package Validation + ``language/{iso}/README.md`` * No other additional files are allowed! -* All folders within the language-directories must contain an ``index.htm`` file (e.g. ``language/en/acp/index.htm``, ``language/en/index.htm``, ``styles/prosilver/theme/en/index.htm``, see the `Language Pack Submission Policy`_ for a complete list.). -* An exception from this rule are the the directories for the viglink-translation and the directories which belong the phpBB package (e.g. ``language/``, ``styles/``). +* The following folders within the language-directories must contain an ``index.htm`` file: ``language/en/acp/index.htm``, ``language/en/index.htm``, ``styles/prosilver/theme/en/index.htm``. +* No ``index.htm`` is need in the directories for the viglink-translation and the directories which belong the phpBB package: ``language/``, ``styles/``) File Validation =============== -* All files must be stored using ``LF`` (LineFeed / UNIX) line endings. +* All files must be saved with ``LF`` (LineFeed / UNIX) line endings. * All ``.php`` files must have a check for the ``IN_PHPBB`` constant: .. code-block:: php @@ -79,7 +79,7 @@ File Validation BOM*. * ``.php`` files must **not** produce any output. There should be no characters before ````, - but just end with a new line + but just end with an empty new line. language/{iso}/composer.json ---------------------------- @@ -93,9 +93,9 @@ The ``composer.json`` from the default language `British English` looks like thi "name": "phpbb/phpbb-language-en", "description": "phpBB Forum Software default language", "type": "phpbb-language", - "version": "4.0.0-a1-dev", + "version": "4.0.0-RC1", "homepage": "https://www.phpbb.com", - "license": "GPL-2.0", + "license": "GPL-2.0-only", "authors": [ { "name": "phpBB Limited", @@ -113,11 +113,12 @@ The ``composer.json`` from the default language `British English` looks like thi "language-iso": "en", "english-name": "British English", "local-name": "British English", - "phpbb-version": "4.0.0-a1-dev", + "phpbb-version": "4.0.0-RC1", "direction": "ltr", "user-lang": "en-gb", "plural-rule": 1, - "recaptcha-lang": "en-GB" + "recaptcha-lang": "en-GB", + "turnstile-lang": "en" } } @@ -126,11 +127,11 @@ Main block The main block of a language's ``composer.json`` file requires these six fields of information: * ``"name":`` Must start with ``phpbb/phpbb-language-`` and be followed by the language iso code e.g.: ``phpbb/phpbb-language-de`` -* ``"description":`` Must contain a short description for your translation e.g.: ``phpBB Forum Software language package Dutch (Casual Honorifics)`` +* ``"description":`` Must contain a short description for your translation e.g.: ``phpBB Forum Software language package Dutch (Casual Honorifics)``. URLs are not allowed. * ``"type":`` Must be: ``"phpbb-language",``. Do not change this! * ``"version":`` Should be the version number of the language package. This can be different than the phpBB-version it is made for. * ``"homepage":`` You may include a URL to your website, or leave this field empty using empty quotes ``""`` -* ``"license":`` Must be: ``"GPL-2.0",``. Do not change this! +* ``"license":`` Must be: ``"GPL-2.0-only",``. Do not change this! Authors ^^^^^^^ @@ -146,21 +147,22 @@ Use this section to credit the authors and maintainers of this translation. You Support ^^^^^^^ -Use this section to provide links to your websites, email, chat channels, etc. where you provide support for this translation. +Use this section to provide links to your websites, email, chat channels, etc. where you provide support for this translation. You should have at least one contact URL e.g. the support section in the Customisation Database on www.phpBB.com Extra ^^^^^ The Extra block contains information required for the translation to function correctly within a phpBB installation. Please do not omit any of these lines, and fill them out carefully. -* ``"language-iso":`` This must be your ISO code. In British English it is ``en``. This is also the same as the directory name e.g. ``language/en/``. +* ``"language-iso":`` This must be your ISO code. In British English it is ``en``. This is also the same as the directory name e.g. ``language/en/`` or ``language/de_x_sie/``. * ``"english-name":`` The English name of your language package e.g.: ``"German (Casual Honorifics)"``. (Formerly, this was the first line of ``language/{iso}/iso.txt``.) * ``"local-name":`` The local name of your language package e.g.: ``"Deutsch (Du)"``. (Formerly, this was the second line of ``language/{iso}/iso.txt``.) -* ``"phpbb-version":`` This must represent an existing phpBB release version e.g.: ``4.0.1``. Individual naming is not allowed here! +* ``"phpbb-version":`` This must represent an existing phpBB release version e.g.: ``4.0.0``. Individual naming is not allowed here! * ``"direction":`` Use ``"ltr""`` for "left-to-right" languages (e.g.: Italian, Dutch, German) and ``"rtl"`` for right-to-left language (e.g.: Arabic). -* ``"user-lang":`` Input the user language code, e.g.: "de". (Formerly defined in the ``language/{iso}/common.php`` e.g.: ``'USER_LANG' => 'de',``.) +* ``"user-lang":`` Input the user language code, e.g.: "de". (Formerly defined in the ``language/{iso}/common.php`` e.g.: ``'USER_LANG' => 'de',`` or ``'USER_LANG' => 'de-x-sie',``.) * ``"plural-rule":`` Input the plural rule number of your language. (Formerly defined in the ``language/{iso}/common.php`` e.g.: ``'PLURAL_RULE' => 1,``.) Check the `plurals`_ section for more details. * ``"recaptcha-lang":`` Input the ReCaptcha-Language-Code here. (Formerly defined in the ``language/{iso}/captcha_recaptcha.php`` e.g.: ``'RECAPTCHA_LANG' => 'de',``.) Check `Google ReCaptcha`_ for further information which code to use. +* ``"turnstile-lang":`` Input the Turnstile-Language-Code here. Check `Cloudflare Turnstile`_ for further information which code to use. .. note:: @@ -314,5 +316,6 @@ License .. _officially: https://www.phpbb.com/support/intl/ .. _Dutch language: https://www.phpbb.com/customise/db/translation/dutch_casual_honorifics/ .. _Google ReCaptcha: https://developers.google.com/recaptcha/docs/language +.. _Cloudflare Turnstile: https://developers.cloudflare.com/turnstile/reference/supported-languages/ .. _plurals: https://area51.phpbb.com/docs/dev/master/language/plurals.html .. _composer.json validation: https://getcomposer.org/doc/03-cli.md#validate From ae195e1b1fafb00c9f7630e2c5edd7f8987f65d3 Mon Sep 17 00:00:00 2001 From: Christian Schnegelberger Date: Sun, 28 Sep 2025 10:49:52 +0200 Subject: [PATCH 2/2] Add punctuation and an empty to validation.rst and guidelines.rst --- development/language/guidelines.rst | 2 +- development/language/validation.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/development/language/guidelines.rst b/development/language/guidelines.rst index ccab9c44..03bfe6b7 100644 --- a/development/language/guidelines.rst +++ b/development/language/guidelines.rst @@ -132,7 +132,7 @@ If your language pack is denied and then resubmitted, it is placed at the end of 5) Submissions should follow the recommendations in the `Coding Guidelines`_ as closely as possible. -6) All PHP and text files must be encoded in UTF-8 without BOM and have new line at the end of the file. Many modern text editors use this as a default setting, but we recommend checking it in your editor's settings. We recommend you use `Notepad++`_ or `PSPad`_, both lightweight and free. +6) All PHP and text files must be encoded in UTF-8 without BOM and have an empty new line at the end of the file. Many modern text editors use this as a default setting, but we recommend checking it in your editor's settings. We recommend you use `Notepad++`_ or `PSPad`_, both lightweight and free. 7) The translation is mostly your work and you have a right to hold a copyright on the translation and put your name or the names of those on your team in the ``composer.json`` file in the authors section. diff --git a/development/language/validation.rst b/development/language/validation.rst index 0216cb38..42e50bdd 100644 --- a/development/language/validation.rst +++ b/development/language/validation.rst @@ -147,7 +147,7 @@ Use this section to credit the authors and maintainers of this translation. You Support ^^^^^^^ -Use this section to provide links to your websites, email, chat channels, etc. where you provide support for this translation. You should have at least one contact URL e.g. the support section in the Customisation Database on www.phpBB.com +Use this section to provide links to your websites, email, chat channels, etc. where you provide support for this translation. You should have at least one contact URL, e.g. the support section in the Customisation Database on www.phpBB.com. Extra ^^^^^