Bug #16015 Updated: Online Documentation Differs in languages

From: Date: Tue, 16 Jul 2002 06:11:21 +0000
Subject: Bug #16015 Updated: Online Documentation Differs in languages
References: 1  Groups: php.bugs php.doc 
Request: Send a blank email to php-bugs+get-14288@lists.php.net to get a copy of this message
ID: 16015 Updated by: philip@php.net Reported By: ronnie@bit.nl -Status: Bogus +Status: Open Bug Type: Documentation problem -PHP Version: 4.1.2 +PHP Version: CVS New Comment: Making this a documentation feature request to help lesson the impact of outdated translations. Idea #1: Use the revision and translator files, along with whatever else comes to mind, to let the reader know they're reading an outdated translation. Does a small change to en/ instantly make the nl/ outdated? No. How about two small changes? Maybe not. One large sweeping change? Sure, I think so... This of course is why no such super system exists, maybe one will be thought of ... What information could be extracted to help the reader? Maybe asking a lot :) Idea #2 Here's a start. Keep all function methodsynopsis information up-to-date, automagically, in all languages. The simplest way is to make this information identical for all translations. One copy, in en/. For example, let's take rtrim(): string rtrim ( string str [, string charlist]) That could easily remain the same in all manual translations ... in English, Finnish, Dutch, etc. A string is a string. If parameter names should change or not, who knows, it'd be easier if not :) AFAICT parameter names are rarely translated/changed anyways. Where should the methodsynopsis info be kept? I would assume in the en/ function files. If also in the translated files somehow it needs to be kept in sync. Anyway, this phpdoc feature request doesn't need to get *too* specific :) Look at fopen() for an example on why this feature request is good. Previous Comments: ------------------------------------------------------------------------ [2002-03-12 05:44:53] torben@php.net The Dutch manual appears to be in the middle of updating, and got that part of the Dutch version done before it did the English. Changes to the manual can take a while to propagate. Torben ------------------------------------------------------------------------ [2002-03-12 05:35:45] ronnie@bit.nl I have found a difference in two PHP manuals which both are online at... http://nl.php.net/manual/nl/language.variables.predefined.php http://nl.php.net/manual/en/language.variables.predefined.php De Dutch page contains information about superglobals and the english page about Apache Variables. ------------------------------------------------------------------------ -- Edit this bug report at http://bugs.php.net/?id=16015&edit=1

« previous php.bugs (#14288) next »