User:Lvl/Devel/Distributed gettext fixing effort
Jump to navigation
Jump to search
Here is a list of files that remain to be checked for correct gettext markup.
Many of these files have already some kind of markup, but in most cases the markup is not done completely, or it was not done according to our best practices and therefore needs to be fixed or checked.
I'm giving the list in a rough priority order, but that should not prevent people for addressing the files in a different order. The priority here is arbitrary and has not been discussed or "approved".
Developers: Please edit this wiki page and mention on which files you will work. Here is the suggested way-ahead:
- before working on a file, add your name in front of the file you're considering for review, by inserting -- ~~~ (this is a special wiki syntax that will add your name).
- once you're finished fixing the gettext on this file:
- for very simple changes, like small gettext() changes, it is acceptable to just lint-test the file to ensure that the syntax is correct, without going through the hoops of having the change be reviewed by another developer. Just lint (php -l) the php file after making the change and before committing.
- on the other hand if fixing the gettext markup needed more complex changes, instead of "Done", put "needing review". Another developer will then coordinate with you to review your code, and put "Done" finally when the changes are reviewed and committed to CVS.
See also:
- DP Code Best Practices and especially the section about string localization
- DP Code Text Localization
- User:Cpeel/CVS file cleanup
- User:Lvl/Devel/I18n TODO list for a more general list of things to do, apart from fixing the details of gettext markup.
High priority
Login and general pages
- accounts/activate.php -- Done. Lvl
- accounts/addproofer.php -- Done. Lvl
- accounts/login.php -- Done. Lvl
- accounts/signin.php -- Checked OK. Lvl
- activity_hub.php -- Done. Lvl
- default.php -- Checked OK. Lvl
- faq/faq_central.php
- pinc/maintenance_mode.inc -- Checked OK. Lvl
- pinc/prefs_options.inc -- Checked OK. Lvl
- userprefs.php -- Done. Lvl
- pinc/theme.inc -- Done. Lvl
- pinc/ThemedTable.inc -- No translatable text. Lvl
- pinc/site_specific.inc -- Done. Lvl
- pinc/slim_header.inc -- No translatable text. Lvl
- pinc/gradual.inc -- Checked OK. Lvl
- pinc/username.inc -- Checked OK. Lvl
News
In order to have the site news display in the user's language, some additional logic must be designed.
Proofreading interface
- tools/proofers/button_menu.inc -- Done. Lvl
- tools/proofers/ctrl_frame.php -- Done. Lvl
- tools/proofers/for_mentors.php -- Done. Lvl
- tools/proofers/greek2ascii.php -- Done. Lvl
- tools/proofers/images_index.php -- Done. Lvl
- tools/proofers/image_block_enh.inc -- Done. Lvl
- tools/proofers/image_frame_std.php -- No translatable text (except for the frame title which can be neglected). Lvl
- tools/proofers/mktable.php -- hard (monolithic UTF-8 code. Latin-1 translation will fail.) Lvl
- tools/proofers/my_projects.php -- Done. Lvl
- tools/proofers/PPage.inc -- Done. Lvl
- tools/proofers/processtext.php -- Checked OK. Lvl
- tools/proofers/proof.php -- Done. Lvl
- tools/proofers/proof_frame.inc -- Checked OK. Lvl
- tools/proofers/proof_frame.php -- Done. Lvl
- tools/proofers/proof_frame_enh.inc -- Checked OK. Lvl
- tools/proofers/proof_frame_std.inc -- Checked OK. Lvl
- tools/proofers/report_bad_page.php -- Done. Lvl
- tools/proofers/review_work.php -- Done. Lvl
- tools/proofers/round.php -- Done. Lvl
- tools/proofers/spellcheck.inc -- Done. Lvl
- tools/proofers/spellcheck_text.inc -- Done. Lvl
- tools/proofers/srchrep.php -- Done. Lvl
- tools/proofers/text_frame_std.inc -- Done. Lvl
- tools/proofers/text_frame_std.php -- No translatable text. Lvl
- tools/proofers/toolbox.inc -- Done. Lvl
- pinc/button_defs.inc -- Done. Lvl
- pinc/wordcheck_engine.inc -- Checked OK. Lvl
- pinc/abort.inc -- Checked OK. Lvl
- pinc/simple_proof_text.inc -- Checked OK. Lvl
Rounds and projects visible to the Proofreaders
- tools/request_access.php -- Done. Lvl
- tools/project_manager/detail_legend.inc -- Checked OK. Lvl
- tools/project_manager/page_detail.php -- Checked OK. Lvl
- tools/project_manager/page_table.inc -- Done. Lvl
- project.php -- Done. Lvl [**project history only partly translated]
- pinc/filter_project_list.inc -- Done. Lvl
- tools/set_project_event_subs.php -- Checked OK. Lvl
- pinc/special_colors.inc -- Done. Lvl [**note that special day names are not translated]
- tools/project_manager/diff.php -- Done. Lvl
Forums
(ask Donovan and the other Squirrels.)
As we know, phpbb2 is no longer supported, but the language packs are still available via Ubuntu archives at least for the point version immediately prior to ours. I will look in to which packs are included (53 according to the package documentation) and update this once I have information to report.--donovan 08:32, 20 July 2010 (PDT)
From this post in Recent Additions: "phpBB2 Language Packs for Dutch, French, German, Italian, Portuguese and Spanish have been installed."
Smoothreading
- pinc/showavailablebooks.inc -- Checked OK. Lvl
- pinc/smoothread.inc -- Done. Lvl
- tools/post_proofers/smooth_reading.php -- Checked OK. Lvl
- tools/upload_text.php -- Checked OK. Lvl
- pinc/page_header.inc -- Done. Lvl
- pinc/Stage.inc -- Done. Lvl
- pinc/stages.inc -- Checked OK. Lvl
- tools/change_sr_commitment.php -- Done. Lvl
Medium priority
Quiz
The quiz need to be looked at first to see how to translate the quiz themselves. TODO: understand what is remaining to be done in Amy's quizzes. Translating the wizard interface itself is very low priority
- quiz/generic/hints.php
- quiz/generic/main.php
- quiz/generic/orig.php
- quiz/generic/proof.php
- quiz/generic/returnfeed.php
- quiz/generic/right.php
- quiz/generic/wizard/checks.php
- quiz/generic/wizard/general.php
- quiz/generic/wizard/messages.php
- quiz/generic/wizard/output.php
- quiz/generic/wizard/start.php
- quiz/small_theme.inc
- quiz/start.php
- quiz/tuts/tut1.php
- quiz/tuts/tut2.php
- quiz/tuts/tut3.php
- quiz/tuts/tut4.php
- quiz/tuts/tut5.php
- pinc/Quiz.inc
Post-processing
- tools/pool.php -- Checked OK. Lvl
- pinc/Pool.inc -- No translateable strings. Lvl
- tools/post_proofers/download_scannos.php -- Checked OK. Lvl
- tools/post_proofers/postcomments.php -- Checked OK. Lvl
- tools/post_proofers/ppv_report.php -- Done. Lvl [**$language and $difficulty_level not translated yet]
Member statistics
- stats/members/mbr_list.php -- Done. Lvl
- stats/members/mbr_xml.php -- Done. Lvl
- stats/members/mdetail.php -- Checked OK. Lvl
- stats/includes/member.inc -- Done. Lvl [**note: strings like "none" will need context added; number_format not localised]
- stats/includes/team.inc -- Done. Lvl
Teams
- stats/members/jointeam.php -- Checked OK. Lvl
- stats/teams/new_team.php -- Done. Lvl
- stats/teams/tdetail.php -- Done. Lvl
- stats/teams/teams_xml.php -- No translatable strings (no need to translate XML file). Lvl
- stats/teams/tedit.php -- Checked OK. Lvl
- stats/teams/tlist.php -- Checked OK. Lvl
Project manager
- tools/changestate.php -- Done. Lvl
- tools/download_images.php -- Checked OK. Only error messages, which are untranslated. Lvl
- tools/project_manager/add_files.php -- Done. Lvl
- tools/project_manager/automodify.php -- Apparently only admin traces, not translated. Lvl [**emails to be translated later]
- tools/project_manager/autorelease.inc -- Apparently only admin traces, not translated. Lvl [**emails to be translated later]
- tools/project_manager/displayimage.php -- Done. Lvl
- tools/project_manager/downloadproofed.php -- Checked OK. Only error messages, which are untranslated. Lvl
- tools/project_manager/editproject.php -- Done. Lvl [**names of changed fields logged to project history not translated.]
- tools/project_manager/edit_common.inc -- Done. Lvl
- tools/project_manager/edit_pages.php -- Done. Lvl
- tools/project_manager/external_catalog_search.php -- Done. Lvl [**language not translated; encoding issues with external results to be fixed later]
- tools/project_manager/generate_post_files.php -- Only admin messages, not translated. Lvl
- tools/project_manager/handle_bad_page.php -- Done. Lvl
- tools/project_manager/page_operations.inc -- Checked OK. Lvl
- tools/project_manager/post_files.inc -- No translateable strings. Lvl
- tools/project_manager/projectmgr.inc -- Done. Lvl
- tools/project_manager/projectmgr.php -- Done. Lvl [**difficulty letter, languages, special days dates not translated yet; translated genres not in alphabetic order in search widget]
- tools/project_manager/replace_image.php -- Done. Lvl
- tools/project_manager/show_specials.php -- Done. Lvl [**date not localised in ugly dpsql_dump_query() stuff.]
WordCheck for the PM
- tools/project_manager/edit_project_word_lists.php -- Done. Lvl [**todo: language, link to wordcheck faq]
- tools/project_manager/show_adhoc_word_details.php -- Done. Lvl
- tools/project_manager/show_all_good_word_suggestions.php -- Checked OK. Lvl
- tools/project_manager/show_current_flagged_words.php -- Checked OK. Lvl
- tools/project_manager/show_good_word_suggestions.php -- Checked OK. Lvl
- tools/project_manager/show_good_word_suggestions_detail.php -- Done. Lvl
- tools/project_manager/show_project_possible_bad_words.php -- Checked OK. Lvl [**todo: in all these WordCheck scripts returning a file, mention the encoding in the header() function.]
- tools/project_manager/show_project_stealth_scannos.php -- Checked OK. Lvl
- tools/project_manager/show_project_wordcheck_stats.php -- Checked OK. Lvl
- tools/project_manager/graph_flags_per_page.php -- Checked OK. Lvl [**todo: check possible encoding issues with these graphs]
- tools/project_manager/graph_pages_per_number_of_flags.php -- Checked OK. Lvl
- tools/project_manager/show_project_wordcheck_usage.php -- Checked OK. Lvl
- tools/project_manager/show_word_context.php -- Done. Lvl
- tools/project_manager/word_freq_table.inc -- Done. Lvl
Low priority
Site statistics
- stats/checkedout.php -- Done. Lvl [** hand-concatenated date not translated; this is yet another project list that should preferably reuse existing code]
- stats/misc_stats1.php -- Done. Lvl
- stats/pm_stats.php -- Done. Lvl
- stats/PPV_avail.php -- Done. Lvl [** same remarks as for stats/checkedout.php]
- stats/ppv_stats.php -- Done. Lvl
- stats/pp_stats.php -- Done. Lvl
- stats/PP_unknown.php -- Checked OK. Lvl [** date via sql from_unixtime() not localised]
- stats/proof_stats.php -- Done. Lvl
- stats/release_queue.php -- Done. Lvl [** date via sql from_unixtime() not localised]
- stats/requested_books.php -- Done. Lvl [** genre and language not translated: needs to replace current mysql_dump_query logic.]
- stats/software.php -- Done. Lvl [** language names and logic to be improved]
- stats/statestats.inc -- No translateable strings. Lvl
- stats/stats_central.php -- Done. Lvl
- stats/to_be_released.php -- Markup OK. Lvl [**date, language and genre not localised]
graphs
- stats/jpgraph_files/average_hour_users_logging_on.php -- Checked OK. Lvl
- stats/jpgraph_files/common.inc
- stats/jpgraph_files/cumulative_month_proj.php
- stats/jpgraph_files/cumulative_total_proj_graph.php
- stats/jpgraph_files/cumulative_total_proj_summary_graph.php
- stats/jpgraph_files/curr_month_proj.php
- stats/jpgraph_files/pages_daily.php
- stats/jpgraph_files/percent_users_who_proof.php
- stats/jpgraph_files/tallyboard_deltas.php
- stats/jpgraph_files/total_pages_by_month_graph.php
- stats/jpgraph_files/total_proj_graph.php
- stats/jpgraph_files/users_by_country.php
- stats/jpgraph_files/users_by_language.php
- stats/jpgraph_files/users_by_month_joined.php
- stats/jpgraph_files/users_by_pages_proofed_graph.php
- stats/jpgraph_files/users_logging_on.php
- stats/misc_user_stats.php -- Checked OK. Lvl
- stats/projects_Xed_graphs.php -- Checked OK. Lvl
- stats/pages_proofed_graphs.php -- Checked OK. Lvl
- stats/user_logon_stats.php -- Checked OK. Lvl
Internal utilities, to be translated according to the need
- pinc/archiving.inc -- Not to be translated. Lvl
- pinc/BrowseUtility.inc -- Checked OK. Lvl
- pinc/dpsession_via_cookies.inc -- Checked OK. Lvl
- pinc/dpsql.inc -- Done. Lvl
- pinc/forum_interface.inc -- No translateable string. Lvl [** a few inefficient SELECT * queries]
- pinc/list_projects.inc -- Checked OK. Lvl [** language not translated]
- pinc/maybe_mail.inc -- Checked OK, but logic to be changed for email translation. Lvl
- pinc/mentorbanner.inc -- Done. Lvl
- pinc/metarefresh.inc -- Checked OK. Lvl
- pinc/page_tally.inc -- No translateable string Lvl
- pinc/phpbb2.inc -- Not to be translated. Lvl
- pinc/ProjectTransition.inc -- Checked OK. Lvl [** emails, forum posts not translated.]
- pinc/project_continuity.inc -- Checked OK. Lvl
- pinc/project_events.inc -- No translateable string Lvl
- pinc/project_edit.inc -- Done. Lvl
- pinc/project_trans.inc -- Checked OK. Lvl
- pinc/showstartexts.inc -- Checked OK, except for the alt attribute of image. Lvl
- pinc/Stopwatch.inc -- No translateable string Lvl
- pinc/tabs.inc -- No translateable string Lvl
- pinc/TallyBoard.inc -- No translateable string Lvl
- pinc/user_is.inc -- Checked OK. Lvl
Very Low Priority
Task center
We can translate the task center, but in any case the tasks themselves will have to be written in English to be understood by the admins.
- tasks.php
Image source manager
- tools/project_manager/show_image_sources.php -- Done. Lvl [**language, genre not translated in dpsql_dump]
- tools/project_manager/manage_image_sources.php -- Done. Lvl [**emails not translated]
Translation center:
(this is the new translation center)
- locale/translators/new_index.php -- Done. Lvl
Site admin
- tools/site_admin/displayrandrules.php [** do be done later when implementing LOTE random rules]
- tools/site_admin/edit_mail_address_for_non_activated_user.php -- Done . Lvl
- tools/site_admin/insert_project.php
- tools/site_admin/manage_site_word_lists.php
- tools/site_admin/proj_approvals.php
- tools/site_admin/rename_pages.php
- tools/site_admin/shared_postednums.php
- tools/site_admin/sitenews.php
- tools/site_admin/stats_repair.php
- tools/modify_access.php
- tools/pending_access_requests.php -- Done . Lvl
- config.php
- stats/faq_data.php
- tools/project_manager/move_projects.php -- Checked OK. Lvl
Files where only debug information is output
- pinc/DPage.inc
- pinc/SettingsClass.inc
- pinc/LPage.inc
- pinc/projectinfo.inc
FAQ files
No markup needed
For lengthy documents, we shall not use gettext but instead translate the entire document and manage a mapping from the english urls to the translation urls (at least that's my proposal)
- faq/document.php
- faq/formatting_guidelines_dutch.php
- faq/formatting_guidelines_francaises.php
- faq/formatting_guidelines_german.php
- faq/formatting_guidelines_italian.php
- faq/formatting_guidelines_portuguese.php
- faq/dochist.php
- faq/proofreading_guidelines.php
- faq/proofreading_guidelines_dutch.php
- faq/proofreading_guidelines_francaises.php
- faq/proofreading_guidelines_german.php
- faq/proofreading_guidelines_italian.php
- faq/proofreading_guidelines_portuguese.php
- faq/proofreading_guidelines_spanish.php
- faq/cp.php
- faq/pm-faq.php
- faq/post_proof.php
- faq/scanning.php
- faq/dpf.php
- faq/longabsent.php
- faq/ppv.php
- faq/ProoferFAQ.php
- faq/wordcheck-faq.php -- TODO: move word list tables out of here.
- faq/dev_process.php
To be gettexted
- faq/font_sample.php
- faq/simple_proof_rules.php
- faq/site_progress_snapshot_legend.php
Needs to be implemented as PHP
Use gettext or handle translations as separate documents??
- faq/privacy.php
- faq/prooffacehelp.php
Not to be translated
- faq/DPflow.php -- text is included in a picture
- faq/templates_guide.php -- TODO: disentangle code, data and documentation
- faq/feeds_sdk/index.php -- obsolete stuff?
Files where nothing is to be translated
(files which contain no English text):
- tools/project_manager/DifferenceEngine.inc -- Lvl Done
- tools/project_manager/DifferenceEngineWrapper.inc -- Lvl Done
cron jobs (no user interface)
- crontab/archive_projects.php
- crontab/del_teams.php
- crontab/genthumbs.php
- crontab/import_pg_catalog.php
- crontab/inactivate_users.php
- crontab/log_project_states.php
- crontab/notify_old_pp.php
- crontab/notify_users.php
- crontab/onoff_special_event_queues.php
- crontab/take_tally_snapshots.php
- crontab/update_ppers.php
- crontab/update_user_birthdays.php
Unused files
Code of dubious interest or status
- tools/proofers/mentorclasses.inc
- stats/temp_PM_stats.php
- pinc/Profileclass.inc
- pinc/Userclass.inc
- sample/Usertest.php
Authors stuff
- tools/authors/add.php
- tools/authors/addbio.php
- tools/authors/author.php
- tools/authors/authors.inc
- tools/authors/authorxml.php
- tools/authors/bio.php
- tools/authors/bioxml.php
- tools/authors/harvest.php
- tools/authors/listing.php
- tools/authors/manage.php
- tools/authors/menu.inc
- tools/authors/search.inc
Currently unused code (potentially used later)
- tools/proofers/md_available.php
- tools/proofers/md_phase1.php
- tools/proofers/md_phase2.php
- tools/proofers/hiero/display.php
- tools/proofers/hiero/index.php
- tools/proofers/hiero/table.php
Unused code, to be moved to the attic or deleted
- stats/statestats.php -- not linked from anywhere; obsolete (outputs data from november 2003!)
- stats/renewals_status.php -- not linked from anywhere; specific and obsolete.
- stats/currentstatestats.inc -- temporary hack that was never included anywhere.
- stats/books/book_list.php -- not linked from anywhere, redundant with list_etexts.php
- pinc/showtexts.inc -- only used by stats/books/book_list.php, and buggy.
- stats/books/bdetail.php -- no longer linked from anywhere, and redundant.
- stats/include/book.inc -- obsolete, only used by stats/books/bdetail.php
- faq/doc-copy.php -- Guidelines for the copyright renewals projects
- sample/shift_range.php
- sample/tif2png.php
- tools/catalog/get_page_text.php
- tools/catalog/index.php
- faq/download.php
- tools/proofers/morenonascii.php
- faq/translate.php -- old translation center
- locale/translators/index.php
- locale/translators/new_lang.php
- locale/translators/save_po.php
- tools/project_manager/edit_uberproject.php -- not linked from anywhere; broken.