PHPDocWiki: DocSkel/MigrationStatus ...

Migration Status

This is the migration status page.

The Edit Table

If you have decided to migrate a reference chapter, please add yourself to the following
table before starting any work. Do one extension at a time. Set the “status” field to wip (work in
progress) and add your @php.net username as “Contributor”.
Once you're done with the translation, simply set the status to “done” and add the date of
the CVS commit (as YYYY/MM/DD) after your username.

How to Edit

The process of implementing the new doc style is not automated. Here are the steps involved for implementing this conversion:

Whitespace
When migrating a reference, the whitespace fix is in a seperate commit and done before any content changes. Here's a list of possible whitespace changes:

• The new doc style beings at column 0 (flush left) while many of the old files being at column 2 (not flush left).
• The methodsynopsis may need to be moved over to the left one additional space. It's essentially flush left with the refpurpose, which begins on column 1.
• Each methodsynopsis entry is one one line, as is the refpurpose. Everything else must not exceed 78 characters in length.
• The example code (within the CDATA) should not be touched.
• Here's an example commit message: WS, preparation for the new doc style
• Commit the entire extension in one commit. Be sure to make test and cvs diff -u before submit.
• There is now a script that automatically performs these changes: phpdoc/scripts/fix-whistespace.php

Content
After performing a whitespace commit, it's time to alter the actual tags.

• Try to keep as much content the same as to create a smaller DIFF. This helps translators.
• Implement entities during this stage.
• Here's an example commit message: ref.extname: Implemented the new doc style, new entities, and rewording where appropriate
• Commit the entire extension in one commit. Be sure to make test and cvs diff -u before submit.
• There is also /scripts/switch-to-newstyle.php to help do initial work, use it first if so desired.

Don't add any new item to this list!