r64808 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r64807‎ | r64808 | r64809 >
Date:17:21, 9 April 2010
Author:ialex
Status:ok
Tags:
Comment:
Update --help screen for better readability
Modified paths:
  • /trunk/phase3/maintenance/language/checkLanguage.inc (modified) (history)

Diff [purge]

Index: trunk/phase3/maintenance/language/checkLanguage.inc
@@ -1,8 +1,8 @@
22 <?php
 3+
34 /**
45 * @ingroup MaintenanceLanguage
56 */
6 -
77 class CheckLanguageCLI {
88 protected $code = null;
99 protected $level = 2;
@@ -190,17 +190,23 @@
191191 Run this script to check a specific language file, or all of them.
192192 Command line settings are in form --parameter[=value].
193193 Parameters:
194 - * lang: Language code (default: the installation default language).
195 - * all: Check all customized languages.
196 - * help: Show this help.
197 - * level: Show the following display level (default: 2).
198 - * links: Link the message values (default off).
199 - * prefix: prefix to add to links.
200 - * wikilang: For the links, what is the content language of the wiki to display the output in (default en).
201 - * whitelist: Do only the following checks (form: code,code).
202 - * blacklist: Don't do the following checks (form: code,code).
203 - * easy: Do only the easy checks, which can be treated by non-speakers of the language.
204 - * noexif: Don't check for EXIF messages (a bit hard and boring to translate), if you know that they are currently not translated and want to focus on other problems (default off).
 194+ --help: Show this help.
 195+ --lang: Language code (default: the installation default language).
 196+ --all: Check all customized languages.
 197+ --level: Show the following display level (default: 2):
 198+ * 0: Skip the checks (useful for checking syntax).
 199+ * 1: Show only the stub headers and number of wrong messages, without list of messages.
 200+ * 2: Show only the headers and the message keys, without the message values.
 201+ * 3: Show both the headers and the complete messages, with both keys and values.
 202+ --links: Link the message values (default off).
 203+ --prefix: prefix to add to links.
 204+ --wikilang: For the links, what is the content language of the wiki to display the output in (default en).
 205+ --noexif: Don't check for EXIF messages (a bit hard and boring to translate), if you know
 206+ that they are currently not translated and want to focus on other problems (default off).
 207+ --whitelist: Do only the following checks (form: code,code).
 208+ --blacklist: Don't do the following checks (form: code,code).
 209+ --easy: Do only the easy checks, which can be treated by non-speakers of the language.
 210+
205211 Check codes (ideally, all of them should result 0; all the checks are executed by default (except language-specific check blacklists in checkLanguage.inc):
206212 * untranslated: Messages which are required to translate, but are not translated.
207213 * duplicate: Messages which translation equal to fallback
@@ -220,11 +226,6 @@
221227 * magic-case: Magic words whose translation changes the case-sensitivity of the original English word.
222228 * special: Special page names that were not translated.
223229 * special-old: Special page names which do not exist.
224 -Display levels (default: 2):
225 - * 0: Skip the checks (useful for checking syntax).
226 - * 1: Show only the stub headers and number of wrong messages, without list of messages.
227 - * 2: Show only the headers and the message keys, without the message values.
228 - * 3: Show both the headers and the complete messages, with both keys and values.
229230
230231 ENDS;
231232 }
@@ -454,6 +455,9 @@
455456 }
456457 }
457458
 459+/**
 460+ * @ingroup MaintenanceLanguage
 461+ */
458462 class CheckExtensionsCLI extends CheckLanguageCLI {
459463 private $extensions;
460464

Status & tagging log