RtkDev:Project Roadmap

From Learning Japanese Wiki (RtKWiki)

Jump to: navigation, search
RevTK Developers Hub
All articles

This is the roadmap for Phase 1. The priority for the next releases is to fix bugs, and prepare the groundwork for the Chinese version!

Contents

Planned bugfixes & tweaks

These are mostly bugfixes or small changes, new features are in the other list below.

If a bug is reported in the forums, the link to the topic is added next to the summary.

  • keyword typo "sitting in mediation" should be "sitting in meditation" (frame # 2844) (gfb345)
  • there is a problem with "distress"? RtkDev:Bug:Error with distress keyword from Fredde79
  • fix RTK1 completion message to use RTK1 flashcard count instead of max frame number [1] Ali.najaf
  • fix adding non RTK flashcards through Manage tabs [2]
  • formatting of multiple edition keywords on flashcards was lost in refactoring [3]
  • fix issue with reconnect in flashcard review page [4]
  • fix maintenance page: remove redirect (refreshing page should work when the site is back up)
  • fix timestamp 0 (never tested) Last Review date in the Detailed flashcard list [5]
  • Add back column titles in Flashcard Export and/or simple options for export (1st row = col.titles on/off)
  • The reports tab is not longer on the My story List page. [6] ycomnougue
  • test flashcard flip buggy display in Firefox 2...
  • Add unlearned kanji to progress chart bars (blue) [7]
  • Fix footer on Profile and Reading pages [8]
  • Add a clearer notice (at the top) in the create account page that an account is created on the community forums. Perhaps also allow the prrson NOT to create the forum account, and add notice to just fire an email to the admin (link contact page) when one wants the forum account (this should work so long as forum registrations are not allowed ,the usernames cant be taken).
  • Improve indexation (cf. woorank
    • All site news page title are the same! (use the news title, duh)
  • (for portable devices) in the Study area, add a button to be able to submit the search field [9]

Forum related

  • fix registration fo main site username to disallow special characters which are not accepted by PunBB forum login ("!" exclamation mark)
  • 22 characters long password doesn't work on the forum (textbox length limit +validation?) (Magnus)

Planned features/changes

Tentatively planned changes

  • Custom keywords
    • "edit in place" input field on the study page
    • tooltip to show the original keyword on review page?
    • import keywords list (csv, framenum or kanji, keyword)
  • Roadmap:Add support for non RTK kanji (6000+ kanji from JIS X 0208)
  • Roadmap:Better registration method : "untie" the forum accounts, optin for forum account creation, extra backend options
  • Select kanji font from user's system (with flash plugin), add Manage > Options
  • View stories by user (search public stories) [10]
  • Simple REST API (useful links [11] PDF) forum In development by User:Johnrb
  • Add a way to suspend reviews (max number of expired cards per day setting? 0 = suspended)
  • Button to add kanji right from study page [12]
  • Improve UI for restudy feature: beter labeling of the review buttons.
  • Red stack goes to review mode (with warning?), and add a new Restudy button to the review page?
  • Clicking green stacks shows a warning dialog, user can confirm to review green pile. This should help users who are new to SRS'es to avoid reviewing too early and messing up the Leitner schedule (and their success rate).
  • Printing stories. Requires refactor of the "My Stories" list [13]

Improving the kanji flashcards

  • Include "top 3 onyomi/kunyomi" words from JMDICT for each kanji flashcard, in kana on front, kanji on back (fab: this will use the Trinity schema, as does "iVocab Shuffle") Nukemarine

Usability/other

  • Merge My Stories and Manage exports
    • Option to include column names
    • Option to include stories (on by default)
  • Add a way for users to completely delete their account.

Extras

  • CSV Export of kanji selected from the reading page
  • Review any range of RTK cards outside of the SRS
  • Fullscreen Review mode

Someday/Maybe

  • OpenID login php article - punBB OpenID extension
  • Links to dictionaries, also custom url pattern similar to Edit Search Engines
    • eg. http://jisho.org/kanji/details/%s (note doesn't work on zhongwen.com)
  • JSON/XML interface for syncing the deck? [14]
  • Add RtK3 filter + lessons to progress page (& auto switch if totalkanji>2042)
  • Add the kanji itself in the story links, in a tooltip [15]

Framework

Upgrade the whole package to Symfony 1.x, this will then allow a smooth transition to Symfony 2.0 in the long term.

The main refactoring involves:

  • Removing Core code and adding /lib/sf/ classes
  • Make a small script that takes the configuration files (view.config.php, security.config.php) in php array and output YAML. Symfony has utility functions in its YAML class for converting to and from php arrays.
  • Split settings.php into routing config, default view configuration, and so on, and convert those to YAML as previous step.
  • We would continue to use Zend_Db API, so Doctrine should be disabled, and Zend_Db installed under libs/ somewhere. This should minimize refactoring as coreDatabase methods are 99% identical to Zend_Db API.
  • A mass rename of all template files in the Symfony convention (I think Symfony doesn't use "View" suffix in the templates).

Someday/maybe:

  • Use Twig for templating, or as part of Symfony 2 upgrade.
    • Better for documenting templates
    • Extendable

Tools

  • Maintain a MySQLWorkbench file for A3 printing (include the PDF?) for database structure "cheatsheet"
  • Extract common code between batch/maintenance/createUser.php and lib/juicer/JuicerCLI.php AND batch/build_app.php, and create a base class that can be reused to create other tools quickly (verbose option, throwError(), getOption(), showHelp(), etc)

Repository

These are planned changes to the repository to do by the maintainer (Fabrice).

  • Include scripts (Perl, php) that are used to generate the static data in the RevTK database
  • Include data files useful for the project (edict.utf8, radicals.utf8, radkfile, jmdict.xml and so on).
    • Where to host this? (175MB)
    • Or add to the Data files page.

Website Support & SEO

Note: this is normally only worked on by Fabrice, since it concerns website's sustainability, affiliations and direct advertising. However this is open for suggestions too.

  • Put a link to Amazon on the left side of the Home Page that us regulars see (Harrow)
  • Create a Amazon store? (best learning materials selected by members, eg. dictionaries, textbooks, NDS kanji games, and so on)
Retrieved from "http://rtkwiki.koohii.com/wiki/RtkDev:Project_Roadmap"