Revision tracking in phpdoc and peardoc
| From: | Christian Weiske | Date: | Sat, 08 Nov 2008 23:05:42 +0000 |
| Subject: | Revision tracking in phpdoc and peardoc | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969379646@lists.php.net to get a copy of this message | ||
Hello all,
Now that peardoc also uses PhD, we need a good method to track
revisions for the english version and translations.
We need a way to determine if translations are outdated, and if those
outdatedness is only minor or a major outdatance.
There has been a discussion about this [1], but that was over a year
ago and nothing has been done yet.
I personally favor the docbook revision attribute for the file's top
level tag, with a major and minor rev number. Incrementing the major one
determines that big/major changes have been done, while a minor number
enhancement tells you that only smaller things have changed. The
numbers would be updated manually instead of automatically - which has
the advantage that typos can be fixed without bumping the number.
When a translation differs in the major number, a big fat warning
should be displayed at top of the page.
In comparison to the currently used Revcheck comment in the files, the
revision attributes can be read programmatically using plain XML
libraries, without own parsing scripts.
So what do people think now, one year after the last discussion?
[1] http://markmail.org/message/3t2pmgoq35h5ogep
--
Regards/Mit freundlichen Grüßen
Christian Weiske
-= Geeking around in the name of science since 1982 =-
Attachment: [application/pgp-signature] signature.asc
Attachment: [application/pgp-signature] signature.asc