├── advisories ├── images │ ├── file-is-not-using-Linux-line-endings-(LF).png │ └── file-must-be-encoded-using-UTF8-without-BOM.png ├── file-must-be-encoded-using-UTF8-without-BOM.md └── file-is-not-using-Linux-line-endings-(LF).md ├── README.md ├── validation.md └── guidelines.md /advisories/images/file-is-not-using-Linux-line-endings-(LF).png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/phpbb/phpbb-translation-policies/3.2.x/advisories/images/file-is-not-using-Linux-line-endings-(LF).png -------------------------------------------------------------------------------- /advisories/images/file-must-be-encoded-using-UTF8-without-BOM.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/phpbb/phpbb-translation-policies/3.2.x/advisories/images/file-must-be-encoded-using-UTF8-without-BOM.png -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # phpBB Translation Policies 2 | 3 | Policies for **phpBB 3.2 Rhea** 4 | 5 | + [Language Pack Submission Policy](guidelines.md "Language Pack Submission Policy") 6 | 7 | + [Language Pack Validation Policy](validation.md "Language Pack Validation Policy") 8 | 9 | -------------------------------------------------------------------------------- /advisories/file-must-be-encoded-using-UTF8-without-BOM.md: -------------------------------------------------------------------------------- 1 | # File must be encoded using UTF8 without BOM 2 | 3 | The failure should be quite easy to fix and it's also possible on windows. 4 | Most editors have a one-click option for that. 5 | E.g. if you use [Notepad++](http://www.notepad-plus-plus.org/) to translate the files: 6 | 7 | `Encoding` => `Convert to UTF8 without BOM`: 8 | 9 | ![Fixing "File" is not using Linux line endings (LF)](images/file-must-be-encoded-using-UTF8-without-BOM.png) -------------------------------------------------------------------------------- /advisories/file-is-not-using-Linux-line-endings-(LF).md: -------------------------------------------------------------------------------- 1 | # File is not using Linux line endings (LF) 2 | 3 | The failure should be quite easy to fix and it's also possible on windows. 4 | Most editors have a one-click option for that. 5 | E.g. if you use [Notepad++](http://www.notepad-plus-plus.org/) to translate the files: 6 | 7 | `Edit` => `EOL Conversion` => `Convert to UNIX Format`: 8 | 9 | ![Fixing "File" is not using Linux line endings (LF)](images/file-is-not-using-Linux-line-endings-(LF).png) -------------------------------------------------------------------------------- /validation.md: -------------------------------------------------------------------------------- 1 | # Language Pack Validation Policy 2 | 3 | Below are the validation rules for phpBB language packages. 4 | 5 | ## Package Validation 6 | * Language packages must include all files that are included in the folders for the English language. This includes the following folders: 7 | + `ext/phpbb/viglink/language/en/` 8 | + `language/en/` 9 | + `styles/prosilver/theme/en/`. 10 | * Language packages must contain 1 additional files: 11 | + `language/{iso}/LICENSE` 12 | * Language packages may contain 4 more additional files: 13 | + `language/{iso}/AUTHORS.md` 14 | + `language/{iso}/CHANGELOG.md` 15 | + `language/{iso}/README.md` 16 | + `language/{iso}/VERSION.md` 17 | * No other additional files are allowed! 18 | * All folders must contain an `index.htm` file. 19 | 20 | ## File Validation 21 | * All files must be stored using `LF` (LineFeed / UNIX) line endings. 22 | * All `.php` files must have a check for the `IN_PHPBB` constant: 23 | 24 | if (!defined('IN_PHPBB')) 25 | { 26 | exit; 27 | } 28 | * All files containing non-english language (`.php`, `.txt`, aswell as all additional files from [section 1.](#package-validation "Package Validation")) must be saved as *UTF8 without BOM*. 29 | * `.php` files must **not** produce any output. There should be no characters before ``, but just end with a new line 31 | 32 | ### `language/{iso}/iso.txt` 33 | * The file must contain exactly 3 lines: 34 | 1. English language name 35 | + Language name in the spoken language 36 | + Author(-group) information (Plaintext only, no links allowed) 37 | 38 | ### `*/index.htm` 39 | The `index.htm` files in all folders must either be completly empty, or contains the default html body: 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | ### `language/{iso}/help/*.php` 53 | * The file must must only contain 1 array named `$lang`. No other variables are allowed. 54 | * The array must only contain arrays with the following structure: 55 | 56 | array( 57 | 0 => 'TextA', 58 | 1 => 'TextB', 59 | ), 60 | 61 | + If TextA is `--` the entry is a headline. 62 | + If both, TextA and TextB, are `--` the entry causes a column switch for the 2 column page layout. A `help/*.php` file must contain exactly one of these entries. 63 | * For TextA and TextB normal [Key Validation](#key-validation) applies. 64 | 65 | ### `language/{iso}/email/*.txt` and `language/{iso}/email/short/*.txt` 66 | * Emails must only contain the subject-line, when the english email template also contains it: 67 | 68 | Subject: {Translated subject here} 69 | * Emails must only contain the `{EMAIL_SIG}`, when the english email template also contains it. Additional the `{EMAIL_SIG}` must always be on it's own line, must be the last line of text and is followed by an empty new line. 70 | * Emails should use all variables that are provided in the english email template, in order to provide the same information to the user. 71 | * Emails may only contain `{U_BOARD}`, `{EMAIL_SIG}` and `{SITENAME}` as additional variables. No other variables are available. 72 | * Emails must not use HTML content. 73 | * There must be an empty new line at the end of the file. 74 | 75 | ### `language/{iso}/*.php` and `language/{iso}/acp/*.php` 76 | * The file must must only contain 1 array named `$lang`. No other variables are allowed. 77 | * Language files must contain all keys, which are included in the english language file. 78 | * Language files must only contain keys, which are also included in the english language file. 79 | * For all entries the [Key Validation](#key-validation) applies. 80 | 81 | 82 | ## Key Validation 83 | 84 | ### Type 85 | * Entries must be of the same type as in the english language. If the entry is of type `string`, your translation must be of type `string`. If the english language is of type `array` (e.g. using plurals), your translation must be of type `array` aswell. 86 | * If the entry is an array, your translation must contain the same keys as the english array. Exceptions are plural forms. 87 | 88 | ### String And Integer Replacements 89 | * If the english string contains replacements, such as `%s`, `%1$s`, `%d` and `%1$d`, your string should contain the same number of replacements. Exceptions are integer replacements in plural forms. This allows you to use 90 | > No posts 91 | 92 | rather then 93 | > 0 posts 94 | 95 | ### HTML 96 | * Strings should only contain HTML that is also included in the english strings. 97 | * Additional ``, ``, ``, `` and `
` are allowed. 98 | * `` should not be used, use `` instead. 99 | * `` should not be used, use `` instead. 100 | * Strings should only close HTML which it has opened itself and should close all HTML it has opened. Exceptions here are: 101 | + `language/{iso}/install.php` 102 | * `INSTALL_CONGRATS_EXPLAIN` 103 | * `INSTALL_INTRO_BODY` 104 | * `SUPPORT_BODY` 105 | * `UPDATE_INSTALLATION_EXPLAIN` 106 | * `OVERVIEW_BODY` 107 | + `language/{iso}/ucp.php` 108 | * `TERMS_OF_USE_CONTENT` 109 | * `PRIVACY_POLICY` 110 | 111 | which are always inside of a `

` tag and are allowed to close it, if they reopen it later on. 112 | 113 | ### Arrays 114 | * Arrays must have the same structure and elements as the english version. Exceptions are plural forms, which may have more or less keys, depending on the plural rule. -------------------------------------------------------------------------------- /guidelines.md: -------------------------------------------------------------------------------- 1 | # Language Pack Submission Policy 2 | 3 | Below are the procedures and guidelines that need to be followed by any translator submitting a language pack to our Customisation Database. 4 | All approved language packs can be found in our [Language Packs Database](https://www.phpbb.com/languages/ "Language Packs Database"). 5 | If you submit your language pack to our Customisation Database, it will first be automatically sent to the Translations Manager for validation. 6 | He is responsible for ensuring that your submission follows the guidelines below. 7 | Failure to comply with the following instructions could lead to an instant denial of your submission. 8 | Please note the Translations Manager has full discretion on what he approves or denies. 9 | This process can sometimes take a considerable amount of time, so it's in your best interest to follow all of the guidelines from the start. 10 | If your language pack is denied and then resubmitted, it is placed at the end of the queue. 11 | 12 | 1. Submissions have to be compatible with the latest version of phpBB. Any missing key will be detected during the upload process and your submission will be automatically denied. 13 | 14 | 15 | 2. Submissions have to be complete. Partial translations are not allowed and will be systematically denied. E-mail text files and theme-images must also be fully translated. 16 | 17 | 18 | 3. Language packs can contain five additional files (one mandatory and four optionals) that are not present in the British English language pack: `LICENSE` (mandatory), `README.md` (optional), `AUTHORS.md` (optional), `VERSION.md` (optional) and `CHANGELOG.md` (optional). 19 | You are free to write whatever you want in the `README` file, you can list all the authors and contributors of your language pack in the `AUTHORS` file, you can put the version of your language pack in the `VERSION` file and you can list all the version history in the `CHANGELOG` file. 20 | Concerning the `LICENSE` file, it is automatically added during the upload process, you do not have to manually add it. It tells to the user the license used. 21 | Language packs inherits phpBB's license [GNU General Public License 2.0](http://www.opensource.org/licenses/gpl-2.0.php "GNU General Public License 2.0"), and no additional or alternative licenses are allowed. 22 | These files must be placed in the `language/{iso}/` directory, next to the `iso.txt` file. Any other additional file will be detected and your submission will be denied. 23 | 24 | 25 | 4. Submissions must have the following files and structure: 26 | 27 | languagename_versionnumber.zip 28 | languagename_versionnumber/ 29 | ext/ 30 | phpbb/ 31 | viglink/ 32 | language/ 33 | {iso}/ 34 | info_acp_viglink.php 35 | viglink_module_acp.php 36 | language/ 37 | {iso}/ 38 | acp/ 39 | attachments.php 40 | ban.php 41 | board.php 42 | bots.php 43 | common.php 44 | database.php 45 | email.php 46 | extensions.php 47 | forums.php 48 | groups.php 49 | index.htm (optional) 50 | language.php 51 | modules.php 52 | permissions.php 53 | permissions_phpbb.php 54 | posting.php 55 | profile.php 56 | prune.php 57 | search.php 58 | styles.php 59 | users.php 60 | email/ 61 | short/ 62 | bookmark.txt 63 | index.htm (optional) 64 | newtopic_notify.txt 65 | post_approved.txt 66 | post_disapproved.txt 67 | post_in_queue.txt 68 | privmsg_notify.txt 69 | quote.txt 70 | report_pm.txt 71 | report_post.txt 72 | topic_approved.txt 73 | topic_disapproved.txt 74 | topic_in_queue.txt 75 | topic_notify.txt 76 | admin_activate.txt 77 | admin_send_email.txt 78 | admin_welcome_activated.txt 79 | admin_welcome_inactive.txt 80 | bookmark.txt 81 | contact_admin.txt 82 | coppa_resend_inactive.txt 83 | coppa_welcome_inactive.txt 84 | email_notify.txt 85 | forum_notify.txt 86 | group_added.txt 87 | group_request.txt 88 | index.htm (optional) 89 | installed.txt 90 | newtopic_notify.txt 91 | pm_report_closed.txt 92 | pm_report_deleted.txt 93 | post_approved.txt 94 | post_disapproved.txt 95 | post_in_queue.txt 96 | privmsg_notify.txt 97 | profile_send_email.txt 98 | profile_send_im.txt 99 | quote.txt 100 | report_closed.txt 101 | report_deleted.txt 102 | report_pm.txt 103 | report_post.txt 104 | test.txt 105 | topic_approved.txt 106 | topic_disapproved.txt 107 | topic_in_queue.txt 108 | topic_notify.txt 109 | user_activate.txt 110 | user_activate_inactive.txt 111 | user_activate_passwd.txt 112 | user_reactivate_account.txt 113 | user_remind_inactive.txt 114 | user_resend_inactive.txt 115 | user_welcome.txt 116 | user_welcome_inactive.txt 117 | help/ 118 | bbcode.php 119 | faq.php 120 | app.php 121 | AUTHORS.md (optional) 122 | captcha_qa.php 123 | captcha_recaptcha.php 124 | cli.php 125 | CHANGELOG.md (optional) 126 | common.php 127 | groups.php 128 | index.htm (optional) 129 | install.php 130 | iso.txt 131 | LICENSE 132 | mcp.php 133 | memberlist.php 134 | migrator.php 135 | plupload.php 136 | posting.php 137 | README.md (optional) 138 | search.php 139 | ucp.php 140 | VERSION.md (optional) 141 | viewforum.php 142 | viewtopic.php 143 | styles/ 144 | prosilver/ 145 | theme/ 146 | {iso}/ 147 | icon_user_online.gif 148 | index.htm (optional) 149 | stylesheet.css 150 | 151 | 5. Submissions have to follow as much as possible the [3.2 Translation (i18n/L10n) Guidelines](https://area51.phpbb.com/docs/32x/coding-guidelines.html#translation "3.2 Translation (i18n/L10n) Guidelines") recommandantions, especially the [3.2 Writing style](https://area51.phpbb.com/docs/32x/coding-guidelines.html#writingstyle "3.2 Writing style"). 152 | 153 | 154 | 6. All the PHP and text files have to be encoding 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. 155 | We recommend you [Notepad++](https://notepad-plus-plus.org/ "Notepad++") or [PSPad](http://www.pspad.com/en/ "PSPad"), both lightweight and free. 156 | 157 | 158 | 7. The translation is mostly your work and you have a right to hold a copyright and names to it. 159 | 160 | 161 | 8. A maximum of 3 links can be included as an author credit in the footer, customisable via the `'TRANSLATION_INFO'` key in `common.php`. 162 | Please note that the Translations Manager has complete discretion on what is acceptable as an author credit link. 163 | 164 | 165 | 9. Submissions have to be submitted as a single zip file. For information, the Customisation Database will automatically name `languagename_versionnumber.zip` your uploaded language pack. 166 | For example, if a Brazilian Portuguese language pack author uploads an archive named `Brasileiro_1.0.5.zip`, it will be automatically changed to `brazilian_portuguese_1_0_5.zip`. 167 | 168 | 169 | 10. Contribution description in the Customisation Database should be translated into English in addition of your local language. 170 | Some administrators might want to download your translation without speak your language. 171 | 172 | 173 | 11. Contribution screenshot in the Customisation Database should only be the flag of the country whose the language is spoken. 174 | For example, the flag of France for the French language. 175 | 176 | 177 | 12. Revision name in the Customisation Database should be left blank, contain the phpBB package version and/or package release name (e.g. "**3.0.12 / Richard 'D¡cky' Foote**" for 3.0.12) for more understanding. 178 | 179 | 180 | 13. The Demo URL in the Customisation Database must be empty, unless you want to put a link to an international community ([officially](https://www.phpbb.com/support/intl/ "officially") listed or not) related to the language of the contribution. 181 | For example, http://www.phpbbarabia.com/ as Demo URL concerning the [Arabic language](https://www.phpbb.com/customise/db/translation/arabic/ "Arabic language") is allowed. 182 | --------------------------------------------------------------------------------